Up and running in five minutes
One command installs CoreBit on your Linux host, sets up its database, and prints your login and management commands.
curl -fsSL https://licensing.corebit.network/install.sh | sudo bash -s
Completes in under five minutes and prints your login and management commands.
Requirements
- Linux (tested on Ubuntu; other distros work)
- Lightweight, multi-threaded polling — 309 MikroTik devices on a single-core VM in under 30 seconds
- On-premise: no cloud account or outbound subscription required
First four steps
- Log in with the printed credentials (default admin / admin) and change the password.
- Add credential profiles (MikroTik API, SNMP, Prometheus, Proxmox…).
- Scan your IP ranges to discover and bulk-create devices.
- Place devices on a map and draw the connections between them.
Installer flags
| --update | Update an existing installation |
| --uninstall | Remove CoreBit |
| --no-db | Skip database setup (use an external DB) |
| --db-host HOST | PostgreSQL host (default: localhost) |
| --db-port PORT | PostgreSQL port (default: 5432) |
| --db-name NAME | Database name (default: corebit) |
| --db-user USER | Database user (default: corebit) |
| --port PORT | Application port (default: 3000) |
| --run-as-root | Run the service as root |
| --verbose | Show detailed installer output |
| --agent | Install as a remote probe agent (headless: no database, no UI) |
| --server=URL | The CoreBit server the agent reports to (used with --agent) |
Add a remote probe agent
Monitor a network CoreBit can't reach directly — a branch office, a customer LAN, anything behind NAT. Install the same CoreBit build in agent mode on a small Linux host at that site and point it at your server. It connects outbound only (no inbound firewall rule) and does the polling from there.
curl -fsSL https://licensing.corebit.network/install.sh | sudo bash -s -- --agent --server=https://your-corebit-server
Prefer containers? Run the same image in agent mode:
docker run -d --name corebit-agent --network host --restart unless-stopped -e COREBIT_ROLE=agent -e COREBIT_SERVER_URL=https://your-corebit-server -e COREBIT_AGENT_NAME="Branch office" -v corebit-agent:/app/data ghcr.io/cis2131/corebit-docker
- No database or interface is installed — the agent just runs the pollers and ships results back to your server.
- It appears under Settings → Monitoring → Remote Agents as "unverified" and only starts working after you Accept it (each agent has its own key — no password to paste).
- Assign devices with the "Monitored by" picker; their status, alarms, notifications, history and graphs behave exactly like a locally-monitored device.
- Survives uplink outages — it buffers measurements locally and backfills them when the link returns, so there's no gap and no false "offline" for the whole site.
- Runs in Docker too — use the same image with COREBIT_ROLE=agent (host network + one small data volume for its identity key). See the Docker guide.
- Remote agents are an add-on licensed by agent count.
Documentation
Setup guides, configuration and how-tos live on the GitHub wiki — from first credentials to notifications and backups.
Open the wikiQuestions or a bug?
Ask a question or report an issue on GitHub. Bugs, feature requests and support all get tracked there.
Report an issuePrefer containers?
A Docker image is published for every release. Follow the container guide on the GitHub wiki.
Docker guideTry it at home first
Run CoreBit as a Home Assistant add-on to map and monitor your own home network — the easiest way for administrators to get hands-on and familiar with CoreBit before bringing it to work. Install from the add-on store, a database is bundled so there's nothing else to set up, and it runs on amd64 and 64-bit ARM.
Home Assistant add-onUbuntu 24.04+
Ubuntu 24.04 removed setuid from the ping utilities; the installer grants CAP_NET_RAW / CAP_NET_ADMIN automatically. If reachability checks still fail, reinstall with --run-as-root.
Map your network today
Install the free edition on your own hardware and have your first devices on a map in minutes.
curl -fsSL https://licensing.corebit.network/install.sh | sudo bash -s