tone down the capslock
This commit is contained in:
parent
a0f1882f0a
commit
3902576833
|
@ -29,7 +29,7 @@ The process begins by pressing the button marked
|
|||
to activate the honk form.
|
||||
.Pp
|
||||
Honks are posted publicly.
|
||||
.Ss BASICS
|
||||
.Ss Basics
|
||||
A subset of markdown is supported.
|
||||
.Bl -tag -width tenletters
|
||||
.It bold
|
||||
|
@ -85,7 +85,7 @@ will work for anyone.
|
|||
.Ql @https://example.com
|
||||
works as well.
|
||||
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
|
||||
.Ar hoot
|
||||
operator followed by the URL.
|
||||
|
|
24
docs/honk.8
24
docs/honk.8
|
@ -26,7 +26,7 @@ daemon processes messages from other federated servers.
|
|||
This is the admin manual.
|
||||
For user operation, see
|
||||
.Xr honk 1 .
|
||||
.Ss SETUP
|
||||
.Ss Setup
|
||||
.Pp
|
||||
Set up a TLS reverse proxy.
|
||||
.Nm
|
||||
|
@ -37,7 +37,7 @@ Make sure to pass the Host header, if necessary (as for nginx).
|
|||
.Bd -literal -offset indent
|
||||
proxy_set_header Host $http_host;
|
||||
.Ed
|
||||
.Ss BUILD
|
||||
.Ss Build
|
||||
Building
|
||||
.Nm
|
||||
requires a go compiler and libsqlite.
|
||||
|
@ -49,7 +49,7 @@ to be installed.
|
|||
Run make.
|
||||
Please be patient.
|
||||
Even on fast machines, building from source can take several seconds.
|
||||
.Ss OPTIONS
|
||||
.Ss Options
|
||||
The following options control where
|
||||
.Nm
|
||||
looks for data.
|
||||
|
@ -63,17 +63,17 @@ The root view directory, where html and other templates are stored.
|
|||
Read only.
|
||||
Defaults to ".".
|
||||
.El
|
||||
.Ss INIT
|
||||
.Ss Init
|
||||
Run the
|
||||
.Ic init
|
||||
command.
|
||||
This will create the database and ask four questions, as well as creating
|
||||
the initial user.
|
||||
See below about importing existing data.
|
||||
.Ss OPERATION
|
||||
.Ss Operation
|
||||
Run honk.
|
||||
Log messages are sent to stderr and should probably be redirected to a file.
|
||||
.Ss CUSTOMIZATION
|
||||
.Ss Customization
|
||||
Add custom memes (stickers) to the
|
||||
.Pa memes
|
||||
data directory.
|
||||
|
@ -102,7 +102,7 @@ Displayed on the about page.
|
|||
Displayed about the login form.
|
||||
.El
|
||||
.Pp
|
||||
.Ss USER ADMIN
|
||||
.Ss User Admin
|
||||
New users can be added with the
|
||||
.Ic adduser
|
||||
command.
|
||||
|
@ -111,14 +111,14 @@ This is discouraged.
|
|||
Passwords may be reset with the
|
||||
.Ic chpass Ar username
|
||||
command.
|
||||
.Ss MAINTENANCE
|
||||
.Ss Maintenance
|
||||
The database may grow large over time.
|
||||
The
|
||||
.Ic cleanup Op Ar days
|
||||
command exists to purge old data, by default 30 days.
|
||||
This removes unreferenced, unsaved posts and attachments.
|
||||
It does not remove any original content.
|
||||
.Ss UPGRADE
|
||||
.Ss Upgrade
|
||||
Stop the old honk process.
|
||||
Backup the database.
|
||||
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
|
||||
.Ic version
|
||||
command.
|
||||
.Ss SECURITY
|
||||
.Ss Security
|
||||
.Nm
|
||||
is not currently hardened against SSRF, server side request forgery.
|
||||
Be mindful of what other services may be exposed via localhost or the
|
||||
local network.
|
||||
.Ss DEBUG
|
||||
.Ss Debug
|
||||
Debug mode may be enabled or disabled by running
|
||||
.Ic debug Ar on|off .
|
||||
In debug mode, secure cookies are disabled and templates are reloaded
|
||||
every request.
|
||||
.Ss IMPORT
|
||||
.Ss Import
|
||||
Data may be imported and converted from other services using the
|
||||
.Ic import
|
||||
command.
|
||||
|
|
Loading…
Reference in New Issue