Mercurial > silorider
annotate README.rst @ 16:025e6a5bb5a3
Added tag 0.2.0 for changeset cb1dc5c864d8
| author | Ludovic Chabant <ludovic@chabant.com> |
|---|---|
| date | Mon, 30 Jul 2018 00:00:30 -0700 |
| parents | cb1dc5c864d8 |
| children | 678278cb85b1 |
| 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 | |
|
15
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
30 SiloRider will need to read a configuration file in `INI`_ format. The minimum |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
31 requirement is to define at least one "silo" using a ``silo:<name>`` section, |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
32 and to specify the url to one of your personal websites:: |
| 0 | 33 |
| 34 [silo:my_mastodon] | |
| 35 type: mastodon | |
| 36 url: https://mastodon.social | |
| 37 | |
|
15
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
38 [urls] |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
39 my_blog: https://your.website.com |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
40 |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
41 This defines one Mastodon silo to which you want to cross-post entries from |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
42 your blog at ``your.website.com``. |
| 0 | 43 |
| 44 You can then run:: | |
| 45 | |
| 46 silorider auth my_mastodon | |
| 47 | |
|
15
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
48 This command will authenticate your Mastodon account and provide SiloRider with |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
49 the permission to post to your timeline. The authorization tokens are stored in |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
50 a cache file that defaults to ``silorider.db``, next to the configuration file. |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
51 Later, this cache will also contain the list of entries already posted to each |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
52 silo. |
| 0 | 53 |
| 54 Once authenticated, you can run:: | |
| 55 | |
|
15
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
56 silorider populate |
| 0 | 57 |
|
15
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
58 This will populate the cache with the existing entries, since you probably |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
59 don't want the first run of SiloRider to cross-post your last dozen or so |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
60 entries in one go. |
| 0 | 61 |
| 62 Later, when you post something new, you can then run:: | |
| 63 | |
|
15
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
64 silorider process |
| 0 | 65 |
|
15
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
66 This will pick up the new entries and post them to Mastodon. You can run this |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
67 command again regularly... if there's something new, SiloRider will cross-post |
|
cb1dc5c864d8
Specify URLs in the config file instead of in the CLI.
Ludovic Chabant <ludovic@chabant.com>
parents:
6
diff
changeset
|
68 it to the configured silos. If not, it will just exit. |
| 0 | 69 |
| 70 | |
| 71 .. _POSSE: https://indieweb.org/POSSE | |
| 72 .. _Microformats: http://microformats.org/ | |
| 73 .. _Mastodon: https://joinmastodon.org/ | |
|
6
6dc64a419a71
Add Twitter to list of support silos.
Ludovic Chabant <ludovic@chabant.com>
parents:
0
diff
changeset
|
74 .. _Twitter: https://twitter.com/ |
| 0 | 75 .. _INI: https://en.wikipedia.org/wiki/INI_file |
| 76 |