Go to file
sclaire-1 1e96f7d067 Edit introduction of README.md (#12372)
The introductory paragraph has been edited to be more cohesive.
2019-11-13 13:54:47 +01:00
.circleci Add missing locale file for ga and add rake task to check for it (#11813) 2019-09-12 04:58:33 +02:00
.dependabot Change dependabot update schedule from live to weekly (#10949) 2019-06-04 11:23:19 +02:00
.github Change stale bot to only touch pull requests over 120 days old (#12217) 2019-10-26 12:45:52 +02:00
app Fix broken admin audit log in whitelist mode (#12303) 2019-11-11 00:05:15 +02:00
bin
config Fix broken admin audit log in whitelist mode (#12303) 2019-11-11 00:05:15 +02:00
db Add abilityto add oneself to lists (#12271) 2019-11-04 13:02:01 +01:00
dist Add TLS v1.3 support (#11603) 2019-08-30 07:42:50 +02:00
lib Add `tootctl media lookup` command (#12283) 2019-11-04 12:55:20 +01:00
log
nanobox Resync Nanobox files with the 2.9.0 release (#11083) 2019-06-14 14:52:31 +02:00
public Updated Twemoji to 12.1.3 (#12342) 2019-11-11 00:04:24 +02:00
spec Fix various issues with account migration (#12301) 2019-11-07 09:05:07 +02:00
streaming Add whitelist mode (#11291) 2019-07-30 11:10:46 +02:00
vendor
.buildpacks
.codeclimate.yml Replace from scss-lint to sass-lint (#10958) 2019-06-04 17:23:18 +02:00
.dockerignore
.editorconfig
.env.nanobox Various updates for Nanobox deploys (#11988) 2019-10-02 00:25:25 +02:00
.env.production.sample Remove quotes in `LDAP_SEARCH_FILTER` example (#12019) 2019-10-01 19:18:50 +02:00
.env.test
.env.vagrant fix vagrant connection error (#12180) 2019-10-24 22:47:24 +02:00
.eslintignore
.eslintrc.js
.foreman
.gitattributes
.gitignore Update .gitignore (#12287) 2019-11-04 12:54:08 +01:00
.haml-lint.yml
.nanoignore
.nvmrc
.profile
.rspec
.rubocop.yml require rubocop-rails in .rubocop.yml (#10974) 2019-06-06 12:31:48 +02:00
.ruby-version Use Ruby 2.6.5 (#12049) 2019-10-02 04:54:32 +02:00
.sass-lint.yml Fix sass-lint config (#10982) 2019-06-06 18:51:46 +02:00
.slugignore
.yarnclean Replace from scss-lint to sass-lint (#10958) 2019-06-04 17:23:18 +02:00
AUTHORS.md Update AUTHORS.md (#12096) 2019-10-07 04:36:32 +02:00
Aptfile
CHANGELOG.md Update changelog for 3.0.1 (#12139) 2019-10-10 07:03:05 +02:00
CODE_OF_CONDUCT.md
CONTRIBUTING.md Fix crowdin badge display in CONTRIBUTING.md (#12273) 2019-11-04 13:01:37 +01:00
Capfile
Dockerfile Dockerfile: put back EXPOSE directive (#12279) 2019-11-04 12:56:21 +01:00
Gemfile Bump parallel from 1.17.0 to 1.18.0 (#12358) 2019-11-11 22:43:43 +09:00
Gemfile.lock Bump parallel from 1.17.0 to 1.18.0 (#12358) 2019-11-11 22:43:43 +09:00
LICENSE
Procfile Bind servers to 0.0.0.0 in Procfile (#11378) 2019-07-22 06:16:30 +02:00
Procfile.dev
README.md Edit introduction of README.md (#12372) 2019-11-13 13:54:47 +01:00
Rakefile
Vagrantfile
app.json Remove deprecated config from Heroku and Scalingo (#11925) 2019-09-23 12:11:59 +02:00
babel.config.js Fix tesseract.js being part of the common chunk (#11571) 2019-08-15 17:24:45 +02:00
boxfile.yml Various updates for Nanobox deploys (#11988) 2019-10-02 00:25:25 +02:00
config.ru
crowdin.yml Update Crowdin configuration file 2019-09-14 11:40:13 +02:00
docker-compose.yml Add healthcheck endpoint for web (#11770) 2019-09-07 02:47:51 +02:00
package.json Bump @babel/core from 7.4.5 to 7.7.2 (#12350) 2019-11-12 00:25:34 +09:00
postcss.config.js
priv-config
scalingo.json Remove deprecated config from Heroku and Scalingo (#11925) 2019-09-23 12:11:59 +02:00
yarn.lock Bump @babel/core from 7.4.5 to 7.7.2 (#12350) 2019-11-12 00:25:34 +09:00

README.md

Mastodon

GitHub release Build Status 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

See the 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 are looped - like vines!

Safety and moderation tools

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, resulting 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
  • Ruby 2.4+
  • Node.js 8+

The repository includes deployment configurations for Docker and docker-compose, but also a few specific platforms like Heroku, Scalingo, and Nanobox. The stand-alone installation guide is available in the documentation.

A Vagrant configuration is included for development purposes.

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 Weblate. 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.freenode.net

License

Copyright (C) 2016-2019 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/.