Mastodon

This key must be set to enable the Active Record Encryption feature within Rails that Mastodon uses to encrypt and decrypt some database attributes. A new Active Record keys can be generated by running:

nix build -f '<nixpkgs>' mastodon; cd result; RAILS_ENV=production ./bin/rails db:encryption:init

If this file does not exist, it will be created with a new Active Record keys.

This key must be set to enable the Active Record Encryption feature within Rails that Mastodon uses to encrypt and decrypt some database attributes. A new Active Record keys can be generated by running:

nix build -f '<nixpkgs>' mastodon; cd result; RAILS_ENV=production ./bin/rails db:encryption:init

If this file does not exist, it will be created with a new Active Record keys.

This key must be set to enable the Active Record Encryption feature within Rails that Mastodon uses to encrypt and decrypt some database attributes. A new Active Record keys can be generated by running:

nix build -f '<nixpkgs>' mastodon; cd result; RAILS_ENV=production ./bin/rails db:encryption:init

If this file does not exist, it will be created with a new Active Record keys.

Do automatic database migrations.

Configure nginx as a reverse proxy for mastodon. Note that this makes some assumptions on your setup, and sets settings that will affect other virtualHosts running on your nginx instance, if any. Alternatively you can configure a reverse-proxy of your choice to serve these paths:

/ -> ${pkgs.mastodon}/public

/ -> 127.0.0.1:{{ webPort }} (If there was no file in the directory above.)

/system/ -> /var/lib/mastodon/public-system/

/api/v1/streaming/ -> 127.0.0.1:{{ streamingPort }}

Make sure that websockets are forwarded properly. You might want to set up caching of some requests. Take a look at mastodon's provided nginx configuration at https://github.com/mastodon/mastodon/blob/master/dist/nginx.conf.

Configure local PostgreSQL database server for Mastodon.

Database host address or unix socket.

Database name.

A file containing the password corresponding to {option}database.user.

Database host port.

Database user.

Elasticsearch host. If it is not null, Elasticsearch full text search will be enabled.

Path to file containing password for optionally authenticating with Elasticsearch.

Elasticsearch port.

If provided, adds a prefix to indexes in Elasticsearch. This allows to use the same Elasticsearch cluster between different projects or Mastodon servers.

It controls the ElasticSearch indices configuration (number of shards and replica).

Used for optionally authenticating with Elasticsearch.

Whether to enable Mastodon, a federated social network server.

Instead of binding to an IP address like 127.0.0.1, you may bind to a Unix socket. This variable is process-specific, e.g. you need different values for every process, and it works for both web (Puma) processes and streaming API (Node.js) processes.

Extra environment variables to pass to all mastodon services.

Extra environment files to pass to all mastodon services. Useful for passing down environmental secrets.

Group under which mastodon runs.

The domain serving your Mastodon instance.

Automatically remove remote media attachments and preview cards older than the configured amount of days.

Recommended in https://docs.joinmastodon.org/admin/setup/.

How old remote media needs to be in order to be removed.

How often to remove remote media.

The format is described in {manpage}systemd.time(7).

The mastodon package to use.

Configure local Redis server for Mastodon.

Use Unix socket

Redis host.

A file containing the password for Redis database.

Redis port.

Path to file containing the secret key base. A new secret key base can be generated by running:

nix build -f '<nixpkgs>' mastodon; cd result; bin/bundle exec rails secret

If this file does not exist, it will be created with a new secret key base.

TCP port used by the mastodon-sidekiq service.

How many Sidekiq processes should be used to handle background jobs, and which job classes they handle. Read the upstream documentation before configuring this!

If not empty, which job classes should be executed by this process. Only one process should handle the 'scheduler' class. If left empty, this process will handle the 'scheduler' class.

Number of threads this process should use for executing jobs. If null, the configured sidekiqThreads are used.

Worker threads used by the mastodon-sidekiq-all service. If sidekiqProcesses is configured and any processes specify null threads, this value is used.

Authenticate with the SMTP server using username and password.

Configure local Postfix SMTP server for Mastodon.

"From" address used when sending Emails to users.

SMTP host used when sending emails to users.

Path to file containing the SMTP password.

SMTP port used when sending emails to users.

SMTP login name.

Number of processes used by the mastodon-streaming service. Please define this explicitly, recommended is the amount of your CPU cores minus one.

You need to set it to the IP from which your reverse proxy sends requests to Mastodon's web process, otherwise Mastodon will record the reverse proxy's own IP as the IP of all requests, which would be bad because IP addresses are used for important rate limits and security functions.

User under which mastodon runs. If it is set to "mastodon", that user will be created, otherwise it should be set to the name of a user created elsewhere. In both cases, the mastodon package will be added to the user's package set and a tootctl wrapper to system packages that switches to the configured account and load the right environment.

Path to file containing the private key used for Web Push Voluntary Application Server Identification. A new keypair can be generated by running:

nix build -f '<nixpkgs>' mastodon; cd result; bin/rake webpush:generate_keys

If this file does not exist, it will be created with a new private key.

Path to file containing the public key used for Web Push Voluntary Application Server Identification. A new keypair can be generated by running:

nix build -f '<nixpkgs>' mastodon; cd result; RAILS_ENV=production bin/rake webpush:generate_keys

If {option}mastodon.vapidPrivateKeyFiledoes not exist, it and this file will be created with a new keypair.

TCP port used by the mastodon-web service.

Processes used by the mastodon-web service.

Threads per process used by the mastodon-web service.