Your self-hosted, globally interconnected microblogging community
Go to file
renovate[bot] 0663c7d78d
fix(deps): update formatjs monorepo (#30359)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2024-05-20 17:14:10 +00:00
.devcontainer Update libretranslate/libretranslate Docker tag to v1.5.7 (#30111) 2024-04-29 08:10:04 +00:00
.github Fix OpenSearch compatibility issue (#30278) 2024-05-14 17:54:28 +00:00
.husky Update husky and remove deprecated features (#29338) 2024-02-22 09:02:15 +00:00
.yarn Replace our custom compression-webpack-plugin patch with the fixed upstream version (#28510) 2023-12-29 09:33:06 +00:00
app Fix Rails/WhereRange cop (#30343) 2024-05-20 09:37:36 +00:00
bin fix(bin/dev): makes conditional for launching overmind POSIX-compliant (#30271) 2024-05-13 09:40:14 +00:00
chart helm: cleanup helm chart, now in mastodon/chart (#21801) 2022-12-09 06:36:29 +01:00
config Use the job class as span name for Sidekiq root spans (#30353) 2024-05-20 08:01:04 +00:00
db Change older Paperclip database migrations for consistency (#30204) 2024-05-20 14:59:27 +00:00
dist Add suggestion for secure cyphers to nginx.conf (#26349) 2023-08-31 12:17:10 +02:00
lib Fix Rails/WhereRange cop (#30343) 2024-05-20 09:37:36 +00:00
log Initial commit 2016-02-20 22:53:20 +01:00
public Use modern ES syntax rather than .call (#29368) 2024-02-27 15:42:05 +00:00
spec Add coverage for custom filters (#30347) 2024-05-20 15:00:09 +00:00
streaming Update Yarn to v4.2.2 (#30220) 2024-05-10 09:22:47 +00:00
vendor Increase files checked by ESLint (#9705) 2019-01-04 11:28:38 +01:00
.browserslistrc Add back support for old browsers (#29654) 2024-03-20 11:07:10 +00:00
.buildpacks Remove nodejs buildpack from buildpacks (#14364) 2020-07-20 09:48:10 +02:00
.bundler-audit.yml Ignore the devise-two-factor advisory as we have rate limits in place (#28733) 2024-01-15 10:45:48 +00:00
.dockerignore Do not copy public/packs-test into Docker (#27736) 2023-11-07 09:22:04 +00:00
.editorconfig Enable EditorConfig trailing whitespace trimming (#23543) 2023-02-12 08:34:17 +01:00
.env.development Enable AR Encryption (#29831) 2024-04-17 09:19:02 +00:00
.env.production.sample fix: remove SMTP_SERVER (#21342) 2022-12-15 18:42:08 +01:00
.env.test Add emphasis on ActiveRecord Encryption configuration values being secret (#30340) 2024-05-17 09:28:40 +00:00
.env.vagrant Add elastic search installation into Vagrantfile (#26512) 2023-08-23 15:46:14 +02:00
.eslintignore Increase files checked by ESLint (#9705) 2019-01-04 11:28:38 +01:00
.eslintrc.js Update eslint (non-major) (#29820) 2024-04-03 18:05:39 +00: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 Ignore dotenv *.local files (#29932) 2024-04-26 14:50:39 +00:00
.haml-lint.yml Use tt extension for form scaffold template (#29676) 2024-04-10 09:20:21 +00:00
.nanoignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.nvmrc Update dependency node to 20.13 (#30211) 2024-05-10 09:25:07 +00:00
.prettierignore Rework Prettier invocation (#28851) 2024-02-27 16:09:27 +00: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 Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.rubocop.yml Disable Style/RedundantFetchBlock cop (#30207) 2024-05-15 13:57:13 +00:00
.rubocop_todo.yml Disable Style/RedundantFetchBlock cop (#30207) 2024-05-15 13:57:13 +00:00
.ruby-gemset Make Mastodon use its own gemset (#17858) 2022-08-13 15:44:34 +02:00
.ruby-version Change default ruby version to 3.3.1 (#28013) 2024-04-29 07:41:59 +00:00
.slugignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.watchmanconfig Fix Jest config (#27834) 2023-11-13 12:19:41 +00:00
.yarnrc.yml Upgrade to Yarn 4, remove support for Node 16 (#27073) 2023-11-08 10:57:21 +00: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 (#27018) 2023-09-21 14:42:15 +02:00
babel.config.js Disable Babel polyfill injection in dev (#27691) 2023-11-06 10:24:41 +00:00
CHANGELOG.md Bump version to v4.3.0-alpha.3 (#29241) 2024-02-16 11:06:47 +00: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 Update CONTRIBUTING.md with additional requirements for API additions (#28274) 2023-12-08 09:52:28 +00: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 docker-compose.yml version is obsolete (#30120) 2024-04-29 17:31:14 +00:00
Dockerfile Change default ruby version to 3.3.1 (#28013) 2024-04-29 07:41:59 +00:00
FEDERATION.md docs: update FEDERATION.md to more closely follow FEP conventions. (#28838) 2024-01-22 11:11:47 +00:00
Gemfile chore(deps): update dependency rspec-sidekiq to v5 (#30314) 2024-05-16 07:43:31 +00:00
Gemfile.lock chore(deps): update dependency rubocop-rails to v2.25.0 (#30341) 2024-05-20 17:04:21 +00:00
ide-helper.js Add JS IDE helper (#13012) 2020-04-27 17:19:53 +02:00
jest.config.js Change icon SVG imports to use a default import (#28709) 2024-01-12 10:31:24 +00:00
jsconfig.json Update devDependencies (non-major) (#29089) 2024-02-27 16:07:43 +00:00
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 2016-09-21 23:04:34 +02:00
lint-staged.config.js Improve lint-staged config (#28704) 2024-01-12 09:09:57 +00:00
package.json fix(deps): update dependency @rails/ujs to v7.1.3 (#30356) 2024-05-20 07:56:28 +00:00
postcss.config.js Fix PostCSS config (#29926) 2024-04-15 09:06:06 +00:00
priv-config TOR federation (#7875) 2018-06-26 20:34:12 +02:00
Procfile fix: make Procfile compatible with herokuish (#12685) 2020-08-29 19:00:30 +02:00
Procfile.dev Split streaming server from web server (#24702) 2023-11-14 17:43:20 +00:00
Rakefile Run Rubocop on Rakefile (#23871) 2023-07-12 09:47:54 +02:00
README.md Update README.md setup steps (#30063) 2024-05-10 12:34:32 +00:00
scalingo.json Add S3 region list reference to Scalingo config (#24152) 2023-04-26 16:46:19 +02:00
SECURITY.md Remove v3.5 branch from supported Mastodon versions (#28574) 2024-01-03 15:04:10 +00:00
stylelint.config.js Update Stylelint disable settings and ignores (#23776) 2023-04-23 22:47:57 +02:00
tsconfig.json Move JS source from packs to entrypoints (#30037) 2024-04-23 16:45:12 +00:00
Vagrantfile Forward 3035 port (#29710) 2024-04-05 09:19:43 +00:00
yarn.lock fix(deps): update formatjs monorepo (#30359) 2024-05-20 17:14:10 +00: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, and 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 12+
  • Redis 4+
  • Ruby 3.1+
  • Node.js 18+

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.

Development

Vagrant

A Vagrant configuration is included for development purposes. To use it, complete the 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 && bin/dev"
  • Open http://mastodon.local in your browser

MacOS

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

  • Use a Ruby version manager to install the specified version from .ruby-version
  • Run bundle to install required gems
  • Run brew install postgresql@14 redis imagemagick libidn to install required dependencies
  • Navigate to Mastodon's root directory and run brew install nvm then nvm use to use the version from .nvmrc
  • Run yarn to install required packages
  • Run corepack enable && corepack prepare
  • Run RAILS_ENV=development bundle exec rails db:setup
  • Finally, run bin/dev which will launch the local services via overmind (if installed) or foreman

Docker

For development with Docker, complete the following steps:

  • Install Docker Desktop
  • Run docker compose -f .devcontainer/docker-compose.yml up -d
  • Run docker compose -f .devcontainer/docker-compose.yml exec app .devcontainer/post-create.sh
  • Finally, run docker compose -f .devcontainer/docker-compose.yml exec app bin/dev

If you are using an IDE with support for the Development Container specification, it will run the above docker compose commands automatically. For Visual Studio Code this requires the Dev Container extension.

GitHub Codespaces

To get you coding in just a few minutes, GitHub Codespaces provides a web-based version of Visual Studio Code and a cloud-hosted development environment fully configured with the software needed for this project..

  • Click this button to create a new codespace:
    Open in GitHub Codespaces
  • Wait for the environment to build. This will take a few minutes.
  • When the editor is ready, run bin/dev in the terminal.
  • After a few seconds, a popup will appear with a button labeled Open in Browser. This will open Mastodon.
  • On the Ports tab, right click on the “stream” row and select Port visibilityPublic.

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