Browse handbook

Run Beacon on Windows

Beacon gives an app on your PC a public address. The PC, the app, and the tunnel all need to be running for a remote visitor to reach that app. Burro is an example. Its Windows address is http://127.0.0.1:4747/. Its public address is https://aburro.openbyl.com/. Burro handles sign-in at both addresses. Burro access guide[1]

Sign in with an Edge account

  1. For your first account, open Register with the one-time invitation from the Edge operator. Choose your own username and password. Use Sign in for an existing account. You can download the Windows pilot installer from your account page. Edge Accounts
  2. Install Beacon 0.3.1 on the PC that runs your app. Choose Sign in to Edge, then compare the code shown by Beacon with the code you approve in your browser. Repeat this on your second PC with the same account. Each PC generates its own private key and has its own hostname prefix. On a PC with an existing manual profile, use the Beacon tray menu to connect the account.
  3. In that PC’s account dashboard, choose Add Route. For example, start your image generator, check its actual HTTP port on loopback, and enter that port and the name images. Use the full hostname in the preview. An exact proxied Cloudflare A record to the VPS is sufficient. The site can use an existing proxied wildcard if the zone owner has configured one.
  4. Account routes start private. Under your laptop in Edge Accounts, open Private access key and choose Create access key. Save the key in your password manager so you can open the app from another device.
  5. To publish a site for everyone, open Route visibility and enter its original device-prefixed hostname. The setting also applies to its short addresses. Switch it back to private to protect new requests. Revoking a device cuts its tunnel and current streams. Rotating its access token invalidates the previous token for new requests. Existing application sessions or downloads already in progress may need a tunnel stop or device revocation for immediate cutoff.

The Add Route form on each laptop targets a port on that laptop. Use the device’s own dashboard and keep its app running. Visitors can use the image generator remotely while the actual computation stays on the origin PC.

Claim a short address

  1. Publish the app from its laptop using Add Route. In Beacon, open Manage account, find that laptop, and choose Short addresses. Your devices
  2. Select the app route and enter the short name you want. Entering images checks images.openbyl.com. Choose Check availability. If the name is taken or reserved, try another.
  3. Choose Claim address. Use Refresh status while Edge sets up HTTPS. Beacon uses the ready short address in its dashboard. If the app has several ready addresses, choose Use as primary beside the one you want Beacon to open.

By default, both addresses reach the same app and share its visibility setting. To retire the device-prefixed address, open Routes → Edit → Manage short addresses in Beacon. Once a short address is ready, find your app under Original addresses and choose Turn off original address. Open the original URL in a fresh browser window to verify that Edge refuses it. Your ready short addresses keep serving the app. To restore the old link later, choose Turn on original address.

Open a private app on another computer

Open the app’s short URL on the other computer. At the browser’s OpenBYL device access prompt, enter beacon as the username and the hosting laptop’s private access key as the password. Your Edge account password signs you in at edge.openbyl.com/account/. If Burro then displays its lock screen, use the Burro key from the hosting laptop’s burro-ollama/data/token file. Burro access guide[1]

If you’ve lost the device key, sign in to Edge Accounts → Your devices, find the laptop hosting the app and expand Private access key. Choose Replace access key, then save the new key when Edge displays it. Replacing it invalidates the old key for every private app on that laptop. Update any browsers and API clients that use it. API clients send the device key in an Authorization: Bearer header. Your devices

Install and connect

For a manually enrolled device, use the profile workflow below.

  1. Ask your Edge administrator for a profile issued for this PC. The enrollment folder contains beacon.toml, ca.pem, identity.pem, and identity.key. The private key lets another process act as this device, so transfer the bundle privately. The administrator installs your device's grant on Edge. Edge enrollment guide
  2. Run Beacon-Setup-0.3.1.exe from the maintainer's release package. Choose whether to create a desktop shortcut and start Beacon at sign-in. Setup installs for your Windows account. If WebView2 is missing, its installation needs internet access. If Windows blocks the package under application control, ask the maintainer for a signed build. Installer, standalone ZIP, and signing instructions[2]
  3. Import the enrollment folder during setup. If you choose beacon.toml when the app first opens, keep that folder in a permanent, private, writable location. An existing installation uses its saved profile.
  4. Open OpenBYL Beacon from Start. Under Overview → Relay connection, look for Connected. A profile previously stopped by its owner will show Stopped. Choose Start tunnel when you are ready. You can also open the local dashboard in your browser. Default Beacon dashboard on this PC http://127.0.0.1:4780/

For the portable edition, extract the entire Beacon-Portable-0.3.1-x64.zip to a folder you own and run beacon-desktop.exe. Keep the accompanying files together. It uses an installed profile if present or prompts for one. A command-line connector is also available. Run one connector per enrolled identity. Foreground CLI installation[3]

Publish a local HTTP app

Suppose your administrator assigns this PC the OpenBYL prefix alex-laptop-, and your notes app serves HTTP on port 3000.

  1. Open http://127.0.0.1:3000/ on this PC and confirm it serves the intended app. Set its visitor authentication and allowed public hostname before sharing it.
  2. In Beacon, open Overview or Routes and choose Add Route. Enter 3000 for the local port and notes for the public hostname. Check the preview reads https://alex-laptop-notes.openbyl.com. You can also enter the full hostname. Choose Add route to save.
  3. Open the route in Routes to see its progress. In manual DNS mode, give the exact record shown under Waiting for DNS to whoever manages your zone. It is a proxied A record pointing to the VPS IPv4 address, with TTL Auto. If the administrator enabled automatic DNS, the server creates or verifies the record.
  4. When the route shows Ready, open its link on a phone using cellular data. Check for a recognizable response from the app and try a protected action in a fresh private window. Ready means the public HTTPS check reached the site's virtual host. Your application can still be down or require sign-in. How publishing works[4]

The form publishes an HTTP service on this PC's IPv4 loopback address. It accepts a single hostname label in the assigned zone and excludes the dashboard's own port. You can save a request while the tunnel is stopped. Beacon submits it after you start the tunnel. To retry a saved request, submit the same hostname and port.

Edit a saved route

Open Routes on the laptop hosting the app and choose Edit on its route. To move the app from one local port to another, enter the new port and choose Save changes. New connections use the new port immediately. Open connections can finish on the old port. The public addresses and access settings follow the route.

To change the link Beacon displays, use Manage short addresses in the route editor. Claim a name and choose Use as primary when it is ready. The same page lets you turn off the app’s original hostname. Beacon refreshes its public link while connected. An Edge operator can retire other published hostnames and edit static routes. Edge operator procedure

Close, stop, or quit

What you want What to do What a visitor sees
Keep serving while you work Close the window with ×. Reopen Beacon from Start or the icon by the clock, sometimes under Show hidden icons. The tunnel keeps serving.
Take this PC's apps offline Choose Overview → Stop tunnel. This closes active streams. The profile remembers the stop across app restarts and sign-ins. New requests through this tunnel cannot reach the apps. The local dashboard stays available.
Bring the apps back Choose Start tunnel and wait for Connected. New requests use the saved routes. Visitors with interrupted streams may need to reconnect.
Exit the program Right-click the notification-area icon and choose Quit Beacon. Both the tunnel and local dashboard close. Open Beacon again whenever you want it running.

Check the right layer

Run this in PowerShell on the PC with Beacon. Substitute your configured dashboard port if it differs. Activity in the dashboard holds recent events. The counters start over when the process restarts. Byte totals measure application data crossing the local origin socket. Use the VPS provider's transfer meter for its billable traffic. Telemetry implementation[5]

$beacon = Invoke-RestMethod 'http://127.0.0.1:4780/api/status'
$beacon | Select-Object name, state, connection_enabled, rtt_ms, active_streams
$beacon.routes | Format-Table name, target, publish_state, total_streams, failures
Symptom Next check
Dashboard does not open Open Beacon from Start. If startup reports a port conflict, check whether a foreground CLI or another connector already owns the profile's dashboard port.
Connecting or Retrying Check internet access and the configured direct relay address. On OpenBYL it is sotpyrk.cloud:7844 over UDP. Give the administrator the time and message from Activity so they can check the firewall, clock, certificate name, and device grant.
Enable route publishing appears Ask for a publishing-enabled device profile. An existing eligible OpenBYL studio profile can enable publishing in setup.
Waiting for Edge or Setting up HTTPS persists Check that the tunnel is running and the requested name fits your prefix. The administrator can check the publisher socket, DNS, Nginx, and certificate issuance.
Public app fails while Connected Test the app locally. Then request the public URL and watch its route counters. For Burro, compare /api/health locally and publicly. An unauthenticated /api/status should return HTTP 401. Burro verification[6]
The OpenBYL field guide loads but Burro fails The guide's homepage lives on the VPS. Use the Burro health check or compare a fresh tunnel proof with the local origin. End-to-end proof[7]

Update or move a device

Run the next setup package to update. Allow a short interruption of active routes. The default program folder is %LOCALAPPDATA%\Programs\OpenBYL Beacon. The installed enrollment is under %LOCALAPPDATA%\OpenBYL\Beacon. With a profile chosen in place, the keys and route state live beside that TOML. Back up that directory privately, including beacon.toml.routes.json and beacon.toml.stopped when present. Windows update and removal[8]

Uninstalling preserves the profile and keys. For a replacement PC, ask the administrator to enroll the new device and revoke the old one. Running two devices with the same client certificate causes them to replace each other's Edge session. If a key goes missing, contact the administrator to revoke that identity.

Repository references

  1. deploy/BURRO.md
  2. packaging/windows/README.md
  3. README.md#install-beacon-on-windows
  4. deploy/PUBLISHING.md
  5. crates/beacon/src/status.rs
  6. deploy/BURRO.md#check-from-another-device
  7. README.md#operate-and-verify
  8. packaging/windows/README.md#update-and-remove