Kezdőlap Felfedezés Súgó
Bejelentkezés
mastodon
/
documentation
tükrözi: https://github.com/tootsuite/documentation
Figyelés 2
Kedvenc 0
Másolás 0
Fájlok Problémák 0 Wiki

Full documentation repository for Mastodon

Fa: v0.1.1
Branch-ok Tag-ek
documentation
ZIP TAR.GZ
Eugen Rochko ad9011154b Fix error when unfollowing somebody who wasn't followed in the first place 9 éve
app e239fc3050 Fix error when unfollowing somebody who wasn't followed in the first place 9 éve
bin aab9f57e36 Adding config for puma, dashboard layout, fixing some queries 9 éve
config 9cb690c706 Access tokens no longer expire, case-insensitive local username validation, as well as case-insensitive Webfinger look-up 9 éve
db 8767a98fbb Adding CSS for form errors, adding missing indices 9 éve
lib 3441361568 Adding simple_form, adding profile settings, header image 9 éve
log 9c4856bdb1 Initial commit 9 éve
public 9c4856bdb1 Initial commit 9 éve
spec 6fec8afc3f Bind oauth applications to users 9 éve
vendor 9c4856bdb1 Initial commit 9 éve
.dockerignore 75b3339a99 Respect "delete" verb on remote feeds 9 éve
.env.production.sample 48d66a2055 Fixing the docker container setup (with assets compilation &co) 9 éve
.gitignore 1eb65e2acc Ignore future .env files - those should not be committed to VC! Nor be part of docker containers 9 éve
.rspec 71fe24096c Adding a Mention model, test stubs 9 éve
.ruby-version 9c4856bdb1 Initial commit 9 éve
Dockerfile 48d66a2055 Fixing the docker container setup (with assets compilation &co) 9 éve
Gemfile 3441361568 Adding simple_form, adding profile settings, header image 9 éve
Gemfile.lock 3441361568 Adding simple_form, adding profile settings, header image 9 éve
LICENSE 3824c58853 Adding GNU Public license, adding home timeline, reblog/favourite counters 9 éve
README.md 786397e15d Adjusted todo list 9 éve
Rakefile 9c4856bdb1 Initial commit 9 éve
config.ru 9c4856bdb1 Initial commit 9 éve
docker-compose.yml 48d66a2055 Fixing the docker container setup (with assets compilation &co) 9 éve

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)
  • Streaming API
  • Blocking users, blocking remote instances

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.