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
 27Selecting just peeping won't actually follow them. (Incomplete feature.)
 28Can be useful for managing as part of a combo, however.
 29
 30-- zonking
 31
 32You can zonk anything you like (or dislike), either your own honk or
 33those of others that you're tired of seeing. Be advised that deletion
 34works poorly in a federated environment. It's more like please disregard.
 35
 36The zonkzone supports muting unwanted contacts. One may mute an actor
 37(zonker), a domain (zurl), thread (zonvoy), or word (zword).
 38
 39-- privacy
 40
 41Posted honks are public. Welcome to the internet.
 42
 43Received messages are only visible when logged in, regardless of addressing.
 44Content from outside is not publicly rehosted, unless bonked.
 45
 46Received messages that are less than public are tagged with a red border.
 47As a special exception to the public honking rule, replies to limited messages
 48will be restricted as much as possible. Note that ActivityPub leaks. Do
 49not use honk for posting truly private information.
 50
 51-- css
 52
 53Custom CSS may be provided by creating a views/local.css file.
 54
 55-- message
 56
 57A custom server message may be set adding a ('servermsg', 'message') entry to
 58the config table using sqlite3.
 59
 60-- emus
 61
 62Custom emus may be provided by creating and populating the emus directory.
 63emus may be referenced when composing a honk via colon wrapping. How pleasant.
 64This :example: will be replaced by emus/example.png.
 65
 66-- memes
 67
 68To save disk space and avoid repeated uploads, the memes directory may be
 69prepopulated with bandwidth wasting reactions and referenced by meme: filename.
 70Example: "Woah. meme: woahface.mp4"
 71
 72-- hoots
 73
 74Link and inline a hoot from that other bird site.
 75hoot: https://twitter.com/tedunangst/status/839169710675611658
 76
 77-- cleanup
 78
 79One should occasionally run `honk cleanup` to free up internal space in the
 80database. (This does not run vacuum, so the file size will not immediately
 81shrink.)
 82
 83-- add user
 84
 85Running `honk adduser` can add additional users. This is discouraged.
 86
 87-- proxy
 88
 89honk requires a TLS terminating reverse proxy be configured. It communicates
 90with other servers via https URLs.
 91
 92If the proxy is configured to support caching, be mindful of the fact that
 93ActivityPub requests vary based on the Accept and Content-Type headers.
 94
 95ActivityPub in practice uses HTTP signatures to verify requests. In order for
 96this to work, the backend server must receive certain header fields
 97unmodified. In particular, the Host header and the message content cannot be
 98altered.
 99
100Specifically, for nginx: proxy_set_header Host $http_host;