phpIPAM Docker image
Branch: master
Clone or download
Pull request Compare This branch is 2 commits ahead of pierrecdn:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Dockerfile
LICENSE
README.md
php.ini

README.md

docker-phpipam

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.

phpIPAM logo

How to use this Docker image

Mysql

Run a MySQL database, dedicated to phpipam.

$ docker run --name phpipam-mysql -e MYSQL_ROOT_PASSWORD=my-secret-pw -v /my_dir/phpipam:/var/lib/mysql -d mysql:5.6

Here, we store data on the host system under /my_dir/phpipam and use a specific root password.

Phpipam

$ docker run -ti -d -p 80:80 -e MYSQL_ENV_MYSQL_ROOT_PASSWORD=my-secret-pw --name ipam --link phpipam-mysql:mysql pierrecdn/phpipam

We are linking the two containers and exposing the HTTP port.

First install scenario

  • Browse to http://<ip>[:<specific_port>]/install/
  • Step 1 : Choose 'Automatic database installation'

step1

  • Step 2 : Re-Enter connection information

step2

step3

  • You're done !

done

Docker compose

You can also create an all-in-one YAML deployment descriptor with Docker compose, like this:

version: '2'

services:
  mysql:
    image: mysql:5.6
    environment:
      - MYSQL_ROOT_PASSWORD=my-secret-pw
    restart: always
    volumes:
      - db_data:/var/lib/mysql
  ipam:
    depends_on:
      - mysql
    image: opinkerfi/phpipam
    environment:
      - MYSQL_ENV_MYSQL_USER=root
      - MYSQL_ENV_MYSQL_ROOT_PASSWORD=my-secret-pw
      - MYSQL_ENV_MYSQL_HOST=mysql
    ports:
      - "80:80"
volumes:
  db_data:

And next :

$ docker-compose up -d

You can also point the MYSQL_ENV_PASSWORD_FILE environment variable to a file, in which case the contents of this file will be used as the password. This makes it possible to use docker secrets for instance:

version: '3'

services:
  ipam:
    environment:
      - MYSQL_ENV_MYSQL_PASSWORD_FILE=/run/secrets/phpipam_mysql_root_password
    secrets:
      - phpipam_mysql_root_password

The secret can be created by running echo my-secret-pw | docker secret create phpipam_mysql_root_password -

Advanced Configuration

Here is the list of the available environment variables in the phpipam container, pass them to docker using -e. None of them are actually needed to run the container, this is only to tweak the behavior.

Environment variable Default value Description
MYSQL_ENV_MYSQL_HOST mysql The host used to reach the MySQL instance
MYSQL_ENV_MYSQL_USER root The user to connect the MySQL instance
MYSQL_ENV_MYSQL_ROOT_PASSWORD (empty) The MySQL password. Can be set using the Web UI during the first install
MYSQL_ENV_MYSQL_DB phpipam The name of the MySQL DB to connect to
MYSQL_ENV_MYSQL_PASSWORD_FILE (empty) A file containing the password (if not using MYSQL_ROOT_PASSWORD) this allows to leverage docker secrets
PHPIPAM_BASE / The base URI under which phpipam runs. Useful when performing rewrites with a reverse-proxy
GMAPS_API KEY (empty) Google Maps API Key, used to display maps of your devices
GMAPS_API_GEOCODE_KEY (empty) Google Maps Geocode API Key, used to find coordinates from an address/ a location of your device

Specific integration (HTTPS, multi-host containers, etc.)

Regarding your requirements and docker setup, you've to expose resources.

For HTTPS, run a reverse-proxy in front of your phpipam container and link it to.

For multi-host containers, expose ports, run etcd or consul to make service discovery works etc.

Notes

phpIPAM is under heavy development by the amazing Miha. To upgrade the release version, just change the PHPIPAM_VERSION environment variable to the target release (see here).