2020-06-29 13:58:48 +02:00
|
|
|
|
# Introduction
|
|
|
|
|
|
|
|
|
|
|
|
This is a [Helm](https://helm.sh/) chart for installing Mastodon into a
|
|
|
|
|
|
Kubernetes cluster. The basic usage is:
|
|
|
|
|
|
|
2021-02-15 08:00:54 +01:00
|
|
|
|
1. edit `values.yaml` or create a separate yaml file for custom values
|
|
|
|
|
|
1. `helm dep update`
|
|
|
|
|
|
1. `helm install --namespace mastodon --create-namespace my-mastodon ./ -f path/to/additional/values.yaml`
|
2020-06-29 13:58:48 +02:00
|
|
|
|
|
|
|
|
|
|
This chart has been tested on Helm 3.0.1 and above.
|
|
|
|
|
|
|
|
|
|
|
|
# Configuration
|
|
|
|
|
|
|
|
|
|
|
|
The variables that _must_ be configured are:
|
|
|
|
|
|
|
2021-02-15 08:00:54 +01:00
|
|
|
|
- password and keys in the `mastodon.secrets`, `postgresql`, and `redis` groups; if
|
2020-06-29 13:58:48 +02:00
|
|
|
|
left blank, some of those values will be autogenerated, but will not persist
|
|
|
|
|
|
across upgrades.
|
|
|
|
|
|
|
2021-02-15 08:00:54 +01:00
|
|
|
|
- SMTP settings for your mailer in the `mastodon.smtp` group.
|
2020-06-29 13:58:48 +02:00
|
|
|
|
|
|
|
|
|
|
# Missing features
|
|
|
|
|
|
|
|
|
|
|
|
Currently this chart does _not_ support:
|
|
|
|
|
|
|
|
|
|
|
|
- Hidden services
|
|
|
|
|
|
- Single Sign-On
|
|
|
|
|
|
- Swift
|
|
|
|
|
|
- configurations using `WEB_DOMAIN`
|
|
|
|
|
|
|
|
|
|
|
|
# Upgrading
|
|
|
|
|
|
|
|
|
|
|
|
Because database migrations are managed as a Job separate from the Rails and
|
|
|
|
|
|
Sidekiq deployments, it’s possible they will occur in the wrong order. After
|
|
|
|
|
|
upgrading Mastodon versions, it may sometimes be necessary to manually delete
|
|
|
|
|
|
the Rails and Sidekiq pods so that they are recreated against the latest
|
|
|
|
|
|
migration.
|
