rslocal

English | 中文

What is rslocal?

Rslocal is like ngrok built in Rust, it builds a tunnel to localhost.

Project status

• [x] support http
• [x] support tcp
• [ ] support udp
• [x] support token login
• [ ] support oidc login
• [ ] disconnection reconnect
• [ ] access log for client

Rslocal

A client program that runs locally to receive server requests and forward them to local services

Installation

MacOS

shell brew install saltbo/bin/rslocal

OtherOS (Does not support Windows for the time being. You need to download it manually.)

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

Usage

shell rslocal config rslocal http 8000 rslocal tcp 18000

Rslocald

Server program that receives external requests and forwards them to rslocal

Cloud-service

Visit localtest.rs

Self-hosted

```shell 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 ```

Configfile

The rslocald.toml file is required for rslocald.

```toml [core] debug = false bindaddr = "0.0.0.0:8422" authmethod = "token" # token, oidc allow_ports = "18000-19000"

[http] bindaddr = "0.0.0.0:8423" defaultdomain = "example.com"

default_static = "/etc/rslocal/webroot" # support later

[tokens] bob = "rslocaldabc11" alice = "rslocaldabc32"

[oidc]

issuer = ""

audience = ""

```

Contributing

1. write code for the todo and fixme tag
2. implement the unchecked item of the Project status

Special thanks

• rust_zh
• bdbai
• spacemeowx2
• Pop

License

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