Skip to content

Commit

Permalink
clarifications and examples
Browse files Browse the repository at this point in the history
  • Loading branch information
or-else committed Sep 2, 2018
1 parent 443b415 commit 0f3ab66
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,18 +66,17 @@ You can specify the following environment viriables when issuing `docker run` co

| Variable | Type | Default | Function |
| --- | --- | --- | --- |
| API_KEY_SALT | string | `T713/rYYgW7g4m3vG6zGRh7+FM1t0T8j13koXScOAj4=` | base64-encoded 32 random bytes used as API salt. Use [keygen](../keygen) to create the API key. |
| AUTH_TOKEN_KEY | string | `wfaY2RgF2S1OQI/ZlK+LSrp1KB2jwAdGAIHQ7JZn+Kc=` | base64-encoded 32 random bytes used as salt for authentication tokens |
| DEBUG_EMAIL_VERIFICATION_CODE | string | | Enable dummy email verification code. Disabled by default (empty string). |
| API_KEY_SALT | string | `T713/rYYgW7g4m3vG6zGRh\ 7+FM1t0T8j13koXScOAj4=` | base64-encoded 32 random bytes used as API salt. Use [keygen](../keygen) to create a personalized API key. |
| AUTH_TOKEN_KEY | string | `wfaY2RgF2S1OQI/ZlK+LS\ rp1KB2jwAdGAIHQ7JZn+Kc=` | base64-encoded 32 random bytes used as salt for authentication tokens |
| DEBUG_EMAIL_VERIFICATION_CODE | string | | Enable dummy email verification code, e.g. `123456`. Disabled by default (empty string). |
| MYSQL_DSN | string | `'root@tcp(mysql)/tinode'` | MySQL [DSN](https://github.com/go-sql-driver/mysql#dsn-data-source-name) |
| RESET_DB | bool | `false` | Drop and recreate the database. |
| SMTP_PASSWORD | string | | Password to use for authentication with the SMTP server |
| SMTP_PORT | number | | Port number of the SMTP server to use for sending verification emails, e.g. `25` or `587`. |
| SMTP_SENDER | string | | RFC 5322 email address to use in the `FROM` field of verification emails and for authentication with the SMTP server. |
| SMTP_SENDER | string | | [RFC 5322](https://tools.ietf.org/html/rfc5322) email address to use in the `FROM` field of verification emails and for authentication with the SMTP server, .e.g. `'"John Doe" <jdoe@example.com>'` |
| SMTP_SERVER | string | | Name of the SMTP server to use for sending verification emails, e.g. `smtp.gmail.com`. If SMTP_SERVER is not defined, email verification will be disabled. |
| TLS_CONTACT_ADDRESS | string | | Optional email address to use as contact for Lets Encrypt certificats. |
| TLS_DOMAIN_NAME | string | | If non-empty, enables TLS (http**s**) and configures domain name of your container. In order for TLS to work you have to correctly configure DNS for your container. |
| TLS_ENABLED | bool | `false` | |
| TLS_CONTACT_ADDRESS | string | | Optional email to use as contact for [LetsEncrypt](https://letsencrypt.org/) certificates, e.g. `jdoe@example.com`. |
| TLS_DOMAIN_NAME | string | | If non-empty, enables TLS (http**s**) and configures domain name of your container, e.g. `www.example.com`. In order for TLS to work you have to expose your HTTPS port to the Internet and correctly configure DNS. It WILL FAIL with `localhost` or unroutable IPs. |
| UID_ENCRYPTION_KEY | string | `la6YsO+bNX/+XIkOqc5Svw==` | base64-encoded 16 random bytes used as an encryption key for user IDs. |

Unix-like systems offer a convenient way to generate a random base64-encoded string of desired length as
Expand Down

0 comments on commit 0f3ab66

Please sign in to comment.