Skip to content
KinanLakPublic

About

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

360 Commits

Folders and files

Repository files navigation

Netplan

Netplan is a collaborative map of buildings for network teams. You draw floors and walls, place racks, switches, wall sockets and PCs, and connect them with cables. Netplan can then read NetBox and LibreNMS to show where each PC was last seen on the network. Several people can edit the same floor at once. The interface is in French.

Netplan is fully self-hosted, with accounts and roles and a tool-agnostic inventory. See docs/architecture/current.md for how it is built and docs/adr/ for why.

Development

Requirements: Bun and Docker.

bun install
bun run dev:agent   # local Convex backend in Docker, demo data, Vite
bun run check       # typecheck, lint, format, tests

bun run dev:agent prints the app's URL once it is ready. Each checkout gets its own backend and ports, so several can run side by side.

Running it

cd deploy
cp .env.example .env   # then fill in the secrets
docker compose up -d --build --wait

docs/operations/ covers installation, configuration, upgrades, backups and monitoring.

Documentation

About

Resources

Stars

2 stars

Watchers

0 watching

Forks

Used by

Contributors

Languages