ADD installations instructions to README
This commit is contained in:
parent
87652ee625
commit
3853165bd1
1 changed files with 51 additions and 4 deletions
55
README.md
55
README.md
|
@ -50,6 +50,57 @@ ip -br a | curl -X POST https://aukpad.com --data-binary @- # command output
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
|
**Please use a reverse proxy and TLS in production!**
|
||||||
|
|
||||||
|
### Docker
|
||||||
|
|
||||||
|
**Simple / Testing**
|
||||||
|
|
||||||
|
`docker run -p 127.0.0.1:8000:8000 git.uphillsecurity.com/cf7/aukpad:latest`
|
||||||
|
|
||||||
|
Open `127.0.0.1:8000`
|
||||||
|
|
||||||
|
**Adv. example with Podman**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Create Pod
|
||||||
|
podman pod create --name aukpad-pod -p 127.0.0.1:8000:8000
|
||||||
|
|
||||||
|
# Start Valkey Container (or replace with redis)
|
||||||
|
podman run -d --name aukpad-cache \
|
||||||
|
--replace \
|
||||||
|
--pod aukpad-pod \
|
||||||
|
--restart=unless-stopped \
|
||||||
|
docker.io/valkey/valkey:7 \
|
||||||
|
--requirepass xeZNopyIeMMncqDFPHtJQwMwIathgMWo \
|
||||||
|
--maxmemory 2gb \
|
||||||
|
--maxmemory-policy allkeys-lru \
|
||||||
|
--save "" \
|
||||||
|
--appendonly no \
|
||||||
|
--bind 0.0.0.0 \
|
||||||
|
--protected-mode yes
|
||||||
|
|
||||||
|
# Start aukpad Container
|
||||||
|
podman run -d --name aukpad-app \
|
||||||
|
--replace \
|
||||||
|
--pod aukpad-pod \
|
||||||
|
--read-only \
|
||||||
|
--tmpfs /tmp \
|
||||||
|
--security-opt no-new-privileges:true \
|
||||||
|
--cap-drop ALL \
|
||||||
|
--user 1000:1000 \
|
||||||
|
-e USE_VALKEY=true \
|
||||||
|
-e VALKEY_URL=redis://:xeZNopyIeMMncqDFPHtJQwMwIathgMWo@localhost:6379 \
|
||||||
|
-e MAX_TEXT_SIZE=5 \
|
||||||
|
-e MAX_CONNECTIONS_PER_IP=20 \
|
||||||
|
-e RETENTION_HOURS=72 \
|
||||||
|
git.uphillsecurity.com/cf7/aukpad:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
*Tested only with Podman - Docker-Compose file might follows.*
|
||||||
|
|
||||||
|
Enable support for web sockets in your reverse proxy of choice! - Nginx config example will be added at some point.
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
||||||
The following environment variables can be configured:
|
The following environment variables can be configured:
|
||||||
|
@ -63,10 +114,6 @@ The following environment variables can be configured:
|
||||||
| `RETENTION_HOURS` | `48` | How long to retain pads in hours after last access |
|
| `RETENTION_HOURS` | `48` | How long to retain pads in hours after last access |
|
||||||
| `DESCRIPTION` | `powered by aukpad.com` | Instance description shown on info page |
|
| `DESCRIPTION` | `powered by aukpad.com` | Instance description shown on info page |
|
||||||
|
|
||||||
### Running
|
|
||||||
|
|
||||||
WORK IN PROGRESS
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue