diff options
| -rw-r--r-- | template/README.md | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/template/README.md b/template/README.md index 702ebfa..698dd1d 100644 --- a/template/README.md +++ b/template/README.md @@ -6,7 +6,16 @@ Run `generate.py` and it will help you configure and generate the final config f 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. | +| `CRUPEST_DOMAIN` | Domain to deploy. | +| `CRUPEST_USER` | Your username. Run `id -un` to get it. | +| `CRUPEST_GROUP` | Your group. Run `id -gn` to get it. | +| `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. | +| `CRUPEST_IN_CHINA` | Set to `true` if you are in China. | + +Note: + +1. `CRUPEST_{USER,GROUP,UID,GID}` are used to sync your account to some containers like `code-server` to avoid permission problems. You don't bother to manually set them as the python script will do it for you. However if you change them, you need to manually update it in config and regenerate something. But I don't really think you should change them. + +2. `CRUPEST_IN_CHINA` is used to set the mirror for some containers both in themselves or in the process of building them. It is default to `false`. If you are in China, you can set it to `true` to speed up the process. |