dirk
/
honk
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix up some old docs

This commit is contained in:
Ted Unangst 2022-05-31 14:55:20 -04:00
parent 65ba713c17
commit 8382e603e6
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/honk.8
View File

@ -154,6 +154,12 @@ Backups may be performed by running
.Ic backup dirname . .Ic backup dirname .
Backups only include the minimal necessary information, such as user posts Backups only include the minimal necessary information, such as user posts
and follower information, but not external posts. and follower information, but not external posts.
.Pp
Sometimes servers simply disappear, resulting in many errors trying to deliver
undeliverable messages.
Running
.Ic unplug Ar hostname
will delete all subscriptions and pending deliveries.
.Ss Upgrade .Ss Upgrade
Stop the old honk process. Stop the old honk process.
Backup the database. Backup the database.
@ -165,19 +171,13 @@ Restart.
The current version of the honk binary may be printed with the The current version of the honk binary may be printed with the
.Ic version .Ic version
command. command.
.Ss unplug
Sometimes servers simply disappear, resulting in many errors trying to deliver
undeliverable messages.
Running
.Ic unplug Ar hostname
will delete all subscriptions and pending deliveries.
.Ss Security .Ss Security
.Nm .Nm
is not currently hardened against SSRF, server side request forgery. is not currently hardened against SSRF, server side request forgery.
Be mindful of what other services may be exposed via localhost or the Be mindful of what other services may be exposed via localhost or the
local network. local network.
.Ss Debug .Ss Development
Debug mode may be enabled or disabled by running Development mode may be enabled or disabled by running
.Ic devel Ar on|off . .Ic devel Ar on|off .
In devel mode, secure cookies are disabled, TLS certs are not verified, In devel mode, secure cookies are disabled, TLS certs are not verified,
and templates are reloaded every request. and templates are reloaded every request.
@ -185,9 +185,9 @@ and templates are reloaded every request.
Data may be imported and converted from other services using the Data may be imported and converted from other services using the
.Ic import .Ic import
command. command.
Posts are imported and backdated to appear as old honks.
No other information is imported.
Currently supports Mastodon and Twitter exported data. Currently supports Mastodon and Twitter exported data.
Posts are imported and backdated to appear as old honks.
The Mastodon following list is imported, but must be refollowed.
.Pp .Pp
To prepare a Mastodon data archive, extract the archive-longhash.tar.gz file. To prepare a Mastodon data archive, extract the archive-longhash.tar.gz file.
.Dl ./honk import username mastodon source-directory .Dl ./honk import username mastodon source-directory