1
 2Instructions for running of the honk.
 3
 4-- posting
 5
 6Should work as expected. Supports **bold** and *italics*.
 7
 8Large images are rescaled and reduced.
 9
10-- following
11
12In order to follow somebody, you need to enter one of two identifiers.
13
14The easiest is probably their handle, the thing that resembles an email.
15@name@example.com for example.
16
17Alternatively, one may directly enter the actor ID, which is a URL that looks
18like https://example.com/users/name. Note that the commonly seen URL with
19@name in it is not their actor ID and won't work.
20
21Followed honkers may be assigned to combos, listing all their honks together.
22
23Selecting just peeping won't actually follow them. (Incomplete feature.)
24Cant be useful for managing as part of a combo, however.
25
26-- zonking
27
28You can zonk anything you like (or dislike), either your own honk or
29those of others that you're tired of seeing. Be advised that deletion
30works poorly in a federated environment. It's more like please disregard.
31
32The killzone supports blocking unwanted contacts. One may block an actor
33(zonker), a domain (zurl), or thread (zonvoy).
34
35-- privacy
36
37Honks are public. Welcome to the internet.
38
39Received messages are only visible when logged in, regardless of addressing.
40
41Received messages that are less than public are tagged with a red border.
42
43-- css
44
45Custom CSS may be provided by creating a views/local.css file.
46
47-- message
48
49A custom server message may be set adding a ('servermsg', 'message') entry to
50the config table using sqlite3.
51
52-- emus
53
54Custom emus may be provided by creating and populating the emus directory.
55emus may be referenced when composing a honk via colon wrapping. How pleasant.
56This :example: will be replaced by emus/example.png.
57
58-- proxy
59
60honk requires a TLS terminating reverse proxy be configured. It communicates
61with other servers via https URLs.
62
63If the proxy is configured to support caching, be mindful of the fact that
64ActivityPub requests vary based on the Accept and Content-Type headers.
65
66ActivityPub in practice uses HTTP signatures to verify requests. In order for
67this to work, the backend server must receive certain header fields
68unmodified. In particular, the Host header and the message content cannot be
69altered.
70
71Specifically, for nginx: proxy_set_header Host $http_host;