Federated social network node, running on kosmos.social https://kosmos.social
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.
 
 
 
 
 
Eugen Rochko 42dcb0d4cb Adding Sidekiq for background processing (firstly just of mailers) 7 years ago
app Fix subscriptions:clear task, refactor feeds, refactor streamable activites 7 years ago
bin Adding config for puma, dashboard layout, fixing some queries 7 years ago
config Adding Sidekiq for background processing (firstly just of mailers) 7 years ago
db Only re-download avatar if URL changed (fix #19) 7 years ago
lib Fix subscriptions:clear task, refactor feeds, refactor streamable activites 7 years ago
log Initial commit 7 years ago
public Adding favicon 7 years ago
spec Fix subscriptions:clear task, refactor feeds, refactor streamable activites 7 years ago
vendor/assets Initial commit 7 years ago
.dockerignore Respect "delete" verb on remote feeds 7 years ago
.env.production.sample Fixing the docker container setup (with assets compilation &co) 7 years ago
.gitignore Ignore future .env files - those should not be committed to VC! Nor be part of docker containers 7 years ago
.rspec Adding a Mention model, test stubs 7 years ago
.ruby-version Initial commit 7 years ago
.travis.yml Increase note truncation length on account grids, improve FanOutOnWrite a bit, 7 years ago
Dockerfile Fixing the docker container setup (with assets compilation &co) 7 years ago
Gemfile Adding Sidekiq for background processing (firstly just of mailers) 7 years ago
Gemfile.lock Adding Sidekiq for background processing (firstly just of mailers) 7 years ago
LICENSE Adding GNU Public license, adding home timeline, reblog/favourite counters 7 years ago
README.md Linking badges 7 years ago
Rakefile Initial commit 7 years ago
config.ru Initial commit 7 years ago
docker-compose.yml Adding Sidekiq for background processing (firstly just of mailers) 7 years ago

README.md

Mastodon

Build Status Code Climate

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

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

Consult the example configuration file, .env.production.sample for the full list.

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 -d

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

docker-compose run web rake db:migrate

And since the instance running in the container will be running in production mode, you need to pre-compile assets:

docker-compose run web rake assets:precompile

The container has two volumes, for the assets and for user uploads. 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.

Updating

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

git pull

To pull down the updates, re-run

docker-compose build

And finally,

docker-compose up -d

Which will re-create the updated containers, leaving databases and data as is. Depending on what files have been updated, you might need to re-run migrations and asset compilation.