WS-EPHEMERAL

[!WARNING] Please use this tool responsibly. Excessive or inappropriate usage may result in temporary suspension of your account. Due to lack of time I will try to revisit sometime in future but I strongly advice to let it run at default pace, that is once every week. For new user cookie generation might fail at the beginning, please try again after some time once you delete partially created cookie.

[!NOTE] Current State of the Project: There are upstream web changes affecting this project. I am also suffering from issue and I would like implement fixes but lack of time its not possible at the moment. I plan to get back to it as soon as possible.

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

[!important] NOTE: V1 is deprecated and should not be used.

Registries

There are two registries available:

• dhruvinsh/ws-ephemeral
• ghcr.io/dhruvinsh/ws-ephemeral

Tags

Available tags for docker image (based on semver):

Deploy

Cli

docker run \
-e ONESHOT=false \
-e QBIT_HOST=http://192.168.1.10 \
-e QBIT_PASSWORD=password \
-e QBIT_PORT=8080 \
-e QBIT_PRIVATE_TRACKER=true \
-e QBIT_USERNAME=username \
-e REQUEST_TIMEOUT=10 \
-e WS_COOKIE_PATH=/cookie \
-e WS_DEBUG=False \
-e WS_PASSWORD=password \
-e WS_USERNAME=username \
-e WS_TOPT=totp_token \
-v /path/to/local/data:/cookie \
dhruvinsh/ws-ephemeral:latest

Docker-compose

Docker compose file is provided for example, make some adjustment and run as,

docker compose up -d

Environment Variables

[!tip] NOTE: for usage see Docker Setup v2 setup guide.

Unraid Setup

Unraid template is now available under community application.

Changelog

Located here

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.

Roadmap

• Support 2FA, #19
• Daemon mode and job mode
  • Rest API (useful for cron/script job)
  • Separate port renewal, qbittorrent update and private tracker logic
  • Random job time for cron job #15
• Allow to run custom script (for now Bash script only) #12
• Support for deluge
• Gluetun support #2392

License

GPL3