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 DESCRIPTION
23The
24.Nm
25daemon processes messages from other federated servers.
26This is the admin manual.
27For user operation, see
28.Xr honk 1 .
29.Ss SETUP
30.Pp
31Set up a TLS reverse proxy.
32.Nm
33can listen on TCP or unix sockets, but will not terminate TLS.
34https is a required component for federation.
35.Pp
36Make sure to pass the Host header, if necessary (as for nginx).
37.Bd -literal -offset indent
38proxy_set_header Host $http_host;
39.Ed
40.Ss INIT
41Run the
42.Ic init
43command.
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
60.Ic cleanup
61command exists to purge old data, by default 30 days.
62.Ss UPGRADE
63Stop the old honk process.
64.Dl pkill honk
65Backup the database.
66.Dl cp honk.db backup.db
67Perform the upgrade with the
68.Ic upgrade
69command.
70.Dl ./honk upgrade
71Restart.
72.Dl ./honk
73.Sh ENVIRONMENT
74Image processing and scaling requires considerable memory.
75It is recommended to adjust the datasize ulimit to at least 1GB.
76.Sh SEE ALSO
77.Xr intro 1 ,
78.Xr honk 1
79.Sh CAVEATS
80There's no online upgrade capability.
81Upgrades may result in minutes of downtime.