From 0d0f51f1018a03e67c7e845b1d5b82827ca5d111 Mon Sep 17 00:00:00 2001 From: Jake Howard Date: Sun, 3 Mar 2024 19:30:20 +0000 Subject: [PATCH] Add README --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..34a873c --- /dev/null +++ b/README.md @@ -0,0 +1,21 @@ +# Slides + +A custom container to serve my talk slides. + +You probably don't want to use this yourself, but it's open source anyway! + +## Features + +- Serve files performantly with `nginx` +- Automatically calculate a sitemap based on directories +- Redirect the root to my website. +- Upload files via WebDAV (protected by basic auth). +- Healthcheck endpoint at `/.ping`. + +## Configuration + +Files should be mounted to `/srv`. + +By default, basic auth is credentials are `user:password`, but can be overridden by `/etc/nginx/.htpasswd`. + +By default, the container runs as UID `1000`, which can be overridden by `$PUID`.