dirk
/
honk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

tighten up the README a bit

This commit is contained in:
Ted Unangst 2019-10-15 15:57:18 -04:00
parent 725c652558
commit 50f3926678
1 changed files with 9 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README
View File

@ -3,30 +3,18 @@ honk
-- features -- features
Take control of your honks. Take control of your honks.
Join the federation in the fight against the evil empire.
Send honks. Receive honks. And not just honks. An ActivityPub server focused on minimal setup and support costs.
Bonk, donk, zonk, all your favorite activities are here. Spend more time using the software and less time operating it.
Public RSS.
Custom emus. Memes too.
Purple color scheme.
No attention mining. No attention mining.
No likes, no faves, no polls, no stars, no claps, no counts. No likes, no faves, no polls, no stars, no claps, no counts.
Purple color scheme. Custom emus. Memes too.
Avatars automatically assigned by the NSA.
The button to submit a new honk says "it's gonna be honked". The button to submit a new honk says "it's gonna be honked".
Avatars assigned by the NSA.
Automatic image attachment debloating.
Minimal setup and configuration.
Written in gotesque, an especially grotesque dialect of golang.
-- build -- build
It should be sufficient to type make after unpacking a release. It should be sufficient to type make after unpacking a release.
@ -36,39 +24,26 @@ Even on a fast machine, building from source can take several seconds.
Development sources: hg clone https://humungus.tedunangst.com/r/honk Development sources: hg clone https://humungus.tedunangst.com/r/honk
-- requirements
libsqlite3 (you probably already have it)
go 1.11+
Internet connection not included.
-- setup -- setup
honk expects to be fronted by a TLS terminating reverse proxy. honk expects to be fronted by a TLS terminating reverse proxy.
First, create the database. This will ask four questions. First, create the database. This will ask four questions.
./honk init ./honk init
username: (the username you want) username: (the username you want)
password: (the password you want) password: (the password you want)
listenaddr: (tcp or unix: localhost:31337, /var/www/honk.sock, etc.) listenaddr: (tcp or unix: localhost:31337, /var/www/honk.sock, etc.)
servername: (public DNS name: honk.example.com) servername: (public DNS name: honk.example.com)
Then run honk. Then run honk.
./honk ./honk
Refer also to the docs directory, in particular manual.txt.
Busy honk instances may use megabytes of memory.
-- upgrade -- upgrade
cp honk.db backup.db cp honk.db backup.db
./honk upgrade ./honk upgrade
./honk ./honk
-- documentation
There is a more complete manual. This is just the README.