Merge branch 'main' into 88-error-unable-to-run-the-generated-docker-image

.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

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=<yourExternalIp1> <yourExternalIp2' >> .env.override
+    ```
+    More information can be found [here](../../wiki/Configuration).
+5. **Run the project:**
     ```bash
     make start
     ```

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")