Skip to main content

First-Run Setup

The first time you open OmniBus in a browser it has no admin account, so it shows a setup wizard instead of a login screen.

Reaching the UI​

Open the URL the installer printed:

  • http://<hostname>.local/ — works on most LANs thanks to mDNS.
  • http://<host-ip>/ — always works.

If you installed on a non-default port, append it (e.g. http://omnibus.local:8080/).

:::info Certificate warning on HTTPS OmniBus generates its own TLS certificate on first boot, so browsers show a warning the first time you use https://. You can proceed past it, or install the OmniBus Root CA once to make the warning disappear for good — see Administration → TLS. For HTTP on a trusted LAN you can ignore this. :::

The wizard​

The wizard walks through these steps:

  1. Admin account — choose a username and a strong password. This is the first admin user; the password is stored only as a bcrypt hash.
  2. Hostname — set the device hostname (this is also its .local mDNS name).
  3. Network — keep DHCP, or assign a static IP. (Static-IP configuration is supported on hosts managed by NetworkManager or netplan.)
  4. Time — confirm the time zone / clock.
  5. MQTT — optionally point OmniBus at your MQTT broker now (you can also do this later from the MQTT page).
  6. Finish — completes onboarding and drops you into the dashboard.

You can revisit every one of these settings later from the System, MQTT, and Account pages.

After setup​

You land on the Ports dashboard. From here you typically:

  1. Plug in your USB-to-serial adapter(s).
  2. Click Add Port, pick the device, choose the protocol, and configure it.
  3. Enable the outputs you want (TCP, MQTT, REST, webhooks).

See Concepts → Ports & Adapters for how ports work, then the Protocols section for the specific bus you're bridging.

Roles​

OmniBus has two roles:

  • admin — full control (add/edit ports, change settings, manage users).
  • viewer — read-only.

Create additional users from the Account / Users area. See Administration → Users & Roles.

If you get locked out​

If you lose the admin password, an offline reset tool ships with OmniBus (lib/resetAdmin.js) and the USB-stick factory reset gesture can return the unit to first-run state. Both are covered under System Management.