readme: use markdown, add deployment examples

Signed-off-by: Gunwant Jain <mail@wantguns.dev>
This commit is contained in:
Gunwant Jain 2021-01-06 00:13:07 +05:30
parent 9780e01deb
commit 009972ae88

View File

@ -1,6 +1,7 @@
USAGE
Usage
-----
```plain
POST /
accepts raw data in the body of the request and responds with a URL
@ -13,10 +14,12 @@ USAGE
GET /p/<id>
retrieves the HTML page with syntax-highlighted content for the paste with id `<id>`
```
EXAMPLES
Examples
--------
```plain
Paste a file named 'file.txt' using cURL:
curl --data-binary @file.txt https://bin.wantguns.dev
@ -34,3 +37,38 @@ EXAMPLES
If the uploaded data binary is parsed as "text/*", then the paste will be syntax
highlighted
```
Deployment
----------
### Traefik
```yaml
## (... Traefik service configuration ...) ##
pastebin:
image: wantguns/bin
restart: always
container_name: pastebin
ports:
- 127.0.0.1:6162:6162
environment:
- ROCKET_PORT=6162
- THEME=
- HOST=${BIN_DOMAIN}
volumes:
- /path/to/local/upload:/app/upload
labels:
- "traefik.enable=true"
- "traefik.http.routers.pastebin.rule=Host(`${BIN_DOMAIN}`)"
- "traefik.http.routers.pastebin.entrypoints=secure"
- "traefik.http.routers.pastebin.tls.certresolver=le"
- "traefik.http.services.pastebin.loadbalancer.server.port=6162"
networks:
- bin_network
networks:
- bin_network
```