{"id":13468974,"url":"https://github.com/agrinman/tunnelto","last_synced_at":"2025-05-14T02:03:58.535Z","repository":{"id":38541389,"uuid":"249120770","full_name":"agrinman/tunnelto","owner":"agrinman","description":"Expose your local web server to the internet with a public URL.","archived":false,"fork":false,"pushed_at":"2022-09-24T21:28:44.000Z","size":305,"stargazers_count":2169,"open_issues_count":46,"forks_count":119,"subscribers_count":28,"default_branch":"master","last_synced_at":"2025-04-29T04:08:04.124Z","etag":null,"topics":["async-io","expose","localhost","rust","tunnel"],"latest_commit_sha":null,"homepage":"https://tunnelto.dev","language":"Rust","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/agrinman.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}},"created_at":"2020-03-22T05:39:49.000Z","updated_at":"2025-04-27T12:58:22.000Z","dependencies_parsed_at":"2022-08-09T04:31:55.316Z","dependency_job_id":null,"html_url":"https://github.com/agrinman/tunnelto","commit_stats":null,"previous_names":["agrinman/wormhole"],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrinman%2Ftunnelto","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrinman%2Ftunnelto/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrinman%2Ftunnelto/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/agrinman%2Ftunnelto/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/agrinman","download_url":"https://codeload.github.com/agrinman/tunnelto/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254052667,"owners_count":22006716,"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":["async-io","expose","localhost","rust","tunnel"],"created_at":"2024-07-31T15:01:23.159Z","updated_at":"2025-05-14T02:03:58.480Z","avatar_url":"https://github.com/agrinman.png","language":"Rust","funding_links":[],"categories":["Rust","Applications","HarmonyOS","rust"],"sub_categories":["Web","Windows Manager"],"readme":"\u003cp align=\"center\" \u003e\n\u003cimg width=\"540px\" src=\"https://repository-images.githubusercontent.com/249120770/7ea6d180-b4ba-11ea-96ab-6c3b987aac9d\" align=\"center\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e    \n  \u003ca href=\"https://github.com/agrinman/tunnelto/actions?query=workflow%3A%22Build+and+Release%22\"\u003e\u003cimg src=\"https://github.com/agrinman/wormhole/workflows/Build%20and%20Release/badge.svg\" alt=\"BuildRelease\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://crates.io/crates/wormhole-tunnel\"\u003e\u003cimg src=\"https://img.shields.io/crates/v/tunnelto\" alt=\"crate\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/agrinman/tunnelto/packages/295195\"\u003e\u003cimg src=\"https://img.shields.io/docker/v/agrinman/wormhole?label=Docker\" alt=\"GitHub Docker Registry\"\u003e\u003c/a\u003e \n  \u003ca href=\"https://twitter.com/alexgrinman\"\u003e\u003cimg src=\"https://img.shields.io/twitter/follow/alexgrinman?label=%40AlexGrinman\" alt=\"crate\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# `tunnelto`\n`tunnelto` lets you expose your locally running web server via a public URL.\nWritten in Rust. Built completely with async-io on top of tokio.\n\n1. [Install](#install)\n2. [Usage Instructions](#usage)\n3. [Host it yourself](#host-it-yourself)\n\n# Install\n## Brew (macOS)\n```bash\nbrew install agrinman/tap/tunnelto\n```\n\n## Cargo\n```bash\ncargo install tunnelto\n```\n\n## Everywhere\nOr **Download a release for your target OS here**: [tunnelto/releases](https://github.com/agrinman/tunnelto/releases)\n\n# Usage\n## Quick Start\n```shell script\ntunnelto --port 8000\n```\nThe above command opens a tunnel and forwards traffic to `localhost:8000`.\n\n## More Options:\n```shell script\ntunnelto 0.1.14\n\nUSAGE:\n    tunnelto [FLAGS] [OPTIONS] [SUBCOMMAND]\n\nFLAGS:\n    -h, --help       Prints help information\n    -V, --version    Prints version information\n    -v, --verbose    A level of verbosity, and can be used multiple times\n\nOPTIONS:\n        --dashboard-address \u003cdashboard-address\u003e    Sets the address of the local introspection dashboard\n    -k, --key \u003ckey\u003e                                Sets an API authentication key to use for this tunnel\n        --host \u003clocal-host\u003e\n            Sets the HOST (i.e. localhost) to forward incoming tunnel traffic to [default: localhost]\n\n    -p, --port \u003cport\u003e\n            Sets the port to forward incoming tunnel traffic to on the target host\n\n        --scheme \u003cscheme\u003e\n            Sets the SCHEME (i.e. http or https) to forward incoming tunnel traffic to [default: http]\n\n    -s, --subdomain \u003csub-domain\u003e                   Specify a sub-domain for this tunnel\n\nSUBCOMMANDS:\n    help        Prints this message or the help of the given subcommand(s)\n    set-auth    Store the API Authentication key\n```\n\n# Host it yourself\n1. Compile the server for the musl target. See the `musl_build.sh` for a way to do this trivially with Docker!\n2. See `Dockerfile` for a simple alpine based image that runs that server binary.\n3. Deploy the image where ever you want.\n\n## Testing Locally\n```shell script\n# Run the Server: xpects TCP traffic on 8080 and control websockets on 5000\nALLOWED_HOSTS=\"localhost\" cargo run --bin tunnelto_server\n\n# Run a local tunnelto client talking to your local tunnelto_server\nCTRL_HOST=\"localhost\" CTRL_PORT=5000 CTRL_TLS_OFF=1 cargo run --bin tunnelto -- -p 8000\n\n# Test it out!\n# Remember 8080 is our local tunnelto TCP server\ncurl -H '\u003csubdomain\u003e.localhost' \"http://localhost:8080/some_path?with=somequery\"\n```\nSee `tunnelto_server/src/config.rs` for the environment variables for configuration.\n\n## Caveats for hosting it yourself\nThe implementation does not support multiple running servers (i.e. centralized coordination).\nTherefore, if you deploy multiple instances of the server, it will only work if the client connects to the same instance\nas the remote TCP stream.\n\nThe [version hosted by us](https://tunnelto.dev) is a proper distributed system running on the the fabulous [fly.io](https://fly.io) service. \nIn short, fly.io makes this super easy with their [Private Networking](https://fly.io/docs/reference/privatenetwork/) feature.\nSee `tunnelto_server/src/network/mod.rs` for the implementation details of our gossip mechanism.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagrinman%2Ftunnelto","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagrinman%2Ftunnelto","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagrinman%2Ftunnelto/lists"}