Mercurial > silorider

comparison README.rst @ 0:a1b7a459326a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial commit.
author Ludovic Chabant <ludovic@chabant.com>
date Wed, 18 Jul 2018 20:46:04 -0700
parents
children 6dc64a419a71
comparison
equal deleted inserted replaced
-1:000000000000 0:a1b7a459326a
1
2 SiloRider
3 =========
4
5 SiloRider is a command-line utility that lets you implement the `POSSE`_ model
6 on a website. This is how it works:
7
8 - It reads your website's main page (or whatever URL you supply) and looks for
9 `Microformats`_ markup.
10 - It reads a configuration file where you describe which "silos" (*i.e.*
11 external services) you want to post your content to.
12 - It reads a local cache file to figure out which content has already been
13 posted where, so it only posts new content.
14 - It actually posts that content to each silo.
15
16
17 Supported Silos
18 ---------------
19
20 Right now, the following silos are supported:
21
22 - `Mastodon`_: an open, federated microblogging service.
23 - Print: a debug silo that just prints entries in the console.
24
25
26 Quickstart
27 ----------
28
29 SiloRider will need to read a configuration file in `INI`_ format. The minimum requirement is to define at least one "silo" using a ``silo:<name>`` section::
30
31 [silo:my_mastodon]
32 type: mastodon
33 url: https://mastodon.social
34
35 This defines one Mastodon silo to which you want to post your entries.
36
37 You can then run::
38
39 silorider auth my_mastodon
40
41 This command will authenticate your Mastodon account and provide SiloRider with the permission to post to your timeline. The authorization tokens are stored in a cache file that defaults to ``silorider.db``, next to the configuration file. Later, this cache will also contain the list of entries already posted to each silo.
42
43 Once authenticated, you can run::
44
45 silorider populate https://yourwebsite
46
47 This will populate the cache with the existing entries, since you probably don't want the first run of SiloRider to cross-post your last dozen or so entries in one go.
48
49 Later, when you post something new, you can then run::
50
51 silorider process https://yourwebsite
52
53 This will pick up the new entries and post them to Mastodon. You can run this command again regularly... if there's something new, SiloRider will cross-post it to the configured silos. If not, it will just exit.
54
55
56 .. _POSSE: https://indieweb.org/POSSE
57 .. _Microformats: http://microformats.org/
58 .. _Mastodon: https://joinmastodon.org/
59 .. _INI: https://en.wikipedia.org/wiki/INI_file
60