Custom front end for Mastodon
Go to file
2017-02-11 02:58:00 +01:00
app Make follow requests federate 2017-02-11 02:58:00 +01:00
bin Upgrade to Rails 2016-08-17 17:58:00 +02:00
config Site title is now a setting 2017-02-10 22:37:11 +01:00
db Fix #614 - extra reply-boolean on statuses to account for cases when replied-to 2017-02-09 20:25:39 +01:00
docs Add to instance list 2017-02-10 15:07:44 -05:00
lib Cleaning up format of broadcast real-time messages, removing 2017-02-02 00:03:31 +01:00
log Initial commit 2016-02-20 22:53:20 +01:00
public Improve error page layouting. 500 page has to stay static because it's 2017-01-21 22:30:47 +01:00
spec Make follow requests federate 2017-02-11 02:58:00 +01:00
storybook Move the fonts from Google Fonts to local assets 2017-01-26 20:09:03 +00:00
streaming Make streaming API use one pattern-matching redis pubsub connection 2017-02-07 14:39:08 +01:00
vendor/assets Initial commit 2016-02-20 22:53:20 +01:00
.babelrc Debounce autosuggestions requests 2016-11-13 13:13:36 +01:00
.codeclimate.yml Create .codeclimate.yml 2016-11-17 12:40:23 -05:00
.dockerignore Add sync command for neo4j, fix configuration, add neo4j to docker-compose, fix seed 2016-10-15 12:37:43 +02:00
.env.production.sample Make the streaming API also handle websockets (because trying to get the browser EventSource interface to 2017-02-04 00:34:31 +01:00
.env.test Update .env.test 2016-11-29 17:51:16 +01:00
.env.vagrant Add a default to .env.vagrant 2017-01-26 19:22:59 +11:00
.eslintrc Don't show statuses to blocked users 2016-12-26 19:13:56 +01:00
.gitignore Add capistrano to development environment 2017-01-30 20:03:17 +01:00
.nvmrc set up Mocha/Chai/Enzyme for React component unit testing 2016-10-10 22:48:58 +02:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.rubocop.yml Fix tests, add applications to eager loading/cache for statuses, fix 2017-01-15 14:01:33 +01:00
.ruby-version Upgrade ruby to 2.3.1 2016-11-12 01:55:33 +01:00
.travis.yml Fix #61 - Add list of blocked users to the UI; clean up failed push notifications API 2017-02-05 19:18:11 +01:00
app.json Add Heroku deployment support 2017-01-17 22:00:03 +11:00
Capfile Add capistrano to development environment 2017-01-30 20:03:17 +01:00 Fix rubocop issues, introduce usage of frozen literal to improve performance 2016-11-15 16:56:29 +01:00
docker-compose.yml Make the streaming API also handle websockets (because trying to get the browser EventSource interface to 2017-02-04 00:34:31 +01:00
Dockerfile Remove Neo4J 2016-11-24 23:46:27 +01:00
Gemfile Fix #61 - Add list of blocked users to the UI; clean up failed push notifications API 2017-02-05 19:18:11 +01:00
Gemfile.lock Fix #61 - Add list of blocked users to the UI; clean up failed push notifications API 2017-02-05 19:18:11 +01:00
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 2016-09-21 23:04:34 +02:00
package.json Add unique request IDs to streaming API to improve logs 2017-02-05 23:37:25 +01:00
Procfile Add sounds for notifications. Boop by 2017-01-17 20:09:03 +01:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00 Update broken links, add new sponsor 2017-01-27 17:01:21 +01:00
Vagrantfile fix Vagrantfile so that the correct ruby is installed 2017-01-12 23:20:55 +11:00
yarn.lock Add unique request IDs to streaming API to improve logs 2017-02-05 23:37:25 +01:00


Build Status Code Climate

Mastodon is a free, open-source social network server. A decentralized alternative to commercial platforms, it avoids the risks of a single company monopolizing your communication. Anyone can run Mastodon and participate in the social network seamlessly.

An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

Click on the screenshot to watch a demo of the UI:


Focus of the project on a clean REST API and a good user interface. Ruby on Rails is used for the back-end, while React.js and Redux are used for the dynamic front-end. A static front-end for public resources (profiles and statuses) is also provided.

If you would like, you can support the development of this project on Patreon. Alternatively, you can donate to this BTC address: 17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd



  • Fully interoperable with GNU social and any OStatus platform Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
  • Real-time timeline updates See the updates of people you're following appear in real-time in the UI via WebSockets
  • Federated thread resolving If someone you follow replies to a user unknown to the server, the server fetches the full thread so you can view it without leaving the UI
  • Media attachments like images and WebM Upload and view images and WebM videos attached to the updates
  • OAuth2 and a straightforward REST API Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
  • Background processing for long-running tasks Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
  • Deployable via Docker You don't need to mess with dependencies and configuration if you want to try Mastodon, if you have Docker and Docker Compose the deployment is extremely easy


  • LOCAL_DOMAIN should be the domain/hostname of your instance. This is absolutely required as it is used for generating unique IDs for everything federation-related
  • LOCAL_HTTPS set it to true if HTTPS works on your website. This is used to generate canonical URLs, which is also important when generating and parsing federation-related IDs

Consult the example configuration file, .env.production.sample for the full list. Among other things you need to set details for the SMTP server you are going to use.


  • Ruby
  • Node.js
  • PostgreSQL
  • Redis
  • Nginx

Running with Docker and Docker-Compose

The project now includes a Dockerfile and a docker-compose.yml. You need to turn .env.production.sample into .env.production with all the variables set before you can:

docker-compose build

And finally

docker-compose up -d

As usual, the first thing you would need to do would be to run migrations:

docker-compose run --rm web rails db:migrate

And since the instance running in the container will be running in production mode, you need to pre-compile assets:

docker-compose run --rm web rails assets:precompile

The container has two volumes, for the assets and for user uploads. The default docker-compose.yml maps them to the repository's public/assets and public/system directories, you may wish to put them somewhere else. Likewise, the PostgreSQL and Redis images have data containers that you may wish to map somewhere where you know how to find them and back them up.

Note: The --rm option for docker-compose will remove the container that is created to run a one-off command after it completes. As data is stored in volumes it is not affected by that container clean-up.


  • rake mastodon:media:clear removes uploads that have not been attached to any status after a while, you would want to run this from a periodic cronjob
  • rake mastodon:push:clear unsubscribes from PuSH notifications for remote users that have no local followers. You may not want to actually do that, to keep a fuller footprint of the fediverse or in case your users will soon re-follow
  • rake mastodon:push:refresh re-subscribes PuSH for expiring remote users, this should be run periodically from a cronjob and quite often as the expiration time depends on the particular hub of the remote user
  • rake mastodon:feeds:clear_all removes all timelines, which forces them to be re-built on the fly next time a user tries to fetch their home/mentions timeline. Only for troubleshooting
  • rake mastodon:feeds:clear removes timelines of users who haven't signed in lately, which allows to save RAM and improve message distribution. This is required to be run periodically so that when they login again the regeneration process will trigger

Running any of these tasks via docker-compose would look like this:

docker-compose run --rm web rake mastodon:media:clear


This approach makes updating to the latest version a real breeze.

git pull

To pull down the updates, re-run

docker-compose build

And finally,

docker-compose up -d

Which will re-create the updated containers, leaving databases and data as is. Depending on what files have been updated, you might need to re-run migrations and asset compilation.

Deployment without Docker

Docker is great for quickly trying out software, but it has its drawbacks too. If you prefer to run Mastodon without using Docker, refer to the production guide for examples, configuration and instructions.

Deployment on Heroku (experimental)


Mastodon can theoretically run indefinitely on a free Heroku app. You can view a guide for deployment on Heroku here.

Development with Vagrant

A quick way to get a development environment up and running is with Vagrant. You will need recent versions of Vagrant and VirtualBox installed.

You can find the guide for setting up a Vagrant development environment here.


You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. This section may be updated with more details in the future.

IRC channel: #mastodon on

Extra credits

  • The Emoji One pack has been used for the emojis
  • The error page image courtesy of Dopatwo

Mastodon error image