Your self-hosted, globally interconnected microblogging community
Go to file
Yamagishi Kazutoshi e798c1c64c
Replace metadata-action type to match (#17802)
2022-03-15 20:38:29 +01:00
.circleci Update config.yml (#17799) 2022-03-15 22:11:09 +09:00
.devcontainer Add DevContainer config (#17764) 2022-03-13 15:03:36 +01:00
.github Replace metadata-action type to match (#17802) 2022-03-15 20:38:29 +01:00
app Fix “edited at” in public pages not being properly localized (#17806) 2022-03-15 19:07:25 +01:00
bin Update Mastodon to Rails 6.1 (#15910) 2021-03-24 10:44:31 +01:00
chart Helm chart SSO support (#17205) 2022-02-11 15:01:40 +01:00
config Fix PgHero suggesting migrations (#17807) 2022-03-15 20:27:49 +01:00
db Fix null values being included in some indexes (#17711) 2022-03-12 08:12:57 +01:00
dist Also compress SVG and ICO images in nginx (#17651) 2022-02-26 17:27:11 +01:00
lib Bump version to 3.5.0rc1 (#17618) 2022-03-15 08:16:45 +01:00
log Initial commit 2016-02-20 22:53:20 +01:00
nanobox Resync Nanobox files with the 2.9.0 release (#11083) 2019-06-14 14:52:31 +02:00
public Fixed prototype pollution bug and only allow trusted origin (#17420) 2022-02-01 17:34:48 +01:00
spec Add `types` param to `GET /api/v1/notifications` in REST API (#17767) 2022-03-15 04:11:29 +01:00
streaming Change streaming server error messages when failing to parse client input (#17559) 2022-02-16 14:37:26 +01:00
vendor Increase files checked by ESLint (#9705) 2019-01-04 11:28:38 +01:00
.buildpacks Remove nodejs buildpack from buildpacks (#14364) 2020-07-20 09:48:10 +02:00
.codeclimate.yml Exclude locale files from Code Climate (#16863) 2021-10-18 12:04:42 +02:00
.deepsource.toml Update .deepsource.toml (#15753) 2021-02-19 09:53:25 +01:00
.dockerignore Update .dockerignore/.gitignore for #16947 etc (#17099) 2021-12-06 18:04:04 +01:00
.editorconfig Add final newline to locale files (#2890) 2017-05-07 19:55:47 +02:00
.env.nanobox Remove support for OAUTH_REDIRECT_AT_SIGN_IN (#17287) 2022-01-23 15:50:41 +01:00
.env.production.sample Spelling (#17705) 2022-03-06 22:51:40 +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 Increase files checked by ESLint (#9705) 2019-01-04 11:28:38 +01:00
.eslintrc.js Enable promise/catch-or-return allowFinally (#14289) 2020-07-11 23:51:22 +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 Update .dockerignore/.gitignore for #16947 etc (#17099) 2021-12-06 18:04:04 +01:00
.haml-lint.yml Added haml-lint and fix warnings (#2773) 2017-05-08 03:35:25 +02:00
.nanoignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.nvmrc NodeJS 14 support - circleci/docker/.nvmrc (#16163) 2021-08-10 22:56:13 +02:00
.profile Add ffmpeg and dependent packages as well as LD_LIBRARY_PATHs (#3276) 2017-05-24 17:57:33 +02:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.rubocop.yml Update fix-duplicates maintenance task (#17731) 2022-03-12 08:33:11 +01:00
.ruby-version Upgrade Ruby to 3.0.3 (#17038) 2021-11-24 20:29:05 +01:00
.sass-lint.yml Fix sass-lint config (#10982) 2019-06-06 18:51:46 +02:00
.slugignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.yarnclean Replace from scss-lint to sass-lint (#10958) 2019-06-04 17:23:18 +02:00
AUTHORS.md Bump version to 3.5.0rc1 (#17618) 2022-03-15 08:16:45 +01:00
Aptfile Remove protobuf dependencies (#17539) 2022-02-14 16:08:02 +01:00
CHANGELOG.md Bump version to 3.5.0rc1 (#17618) 2022-03-15 08:16:45 +01:00
CODE_OF_CONDUCT.md Add code of conduct from GitHub generator (#5674) 2017-11-13 17:28:55 +01:00
CONTRIBUTING.md Change references to tootsuite/mastodon to mastodon/mastodon (#16491) 2021-07-13 15:46:20 +02:00
Capfile remove capistrano/faster_assets from Capfile (#2737) 2017-05-03 12:14:52 +02:00
Dockerfile Remove protobuf dependencies (#17539) 2022-02-14 16:08:02 +01:00
FEDERATION.md Add FEDERATION.md (#17029) 2021-11-23 00:15:31 +01:00
Gemfile Bump rails from 6.1.4.6 to 6.1.5 (#17791) 2022-03-15 14:05:20 +09:00
Gemfile.lock Bump rails from 6.1.4.6 to 6.1.5 (#17791) 2022-03-15 14:05:20 +09:00
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 2016-09-21 23:04:34 +02:00
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 Bump version to 3.5.0rc1 (#17618) 2022-03-15 08:16:45 +01:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00
SECURITY.md Remove references to discourse.joinmastodon.org (#17797) 2022-03-15 08:13:22 +01:00
Vagrantfile Remove protobuf dependencies (#17539) 2022-02-14 16:08:02 +01:00
app.json Change references to tootsuite/mastodon to mastodon/mastodon (#16491) 2021-07-13 15:46:20 +02:00
babel.config.js Remove dependency for @babel/plugin-proposal-class-properties (#16155) 2021-05-04 23:13:04 +02:00
boxfile.yml Fix to isolate the sidekiq process that runs the scheduler job (#15314) 2020-12-15 03:04:03 +01:00
config.ru Fix rubocop issues, introduce usage of frozen literal to improve performance 2016-11-15 16:56:29 +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 Add healthcheck for sidekiq (#17365) 2022-01-26 18:08:49 +01:00
ide-helper.js Add JS IDE helper (#13012) 2020-04-27 17:19:53 +02:00
package.json Bump @rails/ujs from 6.1.4 to 6.1.5 (#17776) 2022-03-15 13:48:15 +09:00
postcss.config.js Increase files checked by ESLint (#9705) 2019-01-04 11:28:38 +01:00
priv-config TOR federation (#7875) 2018-06-26 20:34:12 +02:00
scalingo.json Change references to tootsuite/mastodon to mastodon/mastodon (#16491) 2021-07-13 15:46:20 +02:00
yarn.lock Bump @rails/ujs from 6.1.4 to 6.1.5 (#17776) 2022-03-15 13:48:15 +09: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.5+
  • Node.js 12+

The repository includes deployment configurations for Docker and docker-compose as well as specific platforms like Heroku, Scalingo, and Nanobox. 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/.