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 date; ./honk >> log 2>&1
 56Log messages are sent to stderr and should probably be redirected to a file.
 57.Ss CUSTOMIZATION
 58Add custom memes (stickers) to the
 59.Pa memes
 60directory.
 61Image and video files are supported.
 62.Pp
 63Add custom emus (emoji) to the
 64.Pa emus
 65directory.
 66Image files are supported.
 67.Pp
 68Site CSS may be overridden by creating a
 69.Pa views/local.css
 70file.
 71.Pp
 72A custom message me be set by editing the database.
 73(Sorry.)
 74.Dl insert into config values ('servermsg', 'message');
 75.Pp
 76The
 77.Pa views/about.html
 78page doesn't change too frequently.
 79It should be safe to edit.
 80.Ss ADMIN
 81New users can be added with the
 82.Ic adduser
 83command.
 84This is discouraged.
 85.Dl ./honk adduser
 86.Ss MAINTENANCE
 87The database may grow large over time.
 88The
 89.Ic cleanup
 90command exists to purge old data, by default 30 days.
 91.Ss UPGRADE
 92Stop the old honk process.
 93.Dl pkill honk
 94Backup the database.
 95.Dl cp honk.db backup.db
 96Perform the upgrade with the
 97.Ic upgrade
 98command.
 99.Dl ./honk upgrade
100Restart.
101.Dl ./honk
102.Pp
103There's also a
104.Pa blob.db
105file which is important to backup and restore.
106.Sh ENVIRONMENT
107Image processing and scaling requires considerable memory.
108It is recommended to adjust the datasize ulimit to at least 1GB.
109.Sh SEE ALSO
110.Xr intro 1 ,
111.Xr honk 1
112.Sh CAVEATS
113There's no online upgrade capability.
114Upgrades may result in minutes of downtime.