Mercurial > silorider

comparison README.rst @ 15:cb1dc5c864d8 0.2.0

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Specify URLs in the config file instead of in the CLI.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 29 Jul 2018 23:59:39 -0700
parents 6dc64a419a71
children 678278cb85b1
comparison
equal deleted inserted replaced
14:c6bae5dcd8d7 15:cb1dc5c864d8
25 25
26 26
27 Quickstart 27 Quickstart
28 ---------- 28 ----------
29 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:: 30 SiloRider will need to read a configuration file in `INI`_ format. The minimum
31 requirement is to define at least one "silo" using a ``silo:<name>`` section,
32 and to specify the url to one of your personal websites::
31 33
32 [silo:my_mastodon] 34 [silo:my_mastodon]
33 type: mastodon 35 type: mastodon
34 url: https://mastodon.social 36 url: https://mastodon.social
35 37
36 This defines one Mastodon silo to which you want to post your entries. 38 [urls]
39 my_blog: https://your.website.com
40
41 This defines one Mastodon silo to which you want to cross-post entries from
42 your blog at ``your.website.com``.
37 43
38 You can then run:: 44 You can then run::
39 45
40 silorider auth my_mastodon 46 silorider auth my_mastodon
41 47
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. 48 This command will authenticate your Mastodon account and provide SiloRider with
49 the permission to post to your timeline. The authorization tokens are stored in
50 a cache file that defaults to ``silorider.db``, next to the configuration file.
51 Later, this cache will also contain the list of entries already posted to each
52 silo.
43 53
44 Once authenticated, you can run:: 54 Once authenticated, you can run::
45 55
46 silorider populate https://yourwebsite 56 silorider populate
47 57
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. 58 This will populate the cache with the existing entries, since you probably
59 don't want the first run of SiloRider to cross-post your last dozen or so
60 entries in one go.
49 61
50 Later, when you post something new, you can then run:: 62 Later, when you post something new, you can then run::
51 63
52 silorider process https://yourwebsite 64 silorider process
53 65
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. 66 This will pick up the new entries and post them to Mastodon. You can run this
67 command again regularly... if there's something new, SiloRider will cross-post
68 it to the configured silos. If not, it will just exit.
55 69
56 70
57 .. _POSSE: https://indieweb.org/POSSE 71 .. _POSSE: https://indieweb.org/POSSE
58 .. _Microformats: http://microformats.org/ 72 .. _Microformats: http://microformats.org/
59 .. _Mastodon: https://joinmastodon.org/ 73 .. _Mastodon: https://joinmastodon.org/