all repos — honk @ 87e955d322e60c8e66d1afc204d9ed5baabe67ec

my fork of honk

docs/manual.txt (view raw)

 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. This reduces its visibility, but
30doesn't attempt to delete it, which is infeasible.
31It's more like disavow or disregard.
32
33The killzone supports blocking unwanted contacts. One may block an actor
34(zonker), a domain (zurl), or thread (zonvoy).
35
36-- privacy
37
38Honks are public. Welcome to the internet.
39
40Received messages are only visible when logged in, regardless of addressing.
41
42Recevied messages that are less than public are tagged with a red border.
43
44-- css
45
46Custom CSS may be provided by creating a views/local.css file.
47
48-- message
49
50A custom server message may be set adding a ('servermsg', 'message') entry to
51the config table using sqlite3.
52
53-- emus
54
55Custom emus may be provided by creating and populating the emus directory.
56emus may be referenced when composing a honk via colon wrapping. How pleasant.
57This :example: will be replaced by emus/example.png.
58
59-- proxy
60
61honk requires a TLS terminating reverse proxy be configured. It communicates
62with other servers via https URLs.
63
64If the proxy is configured to support caching, be mindful of the fact that
65ActivityPub requests vary based on the Accept and Content-Type headers.
66
67ActivityPub in practice uses HTTP signatures to verify requests. In order for
68this to work, the backend server must receive certain header fields
69unmodified. In particular, the Host header and the message content cannot be
70altered.
71
72Specifically, for nginx: proxy_set_header Host $http_host;