Skip to content

Commit 668c984

Browse files
committed
Update README and docker-compose files for new entrypoint
- Removed MAILTRAIN_SETTING command - Added list of Environment Variables to README
1 parent b21005d commit 668c984

File tree

3 files changed

+23
-7
lines changed

3 files changed

+23
-7
lines changed

README.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,17 +193,35 @@ These are the steps to start Mailtrain via docker-compose:
193193
docker-compose up
194194
```
195195
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-
201196
3. Open the trusted endpoint http://localhost:3000
202197
203198
4. Authenticate as `admin`:`test`
204199
205200
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.
206201
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) |
207225
208226
## License
209227

docker-compose-local.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ services:
2323

2424
mailtrain:
2525
build: .
26-
command: ${MAILTRAIN_SETTINGS}
2726
ports:
2827
- "3000:3000"
2928
- "3003:3003"

docker-compose.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ services:
2323

2424
mailtrain:
2525
image: mailtrain/mailtrain:latest
26-
command: ${MAILTRAIN_SETTINGS}
2726
ports:
2827
- "3000:3000"
2928
- "3003:3003"

0 commit comments

Comments
 (0)