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