Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bonaysoft/rslocal
An easy-to-use tunnel to localhost built in Rust. An alternative to ngrok and frp.
https://github.com/bonaysoft/rslocal
frp grpc network ngrok nps proxy rust tunnel
Last synced: 13 days ago
JSON representation
An easy-to-use tunnel to localhost built in Rust. An alternative to ngrok and frp.
- Host: GitHub
- URL: https://github.com/bonaysoft/rslocal
- Owner: bonaysoft
- License: apache-2.0
- Created: 2022-04-22T12:02:56.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-05-13T03:42:07.000Z (over 2 years ago)
- Last Synced: 2024-08-09T13:13:24.600Z (3 months ago)
- Topics: frp, grpc, network, ngrok, nps, proxy, rust, tunnel
- Language: Rust
- Homepage: https://localtest.rs/
- Size: 116 KB
- Stars: 238
- Watchers: 4
- Forks: 14
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# rslocal
[English](README.md) | [中文](README_zh.md)
[](https://github.com/saltbo/rslocal/actions?query=workflow%3Abuild)
[](https://crates.io/crates/rslocal)
[](https://github.com/saltbo/rslocal/releases)
[](https://github.com/saltbo/rslocal/blob/master/LICENSE)
## 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](https://github.com/saltbo/rslocal/releases).)
```shell
curl -sSf https://raw.githubusercontent.com/saltbo/rslocal/master/install.sh | sh
```
### Usage
```shell
rslocal config
rslocal http 8000
rslocal http 8000 --subdomain test
rslocal tcp 8000
```
## Rslocald
Server program that receives external requests and forwards them to `rslocal`
### Cloud-service
Visit [localtest.rs](https://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
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 = "example.com"
# default_static = "/etc/rslocal/webroot" # support later
[tokens]
bob = "rslocald_abc11"
alice = "rslocald_abc32"
#[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](https://t.me/rust_zh)
- [bdbai](https://github.com/bdbai)
- [spacemeowx2](https://github.com/spacemeowx2)
- [Pop](https://github.com/George-Miao)
## License
rslocal is under the Apache-2.0 license. See the [LICENSE](/LICENSE) file for details.
[](https://starchart.cc/saltbo/rslocal)