Skip to content

Commit f8cfb95

Browse files
committed
Tweak readme wording, add links
1 parent 8366b63 commit f8cfb95

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,10 @@ We support all of the official [environment variables](https://docs.joinmastodon
8080

8181
For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
8282

83+
### Strict reverse proxies
84+
85+
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).
86+
8387
## Usage
8488

8589
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
206210
| `-e SMTP_PASSWORD=` | SMTP password |
207211
| `-e [email protected]` | From address for emails send from Mastodon |
208212
| `-e S3_ENABLED=false` | Enable or disable S3 storage of uploaded files |
209-
| `-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 |
213+
| `-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) |
210214
| `-e ES_HOST=es` | Elasticsearch server hostname |
211215
| `-e ES_PORT=9200` | Elasticsearch port |
212216
| `-e ES_USER=elastic` | Elasticsearch username |

readme-vars.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ param_env_vars:
4949

5050
opt_param_usage_include_env: true
5151
opt_param_env_vars:
52-
- { 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"}
52+
- { 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)"}
5353
- { env_var: "ES_HOST", env_value: "es", desc: "Elasticsearch server hostname"}
5454
- { env_var: "ES_PORT", env_value: "9200", desc: "Elasticsearch port"}
5555
- { env_var: "ES_USER", env_value: "elastic", desc: "Elasticsearch username"}
@@ -79,12 +79,14 @@ app_setup_block: |
7979
8080
This container *requires* separate postgres and redis instances to run.
8181
82-
If you are reverse proxying this container you must proxy the *https* port otherwise you will end up with a redirect loop.
83-
8482
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.
8583
8684
For more information check out the [mastodon documentation](https://docs.joinmastodon.org/).
8785
86+
### Strict reverse proxies
87+
88+
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).
89+
8890
# changelog
8991
changelogs:
9092
- { date: "05.11.22:", desc: "Initial Release." }

0 commit comments

Comments
 (0)