phpipam-agent's Introduction

docker-phpipam-agent

phpIPAM is an open-source web IP address management application. Its goal is to provide light and simple IP address management application.

phpIPAM is developed and maintained by Miha Petkovsek, released under the GPL v3 license, project source is here

Learn more on phpIPAM homepage

This container can be used as a discovery scan agent.

How to use this Docker image

Setup PHPIPAM

See steps in https://github.com/pierrecdn/phpipam
Configure a remote agent (Administration > scan agents), get the key.
For each subnet, enable scan & configure the remote agent by selecting a remote.

Run this container

Pass the MySQL password and the phpipam agent key.

$ docker run -ti -d -e PHPIPAM_AGENT_KEY=dummy-key -e MYSQL_ENV_MYSQL_PASSWORD=my-secret-pw --name ipam-agent --link phpipam-mysql:mysql pierrecdn/phpipam-agent

Now, the discovery scans will be performed every 1mn by default.

The logs are available on stdout/stderr (allowing to use docker logs).

Customize update and discovery schedule

You can use CRONTAB_UPDATE and CRONTAB_DISCOVER environment variables to customize schedule for network updates and discovery respectively.

You can set disabled to disable a schedule.

The format is a crontab definition of the form */15 * * * * :

$ docker run -ti -d -e PHPIPAM_AGENT_KEY=dummy-key -e MYSQL_ENV_MYSQL_PASSWORD=my-secret-pw -e CRONTAB_UPDATE="*/15 * * * *" -e CRONTAB_DISCOVER="disabled" --name ipam-agent --link phpipam-mysql:mysql pierrecdn/phpipam-agent

Recommend Projects