From 3a9c28df3f88910bfe52e92a648dbbe74f4908ea Mon Sep 17 00:00:00 2001 From: Ted Unangst Date: Wed, 10 Apr 2019 08:22:09 -0400 Subject: [PATCH] clarify setup instructions. --- README | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README b/README index ab1fae2..4e82446 100644 --- a/README +++ b/README @@ -31,8 +31,19 @@ Busy honk instances may require megabytes of memory. -- setup +honk expects to be fronted by a TLS terminating reverse proxy. + +First, create the database. + ./honk init +This will ask four questions. +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. + ./honk -honk expects to be fronted by a TLS terminating reverse proxy.