Go to file
Christian Schmidt c4cf92094e
Do not strip tags from `Setting.site_short_description` (#23975)
2023-03-06 15:37:19 +01:00
.circleci Move db migration CI to GitHub Actions (#23624) 2023-02-19 07:06:34 +01:00
.devcontainer Updates dev container and adds doc for getting started with GitHub Codespaces (#23872) 2023-03-05 00:35:00 +01:00
.github Update rebase needed job settings (#23746) 2023-02-20 11:02:06 +01:00
app Do not strip tags from `Setting.site_short_description` (#23975) 2023-03-06 15:37:19 +01:00
bin Update Mastodon to Rails 6.1 (#15910) 2021-03-24 10:44:31 +01:00
chart helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
config Fix pgBouncer resetting application name on every transaction (#23958) 2023-03-05 01:52:42 +01:00
db Upgrade to latest redis-rb 4.x and fix deprecations (#23616) 2023-03-04 16:38:28 +01:00
dist Fix nginx location matching (#20198) 2022-11-09 04:12:57 +01:00
lib Upgrade to latest redis-rb 4.x and fix deprecations (#23616) 2023-03-04 16:38:28 +01:00
log
public Expand Stylelint glob to include CSS files (#22469) 2023-01-05 13:42:13 +01:00
spec Fix spec for api/v1/statuses/translations (#23956) 2023-03-04 23:17:46 +01:00
streaming Fix streaming API not being usable without `DATABASE_URL` (#23960) 2023-03-05 01:52:12 +01:00
vendor
.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 Run bundler-audit on PRs (#23514) 2023-02-18 12:49:09 +01:00
.codeclimate.yml Run bundler-audit on PRs (#23514) 2023-02-18 12:49:09 +01:00
.dockerignore Update .dockerignore/.gitignore for #16947 etc (#17099) 2021-12-06 18:04:04 +01: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 a default DB_HOST to .env.vagrant for enable the streaming (#14030) 2020-06-15 01:57:06 +02:00
.eslintignore
.eslintrc.js Rename JSX files with proper `.jsx` extension (#23733) 2023-02-20 03:20:59 +01:00
.foreman
.gitattributes
.gitignore helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
.haml-lint.yml
.nanoignore
.nvmrc Sync Node.js to 16.19 patch release (#23554) 2023-02-13 04:58:37 +01:00
.prettierignore Ignore JSX files from Prettier (#23777) 2023-02-22 09:56:11 +09:00
.prettierrc.js Format JSON and YAML using Prettier (#17823) 2022-03-21 04:46:11 +01:00
.profile
.rspec
.rubocop.yml Enable Rubocop for app/views (#23874) 2023-03-05 00:33:52 +01:00
.rubocop_todo.yml Disable Style/SymbolArray (#23921) 2023-03-03 22:55:43 +01:00
.ruby-gemset Make Mastodon use its own gemset (#17858) 2022-08-13 15:44:34 +02:00
.ruby-version Upgrade to Ruby 3.2 (#22928) 2023-02-15 08:30:27 +01:00
.slugignore
.yarnclean Replace from scss-lint to sass-lint (#10958) 2019-06-04 17:23:18 +02:00
AUTHORS.md Update AUTHORS.md (#20630) 2022-11-14 08:33:24 +01:00
Aptfile Remove packages that are provided by Heroku stacks (#19836) 2022-12-15 18:55:29 +01:00
CHANGELOG.md Fix Markdown files with Prettier and check in CI (#21972) 2023-02-20 07:37:28 +01:00
CODE_OF_CONDUCT.md Fix Markdown files with Prettier and check in CI (#21972) 2023-02-20 07:37:28 +01:00
CONTRIBUTING.md Fix Markdown files with Prettier and check in CI (#21972) 2023-02-20 07:37:28 +01:00
Capfile Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
Dockerfile Upgrade to Ruby 3.2 (#22928) 2023-02-15 08:30:27 +01:00
FEDERATION.md Add FEDERATION.md (#17029) 2021-11-23 00:15:31 +01:00
Gemfile Remove pry gems (#23884) 2023-03-03 22:53:08 +01:00
Gemfile.lock Update browser gem to version 5.3.1 (#23945) 2023-03-05 00:33:08 +01:00
LICENSE
Procfile fix: make Procfile compatible with herokuish (#12685) 2020-08-29 19:00:30 +02:00
Procfile.dev Set RAILS_ENV in Procfile.dev (#15502) 2021-01-07 09:30:12 +01:00
README.md Updates dev container and adds doc for getting started with GitHub Codespaces (#23872) 2023-03-05 00:35:00 +01:00
Rakefile
SECURITY.md Fix Markdown files with Prettier and check in CI (#21972) 2023-02-20 07:37:28 +01:00
Vagrantfile Update Ubuntu, Node versions, dependencies (#22075) 2022-12-07 00:13:14 +01:00
app.json Make enable_starttls configurable by envvars (#20321) 2022-11-10 21:06:21 +01:00
babel.config.js Remove dependency for @babel/plugin-proposal-class-properties (#16155) 2021-05-04 23:13:04 +02:00
config.ru Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
crowdin.yml Prevent translations from accidentally becoming completely different from source strings on Crowdin without translators noticing. (#17085) 2021-12-01 19:03:35 +01:00
docker-compose.yml Update docker-compose.yml (#19063) 2022-08-27 17:40:46 +02:00
ide-helper.js Add JS IDE helper (#13012) 2020-04-27 17:19:53 +02:00
jest.config.js Move Jest tests to filtered GitHub Action (#23623) 2023-02-16 01:24:35 +01:00
jsconfig.json Correct prettier calls for YML/JSON (#21832) 2022-12-03 12:05:35 +09:00
package.json Allow streaming to connect to postgress with self-signed certs (#21431) 2023-03-03 21:01:18 +01:00
postcss.config.js Remove object-fit polyfill for the old Microsoft Edge (#22693) 2023-01-05 13:32:02 +01:00
priv-config
scalingo.json Make enable_starttls configurable by envvars (#20321) 2022-11-10 21:06:21 +01:00
stylelint.config.js Upgrade to Stylelint 15 with Prettier (#23558) 2023-02-13 04:57:03 +01:00
yarn.lock Allow streaming to connect to postgress with self-signed certs (#21431) 2023-03-03 21:01:18 +01:00

README.md

Mastodon

GitHub release Build Status Code Climate Crowdin Docker Pulls

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

A Vagrant configuration is included for development purposes. To use it, complete 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

Getting Started with GitHub Codespaces

To get started, create a codespace for this repository by clicking this 👇

Open in GitHub Codespaces

A codespace will open in a web-based version of Visual Studio Code. The dev container is fully configured with software needed for this project.

Note: Dev containers is an open spec which is supported by GitHub Codespaces and other tools.

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-2022 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/.