Skip to content

Commit 235da61

Browse files
dorlugasigalCopilot
andcommitted
docs: note --public requires password in README and docs
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent a78be34 commit 235da61

3 files changed

Lines changed: 17 additions & 17 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ termbeam --host 127.0.0.1 # restrict to localhost (default: 0.0.0.0)
110110
| Flag | Description | Default |
111111
| --------------------- | ---------------------------------------------------- | -------------- |
112112
| `--password <pw>` | Set access password (also accepts `--password=<pw>`) | Auto-generated |
113-
| `--no-password` | Disable password ||
113+
| `--no-password` | Disable password (cannot combine with `--public`) ||
114114
| `--generate-password` | Auto-generate a secure password | On |
115115
| `--tunnel` | Create an ephemeral devtunnel URL (private) | On |
116116
| `--no-tunnel` | Disable tunnel (LAN-only) ||

docs/configuration.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,20 @@ description: All TermBeam CLI flags and options — ports, passwords, tunnels, s
77

88
## CLI Flags
99

10-
| Flag | Description | Default |
11-
| --------------------- | -------------------------------------------------------- | --------- |
12-
| `--password <pw>` | Set access password (also accepts `--password=<pw>`) | None |
13-
| `--generate-password` | Auto-generate a secure password (default behavior) | On |
14-
| `--no-password` | Disable auto-generated password ||
15-
| `--tunnel` | Create an ephemeral devtunnel URL (private access) | On |
16-
| `--no-tunnel` | Disable tunnel ||
17-
| `--persisted-tunnel` | Create a reusable devtunnel URL (stable across restarts) | Off |
18-
| `--public` | Allow public tunnel access (no Microsoft login required) | Off |
19-
| `--port <port>` | Server port | `3456` |
20-
| `--host <addr>` | Bind address | `0.0.0.0` |
21-
| `-h, --help` | Show help ||
22-
| `-v, --version` | Show version ||
23-
| `--log-level <level>` | Set log verbosity: `error`, `warn`, `info`, `debug` | `info` |
10+
| Flag | Description | Default |
11+
| --------------------- | ---------------------------------------------------------------- | --------- |
12+
| `--password <pw>` | Set access password (also accepts `--password=<pw>`) | None |
13+
| `--generate-password` | Auto-generate a secure password (default behavior) | On |
14+
| `--no-password` | Disable auto-generated password (cannot combine with `--public`) ||
15+
| `--tunnel` | Create an ephemeral devtunnel URL (private access) | On |
16+
| `--no-tunnel` | Disable tunnel ||
17+
| `--persisted-tunnel` | Create a reusable devtunnel URL (stable across restarts) | Off |
18+
| `--public` | Allow public tunnel access (no Microsoft login required) | Off |
19+
| `--port <port>` | Server port | `3456` |
20+
| `--host <addr>` | Bind address | `0.0.0.0` |
21+
| `-h, --help` | Show help ||
22+
| `-v, --version` | Show version ||
23+
| `--log-level <level>` | Set log verbosity: `error`, `warn`, `info`, `debug` | `info` |
2424

2525
## Environment Variables
2626

@@ -109,7 +109,7 @@ termbeam --persisted-tunnel --password mysecret
109109
!!! info "Persisted vs Ephemeral Tunnels" - `--tunnel` — Creates a fresh tunnel each time, deleted on shutdown. Good for one-off use. - `--persisted-tunnel` — Saves the tunnel ID to `~/.termbeam/tunnel.json` and reuses it across restarts (30-day expiry). The URL stays the same so you can bookmark it on your phone. To get a fresh URL, just switch back to `--tunnel`.
110110

111111
!!! warning
112-
A password is always auto-generated when using a tunnel. By default, tunnel access is private (owner-only via Microsoft login). Use `--public` to allow public access.
112+
A password is always auto-generated when using a tunnel. By default, tunnel access is private (owner-only via Microsoft login). Use `--public` to allow public access. **`--public` cannot be combined with `--no-password`** — TermBeam will refuse to start to prevent unauthenticated public exposure.
113113

114114
Requirements:
115115

docs/security.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Every response includes:
7575
!!! danger "Never Run Without a Password on a Public Network"
7676
Without authentication, anyone on the network can access your terminal with your user permissions.
7777

78-
1. **Password is on by default** — use `--no-password` only for trusted localhost scenarios
78+
1. **Password is on by default** — use `--no-password` only for trusted localhost scenarios. `--public` requires password authentication and will refuse to start without it
7979
2. **Use `--host 127.0.0.1`** if you don't need LAN access
8080
3. **Tunnel access is private by default** — only you (the tunnel owner) can access it via Microsoft login. Use `--public` to allow public access, or `--no-tunnel` for LAN-only mode
8181
4. **Close TermBeam when done** — it's not a daemon, don't leave it running

0 commit comments

Comments
 (0)