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