aboutsummaryrefslogtreecommitdiff
path: root/template/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'template/README.md')
-rw-r--r--template/README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/template/README.md b/template/README.md
new file mode 100644
index 0000000..702ebfa
--- /dev/null
+++ b/template/README.md
@@ -0,0 +1,12 @@
+This directory contains the template files to generate the final config files.
+The template format is quite simple: they are just files containing `{{VAR}}`s. You can simply use text substitution to do the generation. All variable names begin with `CRUPEST_` to avoid name conflicts.
+
+Run `generate.py` and it will help you configure and generate the final config files.
+
+Here are the variables used in templates:
+| Variable | Description |
+| -------- | ----------- |
+| CRUPEST_DOMAIN | Domain to deploy. |
+| CRUPEST_UID | Your uid. Run `id -u` to get it. |
+| CRUPEST_GID | Your gid. Run `id -g` to get it. |
+| CRUPEST_HALO_DB_PASSWORD | Used as halo's h2 database password. Better not to change it after first run. |