diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..8e0a9a0 --- /dev/null +++ b/readme.md @@ -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" +```