From ef39cc12e1055111ae03febbac96518609c665f5 Mon Sep 17 00:00:00 2001 From: CaffeineFueled Date: Fri, 3 Oct 2025 23:30:47 +0200 Subject: [PATCH] ADD installation instructions to README --- README.md | 28 +++++++++++++++++++++++++--- 1 file changed, 25 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4acfab1..5d59f08 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ [Issue tracker](https://git.uphillsecurity.com/cf7/linedump/issues) | `Libera Chat #linedump` - - Status: Beta - expect minor changes - Instance: [linedump.com](https://linedump.com/) - Inspired by: @@ -112,9 +111,32 @@ curl -s https://linedump.com/{path} | base64 -d | openssl enc -d -aes-256-cb ## Installation -Use with reverse-proxy and HTTPS! +**Use with reverse-proxy and HTTPS!** -### Environment Variables +### Docker + +**Simple / Testing** + +`docker run -d -p 127.0.0.1:8000:8000 -v /path/to/upload:/app/upload git.uphillsecurity.com/cf7/linedump:latest` + +Open `http://127.0.0.1:8000` + +**More advanced example with Podman** + +```bash +podman run --replace -d --restart=unless-stopped \ + --name linedump \ + -e BASEURL="https://linedump.com" \ + --userns=keep-id \ + --read-only \ + --cap-drop=ALL \ + --security-opt no-new-privileges:true \ + -p 127.0.0.1:8000:8000 \ + -v linedump:/app/uploads \ + git.uphillsecurity.com/cf7/linedump:latest +``` + +### Configuration | Variable | Description | Default | Required | |----------|-------------|---------|----------|