[Mastodon](https://github.com/mastodon/mastodon/) is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones..
## Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
Simply pulling `lscr.io/linuxserver/mastodon:latest` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
To generate keys for `SECRET_KEY_BASE`&`OTP_SECRET` run `docker run --rm -it -w /app/www --entrypoint rake lscr.io/linuxserver/mastodon secret` once for each.
To generate keys for `VAPID_PRIVATE_KEY`&`VAPID_PUBLIC_KEY` run `docker run --rm -it -w /app/www --entrypoint rake lscr.io/linuxserver/mastodon mastodon:webpush:generate_vapid_key`
This container *requires* separate postgres and redis instances to run.
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/).
## Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
```yaml
---
version: "2.1"
services:
mastodon:
image: lscr.io/linuxserver/mastodon:latest
container_name: mastodon
environment:
- PUID=1000
- PGID=1000
- TZ=America/New_York
- LOCAL_DOMAIN=example.com
- REDIS_HOST=redis
- REDIS_PORT=6379
- DB_HOST=db
- DB_USER=mastodon
- DB_NAME=mastodon
- DB_PASS=mastodon
- DB_PORT=5432
- ES_ENABLED=false
- SECRET_KEY_BASE=
- OTP_SECRET=
- VAPID_PRIVATE_KEY=
- VAPID_PUBLIC_KEY=
- SMTP_SERVER=mail.example.com
- SMTP_PORT=25
- SMTP_LOGIN=
- SMTP_PASSWORD=
- SMTP_FROM_ADDRESS=notifications@example.com
- S3_ENABLED=false
- WEB_DOMAIN=mastodon.example.com #optional
- ES_HOST=es #optional
- ES_PORT=9200 #optional
- ES_USER=elastic #optional
- ES_PASS=elastic #optional
- S3_BUCKET= #optional
- AWS_ACCESS_KEY_ID= #optional
- AWS_SECRET_ACCESS_KEY= #optional
- S3_ALIAS_HOST= #optional
volumes:
- /path/to/appdata/config:/config
ports:
- 80:80
- 443:443
restart: unless-stopped
```
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
```bash
docker run -d \
--name=mastodon \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=America/New_York \
-e LOCAL_DOMAIN=example.com \
-e REDIS_HOST=redis \
-e REDIS_PORT=6379 \
-e DB_HOST=db \
-e DB_USER=mastodon \
-e DB_NAME=mastodon \
-e DB_PASS=mastodon \
-e DB_PORT=5432 \
-e ES_ENABLED=false \
-e SECRET_KEY_BASE= \
-e OTP_SECRET= \
-e VAPID_PRIVATE_KEY= \
-e VAPID_PUBLIC_KEY= \
-e SMTP_SERVER=mail.example.com \
-e SMTP_PORT=25 \
-e SMTP_LOGIN= \
-e SMTP_PASSWORD= \
-e SMTP_FROM_ADDRESS=notifications@example.com \
-e S3_ENABLED=false \
-e WEB_DOMAIN=mastodon.example.com `#optional` \
-e ES_HOST=es `#optional` \
-e ES_PORT=9200 `#optional` \
-e ES_USER=elastic `#optional` \
-e ES_PASS=elastic `#optional` \
-e S3_BUCKET= `#optional` \
-e AWS_ACCESS_KEY_ID= `#optional` \
-e AWS_SECRET_ACCESS_KEY= `#optional` \
-e S3_ALIAS_HOST= `#optional` \
-p 80:80 \
-p 443:443 \
-v /path/to/appdata/config:/config \
--restart unless-stopped \
lscr.io/linuxserver/mastodon:latest
```
## Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
### Ports (`-p`)
| Parameter | Function |
| :----: | --- |
| `80` | Port for web frontend |
| `443` | Port for web frontend |
### Environment Variables (`-e`)
| Env | Function |
| :----: | --- |
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
| `TZ=America/New_York` | Specify a timezone to use EG America/New_York |
| `LOCAL_DOMAIN=example.com` | This is the unique identifier of your server in the network. It cannot be safely changed later. |
| `REDIS_HOST=redis` | Redis server hostname |
| `REDIS_PORT=6379` | Redis port |
| `DB_HOST=db` | Postgres database hostname |
| `DB_USER=mastodon` | Postgres username |
| `DB_NAME=mastodon` | Postgres db name |
| `DB_PASS=mastodon` | Postgres password |
| `DB_PORT=5432` | Portgres port |
| `ES_ENABLED=false` | Enable or disable Elasticsearch (requires a separate ES instance) |
| `SECRET_KEY_BASE=` | Browser session secret. Changing it will break all active browser sessions. |
| `OTP_SECRET=` | MFA secret. Changing it will break two-factor authentication. |
| `VAPID_PRIVATE_KEY=` | Push notification private key. Changing it will break push notifications. |
| `VAPID_PUBLIC_KEY=` | Push notification public key. Changing it will break push notifications. |
| `SMTP_SERVER=mail.example.com` | SMTP server for email notifications |
| `SMTP_PORT=25` | SMTP server port |
| `SMTP_LOGIN=` | SMTP username |
| `SMTP_PASSWORD=` | SMTP password |
| `SMTP_FROM_ADDRESS=notifications@example.com` | From address for emails send from Mastodon |
| `S3_ENABLED=false` | Enable or disable S3 storage of uploaded files |
| `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 |
| `ES_HOST=es` | Elasticsearch server hostname |
| `ES_PORT=9200` | Elasticsearch port |
| `ES_USER=elastic` | Elasticsearch username |
| `ES_PASS=elastic` | Elasticsearch password |
| `S3_BUCKET=` | S3 bucket hostname |
| `AWS_ACCESS_KEY_ID=` | S3 bucket access key ID |
| `S3_ALIAS_HOST=` | Alternate hostname for object fetching if you are front the S3 connections. |
### Volume Mappings (`-v`)
| Volume | Function |
| :----: | --- |
| `/config` | Contains all relevant configuration files. |
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```bash
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
## Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
## User / Group Identifiers
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
[](https://mods.linuxserver.io/?mod=mastodon "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
## Support Info
* Shell access whilst the container is running:
*`docker exec -it mastodon /bin/bash`
* To monitor the logs of the container in realtime:
*`docker logs -f mastodon`
* Container version number
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' mastodon`
* Image version number
*`docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mastodon:latest`
