diff options
author | thursday <xthursdayx@mailbox.org> | 2021-11-25 13:12:14 -0500 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-11-25 13:12:14 -0500 |
commit | 5d75c3c122fbc63025312b8a50cda5592c28d5bc (patch) | |
tree | 4b126d78e3645e75b86fac17eee44a7e89a7519c /docker/README.md | |
parent | Merge branch 'main' into master (diff) | |
parent | Update build-and-publish.yml (diff) | |
download | ferdium-server-5d75c3c122fbc63025312b8a50cda5592c28d5bc.tar.gz ferdium-server-5d75c3c122fbc63025312b8a50cda5592c28d5bc.tar.zst ferdium-server-5d75c3c122fbc63025312b8a50cda5592c28d5bc.zip |
Merge pull request #85 from xthursdayx/main
Update custom service icon host and protocol and fix smtp mailer
Diffstat (limited to 'docker/README.md')
-rw-r--r-- | docker/README.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docker/README.md b/docker/README.md index 98877f4..3cb49be 100644 --- a/docker/README.md +++ b/docker/README.md | |||
@@ -35,7 +35,7 @@ To create the docker container with the proper parameters: | |||
35 | docker create \ | 35 | docker create \ |
36 | --name=ferdi-server \ | 36 | --name=ferdi-server \ |
37 | -e NODE_ENV=development \ | 37 | -e NODE_ENV=development \ |
38 | -e EXTERNAL_DOMAIN=<ferdi-serverdomain> \ | 38 | -e APP_URL=<ferdi-server-url> \ |
39 | -e DB_CONNECTION=<database> \ | 39 | -e DB_CONNECTION=<database> \ |
40 | -e DB_HOST=<yourdbhost> \ | 40 | -e DB_HOST=<yourdbhost> \ |
41 | -e DB_PORT=<yourdbport> \ | 41 | -e DB_PORT=<yourdbport> \ |
@@ -44,7 +44,7 @@ To create the docker container with the proper parameters: | |||
44 | -e DB_DATABASE=<yourdbdatabase> \ | 44 | -e DB_DATABASE=<yourdbdatabase> \ |
45 | -e DB_SSL=false \ | 45 | -e DB_SSL=false \ |
46 | -e MAIL_CONNECTION=smtp \ | 46 | -e MAIL_CONNECTION=smtp \ |
47 | -e SMPT_HOST=<smtpmailserver> \ | 47 | -e SMTP_HOST=<smtpmailserver> \ |
48 | -e SMTP_PORT=<smtpport> \ | 48 | -e SMTP_PORT=<smtpport> \ |
49 | -e MAIL_SSL=true/false \ | 49 | -e MAIL_SSL=true/false \ |
50 | -e MAIL_USERNAME=<yourmailusername> \ | 50 | -e MAIL_USERNAME=<yourmailusername> \ |
@@ -79,7 +79,7 @@ Container images are configured using parameters passed at runtime (such as thos | |||
79 | | :----: | --- | | 79 | | :----: | --- | |
80 | | `-p <port>:3333` | Will map the container's port 3333 to a port on the host, default is 3333. See the [Docker docs](https://docs.docker.com/config/containers/container-networking/) for more information about port mapping | | 80 | | `-p <port>:3333` | Will map the container's port 3333 to a port on the host, default is 3333. See the [Docker docs](https://docs.docker.com/config/containers/container-networking/) for more information about port mapping | |
81 | | `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed**. See the [Docker docs](https://docs.docker.com/) for more information on the use of environmental variables in [Command-line](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only) and [Docker Compose](https://docs.docker.com/compose/environment-variables/) | | 81 | | `-e NODE_ENV=development` | for specifying Node environment, production or development, default is development **currently this should not be changed**. See the [Docker docs](https://docs.docker.com/) for more information on the use of environmental variables in [Command-line](https://docs.docker.com/engine/reference/commandline/run/#mount-volume--v---read-only) and [Docker Compose](https://docs.docker.com/compose/environment-variables/) | |
82 | | `-e EXTERNAL_DOMAIN=<ferdi-serverdomain>` | for specifying the external domain address of the Ferdi-server | | 82 | | `-e APP_URL=<ferdi-server-url>` | for specifying the URL of the Ferdi-server, including `http://` or `https://` as relevant. | |
83 | | `-e DB_CONNECTION=<databasedriver` | for specifying the database being used, default is sqlite, see [below](#supported-databases-and-drivers) for other options | | 83 | | `-e DB_CONNECTION=<databasedriver` | for specifying the database being used, default is sqlite, see [below](#supported-databases-and-drivers) for other options | |
84 | | `-e DB_HOST=<yourdbhost>` | for specifying the database host, default is 127.0.0.1 | | 84 | | `-e DB_HOST=<yourdbhost>` | for specifying the database host, default is 127.0.0.1 | |
85 | | `-e DB_PORT=<yourdbport>` | for specifying the database port, default is 3306 | | 85 | | `-e DB_PORT=<yourdbport>` | for specifying the database port, default is 3306 | |
@@ -88,7 +88,7 @@ Container images are configured using parameters passed at runtime (such as thos | |||
88 | | `-e DB_DATABASE=<databasename>` | for specifying the database name to be used, default is ferdi | | 88 | | `-e DB_DATABASE=<databasename>` | for specifying the database name to be used, default is ferdi | |
89 | | `-e DB_SSL=false` | true only if your database is postgres and it is hosted online, on platforms like GCP, AWS, etc | | 89 | | `-e DB_SSL=false` | true only if your database is postgres and it is hosted online, on platforms like GCP, AWS, etc | |
90 | | `-e MAIL_CONNECTION=<mailsender>` | for specifying the mail sender to be used, default is smtp | | 90 | | `-e MAIL_CONNECTION=<mailsender>` | for specifying the mail sender to be used, default is smtp | |
91 | | `-e SMPT_HOST=<smtpmailserver>` | for specifying the mail host to be used, default is 127.0.0.1 | | 91 | | `-e SMTP_HOST=<smtpmailserver>` | for specifying the mail host to be used, default is 127.0.0.1 | |
92 | | `-e SMTP_PORT=<smtpport>` | for specifying the mail port to be used, default is 2525 | | 92 | | `-e SMTP_PORT=<smtpport>` | for specifying the mail port to be used, default is 2525 | |
93 | | `-e MAIL_SSL=true/false` | for specifying SMTP mail security, default is false | | 93 | | `-e MAIL_SSL=true/false` | for specifying SMTP mail security, default is false | |
94 | | `-e MAIL_USERNAME=<yourmailusername>` | for specifying your mail username to be used, default is username | | 94 | | `-e MAIL_USERNAME=<yourmailusername>` | for specifying your mail username to be used, default is username | |