init

README.md

@@ -0,0 +1,68 @@
+# Project Name
+
+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
+
+WIP
+
+```bash
+$CONTAINER_CMD run --name ${CONTAINER_NAME} \
+    -p 127.0.0.1:${PORT_HOST}:${PORT_CONTAINER} \
+    -e PAD_DOMAIN="${PAD_DOMAIN}" \
+    -e DUMP_DOMAIN="${DUMP_DOMAIN}" \
+    -e PROXY_DOMAIN="${PROXY_DOMAIN}" \
+    --read-only \
+    --security-opt no-new-privileges:true \
+    --cap-drop ALL \
+    --user 1000:1000 \
+    -d ${IMAGE_NAME}:latest
+```
+
+---
+
+## 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