Mastodon, as deployed on the site
Go to file
2024-06-17 16:25:13 -07:00
.devcontainer Improve Codespaces port forwarding (#26400) 2023-08-29 10:20:36 +02:00
.github Bump version to v4.2.0 (#27017) 2023-09-21 16:51:32 +02:00
.husky Use Yarn instead of NPX for pre-commit hook (#24287) 2023-03-28 06:28:57 +02:00
app Merge remote-tracking branch 'localupstream/429' into deploy 2024-06-17 16:25:13 -07:00
bin Move the mastodon/*_cli files to mastodon/cli/* (#24139) 2023-05-23 16:08:26 +02:00
chart helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
config Merge remote-tracking branch 'localupstream/429' into deploy 2024-06-17 16:25:13 -07:00
db Add migration tests for negative settings (#27012) 2023-09-21 12:33:30 +02:00
dist Add suggestion for secure cyphers to nginx.conf (#26349) 2023-08-31 12:17:10 +02:00
lib Bump version to v4.2.9 (#30470) 2024-05-30 15:34:50 +02:00
log Initial commit 2016-02-20 22:53:20 +01:00
public Change: Block GPTBot (#26396) 2023-08-09 11:58:46 +02:00
spec Merge remote-tracking branch 'localupstream/429' into deploy 2024-06-17 16:25:13 -07:00
streaming Fix websocket connections being incorrectly decremented twice on errors (#27238) 2023-10-10 13:52:41 +02:00
vendor Increase files checked by ESLint (#9705) 2019-01-04 11:28:38 +01:00
.browserslistrc Add ES6 compatibility to browserslist (#18519) 2022-05-26 20:29:28 +02:00
.buildpacks Remove nodejs buildpack from buildpacks (#14364) 2020-07-20 09:48:10 +02:00
.bundler-audit.yml Ignore the devise-two-factor advisory as we have rate limits in place (#28733) 2024-01-24 15:31:13 +01:00
.dockerignore Updating ignore files from live 2023-09-21 15:46:57 -07:00
.editorconfig Enable EditorConfig trailing whitespace trimming (#23543) 2023-02-12 08:34:17 +01:00
.env.production.sample fix: remove SMTP_SERVER (#21342) 2022-12-15 18:42:08 +01:00
.env.test Bump webpacker from 4.0.7 to 4.2.0 (#12416) 2019-11-20 17:56:11 +01:00
.env.vagrant Add elastic search installation into Vagrantfile (#26512) 2023-08-23 15:46:14 +02:00
.eslintignore Increase files checked by ESLint (#9705) 2019-01-04 11:28:38 +01:00
.eslintrc.js Upgrade to typescript-eslint v6 (#25904) 2023-07-13 11:49:16 +02:00
.foreman Replace sprockets/browserify with Webpack (#2617) 2017-05-03 02:04:16 +02:00
.gitattributes Add .gitattributes file to avoid unwanted CRLF (#3954) 2017-06-26 13:15:24 +02:00
.gitignore Add phanpy to .gitignore 2023-12-22 10:35:55 -08:00
.haml-lint.yml Consistently use middle dot (·) instead of bullet (•) to separate items (#25248) 2023-06-02 19:58:18 +02:00
.haml-lint_todo.yml Fix haml-lint Rubocop Lint/UnusedBlockArguments cop (#26039) 2023-07-20 17:03:39 +02:00
.nanoignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.nvmrc Update dependency node to 20.7 (#26963) 2023-09-19 11:16:45 +02:00
.prettierignore Fix /share and cleanup and reorganize frontend locale loading (#25240) 2023-06-02 15:00:27 +02:00
.prettierrc.js Use Prettier for ESLint formatting TypeScript (#23631) 2023-05-09 19:02:12 +02:00
.profile Make it possible to upload audio and video to Heroku app (#24866) 2023-05-05 14:41:07 +02:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.rubocop.yml Update rubocop rules for linelength (#26190) 2023-07-28 23:11:45 +02:00
.rubocop_todo.yml Dont match mention in url query string (#25656) 2023-10-10 13:52:41 +02:00
.ruby-gemset Make Mastodon use its own gemset (#17858) 2022-08-13 15:44:34 +02:00
.ruby-version Bump ruby version to 3.2.3 2024-01-24 15:31:13 +01:00
.slugignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.yarnclean Setup Husky and lint-stage for commit fixing (#23308) 2023-03-27 05:17:19 +02:00
app.json Make enable_starttls configurable by envvars (#20321) 2022-11-10 21:06:21 +01:00
Aptfile Make it possible to upload audio and video to Heroku app (#24866) 2023-05-05 14:41:07 +02:00
AUTHORS.md Update AUTHORS.md (#27018) 2023-09-21 14:42:15 +02:00
babel.config.js Update babel monorepo to v7.22.5 (#25405) 2023-06-14 09:22:54 +02:00
Capfile Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
CHANGELOG.md Bump version to v4.2.9 (#30470) 2024-05-30 15:34:50 +02:00
CODE_OF_CONDUCT.md Update Contributor Covenant to 2.1 (#23980) 2023-04-23 23:11:50 +02:00
config.ru Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
CONTRIBUTING.md Convert CircleCI to GitHub Actions (#23608) 2023-03-07 04:49:43 +01:00
crowdin.yml Add a Github Action to send translations to Crowdin for each merge in main (#25869) 2023-07-18 16:56:01 +02:00
docker-compose.yml Merge remote-tracking branch 'localupstream/429' into deploy 2024-06-17 16:25:13 -07:00
Dockerfile Bump ruby version to 3.2.3 2024-01-24 15:31:13 +01:00
FEDERATION.md Update FEDERATION.md (#26819) 2023-09-06 16:28:31 +02:00
Gemfile Improve email address validation (#29838) 2024-05-17 12:30:00 +02:00
Gemfile.lock Update dependency rexml to 3.2.8 2024-05-29 15:31:26 +02:00
ide-helper.js Add JS IDE helper (#13012) 2020-04-27 17:19:53 +02:00
jest.config.js Fix /share and cleanup and reorganize frontend locale loading (#25240) 2023-06-02 15:00:27 +02:00
jsconfig.json Correct prettier calls for YML/JSON (#21832) 2022-12-03 12:05:35 +09:00
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 2016-09-21 23:04:34 +02:00
package.json Use NodeJS v20 by default (#26830) 2023-09-08 13:45:34 +02:00
postcss.config.js Update PostCSS dependencies (#23835) 2023-03-15 04:01:10 +01:00
priv-config TOR federation (#7875) 2018-06-26 20:34:12 +02:00
Procfile fix: make Procfile compatible with herokuish (#12685) 2020-08-29 19:00:30 +02:00
Procfile.dev Support webpacker live-reloading on Docker (#26419) 2023-08-29 10:17:57 +02:00
Rakefile Run Rubocop on Rakefile (#23871) 2023-07-12 09:47:54 +02:00
README.md Fix #27010: update the copyright year in README (#27016) 2023-09-21 13:57:24 +02:00
scalingo.json Add S3 region list reference to Scalingo config (#24152) 2023-04-26 16:46:19 +02:00
SECURITY.md Fix linting failure 2024-02-16 13:57:04 +01:00
statsd-mapping.yaml Update from live: sidekiq performance, prometheus mappings 2023-09-21 15:46:57 -07:00
stylelint.config.js Update Stylelint disable settings and ignores (#23776) 2023-04-23 22:47:57 +02:00
tsconfig.json Use the new JSX transform (#25064) 2023-05-23 10:52:27 +02:00
UPDATE.md mention the merge conflict that happens every single time 2024-02-14 17:16:50 -08:00
Vagrantfile Add search tests (#26703) 2023-09-08 16:17:55 +02:00
yarn.lock Update dependency glob to v10.3.5 (#27002) 2023-09-21 11:06:16 +02:00

Mastodon

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:

Screenshot

Navigation

Features

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!

Deployment

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

Requirements

  • PostgreSQL 9.5+
  • Redis 4+
  • Ruby 2.7+
  • Node.js 14+

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.

Development

Vagrant

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

MacOS

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 && yarn set version classic
  • Run bundle exec rails db:setup (optionally prepend RAILS_ENV=development to target the dev environment)
  • Finally, run overmind start -f Procfile.dev

Docker

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/post-create.sh
  • Finally, run docker compose -f .devcontainer/docker-compose.yml exec app foreman start -f Procfile.dev

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 Procfile.dev 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.

Contributing

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 CONTRIBUTING.md. If your contributions are accepted into Mastodon, you can request to be paid through our OpenCollective.

IRC channel: #mastodon on irc.libera.chat

License

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

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 https://www.gnu.org/licenses/.