ADD installation instructions to README

This commit is contained in:
Caffeine Fueled 2025-10-03 23:30:47 +02:00
parent 2e78cb4103
commit ef39cc12e1
Signed by: cf7
GPG key ID: CA295D643074C68C

View file

@ -4,7 +4,6 @@
[Issue tracker](https://git.uphillsecurity.com/cf7/linedump/issues) | `Libera Chat #linedump` [Issue tracker](https://git.uphillsecurity.com/cf7/linedump/issues) | `Libera Chat #linedump`
- Status: Beta - expect minor changes - Status: Beta - expect minor changes
- Instance: [linedump.com](https://linedump.com/) - Instance: [linedump.com](https://linedump.com/)
- Inspired by: - Inspired by:
@ -112,9 +111,32 @@ curl -s https://linedump.com/{path} | base64 -d | openssl enc -d -aes-256-cb
## Installation ## 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 | | Variable | Description | Default | Required |
|----------|-------------|---------|----------| |----------|-------------|---------|----------|