Skip to content

Quick Start

Get m1nd running and monitoring your first target in under 5 minutes.

v3.13.13jALPHA
1
Install m1nd
Run the one-line installer on any Linux host. It handles packages, venv, systemd — everything.

bash <(curl -fsSL https://raw.githubusercontent.com/jmobastos/projectmind_314lan/main/scripts/install.sh)
2
Open the dashboard
Navigate to http://:8080 in your browser.
Default login: admin / m1nd
3
Change your password
Go to Settings > General and change the default password immediately.
4
Add monitoring targets
Go to Settings > Targets and add your first IP addresses or hostnames. m1nd will start ICMP, DNS, and Speedtest probes automatically.
5
Watch live results
Head to the Dashboard tab. Results stream in real-time via SSE — no refresh needed. You will see RTT charts, DNS resolution times, and anomaly alerts within seconds.

What to do next

Once you see live data flowing, explore these features:

Set up Uptime Monitors

Go to the Monitors tab and create your first HTTP, Ping, TCP, or DNS monitor. See Uptime Monitors for details.

Discover your network

Open the V1sion tab, enter a subnet (e.g., 192.168.1.0/24), and hit Scan. Watch devices appear in real-time on the topology canvas. See V1sion.

Document your assets

The Bra1n tab lets you create an inventory of Sites, Locations, Endpoints, Assets, Applications, Subnets, and Credentials. See Bra1n.

Configure alerts

Set up Webhooks to send alerts to Slack, Teams, PagerDuty, or any HTTP endpoint when monitors go down.

Enable OOB access

Deploy m1nd at a remote site and connect it to ZeroTier or Tailscale for out-of-band monitoring access.

Example: Your first API call

Once m1nd is running, try the API:

bash
# List all monitors
curl -H "X-API-Key: your-key" http://localhost:8080/api/monitors
python
import requests

r = requests.get(
    "http://localhost:8080/api/monitors",
    headers={"X-API-Key": "your-key"}
)
print(r.json())
javascript
const res = await fetch("http://localhost:8080/api/monitors", {
  headers: { "X-API-Key": "your-key" }
})
const data = await res.json()
console.log(data)

See the API Reference for all 138+ endpoints.

Released under the MIT License.