Mercurial > silorider
annotate README.rst @ 9:8830c7d59d7e
Early return if not silos are defined.
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Sun, 29 Jul 2018 20:01:30 -0700 |
| parents | 6dc64a419a71 |
| children | cb1dc5c864d8 |
| rev | line source |
|---|---|
| 0 | 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 | |
|
6
6dc64a419a71
Add Twitter to list of support silos.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
22 - `Mastodon`_: an open, federated social network and microblogging service. |
|
6dc64a419a71
Add Twitter to list of support silos.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
23 - `Twitter`_: a proprietary social network and microblogging service. |
| 0 | 24 - Print: a debug silo that just prints entries in the console. |
| 25 | |
| 26 | |
| 27 Quickstart | |
| 28 ---------- | |
| 29 | |
| 30 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:: | |
| 31 | |
| 32 [silo:my_mastodon] | |
| 33 type: mastodon | |
| 34 url: https://mastodon.social | |
| 35 | |
| 36 This defines one Mastodon silo to which you want to post your entries. | |
| 37 | |
| 38 You can then run:: | |
| 39 | |
| 40 silorider auth my_mastodon | |
| 41 | |
| 42 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. | |
| 43 | |
| 44 Once authenticated, you can run:: | |
| 45 | |
| 46 silorider populate https://yourwebsite | |
| 47 | |
| 48 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. | |
| 49 | |
| 50 Later, when you post something new, you can then run:: | |
| 51 | |
| 52 silorider process https://yourwebsite | |
| 53 | |
| 54 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. | |
| 55 | |
| 56 | |
| 57 .. _POSSE: https://indieweb.org/POSSE | |
| 58 .. _Microformats: http://microformats.org/ | |
| 59 .. _Mastodon: https://joinmastodon.org/ | |
|
6
6dc64a419a71
Add Twitter to list of support silos.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
60 .. _Twitter: https://twitter.com/ |
| 0 | 61 .. _INI: https://en.wikipedia.org/wiki/INI_file |
| 62 |