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.
 35Also, http signature verification requires accurate time keeping.
 36.Pp
 37Make sure to pass the Host header, if necessary (as for nginx).
 38.Bd -literal -offset indent
 39proxy_set_header Host $http_host;
 40.Ed
 41.Ss Build
 42Building
 43.Nm
 44requires a go compiler 1.16 and libsqlite.
 45On
 46.Ox
 47this is the go and sqlite3 packages.
 48Other platforms may require additional development libraries or headers
 49to be installed.
 50Run make.
 51Please be patient.
 52Even on fast machines, building from source can take several seconds.
 53.Ss Options
 54The following options control where
 55.Nm
 56looks for data.
 57.Bl -tag -width datadirxdirx
 58.It Fl datadir Ar dir
 59The root data directory, where the database and other user data are stored.
 60This directory contains all user data that persists across upgrades.
 61Requires write access.
 62Defaults to ".".
 63.It Fl viewdir Ar dir
 64The root view directory, where html and other templates are stored.
 65The contents of this directory are generally replaced with each release.
 66Read only.
 67Defaults to ".".
 68.El
 69.Pp
 70The following options control log output.
 71Acceptable values include "stderr" (the default), "stdout", "null", "syslog",
 72or a file name.
 73syslog messages will be sent to the UUCP facility.
 74.Bl -tag -width errorlogxlogx
 75.It Fl errorlog Ar log
 76The error log.
 77Something bad has happened.
 78.It Fl infolog Ar log
 79The informative messages log.
 80Something has happened, but probably not too bad.
 81.It Fl debuglog Ar log
 82The debug log.
 83There's probably no reason to care.
 84.It Fl log Ar log
 85Set all three logs.
 86.El
 87.Ss Init
 88Run the
 89.Ic init
 90command.
 91This will create the database and ask four questions, as well as creating
 92the initial user.
 93See below about importing existing data.
 94.Ss Operation
 95Run honk.
 96.Ss Customization
 97The funzone contains fun flair that users may add to posts and profiles.
 98Add custom memes (stickers) to the
 99.Pa memes
100data directory.
101Image and video files are supported.
102Add custom emus (emoji) to the
103.Pa emus
104data directory.
105PNG and GIF files are supported.
106.Pp
107Site CSS may be overridden by creating a
108.Pa views/local.css
109file in the data directory.
110Site JS may similarly be included by creating
111.Pa views/local.js .
112A restart is required after changes.
113A site icon.png and favicon.ico will be served from the views directory
114in the data directory, if present.
115.Pp
116Custom HTML messages may be added to select pages by using the
117.Ic admin
118command.
119This interface is a little rough.
120A restart is required after changes.
121.Bl -tag -width tenletters
122.It server
123Displayed on the home page.
124.It about
125Displayed on the about page.
126.It login
127Displayed on the login form.
128.It avatar colors
129Four 32-bit hex colors (RGBA).
130.El
131.Pp
132.Ss User Admin
133New users can be added with the
134.Ic adduser
135command.
136This is discouraged.
137.Pp
138Passwords may be reset with the
139.Ic chpass Ar username
140command.
141.Pp
142Users may be deleted with the
143.Ic deluser Ar username
144command.
145.Ss Maintenance
146The database may grow large over time.
147The
148.Ic cleanup Op Ar days
149command exists to purge old external data, by default 30 days.
150This removes unreferenced, unsaved posts and attachments.
151It does not remove any original content.
152.Pp
153Backups may be performed by running
154.Ic backup dirname .
155Backups only include the minimal necessary information, such as user posts
156and follower information, but not external posts.
157.Pp
158Sometimes servers simply disappear, resulting in many errors trying to deliver
159undeliverable messages.
160Running
161.Ic unplug Ar hostname
162will delete all subscriptions and pending deliveries.
163.Ss Upgrade
164Stop the old honk process.
165Backup the database.
166Perform the upgrade with the
167.Ic upgrade
168command.
169Restart.
170.Pp
171The current version of the honk binary may be printed with the
172.Ic version
173command.
174.Ss Security
175.Nm
176is not currently hardened against SSRF, server side request forgery.
177Be mindful of what other services may be exposed via localhost or the
178local network.
179.Ss Development
180Development mode may be enabled or disabled by running
181.Ic devel Ar on|off .
182In devel mode, secure cookies are disabled, TLS certs are not verified,
183and templates are reloaded every request.
184.Ss Import
185Data may be imported and converted from other services using the
186.Ic import
187command.
188Currently supports Mastodon and Twitter exported data.
189Posts are imported and backdated to appear as old honks.
190The Mastodon following list is imported, but must be refollowed.
191.Pp
192To prepare a Mastodon data archive, extract the archive-longhash.tar.gz file.
193.Dl ./honk import username mastodon source-directory
194.Pp
195To prepare a Twitter data archive, extract the twitter-longhash.zip file.
196After unzipping the data archive, navigate to the tweet_media directory
197and unzip any zip files contained within.
198.Dl ./honk import username twitter source-directory
199.Ss Advanced Options
200Advanced configuration values may be set by running the
201.Ic setconfig Ar key value
202command.
203For example, to increase the fast timeout value from 5 seconds to 10:
204.Dl ./honk setconfig fasttimeout 10
205.Pp
206To support separate mentions without a subdomain,
207e.g. @user@example.com and https://honk.example.com/u/user,
208set config key 'masqname' to 'example.com'.
209Route
210.Pa /.well-known/webfinger
211from the top domain to honk.
212.Pp
213Custom URL seperators (not "u" and "h") may be specified by adding
214"usersep" and "honksep" options to the config table.
215e.g. example.com/users/username/honk/somehonk instead of
216example.com/u/username/h/somehonk.
217.Sh FILES
218.Nm
219files are split between the data directory and the view directory.
220Both default to "." but may be specified by command line options.
221.Pp
222The data directory contains:
223.Bl -tag -width views/local.css
224.It Pa honk.db
225The main database.
226.It Pa blob.db
227Media and attachment storage.
228.It Pa emus
229Custom emoji.
230.It Pa memes
231Stickers and such.
232.It Pa views/local.js
233Locally customized JS.
234.It Pa views/local.css
235Locally customized CSS.
236.El
237.Pp
238The view directory contains:
239.Bl -tag -width views
240.It Pa views
241HTML templates and CSS files.
242.El
243.Sh EXAMPLES
244This series of commands creates a new database, sets a friendly
245welcome message, and runs honk.
246.Bd -literal -offset indent
247honk-v98> make
248honk-v98> ./honk -datadir ../honkdata init
249username: puffy
250password: OxychromaticBlowfishSwatDynamite
251listen address: /var/www/honk.sock
252server name: honk.example.com
253honk-v98> ./honk -datadir ../honkdata admin
254honk-v98> date; ./honk -log honk.log -datadir ../honkdata
255.Ed
256.Pp
257The views directory includes a sample pleroma.css to change color scheme.
258.Bd -literal -offset indent
259honk-v98> mkdir ../honkdata/views
260honk-v98> cp views/pleroma.css ../honkdata/views/local.css
261.Ed
262.Pp
263Upgrade to the next version.
264Clean things up a bit.
265.Bd -literal -offset indent
266datadir> cp honk.db backup.db
267datadir> cd ../honk-v99
268honk-v99> make
269honk-v99> ./honk -datadir ../honkdata upgrade
270honk-v99> ./honk -datadir ../honkdata cleanup
271honk-v99> date; ./honk -log honk.log -datadir ../honkdata
272.Ed
273.Sh ENVIRONMENT
274Image processing and scaling requires considerable memory.
275It is recommended to adjust the datasize ulimit to at least 1GB.
276.Sh SEE ALSO
277.Xr intro 1 ,
278.Xr honk 1
279.Sh CAVEATS
280There's no online upgrade capability.
281Upgrades may result in minutes of downtime.