Skip to content

docs: add v1.0.13 setup and troubleshooting #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
unipheas merged 1 commit into from
Jul 23, 2026
Merged

docs: add v1.0.13 setup and troubleshooting #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,20 @@ open -a BarKeep

The running app version is shown at the bottom-right of its menu.

### Connect the Busy Bar

USB works at the fixed address `10.0.4.20` and does not require a password.
For Wi-Fi:

1. Open the Busy Bar's web interface and go to **Network → HTTP API**.
2. Enable HTTP API access and set its local numeric password.
3. In BarKeep → **Settings**, enter the bar's Wi-Fi IP address and that same
password in **Wi-Fi password**.

The password is the one configured on the physical bar. Tokens created at
`cloud.busy.app` are for the cloud API and will be rejected by the local
device API.

### From source

```bash
Expand Down Expand Up @@ -113,9 +127,12 @@ To notify the Busy Bar whenever Codex or ChatGPT desktop finishes a turn and
waits for you, add this top-level setting to `~/.codex/config.toml`:

```toml
# Apple Silicon Homebrew
notify = ["/opt/homebrew/opt/barkeep-cli/share/barkeep-cli/hooks/codex-notify.sh"]
```

On an Intel Mac, use
`/usr/local/opt/barkeep-cli/share/barkeep-cli/hooks/codex-notify.sh` instead.
The notifier also forwards the event to Codex Computer Use when that helper is
installed. Restart Codex/ChatGPT desktop after changing the setting.

Expand Down Expand Up @@ -178,6 +195,20 @@ CLI env: `BARKEEP_HOST` (device address, default `10.0.4.20`),
`BARKEEP_TOKEN` (the local HTTP API password for Wi-Fi), and
`BARKEEP_THEME` (busy theme, default `on_air`).

### Connection troubleshooting

- **Unreachable over USB:** reconnect the cable, wait a few seconds for the
USB network interface, and leave the host set to `10.0.4.20`.
- **Unreachable over Wi-Fi:** confirm the Mac and Busy Bar can communicate on
the same network. Guest networks and some phone hotspots isolate clients.
- **Token rejected / HTTP 403:** use the local numeric HTTP API password from
the bar's own web interface, not a token from `cloud.busy.app`.
- **No Local Network prompt:** open System Settings → Privacy & Security →
Local Network and enable BarKeep. If it is already enabled, toggle it off
and back on, then relaunch BarKeep.
- **Pasted a full URL:** BarKeep accepts either an IP/hostname or a URL such as
`http://busy-bar.local/login` and normalizes it to the device host.

## Device API notes

Verified against firmware 1.0.2 / API 24.3.0
Expand Down
Loading