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