docs: add readme for phpipam role

This commit is contained in:
Simon Cornet 2026-04-10 08:57:12 +02:00
commit f676e9263a

25
readme.md Normal file
View file

@ -0,0 +1,25 @@
# Ansible Role: phpIPAM
Install and configure [phpIPAM](https://phpipam.net/) - an open-source IP address management tool using Docker.
## Variables
| Variable | Required | Default | Description |
|----------|----------|---------|-------------|
| `phpipam_db_root_password` | Yes | `changeme` | MariaDB root password |
| `phpipam_db_user` | Yes | `phpipam` | phpIPAM database user |
| `phpipam_db_password` | Yes | `changeme` | phpIPAM database password |
| `phpipam_db_name` | Yes | `phpipam` | phpIPAM database name |
| `phpipam_http_port` | Yes | `8080` | HTTP port for phpIPAM web interface |
| `phpipam_scan_interval` | Yes | `6h` | Interval for network scanning |
## Example
```yaml
phpipam_db_root_password: "secure_root_password"
phpipam_db_user: "phpipam"
phpipam_db_password: "secure_password"
phpipam_db_name: "phpipam"
phpipam_http_port: "8080"
phpipam_scan_interval: "12h"
```