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

tone down the capslock

This commit is contained in:
Ted Unangst 2019-11-12 23:56:56 -05:00
parent a0f1882f0a
commit 3902576833
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/honk.5
View File

@ -29,7 +29,7 @@ The process begins by pressing the button marked
to activate the honk form. to activate the honk form.
.Pp .Pp
Honks are posted publicly. Honks are posted publicly.
.Ss BASICS .Ss Basics
A subset of markdown is supported. A subset of markdown is supported.
.Bl -tag -width tenletters .Bl -tag -width tenletters
.It bold .It bold
@ -85,7 +85,7 @@ will work for anyone.
.Ql @https://example.com .Ql @https://example.com
works as well. works as well.
When honking back, the author of the parent post is automatically mentioned. When honking back, the author of the parent post is automatically mentioned.
.Ss EXTRAS .Ss Extras
Threads from the tiny bird site may be included as quotes in a post via the Threads from the tiny bird site may be included as quotes in a post via the
.Ar hoot .Ar hoot
operator followed by the URL. operator followed by the URL.

24
docs/honk.8
View File

@ -26,7 +26,7 @@ daemon processes messages from other federated servers.
This is the admin manual. This is the admin manual.
For user operation, see For user operation, see
.Xr honk 1 . .Xr honk 1 .
.Ss SETUP .Ss Setup
.Pp .Pp
Set up a TLS reverse proxy. Set up a TLS reverse proxy.
.Nm .Nm
@ -37,7 +37,7 @@ Make sure to pass the Host header, if necessary (as for nginx).
.Bd -literal -offset indent .Bd -literal -offset indent
proxy_set_header Host $http_host; proxy_set_header Host $http_host;
.Ed .Ed
.Ss BUILD .Ss Build
Building Building
.Nm .Nm
requires a go compiler and libsqlite. requires a go compiler and libsqlite.
@ -49,7 +49,7 @@ to be installed.
Run make. Run make.
Please be patient. Please be patient.
Even on fast machines, building from source can take several seconds. Even on fast machines, building from source can take several seconds.
.Ss OPTIONS .Ss Options
The following options control where The following options control where
.Nm .Nm
looks for data. looks for data.
@ -63,17 +63,17 @@ The root view directory, where html and other templates are stored.
Read only. Read only.
Defaults to ".". Defaults to ".".
.El .El
.Ss INIT .Ss Init
Run the Run the
.Ic init .Ic init
command. command.
This will create the database and ask four questions, as well as creating This will create the database and ask four questions, as well as creating
the initial user. the initial user.
See below about importing existing data. See below about importing existing data.
.Ss OPERATION .Ss Operation
Run honk. Run honk.
Log messages are sent to stderr and should probably be redirected to a file. Log messages are sent to stderr and should probably be redirected to a file.
.Ss CUSTOMIZATION .Ss Customization
Add custom memes (stickers) to the Add custom memes (stickers) to the
.Pa memes .Pa memes
data directory. data directory.
@ -102,7 +102,7 @@ Displayed on the about page.
Displayed about the login form. Displayed about the login form.
.El .El
.Pp .Pp
.Ss USER ADMIN .Ss User Admin
New users can be added with the New users can be added with the
.Ic adduser .Ic adduser
command. command.
@ -111,14 +111,14 @@ This is discouraged.
Passwords may be reset with the Passwords may be reset with the
.Ic chpass Ar username .Ic chpass Ar username
command. command.
.Ss MAINTENANCE .Ss Maintenance
The database may grow large over time. The database may grow large over time.
The The
.Ic cleanup Op Ar days .Ic cleanup Op Ar days
command exists to purge old data, by default 30 days. command exists to purge old data, by default 30 days.
This removes unreferenced, unsaved posts and attachments. This removes unreferenced, unsaved posts and attachments.
It does not remove any original content. It does not remove any original content.
.Ss UPGRADE .Ss Upgrade
Stop the old honk process. Stop the old honk process.
Backup the database. Backup the database.
Perform the upgrade with the Perform the upgrade with the
@ -133,17 +133,17 @@ file which is important to backup and restore.
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 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 Debug
Debug mode may be enabled or disabled by running Debug mode may be enabled or disabled by running
.Ic debug Ar on|off . .Ic debug Ar on|off .
In debug mode, secure cookies are disabled and templates are reloaded In debug mode, secure cookies are disabled and templates are reloaded
every request. every request.
.Ss IMPORT .Ss Import
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.