You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Kegan Myers d935b26307 Bind to unix socket 2 years ago
app Make the columns wider 2 years ago
bin Add binstub for rspec from rspec-core (#1913) 2 years ago
config Bind to unix socket 2 years ago
db Add language detection (#1772) 2 years ago
docs Fix redirect link on Tuning.md (#1595) 2 years ago
lib Fix bug mentioned in #1565 (#1954) 2 years ago
log Initial commit 3 years ago
public Improve emojis - use SVGs where possible 2 years ago
spec Make file attachment on MediaAttachment optional (#1865) 2 years ago
storybook Fix up storybook 2 years ago
streaming Dev Tooling fixes (eslint/editorconfig) (#1398) 2 years ago
vendor/assets Initial commit 3 years ago
.babelrc Debounce autosuggestions requests 2 years ago
.buildpacks Install nodejs before ruby 2 years ago
.codeclimate.yml Disable CodeClimate duplication checks (#1943) 2 years ago
.dockerignore Add eslint-plugin-jsx-a11y (#1651) 2 years ago
.editorconfig Dev Tooling fixes (eslint/editorconfig) (#1398) 2 years ago
.env.production.sample Add REDIS_DB env variable to configure Redis database (#1366) 2 years ago
.env.test Add recovery code support for two-factor auth (#1773) 2 years ago
.env.vagrant Add a default LOCAL_DOMAIN=mastodon.dev to .env.vagrant 2 years ago
.eslintignore Dev Tooling fixes (eslint/editorconfig) (#1398) 2 years ago
.eslintrc Add eslint-plugin-jsx-a11y (#1651) 2 years ago
.gitignore Add eslint-plugin-jsx-a11y (#1651) 2 years ago
.nvmrc update Node to 6.x LTS (#1228) 2 years ago
.rspec Adding a Mention model, test stubs 3 years ago
.rubocop.yml Fix tests, add applications to eager loading/cache for statuses, fix 2 years ago
.ruby-version Version bumps for ruby and misc gems (#1159) 2 years ago
.slugignore Updates slugignore. 2 years ago
.travis.yml I18n health warnings (#1949) 2 years ago
CONTRIBUTING.md Request documentation (#1616) 2 years ago
Capfile Speed up capistrano deployments 2 years ago
Dockerfile Update node.js and imagemagick (#1951) 2 years ago
Gemfile Allow uploading of files to google cloud storage. (dirty, but working) 2 years ago
Gemfile.lock Allow uploading of files to google cloud storage. (dirty, but working) 2 years ago
ISSUE_TEMPLATE.md Adds note for instance admins. (#1925) 2 years ago
LICENSE Fix #49 - License changed from GPL-2.0 to AGPL-3.0 3 years ago
Procfile Force UTF8 encoding on generated XML (#1140) 2 years ago
README.md Add README note about tagged releases (#1927) 2 years ago
Rakefile Initial commit 3 years ago
Vagrantfile Remove current directory from PATH (#1779) 2 years ago
app.json More SMTP customization (#1372) 2 years ago
config.ru Fix rubocop issues, introduce usage of frozen literal to improve performance 2 years ago
docker-compose.yml Use image too in docker-compose (#1109) 2 years ago
package.json Add the licence key in package.json (#1914) 2 years ago
scalingo.json More SMTP customization (#1372) 2 years ago
yarn.lock Add eslint-plugin-jsx-a11y (#1651) 2 years ago

README.md

Mastodon

Build Status Code Climate

Mastodon is a free, open-source social network server. A decentralized solution to commercial platforms, it avoids the risks of a single company monopolizing your communication. Anyone can run Mastodon and participate in the social network seamlessly.

An alternative implementation of the GNU social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

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

Screenshot

The project focus is a clean REST API and a good user interface. 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. Alternatively, you can donate to this BTC address: 17j2g7vpgHhLuXhN4bueZFCvdxxieyRVWd

Resources

Features

  • Fully interoperable with GNU social and any OStatus platform Whatever implements Atom feeds, ActivityStreams, Salmon, PubSubHubbub and Webfinger is part of the network
  • Real-time timeline updates See the updates of people you’re following appear in real-time in the UI via WebSockets
  • 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 WebM Upload and view images and WebM videos attached to the updates
  • OAuth2 and a straightforward REST API Mastodon acts as an OAuth2 provider so 3rd party apps can use the API, which is RESTful and simple
  • Background processing for long-running tasks Mastodon tries to be as fast and responsive as possible, so all long-running tasks that can be delegated to background processing, are
  • 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

Checking out

If you want a stable release for production use, you should use tagged releases. To checkout the latest available tagged version:

git clone https://github.com/tootsuite/mastodon.git
cd mastodon
git checkout $(git describe --tags `git rev-list --tags --max-count=1`)

Configuration

  • LOCAL_DOMAIN should be the domain/hostname of your instance. This is absolutely required as it is used for generating unique IDs for everything federation-related
  • LOCAL_HTTPS set it to true if HTTPS works on your website. This is used to generate canonical URLs, which is also important when generating and parsing federation-related IDs

Consult the example configuration file, .env.production.sample for the full list. Among other things you need to set details for the SMTP server you are going to use.

Requirements

  • Ruby
  • Node.js
  • PostgreSQL
  • Redis
  • Nginx

Running with Docker and Docker-Compose

The project now includes a Dockerfile and a docker-compose.yml file (which requires at least docker-compose version 1.10.0).

Review the settings in docker-compose.yml. Note that it is not default to store the postgresql database and redis databases in a persistent storage location, so you may need or want to adjust the settings there.

Then, you need to fill in the .env.production file:

cp .env.production.sample .env.production
nano .env.production

Do NOT change the REDIS_* or DB_* settings when running with the default docker configurations.

You will need to fill in, at least: LOCAL_DOMAIN, LOCAL_HTTPS, PAPERCLIP_SECRET, SECRET_KEY_BASE, OTP_SECRET, and the SMTP_* settings. To generate the PAPERCLIP_SECRET, SECRET_KEY_BASE, and OTP_SECRET, you may use:

Before running the first time, you need to build the images:

docker-compose build


docker-compose run --rm web rake secret

Do this once for each of those keys, and copy the result into the .env.production file in the appropriate field.

Then you should run the db:migrate command to create the database, or migrate it from an older release:

docker-compose run --rm web rails db:migrate

Then, you will also need to precompile the assets:

docker-compose run --rm web rails assets:precompile

before you can launch the docker image with:

docker-compose up

If you wish to run this as a daemon process instead of monitoring it on console, use instead:

docker-compose up -d

Then you may login to your new Mastodon instance by browsing to http://localhost:3000/

Following that, make sure that you read the production guide. You are probably going to want to understand how to configure Nginx to make your Mastodon instance available to the rest of the world.

The container has two volumes, for the assets and for user uploads, and optionally two more, for the postgresql and redis databases.

The default docker-compose.yml maps them to the repository’s public/assets and public/system directories, you may wish to put them somewhere else. Likewise, the PostgreSQL and Redis images have data containers that you may wish to map somewhere where you know how to find them and back them up.

Note: The --rm option for docker-compose will remove the container that is created to run a one-off command after it completes. As data is stored in volumes it is not affected by that container clean-up.

Tasks

  • rake mastodon:media:clear removes uploads that have not been attached to any status after a while, you would want to run this from a periodic cronjob
  • rake mastodon:push:clear unsubscribes from PuSH notifications for remote users that have no local followers. You may not want to actually do that, to keep a fuller footprint of the fediverse or in case your users will soon re-follow
  • rake mastodon:push:refresh re-subscribes PuSH for expiring remote users, this should be run periodically from a cronjob and quite often as the expiration time depends on the particular hub of the remote user
  • rake mastodon:feeds:clear_all removes all timelines, which forces them to be re-built on the fly next time a user tries to fetch their home/mentions timeline. Only for troubleshooting
  • rake mastodon:feeds:clear removes timelines of users who haven’t signed in lately, which allows to save RAM and improve message distribution. This is required to be run periodically so that when they login again the regeneration process will trigger

Running any of these tasks via docker-compose would look like this:

docker-compose run --rm web rake mastodon:media:clear

Updating

This approach makes updating to the latest version a real breeze.

  1. git pull to download updates from the repository
  2. docker-compose build to compile the Docker image out of the changed source files
  3. (optional) docker-compose run --rm web rails db:migrate to perform database migrations. Does nothing if your database is up to date
  4. (optional) docker-compose run --rm web rails assets:precompile to compile new JS and CSS assets
  5. docker-compose up -d to re-create (restart) containers and pick up the changes

Deployment without Docker

Docker is great for quickly trying out software, but it has its drawbacks too. If you prefer to run Mastodon without using Docker, refer to the production guide for examples, configuration and instructions.

Deployment on Scalingo

Deploy on Scalingo

You can view a guide for deployment on Scalingo here.

Deployment on Heroku (experimental)

Deploy

Mastodon can run on Heroku, but it gets expensive and impractical due to how Heroku prices resource usage. You can view a guide for deployment on Heroku here, but you have been warned.

Development with Vagrant

A quick way to get a development environment up and running is with Vagrant. You will need recent versions of Vagrant and VirtualBox installed.

You can find the guide for setting up a Vagrant development environment here.

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

Extra credits

  • The Emoji One pack has been used for the emojis
  • The error page image courtesy of Dopatwo

Mastodon error image