Skip to content

Commit

Permalink
docs(ws): updating README and other relevant docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@dhruvinsh
dhruvinsh committed Nov 6, 2023
1 parent 88c7f60 commit 33c08c1
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 30 deletions.
4 changes: 3 additions & 1 deletion .env.example
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
WS_USERNAME=xxxx
WS_PASSWORD=xxxx
WS_DEBUG=False
WS_COOKIE_PATH=/some/mounted/volume/
QBIT_USERNAME=xxxx
QBIT_PASSWORD=xxxx
QBIT_HOST=https://asf.sf.dsa
QBIT_PORT=443
QBIT_PRIVATE_TRACKER=false
DAYS=6
TIME=02:00
ONESHOT=false
ONESHOT=False
REQUEST_TIMEOUT=10
60 changes: 32 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,30 +1,29 @@
# WS-EPHEMERAL

This project aims to automate setting up ephemeral port on windscribe VPN service for the purpose of port forwarding. Once the setup is done it wait patiently for next seven days. It delete the ephemeral port setting if any and set the new one. Useful for some torrent application which are running behind windscribe VPN and need to open the ports.
This project aims to automate setting up ephemeral port on Windscribe VPN
service for the purpose of port forwarding. Once the setup is done it wait
patiently for next seven days. It delete the ephemeral port setting if any and
set the new one. Useful for some torrent application which are running behind
Windscribe VPN and need to open the ports.

## Docker Setup

**NOTE**: updating to latest version will not break existing system but it is not advice to use it any longer. Proper environment values (see below) need to be set for qbit.

**V1 setup (NOT ADVISED TO USE ANYMORE)**

```bash
docker run -e WS_USERNAME=username -e WS_PASSWORD=password -e dhruvinsh/ws-ephemeral:latest
```

**V2 setup**
**NOTE: V1 is deprecated now and note supported.**

```bash
docker run \
-e WS_USERNAME=username \
-e WS_PASSWORD=password \
-e WS_DEBUG=False \
-e WS_COOKIE_PATH=/cookie
-e QBIT_USERNAME=username \
-e QBIT_PASSWORD=password \
-e QBIT_HOST=http://192.168.1.10 \
-e QBIT_PORT=8080 \
-e QBIT_PRIVATE_TRACKER=true \
-e ONESHOT=false \
-e REQUEST_TIMEOUT=10 \
-v /home/user/appdata/:/cookie
dhruvinsh/ws-ephemeral:latest
```

Expand All @@ -38,26 +37,29 @@ docker compose up -d

Available tags for docker image:

| Tag | Container Type |
| ------ | ---------------------------------------------------------------------------------- |
| latest | most recent changes straight from main branch |
| 2.x.x | Specific build from v2 with qbit and matching port support |
| 1.x.x | Specific build from v1 with no qbit or matching port support (in maintenance mode) |
| x | specific major versoin with all patches |
| Tag | Container Type |
| ------ | ---------------------------------------------------------- |
| latest | most recent changes straight from main branch |
| 3.x.x | Persistent cookie support added |
| 2.x.x | Specific build from v2 with qbit and matching port support |
| 1.x.x | DEPRECATED |
| x | specific major versoin with all patches |

### Environment Variables

| Variable | Comment | Applicable Version |
| -------------------- | -------------------------------------------------------------------------------- | ------------------ |
| WS_USERNAME | WS username | v1.x.x and v2.x.x |
| WS_PASSWORD | WS password | v1.x.x and v2.x.x |
| QBIT_USERNAME | QBIT username | v2.x.x |
| QBIT_PASSWORD | QBIT password | v2.x.x |
| QBIT_HOST | QBIT web address like, https://qbit.xyz.com or http://192.168.1.10 | v2.x.x |
| QBIT_PORT | QBIT web port number like, 443 or 8080 | v2.x.x |
| QBIT_PRIVATE_TRACKER | get QBIT ready for private tracker by disabling dht, pex and lsd (true or false) | v2.x.x |
| ONESHOT | Run and setup the code only one time so that job can be schedule externally | v2.x.x |
| REQUEST_TIMEOUT | configurable http api timeout for slow network/busy websites | v2.x.x |
| Variable | Comment |
| -------------------- | -------------------------------------------------------------------------------- |
| WS_USERNAME | WS username |
| WS_PASSWORD | WS password |
| WS_DEBUG | Enable Debug logging |
| WS_COOKIE_PATH | Persistent location for the cookie. (v3.x.x only) |
| QBIT_USERNAME | QBIT username |
| QBIT_PASSWORD | QBIT password |
| QBIT_HOST | QBIT web address like, https://qbit.xyz.com or http://192.168.1.10 |
| QBIT_PORT | QBIT web port number like, 443 or 8080 |
| QBIT_PRIVATE_TRACKER | get QBIT ready for private tracker by disabling dht, pex and lsd (true or false) |
| ONESHOT | Run and setup the code only one time so that job can be schedule externally |
| REQUEST_TIMEOUT | configurable http api timeout for slow network/busy websites |

> NOTE: for usage see [Docker Setup](#docker-setup) v2 setup guide.
Expand All @@ -71,7 +73,9 @@ Located [here](./CHANGELOG.md)

## Privacy

I assure you that nothing is being collected or logged. Your credentials are safe and set via environment variable only. Still If you have further questions or concerns, please open an issue here.
I assure you that nothing is being collected or logged. Your credentials are
safe and set via environment variable only. Still If you have further questions
or concerns, please open an issue here.

## License

Expand Down
4 changes: 3 additions & 1 deletion docker-compose.yaml
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
version: "3.8"

service:
services:
ws-ephemeral:
container_name: ws-ephemeral
image: dhruvinsh/ws-ephemeral:latest
env_file: .env.example
restart: unless-stopped
volumes:
- /home/user/appdata:/cookie

0 comments on commit 33c08c1

Please sign in to comment.