yetangitu/timelimit-server
1
0
Fork 0
mirror of https://codeberg.org/timelimit/timelimit-server.git synced 2025-10-04 10:19:26 +02:00
Code Issues Projects Releases Wiki Activity

Extend Readme infos about MAIL_TRANSPORT

Browse source
This commit is contained in:
Jonas Lochmann 2020-04-06 02:00:00 +02:00
parent 24877ba44e
commit 0d65c01711
No known key found for this signature in database
GPG key ID: 8B8C9AEE10FA5B36
1 changed files with 22 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

28
Readme.md
View file

@ -50,9 +50,15 @@ This fixes the causes of lint warnings (where possible).
- MAIL_SENDER - MAIL_SENDER
- sender (for the from-field) for sent mails - sender (for the from-field) for sent mails
- MAIL_TRANSPORT - MAIL_TRANSPORT
- a JSON encoded configuration for nodemailer (object with service and auth) - a JSON encoded configuration for nodemailer
- see <https://nodemailer.com/smtp/well-known/> for examples - supports setting a smtp server configuration, see <https://nodemailer.com/smtp/>
- allows easier configuration in case of a [well known services](https://nodemailer.com/smtp/well-known/)
- default value is ``null`` - default value is ``null``
- examples
- ``{"host": "localhost", "port": 25}`` (using a local mail server which does not require any authentication)
- ``{"service": "1und1", "auth": {"user": "me@my.timelimit.server", "pass": "my password"}}`` (using a well known service)
- ``{"host": "my.mail.server", "secure": true, "auth": {"user": "me@my.timelimit.server", "pass": "my password"}}`` (using a external smtp server)
- in case of a docker-compose file, you should escape this, e.g. sourround it with ``'`` single quotes
- MAIL_IMPRINT - MAIL_IMPRINT
- a string which is added to the footer of the sent mails - a string which is added to the footer of the sent mails
- default value: ``not defined`` - default value: ``not defined``
@ -144,13 +150,16 @@ services:
NODE_ENV: production NODE_ENV: production
DATABASE_URL: mariadb://timelimit:timelimitpassword@database:3306/timelimit DATABASE_URL: mariadb://timelimit:timelimitpassword@database:3306/timelimit
PORT: 8080 PORT: 8080
MAIL_SENDER: me@my.timelimit.server
MAIL_TRANSPORT: '{"host": "localhost", "port": 25}'
# put additional config variables here # put additional config variables here
ports: ports:
- "8080:8080" - "8080:8080"
restart: always restart: always
# you should enable logging/ comment this out during testing # you can enable logging during testing by commenting this out,
#logging: # but logging is not needed when everything works
# driver: none logging:
driver: none
links: links:
- database - database
database: database:
@ -162,6 +171,10 @@ services:
MYSQL_PASSWORD: timelimitpassword MYSQL_PASSWORD: timelimitpassword
volumes: volumes:
- ./database:/var/lib/mysql - ./database:/var/lib/mysql
# you can enable logging during testing by commenting this out,
# but logging is not needed when everything works
logging:
driver: none
``` ```
The database files will be saved at the folder which contains the docker-compose.yml. The database files will be saved at the folder which contains the docker-compose.yml.
@ -184,9 +197,12 @@ services:
NODE_ENV: production NODE_ENV: production
DATABASE_URL: postgres://user:pass@example.com:5432/dbname DATABASE_URL: postgres://user:pass@example.com:5432/dbname
PORT: 8080 PORT: 8080
MAIL_SENDER: me@my.timelimit.server
MAIL_TRANSPORT: '{"host": "localhost", "port": 25}'
# put additional config variables here # put additional config variables here
restart: always restart: always
# you should enable logging during testing # you can enable logging during testing by commenting this out,
# but logging is not needed when everything works
logging: logging:
driver: none driver: none
# easy solution to use a database which does not run within docker # easy solution to use a database which does not run within docker