{"id":13496056,"url":"https://github.com/bonaysoft/rslocal","last_synced_at":"2025-10-07T21:21:03.566Z","repository":{"id":46102176,"uuid":"484417982","full_name":"bonaysoft/rslocal","owner":"bonaysoft","description":"An easy-to-use tunnel to localhost built in Rust. An alternative to ngrok and frp.","archived":false,"fork":false,"pushed_at":"2022-05-13T03:42:07.000Z","size":119,"stargazers_count":236,"open_issues_count":0,"forks_count":15,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-03T03:33:04.094Z","etag":null,"topics":["frp","grpc","network","ngrok","nps","proxy","rust","tunnel"],"latest_commit_sha":null,"homepage":"https://localtest.rs/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bonaysoft.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":["saltbo"],"patreon":"saltbo","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2022-04-22T12:02:56.000Z","updated_at":"2025-06-17T06:24:18.000Z","dependencies_parsed_at":"2022-08-31T05:40:19.619Z","dependency_job_id":null,"html_url":"https://github.com/bonaysoft/rslocal","commit_stats":null,"previous_names":["saltbo/rslocal"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/bonaysoft/rslocal","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonaysoft%2Frslocal","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonaysoft%2Frslocal/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonaysoft%2Frslocal/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonaysoft%2Frslocal/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bonaysoft","download_url":"https://codeload.github.com/bonaysoft/rslocal/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bonaysoft%2Frslocal/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263415895,"owners_count":23463107,"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":["frp","grpc","network","ngrok","nps","proxy","rust","tunnel"],"created_at":"2024-07-31T19:01:41.622Z","updated_at":"2025-10-07T21:21:03.511Z","avatar_url":"https://github.com/bonaysoft.png","language":"Rust","funding_links":["https://github.com/sponsors/saltbo","https://patreon.com/saltbo"],"categories":["Rust"],"sub_categories":[],"readme":"# rslocal\n\n[English](README.md) | [中文](README_zh.md)\n\n[![](https://github.com/saltbo/rslocal/workflows/build/badge.svg)](https://github.com/saltbo/rslocal/actions?query=workflow%3Abuild)\n[![](https://img.shields.io/crates/v/rslocal.svg?color=orange)](https://crates.io/crates/rslocal)\n[![](https://img.shields.io/github/v/release/saltbo/rslocal.svg?color=brightgreen)](https://github.com/saltbo/rslocal/releases)\n[![](https://img.shields.io/github/license/saltbo/rslocal?color=blue)](https://github.com/saltbo/rslocal/blob/master/LICENSE)\n\n## What is rslocal?\n\nRslocal is like ngrok built in Rust, it builds a tunnel to localhost.\n\n## Project status\n\n- [x] support http\n- [x] support tcp\n- [ ] support udp\n- [x] support token login\n- [ ] support oidc login\n- [ ] disconnection reconnect\n- [ ] access log for client\n\n## Rslocal\n\nA client program that runs locally to receive server requests and forward them to local services\n\n### Installation\n\nMacOS\n\n```shell\nbrew install saltbo/bin/rslocal\n```\n\nOtherOS (Does not support Windows for the time being. You need to [download it manually](https://github.com/saltbo/rslocal/releases).)\n\n```shell\ncurl -sSf https://raw.githubusercontent.com/saltbo/rslocal/master/install.sh | sh\n```\n\n### Usage\n\n```shell\nrslocal config\nrslocal http 8000\nrslocal http 8000 --subdomain test\nrslocal tcp 8000\n```\n\n## Rslocald\n\nServer program that receives external requests and forwards them to `rslocal`\n\n### Cloud-service\n\nVisit [localtest.rs](https://localtest.rs)\n\n### Self-hosted\n\n```shell\nmkdir /etc/rslocal\ntouch /etc/rslocal/rslocald.toml\n#edit your config like example configfile\n\ndocker run -it -p 8422:8422 -p 8423:8423 -v /etc/rslocal:/etc/rslocal saltbo/rslocald\n```\n\n### Configfile\n\nThe `rslocald.toml` file is required for `rslocald`.\n\n```toml\n[core]\ndebug = false\nbind_addr = \"0.0.0.0:8422\"\nauth_method = \"token\"  # token, oidc\nallow_ports = \"18000-19000\"\n\n[http]\nbind_addr = \"0.0.0.0:8423\"\ndefault_domain = \"example.com\"\n# default_static = \"/etc/rslocal/webroot\" # support later\n\n[tokens]\nbob = \"rslocald_abc11\"\nalice = \"rslocald_abc32\"\n\n#[oidc]\n#issuer = \"\"\n#audience = \"\"\n```\n\n## Contributing\n\n1. write code for the todo and fixme tag\n2. implement the unchecked item of the Project status\n\n## Special thanks\n\n- [rust_zh](https://t.me/rust_zh)\n- [bdbai](https://github.com/bdbai)\n- [spacemeowx2](https://github.com/spacemeowx2)\n- [Pop](https://github.com/George-Miao)\n\n## License\n\nrslocal is under the Apache-2.0 license. See the [LICENSE](/LICENSE) file for details.\n\n[![Stargazers over time](https://starchart.cc/saltbo/rslocal.svg)](https://starchart.cc/saltbo/rslocal)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbonaysoft%2Frslocal","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbonaysoft%2Frslocal","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbonaysoft%2Frslocal/lists"}