1.\"
 2.\" Copyright (c) 2019 Ted Unangst
 3.\"
 4.\" Permission to use, copy, modify, and distribute this software for any
 5.\" purpose with or without fee is hereby granted, provided that the above
 6.\" copyright notice and this permission notice appear in all copies.
 7.\"
 8.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 9.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd $Mdocdate$
17.Dt HONK 8
18.Os
19.Sh NAME
20.Nm honk
21.Nd honk administration
22.Sh SYNOPSIS
23.Nm honk
24.Sh DESCRIPTION
25The
26.Nm
27daemon processes messages from other federated servers.
28This is the admin manual.
29For user operation, see
30.Xr honk 1 .
31.Ss SETUP
32.Pp
33Set up a TLS reverse proxy.
34.Nm
35can listen on TCP or unix sockets, but will not terminate TLS.
36https is a required component for federation.
37.Pp
38Make sure to pass the Host header, if necessary (as for nginx).
39.Bd -literal -offset indent
40proxy_set_header Host $http_host;
41.Ed
42.Ss INIT
43Run the init command.
44.Dl ./honk init
45This will create the database and ask four questions, as well as creating
46the initial user.
47.Bd -literal -offset indent
48username: (desired username)
49password: (desired password)
50listenaddr: (tcp or unix: localhost:31337, /var/www/honk.sock, etc.)
51servername: (public DNS name: honk.example.com)
52.Ed
53.Ss OPERATION
54Run honk.
55.Dl ./honk
56Log messages are sent to stderr and should probably be redirected to a file.
57.Ss MAINTENANCE
58The database may grow large over time.
59The cleanup command exists to purge old data, by default 30 days.
60.Ss UPGRADE
61Stop the old honk process.
62.Dl pkill honk
63Backup the database.
64.Dl cp honk.db backup.db
65Upgrade.
66.Dl ./honk upgrade
67Restart.
68.Dl ./honk
69.\" .Sh EXAMPLES
70.Sh SEE ALSO
71.Xr honk 1
72.Sh CAVEATS
73There's no online upgrade capability.
74Upgrades may result in minutes of downtime.