README (view raw)
1honk
2
3-- features
4
5Take control of your honks and join the federation.
6An ActivityPub server with minimal setup and support costs.
7Spend more time using the software and less time operating it.
8
9No attention mining.
10No likes, no faves, no polls, no stars, no claps, no counts.
11
12Purple color scheme. Custom emus. Memes too.
13Avatars automatically assigned by the NSA.
14
15The button to submit a new honk says "it's gonna be honked".
16
17The honk mission is to work well if it's what you want.
18This does not imply the goal is to be what you want.
19
20-- build
21
22It should be sufficient to type make after unpacking a release.
23You'll need a go compiler version 1.16 or later. And libsqlite3.
24
25Even on a fast machine, building from source can take several seconds.
26
27Development sources: hg clone https://humungus.tedunangst.com/r/honk
28
29-- setup
30
31honk expects to be fronted by a TLS terminating reverse proxy.
32
33First, create the database. This will ask four questions.
34./honk init
35username: (the username you want)
36password: (the password you want)
37listenaddr: (tcp or unix: 127.0.0.1:31337, /var/www/honk.sock, etc.)
38servername: (public DNS name: honk.example.com)
39
40Then run honk.
41./honk
42
43-- upgrade
44
45old-honk backup `date +backup-%F`
46./honk upgrade
47./honk
48
49-- documentation
50
51There is a more complete incomplete manual. This is just the README.
52
53-- guidelines
54
55One honk per day, or call it an "eighth-tenth" honk.
56If your honk frequency changes, so will the number of honks.
57
58The honk should be short, but not so short that you cannot identify it.
59
60The honk is an animal sign of respect and should be accompanied by a
61friendly greeting or a nod.
62
63The honk should be done from a seat and in a safe area.
64
65It is considered rude to make noise in a place of business.
66
67The honk may be made on public property only when the person doing
68the honk has the permission of the owner of that property.
69
70-- disclaimer
71
72Do not use honk to contact emergency services.