all repos — honk @ 5cf50073f73383d035eb2e1f937f1a7754e9986e

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.)
24
25-- zonking
26
27You can zonk anything you like (or dislike), either your own honk or
28those of others that you're tired of seeing. This reduces its visibility, but
29doesn't attempt to delete it, which is infeasible.
30It's more like disavow.
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
41-- css
42
43Custom CSS may be provided by creating a views/local.css file.
44
45-- message
46
47A custom server message may be set adding a ('servermsg', 'message') entry to
48the config table using sqlite3.
49
50-- emus
51
52Custom emus may be provided by creating and populating the emus directory.
53emus may be referenced when composing a honk via colon wrapping. How pleasant.
54This :example: will be replaced by emus/example.png.
55
56-- proxy
57
58honk requires a TLS terminating reverse proxy be configured. It communicates
59with other servers via https URLs.
60
61If the proxy is configured to support caching, be mindful of the fact that
62ActivityPub requests vary based on the Accept and Content-Type headers.
63
64ActivityPub in practice uses HTTP signatures to verify requests. In order for
65this to work, the backend server must receive certain header fields
66unmodified. In particular, the Host header and the message content cannot be
67altered.
68
69Specifically, for nginx: proxy_set_header Host $http_host;