1
 2Honk administration guide.
 3
 4This is the admin manual. Please refer to manual.txt for user documentation.
 5
 6-- css
 7
 8Custom CSS may be provided by creating a views/local.css file.
 9
10-- message
11
12A custom server message may be set adding a ('servermsg', 'message') entry to
13the config table using sqlite3.
14
15-- emus and memes
16
17Custom emus may be provided by creating and populating the emus directory.
18emus may be referenced when composing a honk via colon wrapping. How pleasant.
19This :example: will be replaced by emus/example.png.
20
21To save disk space and avoid repeated uploads, the memes directory may be
22prepopulated with bandwidth wasting reactions and referenced by meme: filename.
23
24A list of available emus and memes appears in the funzone.
25
26-- cleanup
27
28One should occasionally run `honk cleanup` to free up internal space in the
29database. This deletes honks older than 30 days, but not those posted by a
30user. `honk cleanup [days]` may be used to adjust the timeframe.
31
32One may also run `honk cleanup [honker]` to delete honks older than 3 days.
33This is useful to reduce the space requirements from following image bots.
34
35(Neither command runs vacuum, so the file size will not immediately shrink.)
36
37-- add user
38
39Running `honk adduser` can add additional users. This is discouraged.
40
41-- proxy
42
43honk requires a TLS terminating reverse proxy be configured. It communicates
44with other servers via https URLs.
45
46If the proxy is configured to support caching, be mindful of the fact that
47ActivityPub requests vary based on the Accept and Content-Type headers.
48
49ActivityPub in practice uses HTTP signatures to verify requests. In order for
50this to work, the backend server must receive certain header fields
51unmodified. In particular, the Host header and the message content cannot be
52altered.
53
54Specifically, for nginx: `proxy_set_header Host $http_host;`