Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jkuri/bore
Reverse HTTP/TCP proxy to help you expose a local server behind a NAT or firewall to the internet via secure SSH tunnels.
https://github.com/jkuri/bore
localtunnel ngrok ssh ssh-server tunnel tunnel-client tunnel-server tunneling
Last synced: 22 days ago
JSON representation
Reverse HTTP/TCP proxy to help you expose a local server behind a NAT or firewall to the internet via secure SSH tunnels.
- Host: GitHub
- URL: https://github.com/jkuri/bore
- Owner: jkuri
- License: mit
- Created: 2020-06-28T22:14:15.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T13:21:11.000Z (8 months ago)
- Last Synced: 2024-08-01T12:23:14.208Z (3 months ago)
- Topics: localtunnel, ngrok, ssh, ssh-server, tunnel, tunnel-client, tunnel-server, tunneling
- Language: Go
- Homepage: https://bore.digital
- Size: 1.62 MB
- Stars: 70
- Watchers: 6
- Forks: 8
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - jkuri/bore - Reverse HTTP/TCP proxy to help you expose a local server behind a NAT or firewall to the internet via secure SSH tunnels. (others)
README
bore
Reverse HTTP/TCP proxy tunnel via secure SSH connections.
## Installation
You can download prebuild binaries [here](https://github.com/jkuri/bore/releases).
### Build from source
First, clone the repository
```sh
git clone https://github.com/jkuri/bore.git
```
Then install client:
```sh
make install_dependencies
make
cp ./build/bore /usr/local/bin/bore
```
This will compile and install `bore` client locally.
## Establish tunnel on hosted bore.digital
Let's say you are running HTTP server locally on port 6500, then command would be:
```sh
bore -s bore.digital -p 2200 -ls localhost -lp 6500
```
2200 is port where bore-server is running and localhost:6500 is local HTTP server.
Example output:
```sh
bore -s bore.digital -p 2200 -ls localhost -lp 6500
Generated HTTP URL: http://918574de.bore.digital
Generated HTTPS URL: https://918574de.bore.digital
Direct TCP: tcp://bore.digital:60637
```
Then open generated URL in the browser to check if it works, then share the URL if needed.
You can also request custom id instead of randomly generated one:
```sh
bore -lp 6500 -id myapp
Generated HTTP URL: http://myapp.bore.digital
Generated HTTPS URL: https://myapp.bore.digital
Direct TCP: tcp://bore.digital:55474
```
If custom requested ID is already taken, then random id is used.
You can also specify custom remote bind listening port, which is useful for using direct TCP connection:
```sh
bore -lp 6500 -bp 55000
Generated HTTP URL: http://fe2d57f3.bore.digital
Generated HTTPS URL: https://fe2d57f3.bore.digital
Direct TCP: tcp://bore.digital:55000
```
Note that for hosted bore you need to specify port in range 55000-65000.
If port is already taken, random port is used.
## Running Server
### Run Compilation
```sh
make install_dependencies
make
```
### Running bore-server example
```sh
BORE_DOMAIN=bore.digital BORE_HTTPADDR=0.0.0.0:80 BORE_SSHADDR=0.0.0.0:2200 ./build/bore-server
```
This will generate initial config at `~/bore/bore-server.yaml` with values you provided over environment variables.
## License
```license
MIT License
Copyright (c) 2020-2023 Jan Kuri
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```