Go to file
Eugen Rochko ab6696e855 Adding doorkeeper, adding a REST API
POST /api/statuses                  Params: status (text contents), in_reply_to_id (optional)
GET  /api/statuses/:id
POST /api/statuses/:id/reblog

GET  /api/accounts/:id
GET  /api/accounts/:id/following
GET  /api/accounts/:id/followers
POST /api/accounts/:id/follow
POST /api/accounts/:id/unfollow

POST /api/follows                  Params: uri (e.g. user@domain)

OAuth authentication is currently disabled, but the API can be used with HTTP Auth.
2016-03-07 12:42:33 +01:00
app Adding doorkeeper, adding a REST API 2016-03-07 12:42:33 +01:00
bin Initial commit 2016-02-20 22:53:20 +01:00
config Adding doorkeeper, adding a REST API 2016-03-07 12:42:33 +01:00
db Adding doorkeeper, adding a REST API 2016-03-07 12:42:33 +01:00
lib Initial commit 2016-02-20 22:53:20 +01:00
log Initial commit 2016-02-20 22:53:20 +01:00
public Initial commit 2016-02-20 22:53:20 +01:00
spec Adding doorkeeper, adding a REST API 2016-03-07 12:42:33 +01:00
vendor/assets Initial commit 2016-02-20 22:53:20 +01:00
.gitignore Adding avatars to profile page and statuses 2016-02-28 00:51:05 +01:00
.rspec Adding a Mention model, test stubs 2016-02-25 00:17:01 +01:00
.ruby-version Initial commit 2016-02-20 22:53:20 +01:00
Gemfile Adding doorkeeper, adding a REST API 2016-03-07 12:42:33 +01:00
Gemfile.lock Adding doorkeeper, adding a REST API 2016-03-07 12:42:33 +01:00
LICENSE Adding GNU Public license, adding home timeline, reblog/favourite counters 2016-03-06 17:52:23 +01:00
README.md Adding GNU Public license, adding home timeline, reblog/favourite counters 2016-03-06 17:52:23 +01:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00
config.ru Initial commit 2016-02-20 22:53:20 +01:00

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

Missing:

  • Media attachments (photos, videos)
  • Home timeline, notifications timeline
  • UI to post, reblog, favourite, follow and unfollow
  • 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