Your self-hosted, globally interconnected microblogging community
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Matt Jankowski 0530ce5e95
Convert accounts controller spec to request spec (#28126)
6 hours ago
.devcontainer Fix devcontainer by not forcing `NODE_ENV` (#28099) 2 days ago
.github Dockerfile rewrite based on Ruby image with performance optimizations and size reduction, dedicated Streaming image (#26850) 2 days ago
.husky Use Yarn instead of NPX for pre-commit hook (#24287) 8 months ago
.yarn Upgrade to Yarn 4, remove support for Node 16 (#27073) 3 weeks ago
app Spec coverage for missing `q` param and error conditions in `api/v2/search` controller (#27842) 6 hours ago
bin Move the mastodon/*_cli files to mastodon/cli/* (#24139) 6 months ago
chart helm: cleanup helm chart, now in mastodon/chart (#21801) 12 months ago
config Add zeitwerk inflector for cli->CLI (#27635) 6 hours ago
db Change link previews to keep original URL from the status (#27312) 2 weeks ago
dist Add suggestion for secure cyphers to nginx.conf (#26349) 3 months ago
lib Move self destruct CLI command definition code to module (#28131) 9 hours ago
log Initial commit 8 years ago
public Change: Block GPTBot (#26396) 4 months ago
spec Convert accounts controller spec to request spec (#28126) 6 hours ago
streaming Fix apt cache not being properly utilized in Dockerfile (#28115) 2 days ago
vendor Increase files checked by ESLint (#9705) 5 years ago
.browserslistrc Add ES6 compatibility to browserslist (#18519) 2 years ago
.buildpacks Remove nodejs buildpack from buildpacks (#14364) 3 years ago
.dockerignore Do not copy `public/packs-test` into Docker (#27736) 3 weeks ago
.editorconfig Enable EditorConfig trailing whitespace trimming (#23543) 10 months ago
.env.production.sample fix: remove SMTP_SERVER (#21342) 12 months ago
.env.test Improve Babel configuration and automatically load polyfills (#27333) 1 month ago
.env.vagrant Add elastic search installation into Vagrantfile (#26512) 3 months ago
.eslintignore Increase files checked by ESLint (#9705) 5 years ago
.eslintrc.js Converted hashtag.jsx to TypeScript (#27872) 2 days ago
.foreman Replace sprockets/browserify with Webpack (#2617) 7 years ago
.gitattributes Add .gitattributes file to avoid unwanted CRLF (#3954) 7 years ago
.gitignore Upgrade to Yarn 4, remove support for Node 16 (#27073) 3 weeks ago
.haml-lint.yml Update haml-lint line length configuration to match rubocop value (#27570) 1 month ago
.haml-lint_todo.yml Consolidate html page title output logic into helper (#27563) 3 weeks ago
.nanoignore Remove Storybook (#4397) 6 years ago
.nvmrc Update dependency node to 20.9 (#27534) 1 month ago
.prettierignore Remove Capistrano (#27295) 2 months ago
.prettierrc.js Use Prettier for ESLint formatting TypeScript (#23631) 7 months ago
.profile Make it possible to upload audio and video to Heroku app (#24866) 7 months ago
.rspec Adding a Mention model, test stubs 8 years ago
.rubocop.yml Fix `RSpec/SpecFilePathFormat` cops (#27730) 3 weeks ago
.rubocop_todo.yml Move lib/devise/* to lib/devise/strategies/* (#27638) 1 day ago
.ruby-gemset Make Mastodon use its own gemset (#17858) 1 year ago
.ruby-version Bump ruby to 3.2.2 due to ReDoS vulnerabilities (#24320) 8 months ago
.simplecov Disable simplecov `enable_coverage_for_eval` option, move to standalone file (#27869) 2 weeks ago
.slugignore Remove Storybook (#4397) 6 years ago
.watchmanconfig Fix Jest config (#27834) 2 weeks ago
.yarnrc.yml Upgrade to Yarn 4, remove support for Node 16 (#27073) 3 weeks ago Update (#27018) 2 months ago
Aptfile Make it possible to upload audio and video to Heroku app (#24866) 7 months ago Prune the changelog of older entries (#27432) 1 month ago Update Contributor Covenant to 2.1 (#23980) 7 months ago Convert CircleCI to GitHub Actions (#23608) 9 months ago
Dockerfile Fix apt cache not being properly utilized in Dockerfile (#28115) 2 days ago Update (#26819) 3 months ago
Gemfile Add debug + irb gems to assist with debugging in development and tests (#27960) 1 week ago
Gemfile.lock chore(deps): update dependency pghero to v3.4.0 (#28117) 1 day ago
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 7 years ago
Procfile fix: make Procfile compatible with herokuish (#12685) 3 years ago Split streaming server from web server (#24702) 2 weeks ago Upgrade to Yarn 4, remove support for Node 16 (#27073) 3 weeks ago
Rakefile Run Rubocop on Rakefile (#23871) 5 months ago Mark version 4.0 as no longer supported (#27627) 4 weeks ago
Vagrantfile Change Vagrant to install Node 20 (#28100) 9 hours ago
app.json Make enable_starttls configurable by envvars (#20321) 1 year ago
babel.config.js Disable Babel polyfill injection in dev (#27691) 3 weeks ago Autofix Rubocop remaining Layout rules (#23679) 9 months ago
crowdin.yml Add a Github Action to send translations to Crowdin for each merge in main (#25869) 5 months ago
docker-compose.yml Let use http_hidden_proxy on docker-compose (#27054) 1 month ago
ide-helper.js Add JS IDE helper (#13012) 4 years ago
jest.config.js Fix Jest config (#27834) 2 weeks ago
jsconfig.json Correct prettier calls for YML/JSON (#21832) 1 year ago
package.json Converted app/javascript/mastodon/utils/ folder to TypeScript (#27895) 2 days ago
postcss.config.js Update PostCSS dependencies (#23835) 9 months ago
priv-config TOR federation (#7875) 6 years ago
scalingo.json Add S3 region list reference to Scalingo config (#24152) 7 months ago
stylelint.config.js Update Stylelint disable settings and ignores (#23776) 7 months ago
tsconfig.json Use the new JSX transform (#25064) 6 months ago
yarn.lock fix(deps): update dependency jsdom to v23.0.1 (#28135) 7 hours ago


GitHub release Ruby Testing Crowdin

Mastodon is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones. On Mastodon, users can publish anything they want: links, pictures, text, and video. All Mastodon servers are interoperable as a federated network (users on one server can seamlessly communicate with users from another one, including non-Mastodon software that implements ActivityPub!)

Click below to learn more in a video:




No vendor lock-in: Fully interoperable with any conforming platform

It doesn't have to be Mastodon; whatever implements ActivityPub is part of the social network! Learn more

Real-time, chronological timeline updates

Updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!

Media attachments like images and short videos

Upload and view images and WebM/MP4 videos attached to the updates. Videos with no audio track are treated like GIFs; normal videos loop continuously!

Safety and moderation tools

Mastodon includes private posts, locked accounts, phrase filtering, muting, blocking, and all sorts of other features, along with a reporting and moderation system. Learn more

OAuth2 and a straightforward REST API

Mastodon acts as an OAuth2 provider, so 3rd party apps can use the REST and Streaming APIs. This results in a rich app ecosystem with a lot of choices!


Tech stack

  • Ruby on Rails powers the REST API and other web pages
  • React.js and Redux are used for the dynamic parts of the interface
  • Node.js powers the streaming API


  • PostgreSQL 12+
  • Redis 4+
  • Ruby 2.7+
  • Node.js 16+

The repository includes deployment configurations for Docker and docker-compose as well as specific platforms like Heroku, Scalingo, and Nanobox. For Helm charts, reference the mastodon/chart repository. The standalone installation guide is available in the documentation.



A Vagrant configuration is included for development purposes. To use it, complete the following steps:

  • Install Vagrant and Virtualbox
  • Install the vagrant-hostsupdater plugin: vagrant plugin install vagrant-hostsupdater
  • Run vagrant up
  • Run vagrant ssh -c "cd /vagrant && foreman start"
  • Open http://mastodon.local in your browser


To set up MacOS for native development, complete the following steps:

  • Install the latest stable Ruby version (use a Ruby version manager for easy installation and management of Ruby versions)
  • Run brew install postgresql@14
  • Run brew install redis
  • Run brew install imagemagick
  • Install Foreman or a similar tool (such as overmind) to handle multiple process launching.
  • Navigate to Mastodon's root directory and run brew install nvm then nvm use to use the version from .nvmrc
  • Run corepack enable && corepack prepare
  • Run bundle exec rails db:setup (optionally prepend RAILS_ENV=development to target the dev environment)
  • Finally, run overmind start -f


For development with Docker, complete the following steps:

  • Install Docker Desktop
  • Run docker compose -f .devcontainer/docker-compose.yml up -d
  • Run docker compose -f .devcontainer/docker-compose.yml exec app .devcontainer/
  • Finally, run docker compose -f .devcontainer/docker-compose.yml exec app foreman start -f

If you are using an IDE with support for the Development Container specification, it will run the above docker compose commands automatically. For Visual Studio Code this requires the Dev Container extension.

GitHub Codespaces

To get you coding in just a few minutes, GitHub Codespaces provides a web-based version of Visual Studio Code and a cloud-hosted development environment fully configured with the software needed for this project..

  • Click this button to create a new codespace:
    Open in GitHub Codespaces
  • Wait for the environment to build. This will take a few minutes.
  • When the editor is ready, run foreman start -f in the terminal.
  • After a few seconds, a popup will appear with a button labeled Open in Browser. This will open Mastodon.
  • On the Ports tab, right click on the “stream” row and select Port visibilityPublic.


Mastodon is free, open-source software licensed under AGPLv3.

You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository or submit translations using Crowdin. To get started, take a look at If your contributions are accepted into Mastodon, you can request to be paid through our OpenCollective.

IRC channel: #mastodon on


Copyright (C) 2016-2023 Eugen Rochko & other Mastodon contributors (see

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see