MCPcopy Index your code
hub / github.com/bonaysoft/rslocal

github.com/bonaysoft/rslocal @v0.1.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.1.0 ↗ · + Follow
73 symbols 112 edges 14 files 2 documented · 3%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

rslocal

English | 中文

rslocal是什么?

Rslocal是一个类似ngrok的Rust实现,使用它可以很方便的构建一条内网穿透隧道。

项目状态

  • [x] 支持HTTP协议
  • [x] 支持TCP协议
  • [ ] 支持UDP协议
  • [x] 支持Token登录
  • [ ] 支持OIDC登录
  • [ ] 支持连接断开重连
  • [ ] 客户端支持输出访问日志

Rslocal

运行在本地的客户端程序,用于接收服务器请求并转发给本地的服务

安装

Mac用户

brew install saltbo/bin/rslocal

其他用户(该脚本暂不支持Windows,需要手动下载

curl -sSf https://raw.githubusercontent.com/saltbo/rslocal/master/install.sh | sh

使用

rslocal config
rslocal http 8000
rslocal tcp 18000

Rslocald

服务端程序,用于接收外部请求并转发给rslocal

云服务

访问 localtest.rs 了解详情

自建服务

mkdir /etc/rslocal
touch /etc/rslocal/rslocald.toml
#edit your config like example configfile
docker run -it -p 8422:8422 -p 8423:8423 -v /etc/rslocal:/etc/rslocal saltbo/rslocald

服务端配置文件样例

[core]
[core]
debug = false
bind_addr = "0.0.0.0:8422"
auth_method = "token"  # token, oidc
allow_ports = "18000-19000"

[http]
bind_addr = "0.0.0.0:8423"
default_domain = "localtest.me:8423"
#default_static = "/etc/rslocal/webroot"

[tokens]
bob = "rslocald_abc11"
alice = "rslocald_abc32"

#[oidc]
#issuer = ""
#audience = ""

参与贡献

  1. 搜索代码中的todo和fixme标记,解决它
  2. 实现项目状态中没有打钩的选项

特别感谢

开源协议

rslocal is under the Apache-2.0 license. See the LICENSE file for details.

Stargazers over time

Core symbols most depended-on inside this repo

default
called by 10
src/client/config.rs
random_string
called by 4
src/lib.rs
start
called by 2
src/client/client.rs
event_handler
called by 2
src/server/tcp.rs
transfer
called by 2
src/server/tcp.rs
build_tunnel
called by 2
src/bin/rslocal.rs
wrapper
called by 2
src/bin/rslocal.rs
load
called by 1
src/client/config.rs

Shape

Method 38
Class 18
Function 14
Enum 3

Languages

Rust100%

Modules by API surface

src/server/http.rs13 symbols
src/server/grpc.rs12 symbols
src/client/client.rs11 symbols
src/server/tcp.rs7 symbols
src/lib.rs7 symbols
src/server/tunnel.rs5 symbols
src/bin/rslocal.rs5 symbols
src/server/config.rs4 symbols
src/server/transport.rs3 symbols
src/client/config.rs3 symbols
src/bin/rslocald.rs2 symbols
build.rs1 symbols

For agents

$ claude mcp add rslocal \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page