Bot Updating Documentation

pull/253/head
LinuxServer-CI 2024-10-08 17:04:10 +00:00
rodzic cb0033e372
commit 23e9b726cb
Nie znaleziono w bazie danych klucza dla tego podpisu
1 zmienionych plików z 17 dodań i 5 usunięć

Wyświetl plik

@ -47,9 +47,11 @@ This image provides various versions that are available via tags. Please read th
We provide aliases for the common commands that execute in the correct context so that environment variables from secrets are available to them:
* To generate keys for `SECRET_KEY_BASE` & `OTP_SECRET` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-secret` once for each.
* To generate keys for `SECRET_KEY_BASE` & `OTP_SECRET` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon:latest generate-secret` once for each.
* To generate keys for `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-vapid`
* To generate keys for `VAPID_PRIVATE_KEY` & `VAPID_PUBLIC_KEY` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon:latest generate-vapid`
* To generate keys for `ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY`, `ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT`, & `ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY` run `docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon:latest generate-active-record`
Both of the secret generation aliases above can be run without any other setup having been carried out.
@ -104,6 +106,9 @@ services:
- DB_PASS=mastodon
- DB_PORT=5432
- ES_ENABLED=false
- ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=
- ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=
- ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=
- SECRET_KEY_BASE=
- OTP_SECRET=
- VAPID_PRIVATE_KEY=
@ -130,7 +135,7 @@ services:
- DB_POOL=5 #optional
- NO_CHOWN= #optional
volumes:
- /path/to/appdata/config:/config
- /path/to/mastodon/config:/config
ports:
- 80:80
- 443:443
@ -154,6 +159,9 @@ docker run -d \
-e DB_PASS=mastodon \
-e DB_PORT=5432 \
-e ES_ENABLED=false \
-e ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY= \
-e ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY= \
-e ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT= \
-e SECRET_KEY_BASE= \
-e OTP_SECRET= \
-e VAPID_PRIVATE_KEY= \
@ -181,7 +189,7 @@ docker run -d \
-e NO_CHOWN= `#optional` \
-p 80:80 \
-p 443:443 \
-v /path/to/appdata/config:/config \
-v /path/to/mastodon/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/mastodon:latest
```
@ -211,8 +219,11 @@ Containers are configured using parameters passed at runtime (such as those abov
| `DB_USER=mastodon` | Postgres username |
| `DB_NAME=mastodon` | Postgres db name |
| `DB_PASS=mastodon` | Postgres password |
| `DB_PORT=5432` | Portgres port |
| `DB_PORT=5432` | Postgres port |
| `ES_ENABLED=false` | Enable or disable Elasticsearch (requires a separate ES instance) |
| `ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=` | Primary key for [Active Record Encryption](https://github.com/mastodon/mastodon/pull/29831/files). |
| `ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=` | Deterministic key for [Active Record Encryption](https://github.com/mastodon/mastodon/pull/29831/files). |
| `ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=` | Derivation salt for [Active Record Encryption](https://github.com/mastodon/mastodon/pull/29831/files). |
| `SECRET_KEY_BASE=` | Browser session secret. Changing it will break all active browser sessions. |
| `OTP_SECRET=` | MFA secret. Changing it after initial setup will break two-factor authentication. |
| `VAPID_PRIVATE_KEY=` | Push notification private key. Changing it after initial setup will break push notifications. |
@ -413,6 +424,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
## Versions
* **08.10.24:** - Rebase to Alpine 3.20, enable [Active Record Encryption](https://github.com/mastodon/mastodon/pull/29831/files). Existing users should update their nginx confs to avoid http2 deprecation warnings.
* **21.09.23:** - Rebase to Alpine 3.18, migrate to s6v3.
* **25.05.23:** - Adjust apk flags.
* **09.02.23:** - Add Glitch branch.