Your self-hosted, globally interconnected microblogging community
Go to file
TrashMacNugget 56333cca88 Add license info to README (#6583)
* Add license info to README

* Reference AUTHORS file
2018-03-11 15:12:23 +01:00
.github Move files for GitHub to .github directory (#5989) 2017-12-12 15:10:12 +01:00
app Fix #6715: Make catalan words with the L geminate letter work in hashtags (#6741) 2018-03-11 14:55:49 +01:00
bin Update dependencies for Ruby (2017-10-30) (#5566) 2017-10-31 12:22:32 +01:00
config Change avatar size on form hints (#6707) 2018-03-09 10:57:33 +01:00
db Federate pinned statuses over ActivityPub (#6610) 2018-03-04 09:19:11 +01:00
docs Fix redirect link on Tuning.md (#1595) 2017-04-12 12:40:37 +02:00
lib Bump version to 2.3.0 2018-03-09 12:59:58 +01:00
log Initial commit 2016-02-20 22:53:20 +01:00
nanobox [Nanobox] Tuning Update (#6660) 2018-03-06 21:59:35 +01:00
public add new avatar placeholder missing.png (#6728) 2018-03-11 14:55:38 +01:00
spec Fix #6657 - Use target instead of origin in Remove activity (#6664) 2018-03-07 03:54:46 +01:00
streaming Make sure call `done();` in the listener of public timeline for anonymous connection (#6009) 2017-12-13 14:27:36 +01:00
vendor/assets Initial commit 2016-02-20 22:53:20 +01:00
.babelrc 🎄🔨 Force tree shake emojione (#4202) 2017-07-14 20:30:12 +02:00
.buildpacks Add heroku APT buildpack for scalingo. (#3051) 2017-05-14 12:57:13 +02:00
.codeclimate.yml Upgrade ESLint to version 4.x (#6276) 2018-01-17 16:57:15 +01:00
.dockerignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.editorconfig Add final newline to locale files (#2890) 2017-05-07 19:55:47 +02:00
.env.nanobox [Nanobox] Tuning Update (#6660) 2018-03-06 21:59:35 +01:00
.env.production.sample Adjust suggested ES host in .env sample for docker-compose config (#6710) 2018-03-09 11:32:55 +01:00
.env.test Provide default OTP_SECRET value for development environment (#6617) 2018-03-04 20:28:24 +01:00
.env.vagrant Add a default LOCAL_DOMAIN=mastodon.dev to .env.vagrant 2017-01-26 19:22:59 +11:00
.eslintignore Dev Tooling fixes (eslint/editorconfig) (#1398) 2017-04-11 00:36:03 +02:00
.eslintrc.yml Upgrade ESLint to version 4.x (#6276) 2018-01-17 16:57:15 +01: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 Fix #5274 - Create symlink from public/500.html to public/assets/500.html (#5288) 2017-10-09 20:51:24 +02:00
.haml-lint.yml Added haml-lint and fix warnings (#2773) 2017-05-08 03:35:25 +02:00
.nanoignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.nvmrc update Node to 6.x LTS (#1228) 2017-04-15 02:05:41 +02:00
.postcssrc.yml Add object-fit polyfill for Edge (#4182) 2017-07-14 01:59:34 +02:00
.profile Add ffmpeg and dependent packages as well as LD_LIBRARY_PATHs (#3276) 2017-05-24 17:57:33 +02:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.rubocop.yml Add handling of Linked Data Signatures in payloads (#4687) 2017-08-26 13:47:38 +02:00
.ruby-version Add support Ruby v2.5.0 (#6097) 2018-01-19 20:53:30 +01:00
.scss-lint.yml Enable CodeClimate SCSS Lint checks (#2886) 2017-05-07 20:47:31 +02:00
.slugignore Remove Storybook (#4397) 2017-07-27 22:30:27 +02:00
.travis.yml Remove unnecessary g++ configuration (#6499) 2018-02-18 16:32:17 +01:00
.yarnclean Reduce container size with clean yarn (#3506) 2017-09-30 22:05:24 +02:00
AUTHORS.md docs: Add AUTHORS file (#6685) 2018-03-09 13:11:43 +01:00
Aptfile Specify libicu explicitly in Aptfile (#4920) 2017-09-13 09:30:13 +02:00
CODE_OF_CONDUCT.md Add code of conduct from GitHub generator (#5674) 2017-11-13 17:28:55 +01:00
CONTRIBUTING.md README tidy up (#2026) 2017-04-17 21:28:31 +02:00
Capfile remove capistrano/faster_assets from Capfile (#2737) 2017-05-03 12:14:52 +02:00
Dockerfile Use Alpine Linux yarn package in Docker (#6725) 2018-03-10 11:49:04 +01:00
Gemfile Always install LDAP, CAS and SAML gems, because they don't require deps (#6663) 2018-03-07 02:25:17 +01:00
Gemfile.lock Upgrade chewy to version 5.0.0 (#6649) 2018-03-06 06:14:26 +01:00
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 2016-09-21 23:04:34 +02:00
Procfile More robust PuSH subscription refreshes (#2799) 2017-05-05 02:23:01 +02:00
Procfile.dev Upgrade Webpacker to version 3.0.1 (#5122) 2017-09-27 14:41:54 +02:00
README.md Add license info to README (#6583) 2018-03-11 15:12:23 +01:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00
Vagrantfile Upgrade Vagrant box to Xenial (#6421) 2018-02-04 06:03:01 +01:00
app.json Change logo URL for Heroku and Scalingo (#4476) 2017-08-01 05:59:11 +02:00
boxfile.yml [Nanobox] Tuning Update (#6660) 2018-03-06 21:59:35 +01:00
config.ru Fix rubocop issues, introduce usage of frozen literal to improve performance 2016-11-15 16:56:29 +01:00
docker-compose.yml Separate chown command in Dockerfile. Use tootsuite/mastodon image (#6662) 2018-03-07 01:57:31 +01:00
jest.config.js Enable coverage for Jest (#5442) 2017-10-18 11:39:36 +02:00
package.json Add polyfill for Object.values (#6697) 2018-03-08 13:07:25 +01:00
scalingo.json Change logo URL for Heroku and Scalingo (#4476) 2017-08-01 05:59:11 +02:00
yarn.lock Run tests with npm-run-all (#6688) 2018-03-08 04:43:57 +01:00

README.md

Mastodon

Build Status Code Climate

Mastodon is a free, open-source social network server based on open web protocols like ActivityPub and OStatus. The social focus of the project is a viable decentralized alternative to commercial social media silos that returns the control of the content distribution channels to the people. The technical focus of the project is a good user interface, a clean REST API for 3rd party apps and robust anti-abuse tools.

Click on the screenshot below to watch a demo of the UI:

Screenshot

Ruby on Rails is used for the back-end, while React.js and Redux are used for the dynamic front-end. A static front-end for public resources (profiles and statuses) is also provided.

If you would like, you can support the development of this project on Patreon or Liberapay. Alternatively, you can donate to this BTC address: 17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd


Resources

Features

No vendor lock-in: Fully interoperable with any conforming platform

It doesn't have to be Mastodon, whatever implements ActivityPub or OStatus is part of the social network!

Real-time 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!

Federated thread resolving

If someone you follow replies to a user unknown to the server, the server fetches the full thread so you can view it without leaving the UI

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!

OAuth2 and a straightforward REST API

Mastodon acts as an OAuth2 provider so 3rd party apps can use the API

Fast response times

Mastodon tries to be as fast and responsive as possible, so all long-running tasks are delegated to background processing

Deployable via Docker

You don't need to mess with dependencies and configuration if you want to try Mastodon, if you have Docker and Docker Compose the deployment is extremely easy


Development

Please follow the development guide from the documentation repository.

Deployment

There are guides in the documentation repository for deploying on various platforms.

Contributing

You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository. Here are the guidelines for code contributions

IRC channel: #mastodon on irc.freenode.net

License

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


Extra credits

The elephant friend illustrations are created by Dopatwo