Your self-hosted, globally interconnected microblogging community
Go to file
2023-07-25 10:24:06 -04:00
.devcontainer Update mcr.microsoft.com/devcontainers/ruby Docker tag to v1 (#25613) 2023-06-27 11:28:07 +02:00
.github Coverage for Auth::OmniauthCallbacks controller (#26147) 2023-07-25 09:46:57 +02:00
.husky Use Yarn instead of NPX for pre-commit hook (#24287) 2023-03-28 06:28:57 +02:00
app Revert poll colors to green outside of compose form (#26164) 2023-07-25 15:32:59 +02:00
bin Move the mastodon/*_cli files to mastodon/cli/* (#24139) 2023-05-23 16:08:26 +02:00
chart helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
config Language edit 2023-07-25 10:24:06 -04:00
db Add published_at attribute to preview cards (#26153) 2023-07-25 13:40:35 +02:00
dist Add hardened headers to user-uploaded files (#25756) 2023-07-06 14:31:37 +02:00
lib Bump version to v4.1.5 (#26108) 2023-07-21 21:23:14 +02:00
log
public Expand Stylelint glob to include CSS files (#22469) 2023-01-05 13:42:13 +01:00
spec Coverage for Auth::OmniauthCallbacks controller (#26147) 2023-07-25 09:46:57 +02:00
streaming Add logging of websocket send errors (#25280) 2023-06-10 18:35:57 +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
.bundler-audit.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
.env.vagrant
.eslintignore
.eslintrc.js Upgrade to typescript-eslint v6 (#25904) 2023-07-13 11:49:16 +02:00
.foreman
.gitattributes
.gitignore helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
.haml-lint.yml Consistently use middle dot (·) instead of bullet (•) to separate items (#25248) 2023-06-02 19:58:18 +02:00
.haml-lint_todo.yml Fix haml-lint Rubocop Lint/UnusedBlockArguments cop (#26039) 2023-07-20 17:03:39 +02:00
.nanoignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.nvmrc Update Node.js to 16.20.0 (#24316) 2023-04-07 14:26:11 +02:00
.prettierignore Fix /share and cleanup and reorganize frontend locale loading (#25240) 2023-06-02 15:00:27 +02:00
.prettierrc.js Use Prettier for ESLint formatting TypeScript (#23631) 2023-05-09 19:02:12 +02:00
.profile Make it possible to upload audio and video to Heroku app (#24866) 2023-05-05 14:41:07 +02:00
.rspec
.rubocop.yml Run Rubocop on Rakefile (#23871) 2023-07-12 09:47:54 +02:00
.rubocop_todo.yml Clean up unused application records (#24871) 2023-07-21 13:13:16 +02:00
.ruby-gemset Make Mastodon use its own gemset (#17858) 2022-08-13 15:44:34 +02:00
.ruby-version Bump ruby to 3.2.2 due to ReDoS vulnerabilities (#24320) 2023-03-31 18:28:40 +02:00
.slugignore
.yarnclean Setup Husky and lint-stage for commit fixing (#23308) 2023-03-27 05:17:19 +02:00
app.json Make enable_starttls configurable by envvars (#20321) 2022-11-10 21:06:21 +01:00
Aptfile Make it possible to upload audio and video to Heroku app (#24866) 2023-05-05 14:41:07 +02:00
AUTHORS.md Update AUTHORS.md (#20630) 2022-11-14 08:33:24 +01:00
babel.config.js Update babel monorepo to v7.22.5 (#25405) 2023-06-14 09:22:54 +02:00
Capfile Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
CHANGELOG.md Bump version to v4.1.5 (#26108) 2023-07-21 21:23:14 +02:00
CODE_OF_CONDUCT.md Update Contributor Covenant to 2.1 (#23980) 2023-04-23 23:11:50 +02:00
config.ru Autofix Rubocop remaining Layout rules (#23679) 2023-02-20 06:58:28 +01:00
CONTRIBUTING.md Convert CircleCI to GitHub Actions (#23608) 2023-03-07 04:49:43 +01:00
crowdin.yml Add a Github Action to send translations to Crowdin for each merge in main (#25869) 2023-07-18 16:56:01 +02:00
docker-compose.yml Bump version to v4.1.5 (#26108) 2023-07-21 21:23:14 +02:00
Dockerfile Fix minor typos in comments and spec names (#21831) 2023-05-19 17:13:29 +02:00
FEDERATION.md Add FEDERATION.md (#17029) 2021-11-23 00:15:31 +01:00
Gemfile Paperclip: add support for Azure blob storage (#23607) 2023-07-19 09:02:49 +02:00
Gemfile.lock Update dependency aws-sdk-s3 to v1.131.0 (#26145) 2023-07-24 16:18:19 +02:00
ide-helper.js
jest.config.js Fix /share and cleanup and reorganize frontend locale loading (#25240) 2023-06-02 15:00:27 +02:00
jsconfig.json Correct prettier calls for YML/JSON (#21832) 2022-12-03 12:05:35 +09:00
LICENSE
package.json Change links in multi-column mode so tabs are open in single-column mode (#25893) 2023-07-13 17:18:09 +02:00
postcss.config.js Update PostCSS dependencies (#23835) 2023-03-15 04:01:10 +01:00
priv-config
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
Rakefile Run Rubocop on Rakefile (#23871) 2023-07-12 09:47:54 +02:00
README.md Add MacOS M1/2 setup steps to README (#25682) 2023-07-18 09:02:45 +02:00
scalingo.json Add S3 region list reference to Scalingo config (#24152) 2023-04-26 16:46:19 +02:00
SECURITY.md Fix Markdown files with Prettier and check in CI (#21972) 2023-02-20 07:37:28 +01:00
stylelint.config.js Update Stylelint disable settings and ignores (#23776) 2023-04-23 22:47:57 +02:00
tsconfig.json Use the new JSX transform (#25064) 2023-05-23 10:52:27 +02:00
Vagrantfile Update Ubuntu, Node versions, dependencies (#22075) 2022-12-07 00:13:14 +01:00
yarn.lock Update dependency sass to v1.64.1 (#26146) 2023-07-25 14:45:35 +02:00

Mastodon

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

To set up MacOS for native development, complete the following steps:

  • Install the latest stable Ruby version (use a ruby version manager for easy installation and management of ruby versions)
  • Run brew install postgresql@14
  • Run brew install redis
  • Run brew install imagemagick
  • Install Foreman or a similar tool (such as overmind) to handle multiple process launching.
  • Navigate to Mastodon's root directory and run brew install nvm then nvm use to use the version from .nvmrc
  • Run corepack enable && yarn set version classic
  • Run bundle exec rails db:setup (optionally prepend RAILS_ENV=development to target the dev environment)
  • Finally, run overmind start -f Procfile.dev

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