v0.34.0 doc sweep and update

deploy/README.md

@@ -12,20 +12,4 @@ deploy/lw-deploy.sh --dry-run ...    # print the configuration and commands only
 deploy/lw-deploy.sh --yes ...        # no questions: defaults, or fail on a missing value
 ```
 
-- Roles
-  - `edge`: tails log directories, forwards the entries to an aggregator
-  - `aggregator`: receives from edges; writes files, serves HTTP and TCP streams
-  - `standalone`: tails log directories; writes files, serves streams
-- Runtimes
-  - `docker`, `podman`: a hardened container of the `logwisp` image (Linux)
-  - `native`: systemd on Linux, rc.d on FreeBSD, `--jail NAME` for a jail
-  - `manual`: the configuration only, for `lw -c`
-- Every question has a flag. Before changing anything the script prints its
-  plan and the command line that repeats it without questions, ready for the
-  next node. It starts nothing that `lw --check` rejects.
-- The native runtimes install the service files of `deploy/package/`.
-- Not covered, and printed by the script: filters, rate limits, heartbeat,
-  several pipelines, proxy mode, ACLs, certificate creation. Edit the generated
-  `logwisp.toml` for those.
-
-Scenarios and what each runtime writes: [doc/deployment.md](../doc/deployment.md).
+Roles, runtimes, scenarios and what is not covered: [doc/deployment.md](../doc/deployment.md).

deploy/lw-deploy.sh

@@ -70,7 +70,7 @@ Outputs (aggregator, standalone)
   --tcp-port PORT         serve a plain TCP stream
   --format raw|txt|json   entry format (default txt)
 
-TLS (this script creates no certificates: doc/security.md#enabling-mtls)
+TLS (this script creates no certificates: lw tls makes them, doc/cli.md#lw-tls)
   --tls, --no-tls         TLS on every network link of the node
   --cert-file FILE        this node's certificate: listeners, and edges under mtls
   --key-file FILE         its private key
@@ -122,7 +122,7 @@ Not covered by this script; edit the generated configuration instead
 - proxy mode: browser logins through a TLS-terminating proxy (trusted_proxies)
 - acl on the listeners: address rules, PROXY headers, per-client limits
 - mtls identities other than the certificate CN; node_binding other than force
-- creating certificates: openssl or your PKI (doc/security.md#enabling-mtls)
+- creating certificates: lw tls, openssl or your PKI (doc/cli.md#lw-tls)
 - several native instances on one host: use one per host or jail
 EOF
 }
@@ -612,7 +612,7 @@ resolve() {
 	[ -z "$SINK_ALLOW" ] || _isa=mtls
 	[ -z "$ADD_VIEWERS" ] || _isa=scram
 	if [ "$TLS" = yes ]; then
-		[ "$INTERACTIVE" = 0 ] || note "Certificates come from openssl or your PKI: doc/security.md#enabling-mtls" >&2
+		[ "$INTERACTIVE" = 0 ] || note "Certificates come from lw tls, openssl or your PKI: doc/cli.md#lw-tls" >&2
 		if [ "$ROLE" = edge ]; then
 			ask_opt CA_FILE --ca-file "CA bundle verifying the aggregator (empty: the system roots)" v_file
 		else

deploy/package/freebsd/Makefile

@@ -46,8 +46,9 @@ post-install:
 	${INSTALL_DATA} ${WRKSRC}/config/logwisp.toml ${STAGEDIR}${ETCDIR}/logwisp.toml.sample
 
 post-install-DOCS-on:
-	${MKDIR} ${STAGEDIR}${DOCSDIR}/doc
-	${INSTALL_DATA} ${WRKSRC}/README.md ${STAGEDIR}${DOCSDIR}
-	${INSTALL_DATA} ${WRKSRC}/doc/*.md ${STAGEDIR}${DOCSDIR}/doc
+	${MKDIR} ${STAGEDIR}${DOCSDIR}/doc ${STAGEDIR}${DOCSDIR}/config
+	${INSTALL_DATA} ${WRKSRC}/README.md ${WRKSRC}/logwisp-logo.svg ${STAGEDIR}${DOCSDIR}
+	${INSTALL_DATA} ${WRKSRC}/doc/*.md ${WRKSRC}/doc/lw.1 ${STAGEDIR}${DOCSDIR}/doc
+	${INSTALL_DATA} ${WRKSRC}/config/logwisp.toml ${STAGEDIR}${DOCSDIR}/config
 
 .include <bsd.port.mk>