Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/amalshaji/beaver
Tunnel local ports to public URLs
https://github.com/amalshaji/beaver
localtunnel ngrok ngrok-alternative ngrok-replacement tunnel-client tunnel-server
Last synced: 2 months ago
JSON representation
Tunnel local ports to public URLs
- Host: GitHub
- URL: https://github.com/amalshaji/beaver
- Owner: amalshaji
- License: mit
- Created: 2023-02-04T04:13:37.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-11T23:21:11.000Z (about 1 year ago)
- Last Synced: 2024-06-21T20:05:51.431Z (7 months ago)
- Topics: localtunnel, ngrok, ngrok-alternative, ngrok-replacement, tunnel-client, tunnel-server
- Language: Go
- Homepage: https://github.com/amalshaji/beaver/wiki
- Size: 512 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Beaver
> **Warning**
> ⚠️⚠️ This project is in a very early stage, the APIs might break during the alpha stage. Please use with caution ⚠️⚠️
## Client
### Install
Using homebrew
```shell
➜ brew tap amalshaji/taps
➜ brew install beaver
```
Or, download the binary from the [releases page](https://github.com/amalshaji/beaver/releases)
### Usage
Once the client is installed, run:
```shell
➜ beaver config --init
```
This creates a basic config at `$HOME/.beaver/beaver_client.yaml`,
```yaml
target:
secretkey:
tunnels:
- name: tunnel-1
subdomain: subdomain-1
port: 8000
```
Update your `target` and `secretKey`, and you're ready to go.
## Server
> [Deploying the server using caddy and cloudflare](https://github.com/amalshaji/beaver/wiki/Deploying-the-server-using-caddy)
### Deploy
1. Using docker
```shell
docker run \
-v $PWD/docs/beaver_server.yaml:/app/config/beaver_server.yaml \
-v $PWD/data:/app/data/ \
-p 8080:8080 --restart unless-stopped amalshaji/beaver:0.3.0-alpha.1
```
Replace `$PWD/docs/beaver_server.yaml` with path to your config file
1. Using docker compose
```yaml
services:
beaver:
image: amalshaji/beaver:0.3.0-alpha.1
volumes:
- ./docs/beaver_server.yaml:/app/config/beaver_server.yaml
- ./data:/app/data/
ports:
- 8080:8080
restart: unless-stopped
```
Start the server:
```shell
docker compose up -d
```
### Config
```yaml
# beaver_server.yaml
host : 0.0.0.0 # Address to bind the HTTP server
port : 8080 # Port to bind the HTTP server
domain: localhost # Domain on which the server will be running (eg: tunnel.example.com)
secure: false # Whether the server runs under https
timeout : 3000 # Time to wait before acquiring a WS connection to forward the request (milliseconds)
idletimeout : 60000 # Time to wait before closing idle connection when there is enough idle connections (milliseconds)
```
## Credits
This project is a fork of [hgsgtk/wsp](https://github.com/hgsgtk/wsp)