1
  2Instructions for running of the honk.
  3
  4-- posting
  5
  6Should work as expected.
  7
  8Limited markdown support:
  9	**bold** and *italics*
 10	`code` and ```code block```
 11	> quote
 12
 13Large images are rescaled and reduced.
 14
 15-- following
 16
 17In order to follow somebody, you need to enter one of two identifiers.
 18
 19The easiest is probably their handle, the thing that resembles an email.
 20@name@example.com for example.
 21
 22Alternatively, one may directly enter the actor ID, which is a URL that looks
 23like https://example.com/users/name.
 24
 25Followed honkers may be assigned to combos, listing all their honks together.
 26
 27Followed honkers will appear on the main feedtube unless silenced. Honkers may
 28be silenced by adding them to a combo named "-". (One dash.)
 29
 30Selecting just peeping won't actually follow them. (Incomplete feature.)
 31Can be useful for managing as part of a combo, however.
 32
 33-- zonking
 34
 35You can zonk anything you like (or dislike), either your own honk or
 36those of others that you're tired of seeing. Be advised that deletion
 37works poorly in a federated environment. It's more like please disregard.
 38
 39The zonkzone supports muting unwanted contacts. One may mute an actor
 40(zonker), a domain (zurl), thread (zonvoy), or word (zword).
 41
 42-- privacy
 43
 44Posted honks are public. Welcome to the internet.
 45
 46Received messages are only visible when logged in, regardless of addressing.
 47Content from outside is not publicly rehosted, unless bonked.
 48
 49Received messages that are less than public are tagged with a red border.
 50As a special exception to the public honking rule, replies to limited messages
 51will be restricted as much as possible. Note that ActivityPub leaks. Do
 52not use honk for posting truly private information.
 53
 54-- css
 55
 56Custom CSS may be provided by creating a views/local.css file.
 57
 58-- message
 59
 60A custom server message may be set adding a ('servermsg', 'message') entry to
 61the config table using sqlite3.
 62
 63-- emus
 64
 65Custom emus may be provided by creating and populating the emus directory.
 66emus may be referenced when composing a honk via colon wrapping. How pleasant.
 67This :example: will be replaced by emus/example.png.
 68
 69-- memes
 70
 71To save disk space and avoid repeated uploads, the memes directory may be
 72prepopulated with bandwidth wasting reactions and referenced by meme: filename.
 73Example: "Woah. meme: woahface.mp4"
 74
 75-- hoots
 76
 77Link and inline a hoot from that other bird site.
 78hoot: https://twitter.com/tedunangst/status/839169710675611658
 79
 80-- cleanup
 81
 82One should occasionally run `honk cleanup` to free up internal space in the
 83database. This deletes honks older than 30 days, but not those posted by a
 84user.
 85
 86One may also run `honk reduce [honker]` to delete honks older than 3 days.
 87This is useful to reduce the space requirements from following image bots.
 88
 89(Neither command runs vacuum, so the file size will not immediately shrink.)
 90
 91-- add user
 92
 93Running `honk adduser` can add additional users. This is discouraged.
 94
 95-- proxy
 96
 97honk requires a TLS terminating reverse proxy be configured. It communicates
 98with other servers via https URLs.
 99
100If the proxy is configured to support caching, be mindful of the fact that
101ActivityPub requests vary based on the Accept and Content-Type headers.
102
103ActivityPub in practice uses HTTP signatures to verify requests. In order for
104this to work, the backend server must receive certain header fields
105unmodified. In particular, the Host header and the message content cannot be
106altered.
107
108Specifically, for nginx: `proxy_set_header Host $http_host;`