Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zhu327/workers-tunnel
Edge network tunnel implemented using Cloudflare Workers.
https://github.com/zhu327/workers-tunnel
cloudflare-workers proxy rust vless webassembly websocket
Last synced: 6 days ago
JSON representation
Edge network tunnel implemented using Cloudflare Workers.
- Host: GitHub
- URL: https://github.com/zhu327/workers-tunnel
- Owner: zhu327
- License: mit
- Created: 2023-08-10T12:52:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-13T11:18:58.000Z (19 days ago)
- Last Synced: 2025-01-18T23:28:24.110Z (13 days ago)
- Topics: cloudflare-workers, proxy, rust, vless, webassembly, websocket
- Language: Rust
- Homepage:
- Size: 26.4 KB
- Stars: 111
- Watchers: 2
- Forks: 90
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# workers-tunnel
[](https://deploy.workers.cloudflare.com/?url=https://github.com/zhu327/workers-tunnel/tree/main)
Edge network tunnel implemented using Cloudflare Workers.
It is recommended to use Xray as the tunnel client.
Use the following rules to split traffic by file and route Cloudflare IP directly.
Due to the limitations of Cloudflare Workers, UDP proxy is not supported, and it is not possible to use proxy to connect to Cloudflare's IP addresses. It is recommended to use the following routing configuration to establish a direct connection to Cloudflare's IP addresses.
Replace the domain `your.domain.workers.dev` in the following configuration with your Cloudflare Workers domain.
```json
{
"log": {
"loglevel": "warning"
},
"inbounds": [
{
"port": 1080,
"protocol": "socks",
"sniffing": {
"enabled": true,
"destOverride": [
"http",
"tls"
]
},
"settings": {
"auth": "noauth"
}
}
],
"outbounds": [
{
"settings": {
"vnext": [
{
"port": 443,
"users": [
{
"id": "c55ba35f-12f6-436e-a451-4ce982c4ec1c",
"encryption": "none"
}
],
"address": "your.domain.workers.dev"
}
]
},
"protocol": "vless",
"streamSettings": {
"network": "ws",
"tlsSettings": {
"serverName": "your.domain.workers.dev",
"allowInsecure": true,
"fingerprint": "chrome"
},
"wsSettings": {
"headers": {
"Host": "your.domain.workers.dev"
},
"path": "ws?ed=512"
},
"security": "tls"
}
},
{
"protocol": "freedom",
"settings": {},
"tag": "direct"
}
],
"routing": {
"domainStrategy": "IPIfNonMatch",
"rules": [
{
"type": "field",
"outboundTag": "direct",
"domain": [
"geosite:cn"
]
},
{
"type": "field",
"outboundTag": "direct",
"ip": [
"geoip:cn",
"geoip:private",
"geoip:cloudflare"
]
}
]
}
}
```
Please refer to the following documentation for development and deployment.
**Important**: Before deployment, you need to modify the `vars` configuration in `wrangler.toml` and change `USER_ID` to your UUID.
```toml
[vars]
USER_ID = "c55ba35f-12f6-436e-a451-4ce982c4ec1c"
```
## Setup
To create a `my-project` directory using this template, run:
```sh
$ npm init cloudflare my-project workers-tunnel
# or
$ yarn create cloudflare my-project workers-tunnel
# or
$ pnpm create cloudflare my-project workers-tunnel
```
> **Note:** Each command invokes [`create-cloudflare`](https://www.npmjs.com/package/create-cloudflare) for project creation.
## Usage
This template starts you off with a `src/lib.rs` file, acting as an entrypoint for requests hitting your Worker. Feel free to add more code in this file, or create Rust modules anywhere else for this project to use.
With `wrangler`, you can build, test, and deploy your Worker with the following commands:
```sh
# run your Worker in an ideal development workflow (with a local server, file watcher & more)
$ npm run dev
# deploy your Worker globally to the Cloudflare network (update your wrangler.toml file for configuration)
$ npm run deploy
```
Read the latest `worker` crate documentation here: https://docs.rs/worker
## WebAssembly
`workers-rs` (the Rust SDK for Cloudflare Workers used in this template) is meant to be executed as compiled WebAssembly, and as such so **must** all the code you write and depend upon. All crates and modules used in Rust-based Workers projects have to compile to the `wasm32-unknown-unknown` triple.
Read more about this on the [`workers-rs`](https://github.com/cloudflare/workers-rs) project README.
## Issues
If you have any problems with the `worker` crate, please open an issue on the upstream project issue tracker on the [`workers-rs` repository](https://github.com/cloudflare/workers-rs).