{"id":24665080,"url":"https://github.com/alisawari/wstunnel-scripts","last_synced_at":"2026-05-02T18:41:03.699Z","repository":{"id":258813590,"uuid":"875728550","full_name":"AliSawari/wstunnel-scripts","owner":"AliSawari","description":"util scripts to manage and connect easier to wstunnel connections","archived":false,"fork":false,"pushed_at":"2024-10-24T19:20:03.000Z","size":7683,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-21T10:12:42.362Z","etag":null,"topics":["network","tunnel","websocket","wstunnel"],"latest_commit_sha":null,"homepage":"https://alisawari.github.io/wstunnel-scripts/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AliSawari.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-10-20T17:39:38.000Z","updated_at":"2024-11-03T10:07:54.000Z","dependencies_parsed_at":"2024-10-20T22:36:27.101Z","dependency_job_id":null,"html_url":"https://github.com/AliSawari/wstunnel-scripts","commit_stats":null,"previous_names":["alisawari/wstunnel-scripts"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/AliSawari/wstunnel-scripts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AliSawari%2Fwstunnel-scripts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AliSawari%2Fwstunnel-scripts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AliSawari%2Fwstunnel-scripts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AliSawari%2Fwstunnel-scripts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AliSawari","download_url":"https://codeload.github.com/AliSawari/wstunnel-scripts/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AliSawari%2Fwstunnel-scripts/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263437343,"owners_count":23466367,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["network","tunnel","websocket","wstunnel"],"created_at":"2025-01-26T06:28:36.009Z","updated_at":"2026-05-02T18:40:58.676Z","avatar_url":"https://github.com/AliSawari.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Wstunnel Scripts\n\nsimple server/client utility scripts to manage Wstunnel connections. ⚡\n\nboth windows and linux binaries are supplied from the [Wstunnel](https://github.com/erebe/wstunnel) repository.\nwhich is a Network Tunnel over WebSocket connection written in Rust.\n\n### Configure\n\nFirst you need the Wstunnel binaries. please download the latest binaries for your OS from [their release page](https://github.com/erebe/wstunnel/releases).\nand place them in this directory. (filename should be `wstunnel`)\n\nedit the files before using, each script contains `ip` `localPort` and `remotePort`. \nadditionally, for more security, each script reads the contents of a `secret.txt` that should be existing in the same folder as the scripts.\nthe contents of the file is supplied as an argument to `--restrict-http-upgrade-path-prefix` in order to accept certain connections and refuse the ones that don't have the secret\n\n**Server**\n\n```bash\n\nport=\"3113\"\ndns=\"1.1.1.1\"\n\n./wstunnel server --dns-resolver dns://$dns --restrict-http-upgrade-path-prefix $(cat secret.txt)  ws://0.0.0.0:$port\n\n```\n\nif you wish to run the server as a System Daemon(System D), copy the file `wstunnel-systemd.service` into `/etc/systemd/system`\nand then execute `sudo systemctl daemon-reload ` to load the systemd service. then you can start your service by running `sudo systemctl start wstunnel-systemd.service`\n\nNOTE: make sure you place the `wstunnel-scripts` folder under `/root` in your server. otherwise it won't work and you will need to change the paths in the files.\n\nyou must remember that the SystemD service file will run `systemd-command.sh` which is a bit different than the normal file.\n\n**Client**\n\non Linux edit `linux-client-command.sh` , \non Windows edit `windows-client-command.bat`\n\nmake sure the remote port and ip and content of `secret.txt` matches that of your server.\n\n\n### Execute \n\nonce configured and running on your server, use `linux-client-command.sh` to run the client on linux, or Double-Click `windows-client-command.bat` to run the \nWindows script, **Which will Open up a SOCKS5 Proxy on the specified `localPort`**\n\n### License\n\nThis Repo is under MIT License.\n\n\nHappy Hacking. 🥷\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falisawari%2Fwstunnel-scripts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Falisawari%2Fwstunnel-scripts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Falisawari%2Fwstunnel-scripts/lists"}