Go to file
Matt Jankowski 1ed12d5e2f
Add basic search specs for chewy indexes (#24065)
2023-03-10 19:31:10 +01:00
.devcontainer Sync CI and Docker Compose image versions (#24053) 2023-03-10 11:10:47 +01:00
.github Sync CI and Docker Compose image versions (#24053) 2023-03-10 11:10:47 +01:00
app Center the text itself in upload area (#24029) 2023-03-09 14:35:44 +01:00
bin
chart
config Convert CircleCI to GitHub Actions (#23608) 2023-03-07 04:49:43 +01:00
db Upgrade to latest redis-rb 4.x and fix deprecations (#23616) 2023-03-04 16:38:28 +01:00
dist
lib Add refreshing many accounts at once with "tootctl accounts refresh" (#23304) 2023-03-08 17:06:53 +01:00
log
public
spec Add basic search specs for chewy indexes (#24065) 2023-03-10 19:31:10 +01:00
streaming Disable anonymous access to the streaming API (#23989) 2023-03-06 21:00:10 +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
.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 Enable RSpec/FilePath (#23965) 2023-03-10 16:32:37 +01:00
.rubocop_todo.yml Enable RSpec/FilePath (#23965) 2023-03-10 16:32:37 +01: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 Convert CircleCI to GitHub Actions (#23608) 2023-03-07 04:49:43 +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 Explicitly set github repo in instance presenter spec (#24036) 2023-03-09 14:27:48 +01:00
Gemfile.lock Bump pghero from 3.1.0 to 3.2.0 (#24044) 2023-03-10 14:08:10 +01:00
LICENSE
Procfile
Procfile.dev
README.md Convert CircleCI to GitHub Actions (#23608) 2023-03-07 04:49:43 +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 eslint from 8.33.0 to 8.35.0 (#24049) 2023-03-10 15:24:19 +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 eslint from 8.33.0 to 8.35.0 (#24049) 2023-03-10 15:24:19 +01:00

README.md

Mastodon

GitHub release Ruby Testing 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/.