Mastodon (container)

Mastodon is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones..

Image details

Pulls: 255k

Architectures: amd64, arm64

Image size: 240 MB

Latest: 4.6.0-develop

User: linuxserver

Created: Nov 08, 2022

Updated: 4 days ago

Status: active

Source details

Repo: mastodon/mastodon

Stars: 50.1k

Forks: 7k

Language: Ruby

License: AGPL-3.0

Latest: v4.6.3 · 17 days ago

Updated: 4 hours ago

Website: joinmastodon.org/

Configuration

Type

Container

Platform

linux

Image

linuxserver/mastodon:latest

Ports

80:80/tcp443:443/tcp9394:9394/tcp

Volumes

/config : /srv/lsio/mastodon/config

Env vars

PUID=1000PGID=1000TZ=Etc/UTCLOCAL_DOMAIN=example.comREDIS_HOST=redisREDIS_PORT=6379DB_HOST=dbDB_USER=mastodonDB_NAME=mastodonDB_PASS=mastodonDB_PORT=5432ES_ENABLED=falseACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=SECRET_KEY_BASE=OTP_SECRET=VAPID_PRIVATE_KEY=VAPID_PUBLIC_KEY=SMTP_SERVER=mail.example.comSMTP_PORT=25SMTP_LOGIN=SMTP_PASSWORD=[email protected]S3_ENABLED=falseWEB_DOMAIN=mastodon.example.comES_HOST=esES_PORT=9200ES_USER=elasticES_PASS=elasticS3_BUCKET=AWS_ACCESS_KEY_ID=AWS_SECRET_ACCESS_KEY=S3_ALIAS_HOST=SIDEKIQ_ONLY=falseSIDEKIQ_QUEUE=SIDEKIQ_DEFAULT=falseSIDEKIQ_THREADS=5DB_POOL=5NO_CHOWN=MASTODON_PROMETHEUS_EXPORTER_ENABLED=

Restart

unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/mastodon/config

Installation

Ensure both Docker and Portainer are installed, and up-to-date
Log into your Portainer web UI
Under Settings → App Templates, paste the below URL
Head to Home → App Templates, and the list of apps will show up
Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json

Show Me

docker run -d --name Mastodon \
  -p 80:80/tcp \
  -p 443:443/tcp \
  -p 9394:9394/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -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 '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=' \
  -e 'VAPID_PUBLIC_KEY=' \
  -e 'SMTP_SERVER=mail.example.com' \
  -e 'SMTP_PORT=25' \
  -e 'SMTP_LOGIN=' \
  -e 'SMTP_PASSWORD=' \
  -e '[email protected]' \
  -e 'S3_ENABLED=false' \
  -e 'WEB_DOMAIN=mastodon.example.com' \
  -e 'ES_HOST=es' \
  -e 'ES_PORT=9200' \
  -e 'ES_USER=elastic' \
  -e 'ES_PASS=elastic' \
  -e 'S3_BUCKET=' \
  -e 'AWS_ACCESS_KEY_ID=' \
  -e 'AWS_SECRET_ACCESS_KEY=' \
  -e 'S3_ALIAS_HOST=' \
  -e 'SIDEKIQ_ONLY=false' \
  -e 'SIDEKIQ_QUEUE=' \
  -e 'SIDEKIQ_DEFAULT=false' \
  -e 'SIDEKIQ_THREADS=5' \
  -e 'DB_POOL=5' \
  -e 'NO_CHOWN=' \
  -e 'MASTODON_PROMETHEUS_EXPORTER_ENABLED=' \
  -v /srv/lsio/mastodon/config:/config \
  --restart=unless-stopped \
  linuxserver/mastodon:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  mastodon-container:
    image: linuxserver/mastodon:latest
    ports:
      - 80:80/tcp
      - 443:443/tcp
      - 9394:9394/tcp
    volumes:
      - /srv/lsio/mastodon/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      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'
      ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY: ''
      ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY: ''
      ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT: ''
      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: [email protected]
      S3_ENABLED: 'false'
      WEB_DOMAIN: mastodon.example.com
      ES_HOST: es
      ES_PORT: '9200'
      ES_USER: elastic
      ES_PASS: elastic
      S3_BUCKET: ''
      AWS_ACCESS_KEY_ID: ''
      AWS_SECRET_ACCESS_KEY: ''
      S3_ALIAS_HOST: ''
      SIDEKIQ_ONLY: 'false'
      SIDEKIQ_QUEUE: ''
      SIDEKIQ_DEFAULT: 'false'
      SIDEKIQ_THREADS: '5'
      DB_POOL: '5'
      NO_CHOWN: ''
      MASTODON_PROMETHEUS_EXPORTER_ENABLED: ''
    restart: unless-stopped

Save this file as mastodon-container-stack.yml, then from a manager node, run docker stack deploy -c mastodon-container-stack.yml mastodon-container

version: '3.8'
services:
  mastodon-container:
    image: linuxserver/mastodon:latest
    ports:
      - 80:80/tcp
      - 443:443/tcp
      - 9394:9394/tcp
    volumes:
      - /srv/lsio/mastodon/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
      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'
      ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY: ''
      ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY: ''
      ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT: ''
      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: [email protected]
      S3_ENABLED: 'false'
      WEB_DOMAIN: mastodon.example.com
      ES_HOST: es
      ES_PORT: '9200'
      ES_USER: elastic
      ES_PASS: elastic
      S3_BUCKET: ''
      AWS_ACCESS_KEY_ID: ''
      AWS_SECRET_ACCESS_KEY: ''
      S3_ALIAS_HOST: ''
      SIDEKIQ_ONLY: 'false'
      SIDEKIQ_QUEUE: ''
      SIDEKIQ_DEFAULT: 'false'
      SIDEKIQ_THREADS: '5'
      DB_POOL: '5'
      NO_CHOWN: ''
      MASTODON_PROMETHEUS_EXPORTER_ENABLED: ''
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

`mastodon-container-deployment.yaml`

apiVersion: apps/v1
kind: Deployment
metadata:
  name: mastodon-container
  labels:
    app: mastodon-container
spec:
  replicas: 1
  selector:
    matchLabels:
      app: mastodon-container
  template:
    metadata:
      labels:
        app: mastodon-container
    spec:
      containers:
        - name: mastodon-container
          image: linuxserver/mastodon:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
            - name: LOCAL_DOMAIN
              value: example.com
            - name: REDIS_HOST
              value: redis
            - name: REDIS_PORT
              value: '6379'
            - name: DB_HOST
              value: db
            - name: DB_USER
              value: mastodon
            - name: DB_NAME
              value: mastodon
            - name: DB_PASS
              value: mastodon
            - name: DB_PORT
              value: '5432'
            - name: ES_ENABLED
              value: 'false'
            - name: ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY
              value: ''
            - name: ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY
              value: ''
            - name: ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT
              value: ''
            - name: SECRET_KEY_BASE
              value: ''
            - name: OTP_SECRET
              value: ''
            - name: VAPID_PRIVATE_KEY
              value: ''
            - name: VAPID_PUBLIC_KEY
              value: ''
            - name: SMTP_SERVER
              value: mail.example.com
            - name: SMTP_PORT
              value: '25'
            - name: SMTP_LOGIN
              value: ''
            - name: SMTP_PASSWORD
              value: ''
            - name: SMTP_FROM_ADDRESS
              value: [email protected]
            - name: S3_ENABLED
              value: 'false'
            - name: WEB_DOMAIN
              value: mastodon.example.com
            - name: ES_HOST
              value: es
            - name: ES_PORT
              value: '9200'
            - name: ES_USER
              value: elastic
            - name: ES_PASS
              value: elastic
            - name: S3_BUCKET
              value: ''
            - name: AWS_ACCESS_KEY_ID
              value: ''
            - name: AWS_SECRET_ACCESS_KEY
              value: ''
            - name: S3_ALIAS_HOST
              value: ''
            - name: SIDEKIQ_ONLY
              value: 'false'
            - name: SIDEKIQ_QUEUE
              value: ''
            - name: SIDEKIQ_DEFAULT
              value: 'false'
            - name: SIDEKIQ_THREADS
              value: '5'
            - name: DB_POOL
              value: '5'
            - name: NO_CHOWN
              value: ''
            - name: MASTODON_PROMETHEUS_EXPORTER_ENABLED
              value: ''
          ports:
            - containerPort: 80
              protocol: TCP
            - containerPort: 443
              protocol: TCP
            - containerPort: 9394
              protocol: TCP
          volumeMounts:
            - name: mastodon-container-data-0
              mountPath: /config
      volumes:
        - name: mastodon-container-data-0
          hostPath:
            path: /srv/lsio/mastodon/config

`mastodon-container-service.yaml`

apiVersion: v1
kind: Service
metadata:
  name: mastodon-container
spec:
  type: LoadBalancer
  selector:
    app: mastodon-container
  ports:
    - name: 80-tcp
      port: 80
      targetPort: 80
      protocol: TCP
    - name: 443-tcp
      port: 443
      targetPort: 443
      protocol: TCP
    - name: 9394-tcp
      port: 9394
      targetPort: 9394
      protocol: TCP

Save this file as ~/.config/containers/systemd/mastodon-container.container

[Unit]
Description=Mastodon (container)

[Container]
Image=linuxserver/mastodon:latest
ContainerName=mastodon-container
PublishPort=80:80/tcp
PublishPort=443:443/tcp
PublishPort=9394:9394/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Environment=LOCAL_DOMAIN=example.com
Environment=REDIS_HOST=redis
Environment=REDIS_PORT=6379
Environment=DB_HOST=db
Environment=DB_USER=mastodon
Environment=DB_NAME=mastodon
Environment=DB_PASS=mastodon
Environment=DB_PORT=5432
Environment=ES_ENABLED=false
Environment=ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=
Environment=ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=
Environment=ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=
Environment=SECRET_KEY_BASE=
Environment=OTP_SECRET=
Environment=VAPID_PRIVATE_KEY=
Environment=VAPID_PUBLIC_KEY=
Environment=SMTP_SERVER=mail.example.com
Environment=SMTP_PORT=25
Environment=SMTP_LOGIN=
Environment=SMTP_PASSWORD=
Environment[email protected]
Environment=S3_ENABLED=false
Environment=WEB_DOMAIN=mastodon.example.com
Environment=ES_HOST=es
Environment=ES_PORT=9200
Environment=ES_USER=elastic
Environment=ES_PASS=elastic
Environment=S3_BUCKET=
Environment=AWS_ACCESS_KEY_ID=
Environment=AWS_SECRET_ACCESS_KEY=
Environment=S3_ALIAS_HOST=
Environment=SIDEKIQ_ONLY=false
Environment=SIDEKIQ_QUEUE=
Environment=SIDEKIQ_DEFAULT=false
Environment=SIDEKIQ_THREADS=5
Environment=DB_POOL=5
Environment=NO_CHOWN=
Environment=MASTODON_PROMETHEUS_EXPORTER_ENABLED=
Volume=/srv/lsio/mastodon/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start mastodon-container

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

For app-specific guidance, check Mastodon (container)'s own repo at mastodon/mastodon

The LinuxServer.io team brings you another container release featuring:

regular and timely application updates
easy user mappings (PGID, PUID)
custom base image with s6 overlay
weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
regular security updates

Find us at:

Blog - all the things you can do with our containers including How-To guides, opinions and much more!
Discord - realtime support / chat with the community and the team.
Discourse - post on our community forum.
GitHub - view the source for all of our repositories.
Open Collective - please consider helping us by either donating or contributing to our budget

linuxserver/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 and our announcement here.
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.
The architectures supported by this image are:
| Architecture | Available | Tag | | :----: | :----: | ---- | | x86-64 | ✅ | amd64-\ | | arm64 | ✅ | arm64v8-\ |

Version 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.
| Tag | Available | Description | | :----: | :----: |--- | | latest | ✅ | Stable releases. | | develop | ✅ | Pre-releases only. | | glitch | ✅ | glitch-soc fork releases. |

Application Setup

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: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: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.

To use tootctl you can run something like docker exec -it lscr.io/linuxserver/mastodon /tootctl <command>

Using tootctl requires you to complete the initial Mastodon configuration first.
This container requires separate postgres and redis instances to run.
We support all of the official environment variables for configuration. In place of adding them all to your run/compose you can use an env file such as this example from the upstream project.
For more information check out the mastodon documentation.

Running separate sidekiq instances

It is currently only supported to run a single queue per container instance or all queues in a single container instance.
All containers must share the same /config mount and be on a common docker network.

NOCHOWN Option

On larger Mastodon instances, our init process to verify that permissions are set correctly can noticeably slow down the container startup. If you are experiencing this, you can set NO_CHOWN to true to skip that step of the init.
Do NOT set this on first run of the container. If you enable this option you are taking full responsibility for ensuring that the permissions in your /config mount are correct. If you're even slightly unsure, don't set it.

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.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
>!NOTE >Unless a parameter is flagged as 'optional', it is mandatory and a value must be provided.

docker-compose (recommended, click here for more info)

---
services:
  mastodon:
    image: lscr.io/linuxserver/mastodon:latest
    container_name: mastodon
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
      - 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
      - ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY=
      - ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY=
      - ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT=
      - SECRET_KEY_BASE=
      - OTP_SECRET=
      - VAPID_PRIVATE_KEY=
      - VAPID_PUBLIC_KEY=
      - SMTP_SERVER=mail.example.com
      - SMTP_PORT=25
      - SMTP_LOGIN=
      - SMTP_PASSWORD=
      - [email protected]
      - 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
      - SIDEKIQ_ONLY=false #optional
      - SIDEKIQ_QUEUE= #optional
      - SIDEKIQ_DEFAULT=false #optional
      - SIDEKIQ_THREADS=5 #optional
      - DB_POOL=5 #optional
      - NO_CHOWN= #optional
      - MASTODON_PROMETHEUS_EXPORTER_ENABLED= #optional
    volumes:
      - /path/to/mastodon/config:/config
    ports:
      - 80:80
      - 443:443
      - 9394:9394 #optional
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=mastodon \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -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 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= \
  -e VAPID_PUBLIC_KEY= \
  -e SMTP_SERVER=mail.example.com \
  -e SMTP_PORT=25 \
  -e SMTP_LOGIN= \
  -e SMTP_PASSWORD= \
  -e [email protected] \
  -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` \
  -e SIDEKIQ_ONLY=false `#optional` \
  -e SIDEKIQ_QUEUE= `#optional` \
  -e SIDEKIQ_DEFAULT=false `#optional` \
  -e SIDEKIQ_THREADS=5 `#optional` \
  -e DB_POOL=5 `#optional` \
  -e NO_CHOWN= `#optional` \
  -e MASTODON_PROMETHEUS_EXPORTER_ENABLED= `#optional` \
  -p 80:80 \
  -p 443:443 \
  -p 9394:9394 `#optional` \
  -v /path/to/mastodon/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/mastodon:latest

Parameters

Containers 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.
| Parameter | Function | | :----: | --- | | -p 80:80 | Port for web frontend | | -p 443:443 | Port for web frontend | | -p 9394 | Port for Prometheus metrics | | -e PUID=1000 | for UserID - see below for explanation | | -e PGID=1000 | for GroupID - see below for explanation | | -e TZ=Etc/UTC | specify a timezone to use, see this list. | | -e LOCAL_DOMAIN=example.com | This is the unique identifier of your server in the network. It cannot be safely changed later. | | -e REDIS_HOST=redis | Redis server hostname | | -e REDIS_PORT=6379 | Redis port | | -e DB_HOST=db | Postgres database hostname | | -e DB_USER=mastodon | Postgres username | | -e DB_NAME=mastodon | Postgres db name | | -e DB_PASS=mastodon | Postgres password | | -e DB_PORT=5432 | Postgres port | | -e ES_ENABLED=false | Enable or disable Elasticsearch (requires a separate ES instance) | | -e ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY= | Primary key for Active Record Encryption. | | -e ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY= | Deterministic key for Active Record Encryption. | | -e ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT= | Derivation salt for Active Record Encryption. | | -e SECRET_KEY_BASE= | Browser session secret. Changing it will break all active browser sessions. | | -e OTP_SECRET= | MFA secret. Changing it after initial setup will break two-factor authentication. | | -e VAPID_PRIVATE_KEY= | Push notification private key. Changing it after initial setup will break push notifications. | | -e VAPID_PUBLIC_KEY= | Push notification public key. Changing it after initial setup will break push notifications. | | -e SMTP_SERVER=mail.example.com | SMTP server for email notifications | | -e SMTP_PORT=25 | SMTP server port | | -e SMTP_LOGIN= | SMTP username | | -e SMTP_PASSWORD= | SMTP password | | -e [email protected] | From address for emails send from Mastodon | | -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 ES_HOST=es | Elasticsearch server hostname | | -e ES_PORT=9200 | Elasticsearch port | | -e ES_USER=elastic | Elasticsearch username | | -e ES_PASS=elastic | Elasticsearch password | | -e S3_BUCKET= | S3 bucket hostname | | -e AWS_ACCESS_KEY_ID= | S3 bucket access key ID | | -e AWS_SECRET_ACCESS_KEY= | S3 bucket secret access key | | -e S3_ALIAS_HOST= | Alternate hostname for object fetching if you are front the S3 connections. | | -e SIDEKIQ_ONLY=false | Only run the sidekiq service in this container instance. For large scale instances that need better queue handling. | | -e SIDEKIQ_QUEUE= | The name of the sidekiq queue to run in this container. See notes. | | -e SIDEKIQ_DEFAULT=false | Set to true on the main container if you're running additional sidekiq instances. It will run the default queue. | | -e SIDEKIQ_THREADS=5 | The number of threads for sidekiq to use. See notes. | | -e DB_POOL=5 | The size of the DB connection pool, must be at least the same as SIDEKIQ_THREADS. See notes. | | -e NO_CHOWN= | Set to true to skip chown of /config on init. READ THE APPLICATION NOTES BEFORE SETTING THIS. | | -e MASTODON_PROMETHEUS_EXPORTER_ENABLED= | If set to true, Mastodon’s Ruby processes (web & Sidekiq) will enable the Prometheus instrumentation. | | -v /config | Contains all relevant configuration files. |

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.
As an example:

-e FILE__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

We publish various 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:

```bash
docker exec -it mastodon /bin/bash
```

To monitor the logs of the container in realtime:

```bash
docker logs -f mastodon
```

Container version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' mastodon
```

Image version number:

```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mastodon:latest
```

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:

Via Docker Compose

Update images:

* All images:

    ```bash
    docker-compose pull
    ```

* Single image:

    ```bash
    docker-compose pull mastodon
    ```

Update containers:

* All containers:

    ```bash
    docker-compose up -d
    ```

* Single container:

    ```bash
    docker-compose up -d mastodon
    ```

You can also remove the old dangling images:

```bash
docker image prune
```

Via Docker Run

Update the image:

```bash
docker pull lscr.io/linuxserver/mastodon:latest
```

Stop the running container:

```bash
docker stop mastodon
```

Delete the container:

```bash
docker rm mastodon
```

Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
You can also remove the old dangling images:

```bash
docker image prune
```

Image Update Notifications - Diun (Docker Image Update Notifier)

>!TIP >We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-mastodon.git
cd docker-mastodon
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/mastodon:latest .

The ARM variants can be built on x8664 hardware and vice versa using lscr.io/linuxserver/qemu-static
docker run --rm --privileged lscr.io/linuxserver/qemu-static --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions
05.07.26: - Rebase to Alpine 3.24.
21.10.25: - Add prometheus exporter support.
20.10.25: - Add vips-heif.
08.07.25: - Rebase to Alpine 3.22.
06.06.25: - Rebase to Alpine 3.21, replace deprecated imagemagick with vips.
08.10.24: - Rebase to Alpine 3.20, enable Active Record Encryption. 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.
09.01.23: - Updated nginx conf to fix bring inline with Mastodon configuration (fixes Elk integration).
19.12.22: - Support separate sidekiq queue instances.
05.11.22: - Initial Release.

Serve Mastodon (container) on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxy Domain App port Upstream

Proxying mastodon-container.example.com to http://Mastodon:80

Add this to your Caddyfile

mastodon-container.example.com {
	reverse_proxy http://Mastodon:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

In Portainer, go to Containers, click the container, then Logs. Or run docker logs Mastodon
Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:80 failed: port is already allocated", something else on your server is using that port.

Find what's using it: sudo ss -tlnp | grep :80
Stop the other service, or pick a different host port. In 80:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

Use your server's real IP: http://your-server-ip:80. The 0.0.0.0 link Portainer shows isn't a real address.
Give it a minute after first deploy, Mastodon can take a while to initialise.
Make sure your firewall allows the port, e.g. sudo ufw allow 80

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/mastodon/config
Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/mastodon:latest

"manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
"toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
"no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

This image supports: amd64, arm64
Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

Check the logs right after a restart, the last few lines before it died are the useful ones.
Get the exit code with docker inspect Mastodon --format '{{.State.ExitCode}}'
Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

ACTIVE_RECORD_ENCRYPTION_PRIMARY_KEY, ACTIVE_RECORD_ENCRYPTION_DETERMINISTIC_KEY, ACTIVE_RECORD_ENCRYPTION_KEY_DERIVATION_SALT, SECRET_KEY_BASE, OTP_SECRET, VAPID_PRIVATE_KEY, VAPID_PUBLIC_KEY, SMTP_LOGIN, SMTP_PASSWORD, S3_BUCKET, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, S3_ALIAS_HOST, SIDEKIQ_QUEUE, NO_CHOWN, MASTODON_PROMETHEUS_EXPORTER_ENABLED have no default value, and Mastodon may crash or misbehave if left empty.

Fill them in on the deploy screen before hitting deploy.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Bug within the app: Open an issue on mastodon/mastodon
Template not working: Open an issue on technorabilia/portainer-templates
This website not working: Open an issue on lissy93/portainer-templates

Similar apps

Databag Social

Ferdium (container) Social

Gathio Social

GoToSocial Social

Linkstack Social

Littlelink Server Social

Mastodon (stack) Social

Monica Social