Skip to content
This repository was archived by the owner on Jun 1, 2026. It is now read-only.

Commit b773bfb

Browse files
committed
Clarify install and usage in README
1 parent 473517f commit b773bfb

1 file changed

Lines changed: 60 additions & 10 deletions

File tree

README.md

Lines changed: 60 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,78 @@
22

33
A lightweight, self-hosted HTTP tunnel. Think ngrok, but yours.
44

5-
## Install the CLI
5+
## Use the CLI
66

7-
Requires Node 20+.
7+
Install (Homebrew):
88

99
```bash
10-
npx @851-labs/auger init
10+
brew tap 851-labs/tap
11+
brew install 851-labs/tap/auger
1112
```
1213

13-
Or with Homebrew:
14+
Use (Homebrew):
1415

1516
```bash
16-
brew tap 851-labs/tap
17-
brew install 851-labs/tap/auger
17+
auger init
18+
auger http 3000
19+
```
20+
21+
You’ll get a public URL like `https://bright-ember.auger.yourdomain.com` that proxies to `http://127.0.0.1:3000`.
22+
23+
## Other installation options:
24+
25+
Requires Node 20+ for `bunx`, `npx`, and `pnpm dlx`.
26+
27+
<details>
28+
<summary>bunx</summary>
29+
30+
Install:
31+
32+
```bash
33+
bunx @851-labs/auger init
34+
```
35+
36+
Use:
37+
38+
```bash
39+
bunx @851-labs/auger http 3000
40+
```
41+
42+
</details>
43+
44+
<details>
45+
<summary>npx</summary>
46+
47+
Install:
48+
49+
```bash
50+
npx @851-labs/auger init
1851
```
1952

20-
## Use the tunnel
53+
Use:
2154

2255
```bash
2356
npx @851-labs/auger http 3000
2457
```
2558

26-
You’ll get a public URL like `https://bright-ember.auger.yourdomain.com` that proxies to `http://127.0.0.1:3000`.
59+
</details>
60+
61+
<details>
62+
<summary>pnpm dlx</summary>
63+
64+
Install:
65+
66+
```bash
67+
pnpm dlx @851-labs/auger init
68+
```
69+
70+
Use:
71+
72+
```bash
73+
pnpm dlx @851-labs/auger http 3000
74+
```
75+
76+
</details>
2777

2878
## Deploy the server
2979

@@ -41,11 +91,11 @@ primary_region = "iad"
4191
image = "ghcr.io/851-labs/auger-server:latest"
4292

4393
[env]
44-
AUGER_BASE_DOMAIN = "auger.example.com"
94+
AUGER_BASE_DOMAIN = "auger.example.com" # <- Set this to your root domain.
4595
AUGER_HTTP_PORT = "8080"
4696
AUGER_WS_PATH = "/ws"
4797
AUGER_DB_PATH = "/data/auger.db"
48-
AUGER_TOKENS = "changeme"
98+
AUGER_TOKENS = "changeme" # <- Comma-separated auth tokens (use a strong secret).
4999

50100
[[mounts]]
51101
source = "auger_data"

0 commit comments

Comments
 (0)