8ac5a93a7d
|
||
|---|---|---|
| .devcontainer | ||
| .github | ||
| .husky | ||
| app | ||
| bin | ||
| chart | ||
| config | ||
| db | ||
| dist | ||
| lib | ||
| log | ||
| public | ||
| spec | ||
| streaming | ||
| vendor | ||
| .browserslistrc | ||
| .buildpacks | ||
| .bundler-audit.yml | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.production.sample | ||
| .env.test | ||
| .env.vagrant | ||
| .eslintignore | ||
| .eslintrc.js | ||
| .foreman | ||
| .gitattributes | ||
| .gitignore | ||
| .haml-lint.yml | ||
| .haml-lint_todo.yml | ||
| .nanoignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.js | ||
| .profile | ||
| .rspec | ||
| .rubocop.yml | ||
| .rubocop_todo.yml | ||
| .ruby-gemset | ||
| .ruby-version | ||
| .slugignore | ||
| .yarnclean | ||
| AUTHORS.md | ||
| Aptfile | ||
| CHANGELOG.md | ||
| CODE_OF_CONDUCT.md | ||
| CONTRIBUTING.md | ||
| Capfile | ||
| Dockerfile | ||
| FEDERATION.md | ||
| Gemfile | ||
| Gemfile.lock | ||
| LICENSE | ||
| Procfile | ||
| Procfile.dev | ||
| README.md | ||
| Rakefile | ||
| SECURITY.md | ||
| Vagrantfile | ||
| app.json | ||
| babel.config.js | ||
| config.ru | ||
| crowdin.yml | ||
| docker-compose.yml | ||
| ide-helper.js | ||
| jest.config.js | ||
| jsconfig.json | ||
| package.json | ||
| postcss.config.js | ||
| priv-config | ||
| scalingo.json | ||
| stylelint.config.js | ||
| tsconfig.json | ||
| yarn.lock | ||
README.md
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:
Navigation
- Project homepage 🐘
- Support the development via Patreon
- View sponsors
- Blog
- Documentation
- Roadmap
- Official Docker image
- Browse Mastodon servers
- Browse Mastodon apps
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-hostsupdaterplugin:vagrant plugin install vagrant-hostsupdater - Run
vagrant up - Run
vagrant ssh -c "cd /vagrant && foreman start" - Open
http://mastodon.localin 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 nvmthennvm useto use the version from .nvmrc - Run
corepack enable && yarn set version classic - Run
bundle exec rails db:setup(optionally prependRAILS_ENV=developmentto 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 👇
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/.