diff options
| author | Christine Dodrill <me@christine.website> | 2019-01-09 20:00:43 -0800 |
|---|---|---|
| committer | Christine Dodrill <me@christine.website> | 2019-01-09 20:00:43 -0800 |
| commit | 54fceb8b197dc90cd5d8cc60fab0d1bcad8dcc9c (patch) | |
| tree | 09aa012e70689867e46ac8190e0b0b4871cf21fe /docs | |
| parent | 7628126032977d182af7e8ae56bc3809c294596c (diff) | |
| parent | ddbe51f7fcb3ce1c86e45c7f4a51836be4a91a4c (diff) | |
| download | x-54fceb8b197dc90cd5d8cc60fab0d1bcad8dcc9c.tar.xz x-54fceb8b197dc90cd5d8cc60fab0d1bcad8dcc9c.zip | |
la-baujmi: start on toki pona logic engine
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/man/README.md | 11 | ||||
| -rwxr-xr-x | docs/man/prepare.sh | 5 | ||||
| -rw-r--r-- | docs/man/routed.1 | 129 |
3 files changed, 16 insertions, 129 deletions
diff --git a/docs/man/README.md b/docs/man/README.md new file mode 100644 index 0000000..b0a74fc --- /dev/null +++ b/docs/man/README.md @@ -0,0 +1,11 @@ +# manpages + +These are manpages for a selected group of commands that I consider really useful. I have created a web version of these manpages too at TODO: add link to deployed site. + +## Deployment + +- gzip all the files (`$ gzip *.1`) +- copy to (`/usr/share/man/man1/`) +- `$ man appsluggr` + + diff --git a/docs/man/prepare.sh b/docs/man/prepare.sh index 2180c32..c56f8f1 100755 --- a/docs/man/prepare.sh +++ b/docs/man/prepare.sh @@ -1,3 +1,8 @@ #!/bin/sh +for file in *.1 +do + mandoc -T markdown $file > ../$file.md +done + gzip *.1 diff --git a/docs/man/routed.1 b/docs/man/routed.1 deleted file mode 100644 index 14736b1..0000000 --- a/docs/man/routed.1 +++ /dev/null @@ -1,129 +0,0 @@ -.Dd December 12, 2017 -.Dt ROUTED 1 URM - - -.Sh NAME -.Nm routed -.Nd TLS termination and reverse reverse proxying daemon. - - -.Sh SYNOPSIS -.Nm - - -.Sh ENVIRONMENT - -.Bl -tag -width "routed" -offset indent -compact - -.It Ev BOLTDB_PATH -Specifies the path to the boltdb database -.Nm -stores all of its relevant data in. - -.It Ev WEB_ADDR -Specifies the host+port that -.Nm -will listen on for unsecured HTTP traffic. This will only forward traffic to HTTPS. - -.It Ev SSL_ADDR -Specifies the host+port that -.Nm -will listen on for secure (TLS) traffic. This should have port 443 if you want Let's Encrypt to work (you probably want Let's Encrypt to work). - -.It Ev QUIC_ADDR -Specifies the host+port that -.Nm -will listen on for secure (TLS) QUIC traffic. For more information see https://datatracker.ietf.org/wg/quic/about/. This should also be port 443, but is not essential for Let's Encrypt to work. - -.It Ev BACKEND_TCP_ADDR -Specifies the host+port that -.Nm -will listen on for secure (TLS) TCP connections from backends. Any client that is successfully able to authenticate with -.Nm -on this port will relay HTTP traffic from to and from end users. - -.It Ev BACKEND_KCP_ADDR -Specifies the host+port that -.Nm -will listen on for secure (TLS) KCP (reliable-UDP) connections from backends. Any client that is successfully able to authenticate with -.Nm -on this port will relay HTTP traffic from to and from end users. - -For more information about KCP, see https://github.com/xtaci/kcp-go - -.It Ev GRPC_ADDR -Specifies the host+post that -.Nm -will listen on for secure (TLS) TCP gRPC connections from clients wishing to control -.Nm -configuration. Authentication is enforced and requires the use of an API token generated by the API call route.Tokens.Put. - -.It Ev DOMAIN_SUFFIX -Specifies the domain suffix that -.Nm -will use when automatically generating a domain name for a newly created route. Please set this to something that has a wildcard DNS record pointing to your instances of routed. - -.It Ev ACME_EMAIL -Specifies the email address that -.Nm -will use when creating a new account with Let's Encrypt. This assumes you have read (and agree to) the Let's Encrypt terms of service found here: https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf. - -.It Ev SSL_CERT_KEY -Specifies the encryption key that -.Nm -will use when encrypting and decrypting SSL certificates when loading them from and saving them to the database. This can be created with -.Xr route-cli 1 . - -.El - - -.Sh IMPLEMENTATION NOTES - -In order for -.Nm -to route traffic, a route must be set up using -.Xr route-cli 1 . -Please see its manpage for more information on how to do this. - -.Nm -exposes debugging and introspection information on a randomly generated port every time it starts up. The message will look something like: - -2017/12/13 02:06:56 manhole: Now listening on http://127.0.0.1:39245 - -Expose this using -.Xr route-httpagent 1 -or similar tools. - -.Nm -can be managed using terraform. See -.Xr terraform-provider-route 1 -for more information. - - -.Sh EXAMPLES - -routed - - -.Sh DIAGNOSTICS - -.Ex -std routed - - -.Sh SEE ALSO - -.Bl -bullet - -.It -https://datatracker.ietf.org/wg/quic/about/ - -.It -https://github.com/xtaci/kcp-go - -.It -https://grpc.io/ - -.It -https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf - -.El |
