Your self-hosted, globally interconnected microblogging community
 
 
 
 
 
 
Go to file
Claire f682478de8
Fix inefficiency when searching accounts per username in admin interface (#23801)
2023-02-22 11:53:13 +01:00
.circleci Move db migration CI to GitHub Actions (#23624) 2023-02-19 07:06:34 +01:00
.devcontainer Fix devcontainer.json format (#23715) 2023-02-19 07:02:46 +01:00
.github Update rebase needed job settings (#23746) 2023-02-20 11:02:06 +01:00
app Fix inefficiency when searching accounts per username in admin interface (#23801) 2023-02-22 11:53:13 +01:00
bin
chart
config Rename JSX files with proper `.jsx` extension (#23733) 2023-02-20 03:20:59 +01:00
db Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
dist
lib Autofix Rubocop Rails/RootPathnameMethods (#23760) 2023-02-22 09:57:15 +09:00
log
public
spec Fix rack:attack flaky tests and test end of throttle period (#23799) 2023-02-22 10:28:52 +01:00
streaming fix metrics format (#23520) 2023-02-11 03:00:44 +01:00
vendor
.browserslistrc
.buildpacks
.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
.editorconfig Enable EditorConfig trailing whitespace trimming (#23543) 2023-02-12 08:34:17 +01:00
.env.production.sample
.env.test
.env.vagrant
.eslintignore
.eslintrc.js Rename JSX files with proper `.jsx` extension (#23733) 2023-02-20 03:20:59 +01:00
.foreman
.gitattributes
.gitignore
.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
.profile
.rspec
.rubocop.yml Autofix Rubocop Style/RescueStandardError (#23745) 2023-02-20 11:01:20 +01:00
.rubocop_todo.yml Autofix Rubocop Rails/Blank (#23765) 2023-02-22 09:57:56 +09:00
.ruby-gemset
.ruby-version Upgrade to Ruby 3.2 (#22928) 2023-02-15 08:30:27 +01:00
.slugignore
.yarnclean
AUTHORS.md
Aptfile
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
Gemfile Bump devise from 4.8.1 to 4.9.0 (#23691) 2023-02-21 10:41:28 +01:00
Gemfile.lock Bump devise from 4.8.1 to 4.9.0 (#23691) 2023-02-21 10:41:28 +01:00
LICENSE
Procfile
Procfile.dev
README.md Update README.md (#23409) 2023-02-07 01:23:21 +01:00
Rakefile
SECURITY.md Fix Markdown files with Prettier and check in CI (#21972) 2023-02-20 07:37:28 +01:00
Vagrantfile
app.json
babel.config.js
config.ru Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
crowdin.yml
docker-compose.yml
ide-helper.js
jest.config.js Move Jest tests to filtered GitHub Action (#23623) 2023-02-16 01:24:35 +01:00
jsconfig.json
package.json Bump @babel/plugin-proposal-decorators from 7.20.13 to 7.21.0 (#23769) 2023-02-21 11:35:27 +01:00
postcss.config.js
priv-config
scalingo.json
stylelint.config.js Upgrade to Stylelint 15 with Prettier (#23558) 2023-02-13 04:57:03 +01:00
yarn.lock Bump @babel/plugin-proposal-decorators from 7.20.13 to 7.21.0 (#23769) 2023-02-21 11:35:27 +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

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