├── Dockerfile ├── LICENSE ├── README.md └── php.ini /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:5.6-apache 2 | MAINTAINER Pierre Cheynier 3 | 4 | ENV PHPIPAM_AGENT_SOURCE https://github.com/phpipam/phpipam-agent 5 | 6 | # Install required deb packages 7 | RUN sed -i /etc/apt/sources.list -e 's/$/ non-free'/ && \ 8 | apt-get update && apt-get -y upgrade && \ 9 | rm /etc/apt/preferences.d/no-debian-php && \ 10 | apt-get install -y git cron libgmp-dev iputils-ping fping && \ 11 | rm -rf /var/lib/apt/lists/* 12 | 13 | # Configure apache and required PHP modules 14 | RUN docker-php-ext-configure mysqli --with-mysqli=mysqlnd && \ 15 | docker-php-ext-install mysqli && \ 16 | docker-php-ext-install json && \ 17 | docker-php-ext-install pdo_mysql && \ 18 | ln -s /usr/include/x86_64-linux-gnu/gmp.h /usr/include/gmp.h && \ 19 | docker-php-ext-configure gmp --with-gmp=/usr/include/x86_64-linux-gnu && \ 20 | docker-php-ext-install gmp && \ 21 | docker-php-ext-install pcntl 22 | 23 | COPY php.ini /usr/local/etc/php/ 24 | 25 | # Clone phpipam-agent sources 26 | WORKDIR /opt/ 27 | RUN git clone ${PHPIPAM_AGENT_SOURCE}.git 28 | 29 | WORKDIR /opt/phpipam-agent 30 | # Use system environment variables into config.php 31 | RUN cp config.dist.php config.php && \ 32 | sed -i -e "s/\['key'\] = .*;/\['key'\] = getenv(\"PHPIPAM_AGENT_KEY\");/" \ 33 | -e "s/\['pingpath'\] = .*;/\['pingpath'\] = \"\/usr\/bin\/fping\";/" \ 34 | -e "s/\['db'\]\['host'\] = \"localhost\"/\['db'\]\['host'\] = getenv(\"MYSQL_ENV_MYSQL_HOST\") ?: \"mysql\"/" \ 35 | -e "s/\['db'\]\['user'\] = \"phpipam\"/\['db'\]\['user'\] = getenv(\"MYSQL_ENV_MYSQL_USER\") ?: \"root\"/" \ 36 | -e "s/\['db'\]\['pass'\] = \"phpipamadmin\"/\['db'\]\['pass'\] = getenv(\"MYSQL_ENV_MYSQL_PASSWORD\")/" \ 37 | -e "s/\['db'\]\['port'\] = 3306;/\['db'\]\['port'\] = 3306;\n\n\$password_file = getenv(\"MYSQL_ENV_MYSQL_PASSWORD_FILE\");\nif(file_exists(\$password_file))\n\$db\['db'\]\['pass'\] = preg_replace(\"\/\\\\s+\/\", \"\", file_get_contents(\$password_file));/" \ 38 | config.php 39 | 40 | # Setup crontab 41 | ENV CRONTAB_FILE=/etc/cron.d/phpipam 42 | RUN echo "* * * * * /usr/local/bin/php /opt/phpipam-agent/index.php update > /proc/1/fd/1 2>/proc/1/fd/2" > ${CRONTAB_FILE} && \ 43 | chmod 0644 ${CRONTAB_FILE} && \ 44 | crontab ${CRONTAB_FILE} 45 | 46 | CMD [ "sh", "-c", "printenv > /etc/environment && cron -f" ] 47 | 48 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | 167 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # docker-phpipam-agent 2 | 3 | phpIPAM is an open-source web IP address management application. Its goal is to provide light and simple IP address management application. 4 | 5 | phpIPAM is developed and maintained by Miha Petkovsek, released under the GPL v3 license, project source is [here](https://github.com/phpipam/phpipam-agent) 6 | 7 | Learn more on [phpIPAM homepage](http://phpipam.net) 8 | 9 | This container can be used as a discovery scan agent. 10 | 11 | ## How to use this Docker image 12 | 13 | ### Setup PHPIPAM 14 | 15 | * See steps in https://github.com/pierrecdn/phpipam 16 | * Configure a remote agent (Administration > scan agents), get the key. 17 | ![config_agent](https://user-images.githubusercontent.com/4225738/45190599-0b799000-b23f-11e8-9e41-fb993606264d.png) 18 | 19 | * For each subnet, enable scan & configure the remote agent by selecting a remote. 20 | ![config_subnet](https://user-images.githubusercontent.com/4225738/45190619-2ba94f00-b23f-11e8-9e45-b5e721c63d70.png) 21 | 22 | ### Run this container 23 | 24 | Pass the MySQL password and the phpipam agent key. 25 | 26 | ```bash 27 | $ 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 28 | ``` 29 | 30 | Now, the discovery scans will be performed every 1mn by default. 31 | 32 | The logs are available on stdout/stderr (allowing to use `docker logs`). 33 | -------------------------------------------------------------------------------- /php.ini: -------------------------------------------------------------------------------- 1 | [PHP] 2 | engine = On 3 | short_open_tag = Off 4 | precision = 14 5 | output_buffering = 4096 6 | zlib.output_compression = Off 7 | implicit_flush = Off 8 | serialize_precision = 17 9 | zend.enable_gc = On 10 | expose_php = Off 11 | max_execution_time = 30 12 | max_input_time = 60 13 | error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT 14 | display_errors = Off 15 | log_errors = On 16 | log_errors_max_len = 1024 17 | default_mimetype = "text/html" 18 | default_charset = "UTF-8" 19 | file_uploads = On 20 | upload_max_filesize = 2M 21 | max_file_uploads = 20 22 | allow_url_fopen = On 23 | allow_url_include = Off 24 | default_socket_timeout = 60 25 | 26 | [Date] 27 | date.timezone = "UTC" 28 | 29 | [mail function] 30 | smtp_port = 25 31 | mail.add_x_header = On 32 | 33 | [MySQLi] 34 | mysqli.max_persistent = -1 35 | mysqli.allow_persistent = On 36 | mysqli.max_links = -1 37 | mysqli.cache_size = 2000 38 | mysqli.default_port = 3306 39 | mysqli.reconnect = Off 40 | --------------------------------------------------------------------------------