aukpad-paste-proxy/README.md

91 lines
2 KiB
Markdown

# Aukpad Paste Proxy
This proxy allows the paste creation from temporary aukpads via linedump. Can be used as a 'GUI' for linedump.
- Status: Beta - Docs missing, not suited for current linedump version
---
## Features
**Available**:
**Ideas**:
**Not planned**:
---
## Usage
- Create a pad in aukpad.
- Change the domain of the pad from `aukpad.com` `bin.aukpad.com`
- Create new paste in linedump instance and get redirected
---
## Installation
### Environment Variables
| Variable | Description | Default |
|----------|-------------|---------|
| `PAD_BASEURL` | Source paste service base URL including protocol | `https://aukpad.com` |
| `DUMP_BASEURL` | Destination paste service base URL including protocol | `https://linedump.com` |
| `PROXY_BASEURL` | This proxy's base URL for documentation including protocol | `https://bin.aukpad.com` |
### Manual Container Run
```bash
# Using variables
$CONTAINER_CMD run --name ${CONTAINER_NAME} \
-p 127.0.0.1:${PORT_HOST}:${PORT_CONTAINER} \
-e PAD_BASEURL="${PAD_BASEURL}" \
-e DUMP_BASEURL="${DUMP_BASEURL}" \
-e PROXY_BASEURL="${PROXY_BASEURL}" \
--read-only \
--security-opt no-new-privileges:true \
--cap-drop ALL \
--user 1000:1000 \
-d ${IMAGE_NAME}:latest
# Example with Podman
podman run --name aukpad-paste-proxy \
--replace \
-p 127.0.0.1:8001:8000 \
-e PAD_BASEURL="https://aukpad.com" \
-e DUMP_BASEURL="https://linedump.com" \
-e PROXY_BASEURL="http://127.0.0.1:8001" \
--read-only \
--security-opt no-new-privileges:true \
--cap-drop ALL \
--user 1000:1000 \
-d localhost/aukpad-proxy:dev
```
---
## Security
For security concerns or reports, please contact via `hello a t uphillsecurity d o t com` [gpg](https://uphillsecurity.com/gpg).
---
## License
**Apache License**
Version 2.0, January 2004
http://www.apache.org/licenses/
- ✅ Commercial use
- ✅ Modification
- ✅ Distribution
- ✅ Patent use
- ✅ Private use
- ✅ Limitations
- ❌Trademark use
- ❌Liability
- ❌Warranty