Setting up a dev environment
Instructions on how to start developing for Mastodon.
You can follow the pre-requisites instructions from the production guide, but do not create a
mastodon user. You also don't have to install
python-certbot-nginx as the development environment brings its own webserver. Setting up and running a development environment has been proven successful over WSL2 as well if you are on Windows.
Run following commands in the project directory
In the development environment, Mastodon will use PostgreSQL as the currently signed-in Linux user using the
ident method, which usually works out of the box. The one command you need to run is
rails db:setup which will create the databases
mastodon_test, load the schema into them, and then create seed data defined in
mastodon_development. The only seed data is an admin account with the credentials
[email protected]:3000 /
Please keep in mind, by default Mastodon will run on port 3000. If you configure a different port for it, the generated admin account will use that number.
rails db:setup gives you the Postgres error:
ActiveRecord::NoDatabaseError: FATAL: role "your_user_name" does not exist
your_user_name is your username), then run:
sudo -u postgres createuser your_user_name --createdb
This will create the necessary Postgres user with the permission to create a database.
There are multiple processes that need to be run for the full set of Mastodon’s functionality, although they can be selectively omitted. To run all of them with just one command, you can install Foreman with
gem install foreman --no-document and then use:
In the Mastodon directory. This will start processes defined in
Procfile.dev, which will give you: A Rails server, a Webpack server, a streaming API server, and Sidekiq. Of course, you can run any of those things stand-alone depending on your needs.
|Run the Ruby test suite|
|Check the Ruby code for conformance with our code style|
Last updated October 17, 2020 · Improve this page