ADD more installation instructions and clean up README #1
This commit is contained in:
parent
a4d6d7feb9
commit
d402fa3f02
1 changed files with 12 additions and 32 deletions
44
README.md
44
README.md
|
|
@ -1,26 +1,16 @@
|
||||||
# Aukpad Paste Proxy
|
# Aukpad Paste Proxy
|
||||||
|
|
||||||
This proxy allows the paste creation from temporary aukpads via linedump. Can be used as a 'GUI' for linedump.
|
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.
|
||||||
|
|
||||||
- Status: Beta - Docs missing, not suited for current linedump version
|
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Features
|
|
||||||
|
|
||||||
**Available**:
|
|
||||||
|
|
||||||
**Ideas**:
|
|
||||||
|
|
||||||
**Not planned**:
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
- Create a pad in aukpad.
|
- Create a pad in your aukpad instance of choice.
|
||||||
- Change the domain of the pad from `aukpad.com` `bin.aukpad.com`
|
- 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
|
||||||
- Create new paste in linedump instance and get redirected
|
- 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.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -35,35 +25,25 @@ This proxy allows the paste creation from temporary aukpads via linedump. Can be
|
||||||
| `PROXY_BASEURL` | This proxy's base URL for documentation including protocol | `https://bin.aukpad.com` |
|
| `PROXY_BASEURL` | This proxy's base URL for documentation including protocol | `https://bin.aukpad.com` |
|
||||||
|
|
||||||
|
|
||||||
### Manual Container Run
|
### Docker / Podman
|
||||||
|
|
||||||
```bash
|
```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
|
# Example with Podman
|
||||||
podman run --name aukpad-paste-proxy \
|
podman run -d --name aukpad-paste-proxy \
|
||||||
--replace \
|
--replace \
|
||||||
-p 127.0.0.1:8001:8000 \
|
-p 127.0.0.1:8001:8000 \
|
||||||
-e PAD_BASEURL="https://aukpad.com" \
|
-e PAD_BASEURL="https://aukpad.com" \
|
||||||
-e DUMP_BASEURL="https://linedump.com" \
|
-e DUMP_BASEURL="https://linedump.com" \
|
||||||
-e PROXY_BASEURL="http://127.0.0.1:8001" \
|
-e PROXY_BASEURL="https://bin.aukpad.com" \
|
||||||
--read-only \
|
--read-only \
|
||||||
--security-opt no-new-privileges:true \
|
--security-opt no-new-privileges:true \
|
||||||
--cap-drop ALL \
|
--cap-drop ALL \
|
||||||
--user 1000:1000 \
|
--user 1000:1000 \
|
||||||
-d localhost/aukpad-proxy:dev
|
git.uphillsecurity.com/cf7/aukpad-paste-proxy:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
|
_Replace 'podman' with 'docker'._
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Security
|
## Security
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue