A GNU Social-compatible microblogging server
Ruby JavaScript HTML CSS
Permalink
Failed to load latest commit information.
app API now respects ?limit param as long as it's within 2x default limit Jan 24, 2017
bin Upgrade to Rails 5.0.0.1 Aug 17, 2016
config Add /api/v1/notifications/clear, non-existing link cards for statuses… Jan 23, 2017
db Optional domain block attribute that prevents media attachments from … Jan 23, 2017
docs Add separate sections for Heroku and Vagrant deployments. Add guide f… Jan 22, 2017
lib Fix #463 - Fetch and display previews of URLs using OpenGraph tags Jan 20, 2017
log Initial commit Feb 20, 2016
public Improve error page layouting. 500 page has to stay static because it's Jan 21, 2017
spec Domain blocks now have varying severity - auto-suspend vs auto-silence Jan 23, 2017
storybook Use system fonts on more platforms Jan 5, 2017
vendor/assets Initial commit Feb 20, 2016
.babelrc Debounce autosuggestions requests Nov 13, 2016
.codeclimate.yml Create .codeclimate.yml Nov 17, 2016
.dockerignore Add sync command for neo4j, fix configuration, add neo4j to docker-co… Oct 15, 2016
.env.production.sample Add docker-compose example about rake secret task Dec 29, 2016
.env.test Update .env.test Nov 29, 2016
.env.vagrant Set remote dev environments to use letter_opener_web, add default .en… Jan 21, 2017
.eslintrc Don't show statuses to blocked users Dec 26, 2016
.gitignore Add Vagrant development environment support Jan 7, 2017
.nvmrc setup React Storybook; add example story for LoadingIndicator component Oct 11, 2016
.rspec Adding a Mention model, test stubs Feb 24, 2016
.rubocop.yml Fix tests, add applications to eager loading/cache for statuses, fix Jan 15, 2017
.ruby-version Upgrade ruby to 2.3.1 Nov 12, 2016
.travis.yml Remove remnants of Neo4J Nov 25, 2016
Dockerfile Remove Neo4J Nov 24, 2016
Gemfile Fix #365, 1/2 of #408 - replace rails_autolink with URI.regexp, run l… Jan 23, 2017
Gemfile.lock Fix #365, 1/2 of #408 - replace rails_autolink with URI.regexp, run l… Jan 23, 2017
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 Sep 21, 2016
Procfile Add sounds for notifications. Boop by @jk@mastodon.social Jan 17, 2017
README.md Update README.md to match new documentation (missed from previous com… Jan 22, 2017
Rakefile Initial commit Feb 20, 2016
Vagrantfile fix Vagrantfile so that the correct ruby is installed Jan 12, 2017
app.json Add Heroku deployment support Jan 17, 2017
config.ru Fix rubocop issues, introduce usage of frozen literal to improve perf… Nov 15, 2016
docker-compose.yml Adding rack timeout of 30sec, PuSH jobs moved to push queue so they Nov 29, 2016
package.json Add sounds for notifications. Boop by @jk@mastodon.social Jan 17, 2017
yarn.lock Add sounds for notifications. Boop by @jk@mastodon.social Jan 17, 2017

README.md

Mastodon

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:

Screenshot

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

Resources

Features

  • 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

Configuration

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

Requirements

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

Tasks

  • 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

Updating

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)

Deploy

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.

Contributing

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 irc.freenode.net

Extra credits

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

Mastodon error image