You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+23-5Lines changed: 23 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -193,17 +193,35 @@ These are the steps to start Mailtrain via docker-compose:
193
193
docker-compose up
194
194
```
195
195
196
-
You can specify Mailtrain's URL bases via the `MAILTRAIN_SETTINGS` environment variable as follows. The `--withProxy` parameter is to be used when Mailtrain is put behind a reverse proxy.
197
-
```
198
-
MAILTRAIN_SETTINGS="--trustedUrlBase https://mailtrain.example.com --sandboxUrlBase https://sbox.mailtrain.example.com --publicUrlBase https://lists.example.com --withProxy" docker-compose up
199
-
```
200
-
201
196
3. Open the trusted endpoint http://localhost:3000
202
197
203
198
4. Authenticate as `admin`:`test`
204
199
205
200
The instructions above use an automatically built Docker image on DockerHub (https://hub.docker.com/r/mailtrain/mailtrain). If you want to build the Docker image yourself (e.g. when doing development), use the `docker-compose-local.yml` located in the project's root directory.
206
201
202
+
### Docker Environment Variables
203
+
204
+
| Parameter | Description |
205
+
| --------- | ----------- |
206
+
| URL_BASE_TRUSTED | sets the trusted url of the instance (default: http://localhost:3000) |
207
+
| URL_BASE_SANDBOX | sets the sandbox url of the instance (default: http://localhost:3003) |
208
+
| URL_BASE_SANDBOX | sets the public url of the instance (default: http://localhost:3004) |
209
+
| WITH_PROXY | use if Mailtrain is behind an http reverse proxy |
210
+
| MONGO_HOST | sets mongo host (default: mongo) |
211
+
| REDIS_HOST | sets redis host (default: redis) |
212
+
| MYSQL_HOST | sets mysql host (default: mysql) |
213
+
| MYSQL_HOST | sets mysql database (default: mailtrain) |
214
+
| MYSQL_USER | sets mysql user (default: mailtrain) |
215
+
| MYSQL_PASSWORT | sets mysql password (default: mailtrain) |
216
+
| WITH_LDAP | use if you want to enable LDAP authentication |
217
+
| LDAP_HOST | LDAP Host for authentication (default: ldap) |
218
+
| LDAP_PORT | LDAP port (default: 389) |
219
+
| LDAP_SECURE | use if you want to use LDAP with ldaps protocol |
220
+
| LDAP_BIND_USER | User for LDAP connexion |
221
+
| LDAP_BIND_PASS | Password for LDAP connexion |
222
+
| LDAP_FILTER | LDAP filter |
223
+
| LDAP_BASEDN | LDAP base DN |
224
+
| LDAP_UIDTAG | LDAP UID tag (e.g. uid/cn/username) |
0 commit comments