aukpad-paste-proxy/README.md

71 lines
1.8 KiB
Markdown

# Aukpad Paste Proxy
This proxy allows the paste creation from temporary [aukpad](https://aukpad.com/) via [linedump](https://linedump.com/). Can be used as a 'GUI' for linedump.
---
## Usage
- Create a pad in your aukpad instance of choice.
- Replace the domain of the aukpad instance with the domain of the this proxy while leaving the {paste_id}- for example: https://aukpad.com/fef3 into https://bin.aukpad.com/fef3
- This will create a paste on the chosen linedump instanec of this proxy.
Information can be found on the root page of the proxy instance.
---
## 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` |
### Docker / Podman
```bash
# Example with Podman
podman run -d --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="https://bin.aukpad.com" \
--read-only \
--security-opt no-new-privileges:true \
--cap-drop ALL \
--user 1000:1000 \
git.uphillsecurity.com/cf7/aukpad-paste-proxy:latest
```
_Replace 'podman' with 'docker'._
---
## 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