honk/README

75 lines
1.4 KiB
Plaintext
Raw Permalink Normal View History

2019-04-09 13:59:33 +02:00
honk honk
-- features
2019-04-24 08:16:52 +02:00
Take control of your honks.
Join the federation in the fight against the evil empire.
2019-04-09 13:59:33 +02:00
Send honks. Receive honks. And not just honks.
Bonk, donk, tonk, all your favorite activities are here.
2019-04-29 19:51:16 +02:00
Public RSS.
2019-05-31 06:32:28 +02:00
Custom emus. Memes too.
2019-04-12 21:02:56 +02:00
2019-04-09 13:59:33 +02:00
Purple color scheme.
2019-04-15 23:56:05 +02:00
No attention mining.
No likes, no faves, no polls, no stars, no claps, no counts.
2019-04-09 13:59:33 +02:00
The button to submit a new honk says "it's gonna be honked".
2019-04-29 19:51:16 +02:00
Avatars assigned by the NSA.
2019-04-09 13:59:33 +02:00
Ein Honk is a stupid person auf deutsch.
2019-04-29 19:51:16 +02:00
Automatic image attachment debloating.
2019-04-24 08:16:52 +02:00
2019-04-29 19:51:16 +02:00
Minimal setup and configuration.
2019-04-17 17:04:32 +02:00
2019-04-24 08:16:52 +02:00
Written in gotesque, an especially grotesque dialect of golang.
-- build
It should be sufficient to type make after unpacking a release.
You'll need a go compiler version 1.11 or later.
Even on a fast machine, building from source can take several seconds.
2019-04-09 13:59:33 +02:00
-- requirements
libsqlite3 (you probably already have it)
2019-04-29 19:51:16 +02:00
go 1.11+
Internet connection not included.
2019-04-09 13:59:33 +02:00
-- setup
2019-04-10 14:22:09 +02:00
honk expects to be fronted by a TLS terminating reverse proxy.
2019-04-24 08:16:52 +02:00
First, create the database. This will ask four questions.
2019-04-10 14:22:09 +02:00
2019-04-09 13:59:33 +02:00
./honk init
2019-04-10 14:22:09 +02:00
username: (the username you want)
password: (the password you want)
listenaddr: (tcp or unix: localhost:31337, /var/www/honk.sock, etc.)
servername: (public DNS name: honk.example.com)
Then run honk.
2019-04-09 13:59:33 +02:00
./honk
Refer also to the docs directory, in particular manual.txt.
Busy honk instances may use megabytes of memory.
-- upgrade
cp honk.db backup.db
./honk upgrade
./honk