Your self-hosted, globally interconnected microblogging community
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Eugen Rochko 5c99e304e5 Deleting statuses, deletion propagation 10 years ago
app Deleting statuses, deletion propagation 10 years ago
bin Adding config for puma, dashboard layout, fixing some queries 10 years ago
config Adding a docker-compose template for running Mastodon easily 10 years ago
db Bind oauth applications to users 10 years ago
lib Adding simple_form, adding profile settings, header image 10 years ago
log Initial commit 10 years ago
public Initial commit 10 years ago
spec Bind oauth applications to users 10 years ago
vendor/assets Initial commit 10 years ago
.dockerignore Respect "delete" verb on remote feeds 10 years ago
.env.production.sample Adding a docker-compose template for running Mastodon easily 10 years ago
.gitignore Ignore future .env files - those should not be committed to VC! Nor be part of docker containers 10 years ago
.rspec Adding a Mention model, test stubs 10 years ago
.ruby-version Initial commit 10 years ago
Dockerfile Adding a docker-compose template for running Mastodon easily 10 years ago
Gemfile Adding simple_form, adding profile settings, header image 10 years ago
Gemfile.lock Adding simple_form, adding profile settings, header image 10 years ago
LICENSE Adding GNU Public license, adding home timeline, reblog/favourite counters 10 years ago
README.md Deleting statuses, deletion propagation 10 years ago
Rakefile Initial commit 10 years ago
config.ru Initial commit 10 years ago
docker-compose.yml Adding a docker-compose template for running Mastodon easily 10 years ago

README.md

Mastodon

Mastodon is a federated microblogging engine. An alternative implementation of the GNU Social project. Based on ActivityStreams, Webfinger, PubsubHubbub and Salmon.

Current status of the project is early development. Documentation &co will be added later

Status

  • GNU Social users can follow Mastodon users
  • Mastodon users can follow GNU Social users
  • Retweets, favourites, mentions, replies work in both directions
  • Public pages for profiles and single statuses
  • Sign up, login, forgotten passwords and changing password
  • Mentions and URLs converted to links in statuses
  • REST API, including home and mention timelines
  • OAuth2 provider system for the API
  • Upload header image for profile page
  • Deleting statuses, deletion propagation

Missing:

  • Media attachments (photos, videos)
  • UI to post, reblog, favourite, follow and unfollow
  • Streaming API

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
  • HUB_URL should be the URL of the PubsubHubbub service that your instance is going to use. By default it is the open service of Superfeedr

Requirements

  • PostgreSQL
  • Redis

Running with Docker and Docker-Compose

The project now includes a Dockerfile and a docker-compose.yml. You need to turn .env.production sample into .env.production with all the variables set before you can:

docker-compose build

And finally

docker-compose up

As usual, the first thing you would need to do would be to run migrations:

docker-compose run web rake db:migrate