docs: 📝 update readme
This commit is contained in:
@@ -0,0 +1,21 @@
|
|||||||
|
MIT License
|
||||||
|
|
||||||
|
Copyright (c) 2026 JDB-NET
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@@ -1,28 +1,47 @@
|
|||||||
<div align="center">
|
<div align="center">
|
||||||
<img src="https://assets.jdbnet.co.uk/projects/ipam.png" alt="IPAM" width="200" />
|
|
||||||
|
|
||||||
# IP Address Management
|
<h1>JDB-NET IPAM</h1>
|
||||||
|
|
||||||
|
<p>Open source IP address management for homelabs, small businesses, and IT teams.</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="https://github.com/jdbnet/ipam/blob/main/LICENSE">
|
||||||
|
<img src="https://img.shields.io/github/license/jdbnet/ipam" alt="License" />
|
||||||
|
</a>
|
||||||
|
<a href="https://cr.jdbnet.co.uk">
|
||||||
|
<img src="https://img.shields.io/badge/container-cr.jdbnet.co.uk-blue" alt="Container" />
|
||||||
|
</a>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<a href="https://www.jdbnet.co.uk/products/ipam"><strong>☁️ Managed hosting from £8/month →</strong></a>
|
||||||
|
</p>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
A Flask-based web application for IP Address Management (IPAM). Manage subnets, IP addresses, devices, DHCP pools, and rack infrastructure through a Vue 3 web interface and a JSON REST API.
|
---
|
||||||
|
|
||||||
## Features
|
Manage subnets, IP assignments, DHCP pools, devices, and rack layout from
|
||||||
|
a single web interface. Built with Flask and Vue 3, deployable with a single
|
||||||
- **Subnet management** - CIDR subnets with automatic IP generation
|
Docker Compose file.
|
||||||
- **IP assignment** - Assign addresses to devices with hostname tracking
|
|
||||||
- **Device management** - Names, descriptions, tags, and custom fields
|
|
||||||
- **DHCP pools** — Configure ranges and excluded IPs per subnet
|
|
||||||
- **Rack management** - U positions with front/back layout
|
|
||||||
- **Site organisation** - Group subnets and devices by location
|
|
||||||
- **Audit logging** - Filterable change history with CSV export
|
|
||||||
- **Role-based access control** - Granular permissions and custom roles
|
|
||||||
- **REST API v2** - Session cookies for the browser, API keys for automation
|
|
||||||
|
|
||||||
## Screenshot
|
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## Docker Compose
|
## Features
|
||||||
|
|
||||||
|
- **Subnet management** - CIDR subnets (/24–/32) with automatic IP generation
|
||||||
|
- **IP assignment** - Assign addresses to devices with hostname tracking and assignment history
|
||||||
|
- **DHCP pools** - Configure ranges and excluded IPs per subnet; pool addresses are kept out of manual assignment
|
||||||
|
- **Device management** - Names, descriptions, tags, custom fields, and bulk creation
|
||||||
|
- **Rack layout** - U positions with front/back face placement and non-networked entries
|
||||||
|
- **Site organisation** - Group subnets and devices by location for multi-site networks
|
||||||
|
- **Global search** - Press `/` to search subnets, IPs, devices, and racks from anywhere
|
||||||
|
- **Audit logging** - Filterable change history with CSV export
|
||||||
|
- **Role-based access control** - Granular permissions, custom roles, and enforced 2FA per role
|
||||||
|
- **REST API v2** - Full JSON API with session cookie and API key authentication
|
||||||
|
- **Custom fields** - Extend devices and subnets with admin-defined fields, no schema changes required
|
||||||
|
- **Organisation branding** - Set your name and logo from Settings or environment variables
|
||||||
|
|
||||||
|
## Quick start
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
services:
|
services:
|
||||||
@@ -33,11 +52,33 @@ services:
|
|||||||
ports:
|
ports:
|
||||||
- "5000:5000"
|
- "5000:5000"
|
||||||
environment:
|
environment:
|
||||||
- MYSQL_HOST=10.10.2.27
|
- MYSQL_HOST=your_db_host
|
||||||
- MYSQL_USER=ipam
|
- MYSQL_USER=ipam
|
||||||
- MYSQL_PASSWORD=your_password
|
- MYSQL_PASSWORD=your_password
|
||||||
- MYSQL_DATABASE=ipam
|
- MYSQL_DATABASE=ipam
|
||||||
- SECRET_KEY=your_secret_key
|
- SECRET_KEY=your_secret_key # generate with: openssl rand -hex 32
|
||||||
- NAME=Your Organisation
|
|
||||||
- LOGO_PNG=https://example.com/logo.png
|
|
||||||
```
|
```
|
||||||
|
|
||||||
|
A MySQL or MariaDB database is required. The schema is created automatically
|
||||||
|
on first run. Log in with `admin@example.com` / `password` and change the password immediately.
|
||||||
|
|
||||||
|
## Environment variables
|
||||||
|
|
||||||
|
| Variable | Required | Description |
|
||||||
|
|----------|----------|-------------|
|
||||||
|
| `MYSQL_HOST` | Yes | Database host |
|
||||||
|
| `MYSQL_USER` | Yes | Database user |
|
||||||
|
| `MYSQL_PASSWORD` | Yes | Database password |
|
||||||
|
| `MYSQL_DATABASE` | Yes | Database name |
|
||||||
|
| `SECRET_KEY` | Yes | Flask secret key - use a long random string |
|
||||||
|
|
||||||
|
## Managed hosting
|
||||||
|
|
||||||
|
Don't want to run it yourself? JDB-NET offers fully managed hosting from
|
||||||
|
**£8/month** - provisioned in under 10 minutes, no maintenance required.
|
||||||
|
|
||||||
|
[→ jdbnet.co.uk/products/ipam](https://www.jdbnet.co.uk/products/ipam)
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
[MIT](LICENSE)
|
||||||
Reference in New Issue
Block a user