From: cat æscling <11325618-aescling@users.noreply.gitlab.com>
Date: Thu, 3 Aug 2023 04:28:52 +0000 (-0400)
Subject: Add installation instructions
X-Git-Tag: v1.0.0~1
X-Git-Url: https://git.xn--scling-oua.cat.family/?a=commitdiff_plain;h=f64e6c992911508d98aa5eafbe4697354a64a407;p=httpd-execline.git

Add installation instructions
---

diff --git a/README.md b/README.md
index 7b38faa..b8b993a 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# httpd.execline: a simple\* static webserver ###
+# httpd.execline: a simple static webserver ###
 
 `httpd.execline` performs the business logic of a a static HTTP mirror. it is
 implemented in [execline](https://skarnet.org/software/execline/), in the same
@@ -20,7 +20,33 @@ https://httpd-execline.cat.family/
 the codebase can be found in a
 [git repository](https://gitlab.com/aescling/httpd-execline) hosted by Gitlab.
 
-\* “simple” here better describes functionality than implementation.
+### installation ###
+
+#### with s6 as your service manager
+
+for the quickest install ensure you have systemwide installations of
+[s6](https://skarnet.org/software/s6),
+[execline](https://skarnet.org/software/execline), and
+[s6-networking](https://skarnet.org/software/s6-networking) with TLS support.
+
+1. copy the contents of `visible-to-httpd` to a suitable webroot location, such
+  as `/srv/httpd.execline`
+2. run the provided build script in `dependencies` (on linux, you might want to
+  run the musl chroot script) to render the runtime dependencies availabse in
+  the chroot jail
+3. install an appropriate service directory from examples, or create a custom
+  one according to your needs
+  * in the former case, edit the `data/env` and `log/data/env` files as
+    required
+4. enable the httpd service
+
+(if you do not have systemwide installations of your dependencies, you _could_
+try hacking the httpd service to use the `binaries` folder from the chroot jail
+as part of the `PATH`...)
+
+#### installation otherwise
+
+you are currently on your own.
 
 ## usage ###