jakob/PairDrop
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix rate limit docs and set header hierarchy correctly

Browse source
This commit is contained in:
schlagmichdoch 2023-02-26 21:28:17 +01:00 committed by GitHub
parent 11d6a8a372
commit e96ca53aa4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
docs/host-your-own.md
View file

@ -13,23 +13,23 @@ docker run -d --restart=unless-stopped --name=pairdrop -p 127.0.0.1:3000:3000 ls
>
> To prevent bypassing the proxy by reaching the docker container directly, `127.0.0.1` is specified in the run command.
### Options / Flags
#### Options / Flags
Set options by using the following flags in the `docker run` command:
#### Port
##### Port
```
-p 127.0.0.1:8080:3000
```
> Specify the port used by the docker image
> - 3000 -> `-p 127.0.0.1:3000:3000`
> - 8080 -> `-p 127.0.0.1:8080:3000`
#### Rate limiting requests
##### Rate limiting requests
```
-e RATE_LIMIT=true
```
> Limits clients to 100 requests per 5 min
> Limits clients to 1000 requests per 5 min
#### Websocket Fallback (for VPN)
##### Websocket Fallback (for VPN)
```
-e WS_FALLBACK=true
```
@ -42,8 +42,6 @@ Set options by using the following flags in the `docker run` command:
> Beware that the traffic routed via this fallback is readable by the server. Only ever use this on instances you can trust.
> Additionally, beware that all traffic using this fallback debits the servers data plan.
<br>
### Docker Image from GHCR
```bash
docker run -d --restart=unless-stopped --name=pairdrop -p 127.0.0.1:3000:3000 ghcr.io/schlagmichdoch/pairdrop npm run start:prod
@ -76,7 +74,6 @@ docker run -d --restart=unless-stopped --name=pairdrop -p 127.0.0.1:3000:3000 -i
<br>
## Deployment with Docker Compose
Here's an example docker-compose file:
```yaml
@ -90,7 +87,7 @@ services:
- PUID=1000 # UID to run the application as
- PGID=1000 # GID to run the application as
- WS_FALLBACK=false # Set to true to enable websocket fallback if the peer to peer WebRTC connection is not available to the client.
- RATE_LIMIT=false # Set to true to limit clients to 100 requests per 5 min.
- RATE_LIMIT=false # Set to true to limit clients to 1000 requests per 5 min.
- TZ=Etc/UTC # Time Zone
ports:
- 127.0.0.1:3000:3000 # Web UI
@ -167,7 +164,7 @@ npm start -- --auto-restart
```bash
npm start -- --rate-limit
```
> Limits clients to 100 requests per 5 min
> Limits clients to 1000 requests per 5 min
<br>