Your self-hosted, globally interconnected microblogging community
Go to file
Emelia Smith da230600ac Refactor streaming's filtering logic & improve documentation (#26213) 2023-07-31 14:33:06 +02:00
.circleci Update circleci (#21880) 2022-12-15 18:13:13 +01:00
.devcontainer Install SSH server into devcontainer image (#22679) 2023-01-05 13:32:59 +01:00
.github Skip pushing containers on forks (#24106) 2023-03-16 11:44:25 +01:00
app Change request timeout handling to use a longer deadline (#26055) 2023-07-21 16:07:43 +02:00
bin Fix sidekiq jobs not triggering Elasticsearch index updates (#24046) 2023-03-13 18:44:09 +01:00
chart helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
config Fix CSP headers being unintendedly wide (#26105) 2023-07-21 16:07:43 +02:00
db Wrap db:setup with Chewy.strategy(:mastodon) (#24302) 2023-04-04 12:41:27 +02:00
dist Add hardened headers to user-uploaded files (#25756) 2023-07-06 14:32:26 +02:00
lib Bump version to v4.1.5 2023-07-21 16:07:43 +02:00
log
public Expand Stylelint glob to include CSS files (#22469) 2023-01-05 13:42:13 +01:00
spec Fix CSP headers being unintendedly wide (#26105) 2023-07-21 16:07:43 +02:00
streaming Refactor streaming's filtering logic & improve documentation (#26213) 2023-07-31 14:33:06 +02: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
.codeclimate.yml Replace from Code Climate to Super-Linter (#18587) 2022-06-01 19:22:35 +02:00
.dockerignore Update .dockerignore/.gitignore for #16947 etc (#17099) 2021-12-06 18:04:04 +01:00
.editorconfig
.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 Enable ESLint jsx-a11y/recommended ruleset (#23309) 2023-01-30 14:18:12 +09: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 Align everything to Node.js 16 (#22223) 2022-12-15 17:43:26 +01:00
.prettierignore helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
.prettierrc.js Format JSON and YAML using Prettier (#17823) 2022-03-21 04:46:11 +01:00
.profile
.rspec
.rubocop.yml Run Prettier on YML files (#22345) 2022-12-16 11:11:52 +09:00
.ruby-gemset Make Mastodon use its own gemset (#17858) 2022-08-13 15:44:34 +02:00
.ruby-version Update Ruby to 3.0.6 (#24334) 2023-04-04 12:41:27 +02:00
.slugignore
.yarnclean
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 Bump version to v4.1.5 2023-07-21 16:07:43 +02:00
CODE_OF_CONDUCT.md Change HTTP to HTTPS for links in CODE_OF_CONDUCT (#22465) 2022-12-19 09:46:22 +09:00
CONTRIBUTING.md Note that CircleCI auth may be required to run PR pipelines (#20371) 2022-11-11 02:54:02 +01:00
Capfile
Dockerfile Update Ruby to 3.0.6 (#24334) 2023-04-04 12:41:27 +02:00
FEDERATION.md Add FEDERATION.md (#17029) 2021-11-23 00:15:31 +01:00
Gemfile Bump bootsnap from 1.15.0 to 1.16.0 (#23340) 2023-02-04 15:55:07 +09:00
Gemfile.lock Update dependencies 2023-07-07 19:37:21 +02: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 Use Github Container Registry as the official container image source (#24113) 2023-03-16 11:44:11 +01:00
Rakefile
SECURITY.md Change e-mail in SECURITY.md (#20384) 2022-11-11 05:26:43 +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 Apply Rubocop Style/ExpandPathArguments (#23450) 2023-02-08 07:06:20 +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 Bump version to v4.1.5 2023-07-21 16:07:43 +02:00
ide-helper.js Add JS IDE helper (#13012) 2020-04-27 17:19:53 +02:00
jest.config.js Bump jest from 27.5.1 to 28.0.3 (#18280) 2022-05-04 14:06:49 +09:00
jsconfig.json Correct prettier calls for YML/JSON (#21832) 2022-12-03 12:05:35 +09:00
package.json Bump axios from 1.2.6 to 1.3.2 (#23420) 2023-02-08 10:54:51 +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 Replace from Code Climate to Super-Linter (#18587) 2022-06-01 19:22:35 +02:00
yarn.lock Bump axios from 1.2.6 to 1.3.2 (#23420) 2023-02-08 10:54:51 +01:00

README.md

Mastodon

GitHub release Build Status Code Climate 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, 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

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