1
0
Fork 1
mirror of https://github.com/mastodon/mastodon.git synced 2024-12-21 08:39:44 +00:00
Your self-hosted, globally interconnected microblogging community
Go to file
2024-10-09 17:29:02 +00:00
.devcontainer Update libretranslate/libretranslate Docker tag to v1.6.1 () 2024-09-23 08:35:23 +00:00
.github Fix latest tag for 4.3 docker image builds () 2024-10-09 12:13:32 +00:00
.husky Update husky and remove deprecated features () 2024-02-22 09:02:15 +00:00
.rubocop Enable Rails/Output in spec/ dir () 2024-09-16 08:29:06 +00:00
.yarn Replace our custom compression-webpack-plugin patch with the fixed upstream version () 2023-12-29 09:33:06 +00:00
app Fix notification requests from suspended accounts still being listed () 2024-10-09 17:29:02 +00:00
bin Use flatware to parallelize CI specs () 2024-06-27 07:42:57 +00:00
chart
config Remove unused deprecator configuration () 2024-10-08 12:52:52 +00:00
db Add missing on_delete: :cascade on notification_permissions () 2024-10-07 07:46:03 +00:00
dist Add suggestion for secure cyphers to nginx.conf () 2023-08-31 12:17:10 +02:00
lib Add OpenSSL::SSL::SSLError to http connection errors wrapper () 2024-10-08 14:59:51 +00:00
log
public Fix missing permission on new embeds making them unclickable () 2024-09-30 08:20:20 +00:00
spec Fix notification requests from suspended accounts still being listed () 2024-10-09 17:29:02 +00:00
streaming Update docker/dockerfile Docker tag to v1.10 () 2024-10-01 09:29:38 +00:00
vendor
.browserslistrc Target firefox all the way back to Firefox 78 () 2024-09-06 12:33:38 +00:00
.buildpacks
.dockerignore Do not copy public/packs-test into Docker () 2023-11-07 09:22:04 +00:00
.editorconfig
.env.development Enable AR Encryption () 2024-04-17 09:19:02 +00:00
.env.production.sample Change instructions to use bundle exec rails instead of rake () 2024-07-05 08:54:45 +00:00
.env.test Add emphasis on ActiveRecord Encryption configuration values being secret () 2024-05-17 09:28:40 +00:00
.env.vagrant Add elastic search installation into Vagrantfile () 2023-08-23 15:46:14 +02:00
.eslintignore
.eslintrc.js Enable ESLlint no-case-declarations () 2024-10-01 16:26:30 +00:00
.foreman
.gitattributes
.gitignore Remove fuubar gem and custom rspec --format setting () 2024-09-03 15:24:31 +00:00
.haml-lint.yml Use tt extension for form scaffold template () 2024-04-10 09:20:21 +00:00
.nvmrc Update dependency node to 20.18 () 2024-10-04 07:57:41 +00:00
.prettierignore Rework Prettier invocation () 2024-02-27 16:09:27 +00:00
.prettierrc.js
.rspec Remove fuubar gem and custom rspec --format setting () 2024-09-03 15:24:31 +00:00
.rubocop.yml Use rubocop DisplayCopNames and UseCache defaults (true) () 2024-06-19 09:34:24 +00:00
.rubocop_todo.yml Update parser and rubocop gems () 2024-09-05 10:20:27 +00:00
.ruby-gemset
.ruby-version Update dependency ruby to v3.3.5 () 2024-09-04 08:25:37 +00:00
.slugignore
.watchmanconfig Fix Jest config () 2023-11-13 12:19:41 +00:00
.yarnrc.yml Upgrade to Yarn 4, remove support for Node 16 () 2023-11-08 10:57:21 +00:00
app.json Refresh Heroku related thingy for heroku-24 stack () 2024-09-03 16:03:00 +00:00
Aptfile Refresh Heroku related thingy for heroku-24 stack () 2024-09-03 16:03:00 +00:00
AUTHORS.md Update AUTHORS.md () 2023-09-21 14:42:15 +02:00
babel.config.js fix(deps): update dependency fuzzysort to v3 () 2024-07-24 08:13:09 +00:00
CHANGELOG.md Update changelog and security policy () 2024-10-08 12:24:59 +00:00
CODE_OF_CONDUCT.md
config.ru
CONTRIBUTING.md Add link to org-level contribution guidelines to contributing doc () 2024-07-18 15:45:40 +00:00
crowdin.yml Case correction Github -> GitHub () 2024-06-08 10:32:39 +00:00
docker-compose.yml Update changelog and security policy () 2024-10-08 12:24:59 +00:00
Dockerfile Update dependency ffmpeg to v7.1 () 2024-10-04 07:18:38 +00:00
FEDERATION.md docs: update FEDERATION.md to more closely follow FEP conventions. () 2024-01-22 11:11:47 +00:00
Gemfile Remove unused E2EE messaging code () 2024-09-18 09:27:43 +00:00
Gemfile.lock Update dependency aws-sdk-s3 to v1.167.0 () 2024-10-03 09:04:33 +00:00
ide-helper.js
jest.config.js Change icon SVG imports to use a default import () 2024-01-12 10:31:24 +00:00
jsconfig.json Update devDependencies (non-major) () 2024-02-27 16:07:43 +00:00
LICENSE
lint-staged.config.js Add rubocop binstub, simplify configuration () 2024-06-13 14:27:17 +00:00
package.json Change media reordering design in the compose form in web UI () 2024-09-27 15:09:39 +00:00
postcss.config.js Change PostCSS config to allow logical properties () 2024-08-02 13:17:36 +00:00
priv-config
Procfile Refresh Heroku related thingy for heroku-24 stack () 2024-09-03 16:03:00 +00:00
Procfile.dev Split streaming server from web server () 2023-11-14 17:43:20 +00:00
Rakefile
README.md Update README.md () 2024-06-12 13:48:30 +00:00
scalingo.json
SECURITY.md Update changelog and security policy () 2024-10-08 12:24:59 +00:00
stylelint.config.js Disable stylelint rules that are conflicting with Prettier () 2024-08-08 19:22:16 +00:00
tsconfig.json Enable stricter Typescript options () 2024-05-27 09:24:59 +00:00
Vagrantfile Add libvirt provider parameters to Vagrant () 2024-06-04 20:28:05 +00:00
yarn.lock Update dependency express to v4.21.1 () 2024-10-09 14:24:24 +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, and Scalingo. 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:

  • Install Homebrew and run brew install postgresql@14 redis imagemagick libidn nvm to install the required project dependencies
  • Use a Ruby version manager to activate the ruby in .ruby-version and run nvm use to activate the node version from .nvmrc
  • Run the bin/setup script, which will install the required ruby gems and node packages and prepare the database for local development
  • Finally, run the bin/dev script which will launch services via overmind (if installed) or foreman

Docker

For production hosting and deployment with Docker, use the Dockerfile and docker-compose.yml in the project root directory.

For local development, install and launch Docker, and run:

docker compose -f .devcontainer/compose.yaml up -d
docker compose -f .devcontainer/compose.yaml exec app bin/setup
docker compose -f .devcontainer/compose.yaml exec app bin/dev

Dev Containers

Within IDEs that support the Development Containers specification, start the "Mastodon on local machine" container from the editor. The necessary docker compose commands to build and setup the container should run automatically. For Visual Studio Code this requires installing the Dev Container extension.

GitHub Codespaces

GitHub Codespaces provides a web-based version of VS Code and a cloud hosted development environment configured with the software needed for this project.

Open in GitHub Codespaces

  • Click the button to create a new codespace, and confirm the options
  • Wait for the environment to build (takes a few minutes)
  • When the editor is ready, run bin/dev in the terminal
  • Wait for an Open in Browser prompt. This will open Mastodon
  • On the Ports tab "stream" setting change 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/.