cybrespace
/
mastodon
4
3
Fork 3
Code Issues 7 Pull Requests Releases Activity
The Cybre.Space fork of Mastodon -- https://github.com/tootsuite/mastodon https://cybre.space
72 Commits 26 Branches 0 Tags 93 MiB
Ruby 55.5%
JavaScript 27.8%
SCSS 10.1%
Haml 6.1%
HTML 0.3%
Other 0.1%
Go to file
Eugen Rochko 94eb142ab8 Updating Travis CI file to setup the test environment correctly 2016-03-18 23:31:07 +01:00
app Fix typo on /api/accounts/:id/statuses, fix potential case-sensitivity issue 2016-03-18 23:23:19 +01:00
bin Adding config for puma, dashboard layout, fixing some queries 2016-03-12 16:21:53 +01:00
config Access tokens no longer expire, case-insensitive local username validation, as well as case-insensitive Webfinger look-up 2016-03-16 18:29:52 +01:00
db Adding CSS for form errors, adding missing indices 2016-03-16 11:46:25 +01:00
lib Fix #2, add rake task for PuSH-unsubscribing from remote users who have no 2016-03-17 12:02:45 +01:00
log
…
public Adding favicon 2016-03-18 12:36:57 +01:00
spec Bind oauth applications to users 2016-03-14 17:49:13 +01:00
vendor/assets
…
.dockerignore Respect "delete" verb on remote feeds 2016-03-16 10:46:15 +01:00
.env.production.sample Fixing the docker container setup (with assets compilation &co) 2016-03-16 12:57:01 +01:00
.gitignore Ignore future .env files - those should not be committed to VC! Nor be part of docker containers 2016-03-14 21:44:30 +01:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.ruby-version
…
.travis.yml Updating Travis CI file to setup the test environment correctly 2016-03-18 23:31:07 +01:00
Dockerfile Fixing the docker container setup (with assets compilation &co) 2016-03-16 12:57:01 +01:00
Gemfile Adding simple_form, adding profile settings, header image 2016-03-12 20:47:22 +01:00
Gemfile.lock Adding simple_form, adding profile settings, header image 2016-03-12 20:47:22 +01:00
LICENSE Adding GNU Public license, adding home timeline, reblog/favourite counters 2016-03-06 17:52:23 +01:00
README.md Fix typo on /api/accounts/:id/statuses, fix potential case-sensitivity issue 2016-03-18 23:23:19 +01:00
Rakefile
…
config.ru
…
docker-compose.yml Fixing the docker container setup (with assets compilation &co) 2016-03-16 12:57:01 +01:00

README.md

Mastodon

Build Status

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

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.