MirrorMirror
/
01
mirror of https://github.com/OpenInterpreter/01.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fixing formatting in readme for the expose tunnel section

This commit is contained in:
Tom Chapin 2024-02-22 17:48:04 -08:00
parent a162675d37
commit dd702c0ad6
1 changed files with 19 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -35,29 +35,36 @@ pip install 01OS
# (Behavior can be modified by changing the contents of `.env`)
```
**Expose an 01 server publically:**
**Expose an 01 Server Publicly**
We currently support exposing the 01 server publicly via a couple of different tunnel services:
- bore.pub (https://github.com/ekzhang/bore)
Requirements: Ensure that rust is installed (https://www.rust-lang.org/tools/install), then run `cargo install bore-cli`
- **bore.pub** ([GitHub](https://github.com/ekzhang/bore))
- **Requirements:** Ensure that Rust is installed ([Rust Installation](https://www.rust-lang.org/tools/install)), then run:
```
cargo install bore-cli
```
- **To Expose:**
```bash
01 --server --expose-with-bore
```
- localtunnel (https://github.com/localtunnel/localtunnel)
Requirements: Ensure that Node is installed (https://nodejs.org/en/download), then run `npm install -g localtunnel`
- **localtunnel** ([GitHub](https://github.com/localtunnel/localtunnel))
- **Requirements:** Ensure that Node.js is installed ([Node.js Download](https://nodejs.org/en/download)), then run:
```
npm install -g localtunnel
```
- **To Expose:**
```bash
01 --server --expose-with-localtunnel
```
- ngrok (https://ngrok.com/)
Requirements: Install ngrok (https://ngrok.com/docs/getting-started/), and set up an ngrok account.
Get your auth key from https://dashboard.ngrok.com/get-started/your-authtoken, then set it in
your local configuration by running `ngrok config add-authtoken your_auth_token_here`
- **ngrok** ([Website](https://ngrok.com/))
- **Requirements:** Install ngrok ([Getting Started with ngrok](https://ngrok.com/docs/getting-started/)), and set up an ngrok account. Get your auth key from [ngrok dashboard](https://dashboard.ngrok.com/get-started/your-authtoken), then set it in your local configuration by running:
```
ngrok config add-authtoken your_auth_token_here
```
- **To Expose:**
```bash
01 --server --expose-with-ngrok
```