diff --git a/.env.common b/.env.default similarity index 92% rename from .env.common rename to .env.default index 26ee600..564af13 100644 --- a/.env.common +++ b/.env.default @@ -1,3 +1,7 @@ +# !!! PLEASE DO NOT EDIT THIS FILE !!! +# To make changes to the '.env', use the '.env.override' file +# https://github.com/anyproto/any-sync-dockercompose/wiki/Configuration + AWS_ACCESS_KEY_ID=minio_access_key AWS_SECRET_ACCESS_KEY=minio_secret_key MINIO_BUCKET=minio-bucket @@ -14,7 +18,7 @@ ANY_SYNC_TOOLS_VERSION=latest MONGO_VERSION=7.0.2 REDIS_VERSION=7.2.0-v6 -MINIO_VERSION=RELEASE.2024-07-04T14-25-45Z +MINIO_VERSION=RELEASE.2024-07-04T14-25-45Z EXTERNAL_LISTEN_HOST="127.0.0.1" #EXTERNAL_LISTEN_HOSTS="192.168.1.2 10.0.0.2" diff --git a/README.md b/README.md index 42c3215..408bc50 100644 --- a/README.md +++ b/README.md @@ -15,17 +15,24 @@ Please visit the Wiki for comprehensive guides, installation instructions and mo ## Getting Started To get started, follow these steps: -1. **Clone the repository:** +1. **Install the necessary dependencies:** + You need to install Docker and Docker Compose https://docs.docker.com/compose/install/ +2. **Clone the repository:** ```bash git clone https://github.com/anyproto/any-sync-dockercompose.git ``` -2. **Navigate to the project directory:** +3. **Navigate to the project directory:** ```bash cd any-sync-dockercompose ``` -3. **Install the necessary dependencies:** - You need to install Docker and Docker Compose https://docs.docker.com/compose/install/ -4. **Run the project:** +4. **Configuration:** + For configuration, use the `.env.override` file. + For example, setting an external IP for listening: + ```bash + echo 'EXTERNAL_LISTEN_HOSTS= > .env.override + ``` + More information can be found [here](../../wiki/Configuration). +5. **Run the project:** ```bash make start ``` diff --git a/docker-generateconfig/env.py b/docker-generateconfig/env.py index e7fbbf7..76b8503 100755 --- a/docker-generateconfig/env.py +++ b/docker-generateconfig/env.py @@ -7,7 +7,7 @@ import requests import re cfg = { - 'inputFile': '.env.common', + 'inputFile': '.env.default', 'overrideFile': '.env.override', 'outputFile': '.env', 'overrideVarMap': { @@ -20,6 +20,11 @@ cfg = { 'prod': 'https://puppetdoc.anytype.io/api/v1/prod-any-sync-compatible-versions/', 'stage1': 'https://puppetdoc.anytype.io/api/v1/stage1-any-sync-compatible-versions/', }, + 'outputFileHeader': '''# !!! PLEASE DO NOT EDIT THIS FILE !!! +# To make changes to the '.env', use the '.env.override' file +# https://github.com/anyproto/any-sync-dockercompose/wiki/Configuration + +''', } # load variables from inputFile @@ -78,5 +83,6 @@ for key,value in envVars.items(): # save in output file with open(cfg['outputFile'], 'w') as file: + file.write(cfg['outputFileHeader']) for key, value in envVars.items(): file.write(f"{key}={value}\n")