coolaj86/telebit.js
1
2
Fork 1
Code Issues 48 Pull Requests 3 Releases Activity

clarify

Browse Source
This commit is contained in:
AJ ONeal 2018-06-08 09:58:44 -06:00
parent 49b28f83b8
commit 1f2175b854
1 changed files with 18 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -31,10 +31,19 @@ Features
Examples Examples
======== ========
As a user service
```bash
telebit daemon --config ~/.config/telebit/telebit.yml &
``` ```
telebit --config /opt/telebit/etc/telebit.yml
As a system service
```bash
sudo telebit daemon --config ~/.config/telebit/telebit.yml
``` ```
Example output:
``` ```
Connect to your device by any of the following means: Connect to your device by any of the following means:
@ -55,17 +64,16 @@ HTTPS
ex: curl https://young-grasshopper-37.telebit.cloud ex: curl https://young-grasshopper-37.telebit.cloud
``` ```
<!-- TODO use some imagery ```bash
``` # Forward all https traffic to port 3000
telebit http /path/to/root
telebit http 3000 telebit http 3000
telebit http /path/to/handler.js
telebit ssh 22 # Forward all tcp traffic to port 5050
telebit tcp 3000 telebit tcp 5050
telebit tcp echo
telebit tcp /path/to/handler.js # List all rules
telebit list
``` ```
-->
Install Install
======= =======