Tweak readme wording, add links
This commit is contained in:
parent
8366b63374
commit
f8cfb9546d
2 changed files with 10 additions and 4 deletions
|
@ -80,6 +80,10 @@ We support all of the official [environment variables](https://docs.joinmastodon
|
||||||
|
|
||||||
For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
|
For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
|
||||||
|
|
||||||
|
### Strict reverse proxies
|
||||||
|
|
||||||
|
This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
Here are some example snippets to help you get started creating a container.
|
Here are some example snippets to help you get started creating a container.
|
||||||
|
@ -206,7 +210,7 @@ Container images are configured using parameters passed at runtime (such as thos
|
||||||
| `-e SMTP_PASSWORD=` | SMTP password |
|
| `-e SMTP_PASSWORD=` | SMTP password |
|
||||||
| `-e SMTP_FROM_ADDRESS=notifications@example.com` | From address for emails send from Mastodon |
|
| `-e SMTP_FROM_ADDRESS=notifications@example.com` | From address for emails send from Mastodon |
|
||||||
| `-e S3_ENABLED=false` | Enable or disable S3 storage of uploaded files |
|
| `-e S3_ENABLED=false` | Enable or disable S3 storage of uploaded files |
|
||||||
| `-e WEB_DOMAIN=mastodon.example.com` | This can be set if you want your server identifier to be different to the subdomain hosting Mastodon. See https://docs.joinmastodon.org/admin/config/#basic |
|
| `-e WEB_DOMAIN=mastodon.example.com` | This can be set if you want your server identifier to be different to the subdomain hosting Mastodon. See [https://docs.joinmastodon.org/admin/config/#basic](https://docs.joinmastodon.org/admin/config/#basic) |
|
||||||
| `-e ES_HOST=es` | Elasticsearch server hostname |
|
| `-e ES_HOST=es` | Elasticsearch server hostname |
|
||||||
| `-e ES_PORT=9200` | Elasticsearch port |
|
| `-e ES_PORT=9200` | Elasticsearch port |
|
||||||
| `-e ES_USER=elastic` | Elasticsearch username |
|
| `-e ES_USER=elastic` | Elasticsearch username |
|
||||||
|
|
|
@ -49,7 +49,7 @@ param_env_vars:
|
||||||
|
|
||||||
opt_param_usage_include_env: true
|
opt_param_usage_include_env: true
|
||||||
opt_param_env_vars:
|
opt_param_env_vars:
|
||||||
- { env_var: "WEB_DOMAIN", env_value: "mastodon.example.com", desc: "This can be set if you want your server identifier to be different to the subdomain hosting Mastodon. See https://docs.joinmastodon.org/admin/config/#basic"}
|
- { env_var: "WEB_DOMAIN", env_value: "mastodon.example.com", desc: "This can be set if you want your server identifier to be different to the subdomain hosting Mastodon. See [https://docs.joinmastodon.org/admin/config/#basic](https://docs.joinmastodon.org/admin/config/#basic)"}
|
||||||
- { env_var: "ES_HOST", env_value: "es", desc: "Elasticsearch server hostname"}
|
- { env_var: "ES_HOST", env_value: "es", desc: "Elasticsearch server hostname"}
|
||||||
- { env_var: "ES_PORT", env_value: "9200", desc: "Elasticsearch port"}
|
- { env_var: "ES_PORT", env_value: "9200", desc: "Elasticsearch port"}
|
||||||
- { env_var: "ES_USER", env_value: "elastic", desc: "Elasticsearch username"}
|
- { env_var: "ES_USER", env_value: "elastic", desc: "Elasticsearch username"}
|
||||||
|
@ -79,12 +79,14 @@ app_setup_block: |
|
||||||
|
|
||||||
This container *requires* separate postgres and redis instances to run.
|
This container *requires* separate postgres and redis instances to run.
|
||||||
|
|
||||||
If you are reverse proxying this container you must proxy the *https* port otherwise you will end up with a redirect loop.
|
|
||||||
|
|
||||||
We support all of the official [environment variables](https://docs.joinmastodon.org/admin/config) for configuration. In place of adding them all to your run/compose you can use an env file such as [this example](https://github.com/mastodon/mastodon/blob/main/.env.production.sample) from the upstream project.
|
We support all of the official [environment variables](https://docs.joinmastodon.org/admin/config) for configuration. In place of adding them all to your run/compose you can use an env file such as [this example](https://github.com/mastodon/mastodon/blob/main/.env.production.sample) from the upstream project.
|
||||||
|
|
||||||
For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
|
For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
|
||||||
|
|
||||||
|
### Strict reverse proxies
|
||||||
|
|
||||||
|
This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to [disable this check for the container](https://docs.linuxserver.io/faq#strict-proxy).
|
||||||
|
|
||||||
# changelog
|
# changelog
|
||||||
changelogs:
|
changelogs:
|
||||||
- { date: "05.11.22:", desc: "Initial Release." }
|
- { date: "05.11.22:", desc: "Initial Release." }
|
Loading…
Reference in a new issue