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
12Large images are rescaled and reduced.
13
14-- following
15
16In order to follow somebody, you need to enter one of two identifiers.
17
18The easiest is probably their handle, the thing that resembles an email.
19@name@example.com for example.
20
21Alternatively, one may directly enter the actor ID, which is a URL that looks
22like https://example.com/users/name. Note that the commonly seen URL with
23@name in it is not their actor ID and won't work.
24
25Followed honkers may be assigned to combos, listing all their honks together.
26
27Selecting just peeping won't actually follow them. (Incomplete feature.)
28Cant 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 killzone supports muting unwanted contacts. One may mute an actor
37(zonker), a domain (zurl), or thread (zonvoy).
38
39-- privacy
40
41Honks are public. Welcome to the internet.
42
43Received messages are only visible when logged in, regardless of addressing.
44
45Received messages that are less than public are tagged with a red border.
46Replies to private messages will also be private.
47
48-- css
49
50Custom CSS may be provided by creating a views/local.css file.
51
52-- message
53
54A custom server message may be set adding a ('servermsg', 'message') entry to
55the config table using sqlite3.
56
57-- emus
58
59Custom emus may be provided by creating and populating the emus directory.
60emus may be referenced when composing a honk via colon wrapping. How pleasant.
61This :example: will be replaced by emus/example.png.
62
63-- cleanup
64
65One may occasionally run `honk cleanup` to free up internal space in the
66database. (This does not run vacuum, so the file size will not immediately
67shrink.)
68
69-- add user
70
71Running `honk adduser` can add additional users. This is discouraged.
72
73-- proxy
74
75honk requires a TLS terminating reverse proxy be configured. It communicates
76with other servers via https URLs.
77
78If the proxy is configured to support caching, be mindful of the fact that
79ActivityPub requests vary based on the Accept and Content-Type headers.
80
81ActivityPub in practice uses HTTP signatures to verify requests. In order for
82this to work, the backend server must receive certain header fields
83unmodified. In particular, the Host header and the message content cannot be
84altered.
85
86Specifically, for nginx: proxy_set_header Host $http_host;