root
/
telebit.js
mirror of https://git.coolaj86.com/coolaj86/telebit.js.git
2
2
Fork 0
Code Issues Releases Wiki Activity

update docs

This commit is contained in:
AJ ONeal 2018-06-04 23:50:02 -06:00
parent e96a52212f
commit a43934a405
1 changed files with 13 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -76,12 +76,12 @@ Mac & Linux
Open Terminal and run this install script:
```
curl -fsSL https://get.telebit.cloud/ | bash
curl -fsSL https://get.telebit.cloud | bash
```
<!--
```
bash <( curl -fsSL https://get.telebit.cloud/ )
bash <( curl -fsSL https://get.telebit.cloud )
```
<small>
@ -93,11 +93,7 @@ curl -fsSL https://get.telebit.cloud/ > get.sh; bash get.sh
</small>
-->
Of course, feel free to inspect the install script before you run it.
```
curl -fsSL https://get.telebit.cloud
```
Of course, feel free to inspect the install script before you run it: `curl -fsSL https://get.telebit.cloud`
This will install Telebit Remote to `/opt/telebit` and
put a symlink to `/opt/telebit/bin/telebit.js` in `/usr/local/bin/telebit`
@ -154,6 +150,16 @@ servernames: # servernames that will be forwarded here
example.com: {}
```
Choosing A Relay
================
You can create a free or paid account at https://telebit.cloud
or you can run [Telebit Relay](https://git.coolaj86.com/coolaj86/telebitd.js)
open source on a VPS (Vultr, Digital Ocean)
or your Raspberry Pi at home (with port-forwarding).
Only connect to Telebit Relays that you trust.
<!--
## Important Defaults