fedi/mastodon
1
0
Fork 1
mirror of https://github.com/mastodon/mastodon.git synced 2024-11-25 07:05:20 +00:00
Code Issues Packages Projects Releases Wiki Activity
Your self-hosted, globally interconnected microblogging community
33 commits 139 branches 266 tags 982 MiB
Ruby 63.5%
JavaScript 19.7%
TypeScript 7.1%
SCSS 4.8%
Haml 4.4%
Other 0.5%
Go to file
Eugen Rochko 3b4e04dc32 Fixing some bugs, adding pending test examples
2016-03-05 12:50:59 +01:00
app Fixing some bugs, adding pending test examples 2016-03-05 12:50:59 +01:00
bin Initial commit 2016-02-20 22:53:20 +01:00
config Changing the use of config constants to the Rails configuration object 2016-02-29 20:06:39 +01:00
db Adding paperclip for avatars, fixing design of the public pages 2016-02-28 00:02:59 +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 Fixing some bugs, adding pending test examples 2016-03-05 12:50:59 +01:00
test Initial commit 2016-02-20 22:53:20 +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
config.ru Initial commit 2016-02-20 22:53:20 +01:00
Gemfile Refactoring Grape API methods into normal controllers & other things 2016-02-29 19:42:08 +01:00
Gemfile.lock Refactoring Grape API methods into normal controllers & other things 2016-02-29 19:42:08 +01:00
Rakefile Initial commit 2016-02-20 22:53:20 +01:00
README.md Incoming Salmon requests can be turned into follows and unfollows 2016-02-23 22:17:07 +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.

The core ideals of this project are:

  • Independence of legacy Twitter APIs - we don't want to be compatible with Twitter clients, we want our own clients
  • In that vein, a strong and clean REST API and OAuth2
  • Minimalism. Just because you can do almost anything with ActivityStreams doesn't mean you should. Limit the set of possible functions to what makes sense in a microblogging engine. This will make federation as well as UI design a lot easier
  • Ease of deployment. The end-goal of this project is to be distributable as a Docker image.

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

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