YunoHost-Apps/phpipam_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/phpipam_ynh.git synced 2024-09-03 19:56:39 +02:00
Code Issues Activity Actions 1

Merge pull request #1 from YunoHost-Apps/testing

Browse source 
Testing
This commit is contained in:
Éric Gaspar 2021-07-06 12:57:32 +02:00 • committed by GitHub
commit 3ea3b44f21
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
23 changed files with 2181 additions and 490 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
.DS_Store vendored Normal file
View file

Binary file not shown.

16
.github/PULL_REQUEST_TEMPLATE.md vendored Normal file
View file

@ -0,0 +1,16 @@
## Problem
- *Description of why you made this PR*
## Solution
- *And how do you fix that problem*
## PR Status
- [ ] Code finished and ready to be reviewed/tested
- [ ] The fix/enhancement were manually tested (if applicable)
## Automatic tests
Automatic tests can be triggered on https://ci-apps-dev.yunohost.org/ *after creating the PR*, by commenting "!testme", "!gogogadgetoci" or "By the power of systemd, I invoke The Great App CI to test this Pull Request!". (N.B. : for this to work you need to be a member of the Yunohost-Apps organization)

50
README.md
View file

@ -1,27 +1,49 @@
# phpIPAM app for YunoHost <!--
phpIPAM Server N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
**Shipped version:** 1.4 # phpIPAM for YunoHost
- [Yunohost project](https://yunohost.org) [![Integration level](https://dash.yunohost.org/integration/phpipam.svg)](https://dash.yunohost.org/appci/app/phpipam) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.maintain.svg)
- [phpIPAM website](https://phpipam.net/) [![Install phpIPAM with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpipam)
![](https://phpipam.net/css/images/phpipam_logo_small@2x.png) *[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install phpIPAM quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
[![Install phpIPAM with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=phpipam) ## Overview
### Installing guide Web IP address management application
App can be installed by YunoHost **admin web-interface** or by **running following command**: **Shipped version:** 1.4.3~ynh1
$ sudo yunohost app install https://github.com/YunoHost-Apps/phpipam_ynh **Demo:** http://demo.phpipam.net
1. Login in phpIPAM ## Screenshots
2. Default user : admin password : ipamadmin
![](./doc/screenshots/.DS_Store)
![](./doc/screenshots/dashboard.png)
### Upgrade this package: ## Documentation and resources
$ sudo yunohost app upgrade phpipam -u https://github.com/YunoHost-Apps/phpipam_ynh * Official app website: https://phpipam.net
* Official user documentation: https://yunohost.org/apps
* Official admin documentation: https://phpipam.net/documents/
* Upstream app code repository: https://github.com/phpipam/phpipam
* YunoHost documentation for this app: https://yunohost.org/app_phpipam
* Report a bug: https://github.com/YunoHost-Apps/phpipam_ynh/issues
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing).
To try the testing branch, please proceed like that.
```
sudo yunohost app install https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing --debug
or
sudo yunohost app upgrade phpipam -u https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing --debug
```
**More info regarding app packaging:** https://yunohost.org/packaging_apps

45
README_fr.md Normal file
View file

@ -0,0 +1,45 @@
# phpIPAM pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/phpipam.svg)](https://dash.yunohost.org/appci/app/phpipam) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phpipam.maintain.svg)
[![Installer phpIPAM avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phpipam)
*[Read this readme in english.](./README.md)*
*[Lire ce readme en français.](./README_fr.md)*
> *Ce package vous permet d'installer phpIPAM rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.*
## Vue d'ensemble
Application web de gestion d'adresses IP
**Version incluse :** 1.4.3~ynh1
**Démo :** http://demo.phpipam.net
## Captures d'écran
![](./doc/screenshots/.DS_Store)
![](./doc/screenshots/dashboard.png)
## Documentations et ressources
* Site officiel de l'app : https://phpipam.net
* Documentation officielle utilisateur : https://yunohost.org/apps
* Documentation officielle de l'admin : https://phpipam.net/documents/
* Dépôt de code officiel de l'app : https://github.com/phpipam/phpipam
* Documentation YunoHost pour cette app : https://yunohost.org/app_phpipam
* Signaler un bug : https://github.com/YunoHost-Apps/phpipam_ynh/issues
## Informations pour les développeurs
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing).
Pour essayer la branche testing, procédez comme suit.
```
sudo yunohost app install https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing --debug
ou
sudo yunohost app upgrade phpipam -u https://github.com/YunoHost-Apps/phpipam_ynh/tree/testing --debug
```
**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps

39
check_process
View file

@ -1,42 +1,23 @@
# See here for more informations
# https://github.com/YunoHost/package_check#syntax-check_process-file
# Move this file from check_process.default to check_process when you have filled it.
;; Test complet ;; Test complet
; Manifest ; Manifest
domain="domain.tld" (DOMAIN) domain="domain.tld"
path="/" (PATH) path="/path"
is_public=1 (PUBLIC|public=1|private=0) is_public=1
# password="pass"
# nextclouddomain="domain.tld"
port="9980" (PORT)
; Checks ; Checks
pkg_linter=1 pkg_linter=1
setup_sub_dir=0 setup_sub_dir=1
setup_root=1 setup_root=1
setup_nourl=0 setup_nourl=0
setup_private=0 setup_private=1
setup_public=1 setup_public=1
upgrade=1 upgrade=1
backup_restore=1 backup_restore=1
multi_instance=1 multi_instance=1
incorrect_path=1 change_url=1
port_already_use=0
change_url=0
;;; Levels
Level 1=auto
Level 2=auto
Level 3=auto
# Level 4:
Level 4=1 (This app supports the Nextcloud LDAP auth)
# Level 5:
Level 5=auto
Level 6=auto
Level 7=auto
Level 8=0
Level 9=0
Level 10=0
;;; Options ;;; Options
Email= Email=
Notification=none Notification=none
;;; Upgrade options
; commit=CommitHash
name=Name and date of the commit.
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&is_public=1&

998
conf/SCHEMA.sql Normal file
View file

@ -0,0 +1,998 @@
# Dump of table instructions
# ------------------------------------------------------------
DROP TABLE IF EXISTS `instructions`;
CREATE TABLE `instructions` (
`id` int(11) NOT NULL,
`instructions` text,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `instructions` (`id`, `instructions`)
VALUES
(1,'You can write instructions under admin menu!');
# Dump of table customers
# ------------------------------------------------------------
DROP TABLE IF EXISTS `customers`;
CREATE TABLE `customers` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`title` varchar(128) NOT NULL DEFAULT '',
`address` varchar(255) DEFAULT NULL,
`postcode` int(8) DEFAULT NULL,
`city` varchar(255) DEFAULT NULL,
`state` varchar(255) DEFAULT NULL,
`lat` varchar(12) DEFAULT NULL,
`long` varchar(12) DEFAULT NULL,
`contact_person` text DEFAULT NULL,
`contact_phone` varchar(32) DEFAULT NULL,
`contact_mail` varchar(255) DEFAULT NULL,
`note` text DEFAULT NULL,
`status` set('Active','Reserved','Inactive') DEFAULT 'Active',
PRIMARY KEY (`id`),
UNIQUE KEY `title` (`title`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table ipaddresses
# ------------------------------------------------------------
DROP TABLE IF EXISTS `ipaddresses`;
CREATE TABLE `ipaddresses` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`subnetId` INT(11) UNSIGNED NULL DEFAULT NULL,
`ip_addr` varchar(100) NOT NULL,
`is_gateway` TINYINT(1) NULL DEFAULT '0',
`description` varchar(64) DEFAULT NULL,
`hostname` varchar(255) DEFAULT NULL,
`mac` varchar(20) DEFAULT NULL,
`owner` varchar(128) DEFAULT NULL,
`state` INT(3) NULL DEFAULT '2',
`switch` INT(11) UNSIGNED NULL DEFAULT NULL,
`location` INT(11) UNSIGNED NULL DEFAULT NULL,
`port` varchar(32) DEFAULT NULL,
`note` text,
`lastSeen` DATETIME NULL DEFAULT '1970-01-01 00:00:01',
`excludePing` BINARY NULL DEFAULT '0',
`PTRignore` BINARY NULL DEFAULT '0',
`PTR` INT(11) UNSIGNED NULL DEFAULT '0',
`firewallAddressObject` VARCHAR(100) NULL DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`customer_id` INT(11) unsigned NULL default NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `sid_ip_unique` (`ip_addr`,`subnetId`),
KEY `subnetid` (`subnetId`),
KEY `location` (`location`),
KEY `customer_ip` (`customer_id`),
CONSTRAINT `customer_ip` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `ipaddresses` (`id`, `subnetId`, `ip_addr`, `description`, `hostname`, `state`)
VALUES
(1,3,'168427779','Server1','server1.cust1.local',2),
(2,3,'168427780','Server2','server2.cust1.local',2),
(3,3,'168427781','Server3','server3.cust1.local',3),
(4,3,'168427782','Server4','server4.cust1.local',3),
(5,3,'168428021','Gateway',NULL,2),
(6,4,'168428286','Gateway',NULL,2),
(7,4,'168428042','Server1','ser1.client2.local',2),
(8,6,'172037636','DHCP range',NULL,4),
(9,6,'172037637','DHCP range',NULL,4),
(10,6,'172037638','DHCP range',NULL,4);
# Dump of table logs
# ------------------------------------------------------------
DROP TABLE IF EXISTS `logs`;
CREATE TABLE `logs` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`severity` int(11) DEFAULT NULL,
`date` varchar(32) DEFAULT NULL,
`username` varchar(255) DEFAULT NULL,
`ipaddr` varchar(64) DEFAULT NULL,
`command` varchar(128) DEFAULT '0',
`details` varchar(1024) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table requests
# ------------------------------------------------------------
DROP TABLE IF EXISTS `requests`;
CREATE TABLE `requests` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`subnetId` INT(11) UNSIGNED NULL DEFAULT NULL,
`ip_addr` varchar(100) DEFAULT NULL,
`description` varchar(64) DEFAULT NULL,
`hostname` varchar(255) DEFAULT NULL,
`state` INT NULL DEFAULT '2',
`owner` varchar(128) DEFAULT NULL,
`requester` varchar(128) DEFAULT NULL,
`comment` text,
`processed` binary(1) DEFAULT NULL,
`accepted` binary(1) DEFAULT NULL,
`adminComment` text,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table sections
# ------------------------------------------------------------
DROP TABLE IF EXISTS `sections`;
CREATE TABLE `sections` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(128) NOT NULL DEFAULT '',
`description` text,
`masterSection` INT(11) NULL DEFAULT '0',
`permissions` varchar(1024) DEFAULT NULL,
`strictMode` BINARY(1) NOT NULL DEFAULT '1',
`subnetOrdering` VARCHAR(16) NULL DEFAULT NULL,
`order` INT(3) NULL DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`showVLAN` BOOL NOT NULL DEFAULT '0',
`showVRF` BOOL NOT NULL DEFAULT '0',
`showSupernetOnly` BOOL NOT NULL DEFAULT '0',
`DNS` VARCHAR(128) NULL DEFAULT NULL,
PRIMARY KEY (`name`),
UNIQUE KEY `id_2` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `sections` (`id`, `name`, `description`, `permissions`)
VALUES
(1,'Customers','Section for customers','{\"3\":\"1\",\"2\":\"2\"}'),
(2,'IPv6','Section for IPv6 addresses','{\"3\":\"1\",\"2\":\"2\"}');
# Dump of table settings
# ------------------------------------------------------------
DROP TABLE IF EXISTS `settings`;
CREATE TABLE `settings` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`siteTitle` varchar(64) DEFAULT NULL,
`siteAdminName` varchar(64) DEFAULT NULL,
`siteAdminMail` varchar(64) DEFAULT NULL,
`siteDomain` varchar(32) DEFAULT NULL,
`siteURL` varchar(64) DEFAULT NULL,
`siteLoginText` varchar(128) DEFAULT NULL,
`domainAuth` tinyint(1) DEFAULT NULL,
`enableIPrequests` tinyint(1) DEFAULT NULL,
`enableVRF` tinyint(1) DEFAULT '1',
`enableDNSresolving` tinyint(1) DEFAULT NULL,
`enableFirewallZones` TINYINT(1) NOT NULL DEFAULT '0',
`firewallZoneSettings` VARCHAR(1024) NOT NULL DEFAULT '{"zoneLength":3,"ipType":{"0":"v4","1":"v6"},"separator":"_","indicator":{"0":"own","1":"customer"},"zoneGenerator":"2","zoneGeneratorType":{"0":"decimal","1":"hex","2":"text"},"deviceType":"3","padding":"on","strictMode":"on","pattern":{"0":"patternFQDN"}}',
`enablePowerDNS` TINYINT(1) NULL DEFAULT '0',
`powerDNS` TEXT NULL,
`enableDHCP` TINYINT(1) NULL DEFAULT '0',
`DHCP` VARCHAR(256) NULL default '{"type":"kea","settings":{"file":"\/etc\/kea\/kea.conf"}}',
`enableMulticast` TINYINT(1) NULL DEFAULT '0',
`enableNAT` TINYINT(1) NULL DEFAULT '1',
`enableSNMP` TINYINT(1) NULL DEFAULT '0',
`enableThreshold` TINYINT(1) NULL DEFAULT '1',
`enableRACK` TINYINT(1) NULL DEFAULT '1',
`enableLocations` TINYINT(1) NULL DEFAULT '1',
`enablePSTN` TINYINT(1) NULL DEFAULT '0',
`enableChangelog` TINYINT(1) NOT NULL DEFAULT '1',
`enableCustomers` TINYINT(1) NOT NULL DEFAULT '1',
`link_field` VARCHAR(32) NULL DEFAULT '0',
`version` varchar(5) DEFAULT NULL,
`dbversion` INT(8) NOT NULL DEFAULT '0',
`dbverified` BINARY(1) NOT NULL DEFAULT '0',
`donate` tinyint(1) DEFAULT '0',
`IPfilter` varchar(128) DEFAULT NULL,
`IPrequired` VARCHAR(128) NULL DEFAULT NULL,
`vlanDuplicate` int(1) DEFAULT '0',
`vlanMax` INT(8) NULL DEFAULT '4096',
`subnetOrdering` varchar(16) DEFAULT 'subnet,asc',
`visualLimit` int(2) NOT NULL DEFAULT '0',
`theme` VARCHAR(32) NOT NULL DEFAULT 'dark',
`autoSuggestNetwork` TINYINT(1) NOT NULL DEFAULT '0',
`pingStatus` VARCHAR(32) NOT NULL DEFAULT '1800;3600',
`defaultLang` INT(3) NULL DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`vcheckDate` DATETIME NULL DEFAULT NULL ,
`api` BINARY NOT NULL DEFAULT '0',
`scanPingPath` VARCHAR(64) NULL DEFAULT '/bin/ping',
`scanFPingPath` VARCHAR(64) NULL DEFAULT '/bin/fping',
`scanPingType` SET('ping','pear','fping') NOT NULL DEFAULT 'ping',
`scanMaxThreads` INT(4) NULL DEFAULT '128',
`prettyLinks` SET("Yes","No") NOT NULL DEFAULT 'No',
`hiddenCustomFields` text NULL,
`inactivityTimeout` INT(5) NOT NULL DEFAULT '3600',
`updateTags` TINYINT(1) NULL DEFAULT '0',
`enforceUnique` TINYINT(1) NULL DEFAULT '1',
`authmigrated` TINYINT NOT NULL DEFAULT '0',
`maintaneanceMode` TINYINT(1) NULL DEFAULT '0',
`decodeMAC` TINYINT(1) NULL DEFAULT '1',
`tempShare` TINYINT(1) NULL DEFAULT '0',
`tempAccess` TEXT NULL,
`log` SET('Database','syslog', 'both') NOT NULL DEFAULT 'Database',
`subnetView` TINYINT NOT NULL DEFAULT '0',
`enableCircuits` TINYINT(1) NULL DEFAULT '1',
`enableRouting` TINYINT(1) NULL DEFAULT '0',
`permissionPropagate` TINYINT(1) NULL DEFAULT '1',
`passwordPolicy` VARCHAR(1024) NULL DEFAULT '{\"minLength\":8,\"maxLength\":0,\"minNumbers\":0,\"minLetters\":0,\"minLowerCase\":0,\"minUpperCase\":0,\"minSymbols\":0,\"maxSymbols\":0,\"allowedSymbols\":\"#,_,-,!,[,],=,~\"}',
`2fa_provider` SET('none','Google_Authenticator') NULL DEFAULT 'none',
`2fa_name` VARCHAR(32) NULL DEFAULT 'phpipam',
`2fa_length` INT(2) NULL DEFAULT '16',
`2fa_userchange` BOOL NOT NULL DEFAULT '1',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `settings` (`id`, `siteTitle`, `siteAdminName`, `siteAdminMail`, `siteDomain`, `siteURL`, `domainAuth`, `enableIPrequests`, `enableVRF`, `enableDNSresolving`, `version`, `donate`, `IPfilter`, `vlanDuplicate`, `subnetOrdering`, `visualLimit`)
VALUES
(1, 'phpipam IP address management', 'Sysadmin', 'admin@domain.local', 'domain.local', 'http://yourpublicurl.com', 0, 0, 0, 0, '1.4', 0, 'mac;owner;state;switch;note;firewallAddressObject', 1, 'subnet,asc', 24);
# Dump of table settingsMail
# ------------------------------------------------------------
DROP TABLE IF EXISTS `settingsMail`;
CREATE TABLE `settingsMail` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`mtype` set('localhost','smtp') NOT NULL DEFAULT 'localhost',
`msecure` SET('none','ssl','tls') NOT NULL DEFAULT 'none',
`mauth` set('yes','no') NOT NULL DEFAULT 'no',
`mserver` varchar(128) DEFAULT NULL,
`mport` int(5) DEFAULT '25',
`muser` varchar(64) DEFAULT NULL,
`mpass` varchar(64) DEFAULT NULL,
`mAdminName` varchar(64) DEFAULT NULL,
`mAdminMail` varchar(64) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `settingsMail` (`id`, `mtype`)
VALUES
(1, 'localhost');
# Dump of table subnets
# ------------------------------------------------------------
DROP TABLE IF EXISTS `subnets`;
CREATE TABLE `subnets` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`subnet` VARCHAR(255) NULL DEFAULT NULL,
`mask` VARCHAR(3) NULL DEFAULT NULL,
`sectionId` INT(11) UNSIGNED NULL DEFAULT NULL,
`description` text,
`linked_subnet` INT(11) UNSIGNED NULL DEFAULT NULL,
`firewallAddressObject` VARCHAR(100) NULL DEFAULT NULL,
`vrfId` INT(11) UNSIGNED NULL DEFAULT NULL,
`masterSubnetId` INT(11) UNSIGNED NOT NULL default 0,
`allowRequests` tinyint(1) DEFAULT '0',
`vlanId` INT(11) UNSIGNED NULL DEFAULT NULL,
`showName` tinyint(1) DEFAULT '0',
`device` INT UNSIGNED NULL DEFAULT '0',
`permissions` varchar(1024) DEFAULT NULL,
`pingSubnet` BOOL NULL DEFAULT '0',
`discoverSubnet` BINARY(1) NULL DEFAULT '0',
`resolveDNS` TINYINT(1) NULL DEFAULT '0',
`DNSrecursive` TINYINT(1) NULL DEFAULT '0',
`DNSrecords` TINYINT(1) NULL DEFAULT '0',
`nameserverId` INT(11) NULL DEFAULT '0',
`scanAgent` INT(11) DEFAULT NULL,
`customer_id` INT(11) unsigned NULL default NULL,
`isFolder` BOOL NULL DEFAULT '0',
`isFull` TINYINT(1) NULL DEFAULT '0',
`state` INT(3) NULL DEFAULT '2',
`threshold` int(3) NULL DEFAULT 0,
`location` INT(11) UNSIGNED NULL DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`lastScan` TIMESTAMP NULL,
`lastDiscovery` TIMESTAMP NULL,
PRIMARY KEY (`id`),
KEY `masterSubnetId` (`masterSubnetId`),
KEY `location` (`location`),
KEY `sectionId` (`sectionId`),
KEY `vrfId` (`vrfId`),
KEY `customer_subnets` (`customer_id`),
CONSTRAINT `customer_subnets` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `subnets` (`id`, `subnet`, `mask`, `sectionId`, `description`, `vrfId`, `masterSubnetId`, `allowRequests`, `vlanId`, `showName`, `permissions`, `isFolder`)
VALUES
(1,'336395549904799703390415618052362076160','64',2,'Private subnet 1',0,'0',1,1,1,'{\"3\":\"1\",\"2\":\"2\"}',0),
(2,'168427520','16','1','Business customers',0,'0',1,0,1,'{\"3\":\"1\",\"2\":\"2\"}',0),
(3,'168427776','24','1','Customer 1',0,'2',1,0,1,'{\"3\":\"1\",\"2\":\"2\"}',0),
(4,'168428032','24','1','Customer 2',0,'2',1,0,1,'{\"3\":\"1\",\"2\":\"2\"}',0),
(5, '0', '', 1, 'My folder', 0, 0, 0, 0, 0, '{\"3\":\"1\",\"2\":\"2\"}', 1),
(6, '172037632', '24', 1, 'DHCP range', 0, 5, 0, 0, 1, '{\"3\":\"1\",\"2\":\"2\"}', 0);
# Dump of table devices
# ------------------------------------------------------------
DROP TABLE IF EXISTS `devices`;
CREATE TABLE `devices` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`hostname` varchar(255) DEFAULT NULL,
`ip_addr` varchar(100) DEFAULT NULL,
`type` int(2) DEFAULT '0',
`description` varchar(256) DEFAULT NULL,
`sections` varchar(1024) DEFAULT NULL,
`snmp_community` varchar(100) DEFAULT NULL,
`snmp_version` set('0','1','2','3') DEFAULT '0',
`snmp_port` mediumint(5) unsigned DEFAULT '161',
`snmp_timeout` mediumint(5) unsigned DEFAULT '1000',
`snmp_queries` varchar(128) DEFAULT NULL,
`snmp_v3_sec_level` set('none','noAuthNoPriv','authNoPriv','authPriv') DEFAULT 'none',
`snmp_v3_auth_protocol` set('none','MD5','SHA') DEFAULT 'none',
`snmp_v3_auth_pass` varchar(64) DEFAULT NULL,
`snmp_v3_priv_protocol` set('none','DES','AES') DEFAULT 'none',
`snmp_v3_priv_pass` varchar(64) DEFAULT NULL,
`snmp_v3_ctx_name` varchar(64) DEFAULT NULL,
`snmp_v3_ctx_engine_id` varchar(64) DEFAULT NULL,
`rack` int(11) unsigned DEFAULT NULL,
`rack_start` int(11) unsigned DEFAULT NULL,
`rack_size` int(11) unsigned DEFAULT NULL,
`location` int(11) unsigned DEFAULT NULL,
`editDate` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`id`),
KEY `hostname` (`hostname`),
KEY `location` (`location`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table userGroups
# ------------------------------------------------------------
DROP TABLE IF EXISTS `userGroups`;
CREATE TABLE `userGroups` (
`g_id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`g_name` varchar(32) DEFAULT NULL,
`g_desc` varchar(1024) DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`g_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `userGroups` (`g_id`, `g_name`, `g_desc`)
VALUES
(2,'Operators','default Operator group'),
(3,'Guests','default Guest group (viewers)');
# Dump of table users
# ------------------------------------------------------------
DROP TABLE IF EXISTS `users`;
CREATE TABLE `users` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`username` varchar(255) CHARACTER SET utf8 NOT NULL DEFAULT '',
`authMethod` INT(2) NULL DEFAULT 1,
`password` CHAR(128) COLLATE utf8_bin DEFAULT NULL,
`groups` varchar(1024) COLLATE utf8_bin DEFAULT NULL,
`role` text CHARACTER SET utf8,
`real_name` varchar(128) CHARACTER SET utf8 DEFAULT NULL,
`email` varchar(64) CHARACTER SET utf8 DEFAULT NULL,
`domainUser` binary(1) DEFAULT '0',
`widgets` VARCHAR(1024) NULL DEFAULT 'statistics;favourite_subnets;changelog;top10_hosts_v4',
`lang` INT(11) UNSIGNED NULL DEFAULT '9',
`favourite_subnets` VARCHAR(1024) NULL DEFAULT NULL,
`disabled` SET('Yes','No') NOT NULL DEFAULT 'No',
`mailNotify` SET('Yes','No') NULL DEFAULT 'No',
`mailChangelog` SET('Yes','No') NULL DEFAULT 'No',
`passChange` SET('Yes','No') NOT NULL DEFAULT 'No',
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`lastLogin` TIMESTAMP NULL,
`lastActivity` TIMESTAMP NULL,
`compressOverride` SET('default','Uncompress') NOT NULL DEFAULT 'default',
`hideFreeRange` tinyint(1) DEFAULT '0',
`menuType` SET('Static','Dynamic') NULL DEFAULT 'Dynamic',
`menuCompact` TINYINT NULL DEFAULT '1',
`2fa` BOOL NOT NULL DEFAULT '0',
`2fa_secret` VARCHAR(32) NULL DEFAULT NULL,
`theme` VARCHAR(32) NULL DEFAULT '',
`token` VARCHAR(24) NULL DEFAULT NULL,
`token_valid_until` DATETIME NULL,
`module_permissions` varchar(255) COLLATE utf8_bin DEFAULT '{"vlan":"1","vrf":"1","pdns":"1","circuits":"1","racks":"1","nat":"1","pstn":"1","customers":"1","locations":"1","devices":"1"}',
`compress_actions` TINYINT(1) NULL DEFAULT '1',
PRIMARY KEY (`username`),
UNIQUE KEY `id_2` (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin;
/* insert default values */
INSERT INTO `users` (`id`, `username`, `password`, `groups`, `role`, `real_name`, `email`, `domainUser`,`widgets`, `passChange`)
VALUES
(1,'Admin',X'243624726F756E64733D33303030244A51454536644C394E70766A6546733424524B3558336F6132382E557A742F6835564166647273766C56652E3748675155594B4D58544A5573756438646D5766507A5A51506252626B38784A6E314B797974342E64576D346E4A4959684156326D624F5A33672E',X'','Administrator','phpIPAM Admin','admin@domain.local',X'30','statistics;favourite_subnets;changelog;access_logs;error_logs;top10_hosts_v4', 'Yes');
# Dump of table lang
# ------------------------------------------------------------
DROP TABLE IF EXISTS `lang`;
CREATE TABLE `lang` (
`l_id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`l_code` varchar(12) NOT NULL DEFAULT '',
`l_name` varchar(32) DEFAULT NULL,
PRIMARY KEY (`l_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `lang` (`l_id`, `l_code`, `l_name`)
VALUES
(1, 'en_GB.UTF-8', 'English'),
(2, 'sl_SI.UTF-8', 'Slovenščina'),
(3, 'fr_FR.UTF-8', 'Français'),
(4, 'nl_NL.UTF-8', 'Nederlands'),
(5, 'de_DE.UTF-8', 'Deutsch'),
(6, 'pt_BR.UTF-8', 'Brazil'),
(7, 'es_ES.UTF-8', 'Español'),
(8, 'cs_CZ.UTF-8', 'Czech'),
(9, 'en_US.UTF-8', 'English (US)'),
(10,'ru_RU.UTF-8', 'Russian'),
(11,'zh_CN.UTF-8', 'Chinese'),
(12,'ja_JP.UTF-8', 'Japanese');
# Dump of table vlans
# ------------------------------------------------------------
DROP TABLE IF EXISTS `vlans`;
CREATE TABLE `vlans` (
`vlanId` int(11) NOT NULL AUTO_INCREMENT,
`domainId` INT NOT NULL DEFAULT '1',
`name` varchar(255) NOT NULL,
`number` int(4) DEFAULT NULL,
`description` text,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`customer_id` INT(11) unsigned NULL default NULL,
PRIMARY KEY (`vlanId`),
KEY `customer_vlans` (`customer_id`),
CONSTRAINT `customer_vlans` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `vlans` (`vlanId`, `name`, `number`, `description`)
VALUES
(1,'IPv6 private 1',2001,'IPv6 private 1 subnets'),
(2,'Servers DMZ',4001,'DMZ public');
# Dump of table vlanDomains
# ------------------------------------------------------------
DROP TABLE IF EXISTS `vlanDomains`;
CREATE TABLE `vlanDomains` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(64) DEFAULT NULL,
`description` text,
`permissions` varchar(128) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `vlanDomains` (`id`, `name`, `description`, `permissions`)
VALUES
(1, 'default', 'default L2 domain', NULL);
# Dump of table vrf
# ------------------------------------------------------------
DROP TABLE IF EXISTS `vrf`;
CREATE TABLE `vrf` (
`vrfId` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(32) NOT NULL DEFAULT '',
`rd` varchar(32) DEFAULT NULL,
`description` varchar(256) DEFAULT NULL,
`sections` VARCHAR(128) NULL DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`customer_id` int(11) unsigned DEFAULT NULL,
PRIMARY KEY (`vrfId`),
KEY `customer_vrf` (`customer_id`),
CONSTRAINT `customer_vrf` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table nameservers
# ------------------------------------------------------------
DROP TABLE IF EXISTS `nameservers`;
CREATE TABLE `nameservers` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`name` varchar(255) NOT NULL,
`namesrv1` varchar(255) DEFAULT NULL,
`description` text,
`permissions` varchar(128) DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `nameservers` (`name`, `namesrv1`, `description`, `permissions`)
VALUES
('Google NS', '8.8.8.8;8.8.4.4', 'Google public nameservers', '1;2');
# Dump of table api
# ------------------------------------------------------------
DROP TABLE IF EXISTS `api`;
CREATE TABLE `api` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`app_id` varchar(32) NOT NULL DEFAULT '',
`app_code` varchar(32) NULL DEFAULT '',
`app_permissions` int(1) DEFAULT '1',
`app_comment` TEXT NULL,
`app_security`SET('ssl_code','ssl_token','crypt','user','none') NOT NULL DEFAULT 'ssl_token',
`app_lock` INT(1) NOT NULL DEFAULT '0',
`app_lock_wait` INT(4) NOT NULL DEFAULT '30',
`app_nest_custom_fields` TINYINT(1) NULL DEFAULT '0',
`app_show_links` TINYINT(1) NULL DEFAULT '0',
`app_last_access` datetime DEFAULT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `app_id` (`app_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table changelog
# ------------------------------------------------------------
DROP TABLE IF EXISTS `changelog`;
CREATE TABLE `changelog` (
`cid` int(11) unsigned NOT NULL AUTO_INCREMENT,
`ctype` set('ip_addr','subnet','section') NOT NULL DEFAULT '',
`coid` int(11) unsigned NOT NULL,
`cuser` int(11) unsigned NOT NULL,
`caction` set('add','edit','delete','truncate','resize','perm_change') NOT NULL DEFAULT 'edit',
`cresult` set('error','success') NOT NULL DEFAULT '',
`cdate` datetime NOT NULL,
`cdiff` varchar(2048) DEFAULT NULL,
PRIMARY KEY (`cid`),
KEY `coid` (`coid`),
KEY `ctype` (`ctype`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table widgets
# ------------------------------------------------------------
DROP TABLE IF EXISTS `widgets`;
CREATE TABLE `widgets` (
`wid` int(11) unsigned NOT NULL AUTO_INCREMENT,
`wtitle` varchar(64) NOT NULL DEFAULT '',
`wdescription` varchar(1024) DEFAULT NULL,
`wfile` varchar(64) NOT NULL DEFAULT '',
`wparams` varchar(1024) DEFAULT NULL,
`whref` enum('yes','no') NOT NULL DEFAULT 'no',
`wsize` enum('4','6','8','12') NOT NULL DEFAULT '6',
`wadminonly` enum('yes','no') NOT NULL DEFAULT 'no',
`wactive` enum('yes','no') NOT NULL DEFAULT 'no',
PRIMARY KEY (`wid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `widgets` (`wid`, `wtitle`, `wdescription`, `wfile`, `wparams`, `whref`, `wsize`, `wadminonly`, `wactive`)
VALUES
(1, 'Statistics', 'Shows some statistics on number of hosts, subnets', 'statistics', NULL, 'no', '4', 'no', 'yes'),
(2, 'Favourite subnets', 'Shows 5 favourite subnets', 'favourite_subnets', NULL, 'yes', '8', 'no', 'yes'),
(3, 'Top 10 IPv4 subnets by number of hosts', 'Shows graph of top 10 IPv4 subnets by number of hosts', 'top10_hosts_v4', NULL, 'yes', '6', 'no', 'yes'),
(4, 'Top 10 IPv6 subnets by number of hosts', 'Shows graph of top 10 IPv6 subnets by number of hosts', 'top10_hosts_v6', NULL, 'yes', '6', 'no', 'yes'),
(5, 'Top 10 IPv4 subnets by usage percentage', 'Shows graph of top 10 IPv4 subnets by usage percentage', 'top10_percentage', NULL, 'yes', '6', 'no', 'yes'),
(6, 'Last 5 change log entries', 'Shows last 5 change log entries', 'changelog', NULL, 'yes', '12', 'no', 'yes'),
(7, 'Active IP addresses requests', 'Shows list of active IP address request', 'requests', NULL, 'yes', '6', 'yes', 'yes'),
(8, 'Last 5 informational logs', 'Shows list of last 5 informational logs', 'access_logs', NULL, 'yes', '6', 'yes', 'yes'),
(9, 'Last 5 warning / error logs', 'Shows list of last 5 warning and error logs', 'error_logs', NULL, 'yes', '6', 'yes', 'yes'),
(10,'Tools menu', 'Shows quick access to tools menu', 'tools', NULL, 'yes', '6', 'no', 'yes'),
(11,'IP Calculator', 'Shows IP calculator as widget', 'ipcalc', NULL, 'yes', '6', 'no', 'yes'),
(12,'IP Request', 'IP Request widget', 'iprequest', NULL, 'no', '6', 'no', 'yes'),
(13,'Threshold', 'Shows threshold usage for top 5 subnets', 'threshold', NULL, 'yes', '6', 'no', 'yes'),
(14,'Inactive hosts', 'Shows list of inactive hosts for defined period', 'inactive-hosts', 86400, 'yes', '6', 'yes', 'yes'),
(15, 'Locations', 'Shows map of locations', 'locations', NULL, 'yes', '6', 'no', 'yes'),
(16, 'Bandwidth calculator', 'Calculate bandwidth', 'bw_calculator', NULL, 'no', '6', 'no', 'yes'),
(17, 'Customers', 'Shows customer list', 'customers', NULL, 'yes', '6', 'no', 'yes'),
(18, 'User Instructions', 'Shows user instructions', 'instructions', NULL, 'yes', '6', 'no', 'yes');
# Dump of table deviceTypes
# ------------------------------------------------------------
DROP TABLE IF EXISTS `deviceTypes`;
CREATE TABLE `deviceTypes` (
`tid` int(11) unsigned NOT NULL AUTO_INCREMENT,
`tname` varchar(128) DEFAULT NULL,
`tdescription` varchar(128) DEFAULT NULL,
PRIMARY KEY (`tid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `deviceTypes` (`tid`, `tname`, `tdescription`)
VALUES
(1, 'Switch', 'Switch'),
(2, 'Router', 'Router'),
(3, 'Firewall', 'Firewall'),
(4, 'Hub', 'Hub'),
(5, 'Wireless', 'Wireless'),
(6, 'Database', 'Database'),
(7, 'Workstation', 'Workstation'),
(8, 'Laptop', 'Laptop'),
(9, 'Other', 'Other');
# Dump of table loginAttempts
# ------------------------------------------------------------
DROP TABLE IF EXISTS `loginAttempts`;
CREATE TABLE `loginAttempts` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`datetime` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
`ip` varchar(128) NOT NULL DEFAULT '',
`count` int(2) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `ip` (`ip`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table usersAuthMethod
# ------------------------------------------------------------
DROP TABLE IF EXISTS `usersAuthMethod`;
CREATE TABLE `usersAuthMethod` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`type` set('local','http','AD','LDAP','NetIQ','Radius','SAML2') NOT NULL DEFAULT 'local',
`params` varchar(2048) DEFAULT NULL,
`protected` set('Yes','No') NOT NULL DEFAULT 'Yes',
`description` text,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `usersAuthMethod` (`id`, `type`, `params`, `protected`, `description`)
VALUES
(1, 'local', NULL, 'Yes', 'Local database'),
(2, 'http', NULL, 'Yes', 'Apache authentication');
# Dump of table ipTags
# ------------------------------------------------------------
DROP TABLE IF EXISTS `ipTags`;
CREATE TABLE `ipTags` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`type` varchar(32) DEFAULT NULL,
`showtag` tinyint(4) DEFAULT '1',
`bgcolor` varchar(7) DEFAULT '#000',
`fgcolor` varchar(7) DEFAULT '#fff',
`compress` SET('No','Yes') NOT NULL DEFAULT 'No',
`locked` set('No','Yes') NOT NULL DEFAULT 'No',
`updateTag` TINYINT(1) NULL DEFAULT '0',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `ipTags` (`id`, `type`, `showtag`, `bgcolor`, `fgcolor`, `compress`, `locked`, `updateTag`)
VALUES
(1, 'Offline', 1, '#f59c99', '#ffffff', 'No', 'Yes', 1),
(2, 'Used', 0, '#a9c9a4', '#ffffff', 'No', 'Yes', 1),
(3, 'Reserved', 1, '#9ac0cd', '#ffffff', 'No', 'Yes', 1),
(4, 'DHCP', 1, '#c9c9c9', '#ffffff', 'Yes', 'Yes', 1);
# Dump of table firewallZones
# ------------------------------------------------------------
DROP TABLE IF EXISTS `firewallZones`;
CREATE TABLE `firewallZones` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`generator` tinyint(1) NOT NULL,
`length` int(2) DEFAULT NULL,
`padding` tinyint(1) DEFAULT NULL,
`zone` varchar(31) COLLATE utf8_unicode_ci NOT NULL,
`indicator` varchar(8) COLLATE utf8_unicode_ci NOT NULL,
`description` text COLLATE utf8_unicode_ci,
`permissions` varchar(1024) COLLATE utf8_unicode_ci DEFAULT NULL,
`editDate` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
# Dump of table firewallZoneMapping
# ------------------------------------------------------------
DROP TABLE IF EXISTS `firewallZoneMapping`;
CREATE TABLE `firewallZoneMapping` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`zoneId` int(11) unsigned NOT NULL,
`alias` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci DEFAULT NULL,
`deviceId` int(11) unsigned DEFAULT NULL,
`interface` varchar(255) CHARACTER SET utf8 COLLATE utf8_unicode_ci DEFAULT NULL,
`editDate` timestamp NULL DEFAULT NULL ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`id`),
KEY `devId_idx` (`deviceId`),
CONSTRAINT `devId` FOREIGN KEY (`deviceId`) REFERENCES `devices` (`id`) ON DELETE CASCADE ON UPDATE NO ACTION
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci;
# Dump of table firewallZoneMapping
# ------------------------------------------------------------
DROP TABLE IF EXISTS `firewallZoneSubnet`;
CREATE TABLE `firewallZoneSubnet` (
`zoneId` INT NOT NULL,
`subnetId` INT(11) NOT NULL,
INDEX `fk_zoneId_idx` (`zoneId` ASC),
INDEX `fk_subnetId_idx` (`subnetId` ASC),
CONSTRAINT `fk_zoneId`
FOREIGN KEY (`zoneId`)
REFERENCES `firewallZones` (`id`)
ON DELETE CASCADE
ON UPDATE NO ACTION,
CONSTRAINT `fk_subnetId`
FOREIGN KEY (`subnetId`)
REFERENCES `subnets` (`id`)
ON DELETE CASCADE
ON UPDATE NO ACTION
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table scanAgents
# ------------------------------------------------------------
DROP TABLE IF EXISTS `scanAgents`;
CREATE TABLE `scanAgents` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(128) DEFAULT NULL,
`description` text,
`type` set('direct','api','mysql') NOT NULL DEFAULT '',
`code` varchar(32) DEFAULT NULL,
`last_access` datetime DEFAULT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `code` (`code`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `scanAgents` (`id`, `name`, `description`, `type`)
VALUES
(1, 'localhost', 'Scanning from local machine', 'direct');
# Dump of table nat
# ------------------------------------------------------------
DROP TABLE IF EXISTS `nat`;
CREATE TABLE `nat` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(64) DEFAULT NULL,
`type` set('source','static','destination') DEFAULT 'source',
`src` text DEFAULT NULL,
`dst` text DEFAULT NULL,
`src_port` int(5) DEFAULT NULL,
`dst_port` int(5) DEFAULT NULL,
`device` int(11) unsigned DEFAULT NULL,
`description` text DEFAULT NULL,
`policy` set('Yes','No') NOT NULL DEFAULT 'No',
`policy_dst` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table racks
# ------------------------------------------------------------
DROP TABLE IF EXISTS `racks`;
CREATE TABLE `racks` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(64) NOT NULL DEFAULT '',
`size` int(2) DEFAULT NULL,
`location` INT(11) UNSIGNED NULL DEFAULT NULL,
`row` INT(11) NOT NULL DEFAULT '1',
`hasBack` TINYINT(1) NOT NULL DEFAULT '0',
`topDown` tinyint(1) NOT NULL DEFAULT '0',
`description` text,
`customer_id` INT(11) unsigned NULL default NULL,
PRIMARY KEY (`id`),
KEY `location` (`location`),
KEY `customer_racks` (`customer_id`),
CONSTRAINT `customer_racks` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table rackContents
# ------------------------------------------------------------
DROP TABLE IF EXISTS `rackContents`;
CREATE TABLE `rackContents` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(100) DEFAULT NULL,
`rack` int(11) unsigned DEFAULT NULL,
`rack_start` int(11) unsigned DEFAULT NULL,
`rack_size` int(11) unsigned DEFAULT NULL,
PRIMARY KEY (`id`),
KEY `rack` (`rack`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table locations
# ------------------------------------------------------------
DROP TABLE IF EXISTS `locations`;
CREATE TABLE `locations` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(128) NOT NULL DEFAULT '',
`description` text,
`address` VARCHAR(128) NULL DEFAULT NULL,
`lat` varchar(12) DEFAULT NULL,
`long` varchar(12) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table pstnPrefixes
# ------------------------------------------------------------
DROP TABLE IF EXISTS `pstnPrefixes`;
CREATE TABLE `pstnPrefixes` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(128) DEFAULT NULL,
`prefix` varchar(32) DEFAULT NULL,
`start` varchar(32) DEFAULT NULL,
`stop` varchar(32) DEFAULT NULL,
`master` int(11) DEFAULT '0',
`deviceId` int(11) unsigned DEFAULT NULL,
`description` text,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table pstnNumbers
# ------------------------------------------------------------
DROP TABLE IF EXISTS `pstnNumbers`;
CREATE TABLE `pstnNumbers` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`prefix` int(11) unsigned DEFAULT NULL,
`number` varchar(32) DEFAULT NULL,
`name` varchar(128) DEFAULT NULL,
`owner` varchar(128) DEFAULT NULL,
`state` int(11) unsigned DEFAULT NULL,
`deviceId` int(11) unsigned DEFAULT NULL,
`description` text,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table circuitProviders
# ------------------------------------------------------------
DROP TABLE IF EXISTS `circuitProviders`;
CREATE TABLE `circuitProviders` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(256) DEFAULT NULL,
`description` text,
`contact` varchar(128) DEFAULT '',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table circuits
# ------------------------------------------------------------
DROP TABLE IF EXISTS `circuits`;
CREATE TABLE `circuits` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`cid` varchar(128) DEFAULT NULL,
`provider` int(11) unsigned NOT NULL,
`type` int(10) unsigned DEFAULT NULL,
`capacity` varchar(128) DEFAULT NULL,
`status` enum('Active','Inactive','Reserved') NOT NULL DEFAULT 'Active',
`device1` int(11) unsigned DEFAULT NULL,
`location1` int(11) unsigned DEFAULT NULL,
`device2` int(11) unsigned DEFAULT NULL,
`location2` int(11) unsigned DEFAULT NULL,
`comment` text,
`parent` int(10) unsigned NOT NULL DEFAULT '0',
`customer_id` int(11) unsigned DEFAULT NULL,
`differentiator` varchar(100) DEFAULT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `circuits_diff_UN` (`cid`,`differentiator`),
KEY `location1` (`location1`),
KEY `location2` (`location2`),
KEY `customer_circuits` (`customer_id`),
CONSTRAINT `customer_circuits` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table circuitsLogical
# ------------------------------------------------------------
DROP TABLE IF EXISTS `circuitsLogical`;
CREATE TABLE `circuitsLogical` (
`id` int(10) unsigned NOT NULL AUTO_INCREMENT,
`logical_cid` varchar(128) NOT NULL,
`purpose` varchar(64) DEFAULT NULL,
`comments` text,
`member_count` int(4) unsigned NOT NULL DEFAULT '0',
PRIMARY KEY (`id`),
UNIQUE KEY `circuitsLogical_UN` (`logical_cid`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table circuitsLogicalMapping
# ------------------------------------------------------------
DROP TABLE IF EXISTS `circuitsLogicalMapping`;
CREATE TABLE `circuitsLogicalMapping` (
`logicalCircuit_id` int(11) unsigned NOT NULL,
`circuit_id` int(11) unsigned NOT NULL,
`order` int(10) unsigned DEFAULT NULL
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table circuitTypes
# ------------------------------------------------------------
DROP TABLE IF EXISTS `circuitTypes`;
CREATE TABLE `circuitTypes` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`ctname` varchar(64) NOT NULL,
`ctcolor` varchar(7) DEFAULT '#000000',
`ctpattern` enum('Solid','Dotted') DEFAULT 'Solid',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `circuitTypes` (`ctname`) VALUES ('Default');
# Dump of table php_sessions
# ------------------------------------------------------------
DROP TABLE IF EXISTS `php_sessions`;
CREATE TABLE `php_sessions` (
`id` varchar(128) NOT NULL DEFAULT '',
`access` int(10) unsigned DEFAULT NULL,
`data` text NOT NULL,
`remote_ip` varchar(100) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table routing_bgp
# ------------------------------------------------------------
DROP TABLE IF EXISTS `routing_bgp`;
CREATE TABLE `routing_bgp` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`local_as` int(12) unsigned NOT NULL,
`local_address` varchar(100) NOT NULL DEFAULT '',
`peer_name` varchar(255) NOT NULL DEFAULT '',
`peer_as` int(12) unsigned NOT NULL,
`peer_address` varchar(100) NOT NULL DEFAULT '',
`bgp_type` enum('internal','external') NOT NULL DEFAULT 'external',
`vrf_id` int(11) unsigned DEFAULT NULL,
`circuit_id` int(11) unsigned DEFAULT NULL,
`customer_id` int(11) unsigned DEFAULT NULL,
`description` text DEFAULT NULL,
PRIMARY KEY (`id`),
KEY `vrf_id` (`vrf_id`),
KEY `circuit_id` (`circuit_id`),
KEY `cust_id` (`customer_id`),
CONSTRAINT `circuit_id` FOREIGN KEY (`circuit_id`) REFERENCES `circuits` (`id`) ON DELETE SET NULL ON UPDATE CASCADE,
CONSTRAINT `cust_id` FOREIGN KEY (`customer_id`) REFERENCES `customers` (`id`) ON DELETE SET NULL ON UPDATE CASCADE,
CONSTRAINT `vrf_id` FOREIGN KEY (`vrf_id`) REFERENCES `vrf` (`vrfId`) ON DELETE SET NULL ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table routing_subnets
# ------------------------------------------------------------
DROP TABLE IF EXISTS `routing_subnets`;
CREATE TABLE `routing_subnets` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`type` enum('bgp','ospf') NOT NULL DEFAULT 'bgp',
`direction` enum('advertised','received') NOT NULL DEFAULT 'advertised',
`object_id` int(11) unsigned NOT NULL,
`subnet_id` int(11) NOT NULL,
PRIMARY KEY (`id`),
UNIQUE KEY `type` (`type`,`object_id`,`subnet_id`),
KEY `bgp_id` (`object_id`),
KEY `subnet_id` (`subnet_id`),
CONSTRAINT `bgp_id` FOREIGN KEY (`object_id`) REFERENCES `routing_bgp` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
CONSTRAINT `subnet_id` FOREIGN KEY (`subnet_id`) REFERENCES `subnets` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table -- for autofix comment, leave as it is
# ------------------------------------------------------------
UPDATE `settings` SET `version` = "1.43";
UPDATE `settings` SET `dbversion` = 25;

10
conf/app.src
View file

@ -1,7 +1,7 @@
SOURCE_URL=https://github.com/phpipam/phpipam/archive/1.4.tar.gz SOURCE_URL=https://github.com/phpipam/phpipam/releases/download/v1.4.3/phpipam-v1.4.3.zip
SOURCE_SUM=57f3fe96f0147a74cb5c62da8b2f2d5c850d666e8db302ef1bcd2e860d85e73ba714fecadab79a390475567098a36362df4d7f3a694fcc3617248116f06c0696 SOURCE_SUM=f85b11399fc2fd3d3027e41bc7eecb89149454f3845fe1cda4c1e3722d16d00d
SOURCE_SUM_PRG=sha512sum SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz SOURCE_FORMAT=zip
SOURCE_IN_SUBDIR=true SOURCE_IN_SUBDIR=true
SOURCE_EXTRACT=true SOURCE_EXTRACT=true
SOURCE_FILENAME=phpipam.tar.gz SOURCE_FILENAME=phpipam.zip

30
conf/config.dist.php
View file

@ -4,21 +4,21 @@
* database connection details * database connection details
******************************/ ******************************/
$db['host'] = 'localhost'; $db['host'] = 'localhost';
$db['user'] = 'yunouser'; $db['user'] = '__DB_NAME__';
$db['pass'] = 'yunopass'; $db['pass'] = '__DB_PWD__';
$db['name'] = 'yunobase'; $db['name'] = '__DB_NAME__';
$db['port'] = 3306; $db['port'] = 3306;
/** /**
* Database webhost settings * Database webhost settings
* *
* Enable and change this setting if your MySQL database does not run on * Change this setting if your MySQL database does not run on localhost
* localhost and you want to use the automatic database installation method * and you want to use the automatic database installation method to
* to create a database user for you (which by default is created @localhost) * create a database user for you (which by default is created @localhost)
* *
* Set to the hostname or IP address of the webserver, or % to allow all * Set to the hostname or IP address of the webserver, or % to allow all
******************************/ ******************************/
// $db['webhost'] = 'localhost'; $db['webhost'] = '%';
/** /**
@ -96,6 +96,13 @@ $api_allow_unsafe = false;
******************************/ ******************************/
$phpsessname = "phpipam"; $phpsessname = "phpipam";
/**
* Cookie SameSite settings ("None", "Lax"=Default, "Strict")
* - "Strict" increases security
* - "Lax" required for SAML2
* - "None" requires HTTPS
*/
$cookie_samesite = "Lax";
/** /**
* Session storage - files or database * Session storage - files or database
@ -117,7 +124,7 @@ $session_storage = "files";
* *
******************************/ ******************************/
if(!defined('BASE')) if(!defined('BASE'))
define('BASE', "/"); define('BASE', "__PATH__/");
/** /**
@ -176,3 +183,10 @@ $config['split_ip_custom_fields'] = false; // Show custom field
* If multiple php versions are present; overide selection with $php_cli_binary. * If multiple php versions are present; overide selection with $php_cli_binary.
*/ */
// $php_cli_binary = '/usr/bin/php7.1'; // $php_cli_binary = '/usr/bin/php7.1';
/**
* Path to mysqldump binary
*
* default: '/usr/bin/mysqldump'
*/
// $mysqldump_cli_binary = '/usr/bin/mysqldump';

7
conf/mail.src
View file

@ -1,7 +0,0 @@
SOURCE_URL=https://github.com/PHPMailer/PHPMailer/archive/v6.0.5.tar.gz
SOURCE_SUM=5b18700ef26fe5de20a7ca291ece44b897182c603ed8187e0f711099325b35b20f8dbab2c456eaac1338731356661237d9b249c2f40051807b0d58ead612013c
SOURCE_SUM_PRG=sha512sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_EXTRACT=true
SOURCE_FILENAME=phpmailer.tar.gz

31
conf/nginx.conf
View file

@ -1,17 +1,28 @@
root __FINALPATH__/; #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent;
index index.php; location __PATH__/ {
try_files $uri $uri/ /index.php?$args;
# Force usage of https # Path to source
alias __FINALPATH__/ ;
# Force usage of https
if ($scheme = http) { if ($scheme = http) {
rewrite ^ https://$server_name$request_uri? permanent; rewrite ^ https://$server_name$request_uri? permanent;
} }
location ~ \.php$ { index index.php;
try_files $uri =404;
fastcgi_pass unix:/var/run/php/php7.0-fpm.sock;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name;
include /etc/nginx/fastcgi_params;
try_files $uri $uri/ index.php;
location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$;
fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
fastcgi_index index.php;
include fastcgi_params;
fastcgi_param REMOTE_USER $remote_user;
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param SCRIPT_FILENAME $request_filename;
}
# Include SSOWAT user panel.
include conf.d/yunohost_panel.conf.inc;
} }

430
conf/php-fpm.conf Normal file
View file

@ -0,0 +1,430 @@
; Start a new pool named 'www'.
; the variable $pool can be used in any directive and will be replaced by the
; pool name ('www' here)
[__NAMETOCHANGE__]
; Per pool prefix
; It only applies on the following directives:
; - 'access.log'
; - 'slowlog'
; - 'listen' (unixsocket)
; - 'chroot'
; - 'chdir'
; - 'php_values'
; - 'php_admin_values'
; When not set, the global prefix (or /usr) applies instead.
; Note: This directive can also be relative to the global prefix.
; Default Value: none
;prefix = /path/to/pools/$pool
; Unix user/group of processes
; Note: The user is mandatory. If the group is not set, the default user's group
; will be used.
user = __USER__
group = __USER__
; The address on which to accept FastCGI requests.
; Valid syntaxes are:
; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on
; a specific port;
; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on
; a specific port;
; 'port' - to listen on a TCP socket to all addresses
; (IPv6 and IPv4-mapped) on a specific port;
; '/path/to/unix/socket' - to listen on a unix socket.
; Note: This value is mandatory.
listen = /var/run/php/php__PHPVERSION__-fpm-__NAMETOCHANGE__.sock
; Set listen(2) backlog.
; Default Value: 511 (-1 on FreeBSD and OpenBSD)
;listen.backlog = 511
; Set permissions for unix socket, if one is used. In Linux, read/write
; permissions must be set in order to allow connections from a web server. Many
; BSD-derived systems allow connections regardless of permissions.
; Default Values: user and group are set as the running user
; mode is set to 0660
listen.owner = www-data
listen.group = www-data
;listen.mode = 0660
; When POSIX Access Control Lists are supported you can set them using
; these options, value is a comma separated list of user/group names.
; When set, listen.owner and listen.group are ignored
;listen.acl_users =
;listen.acl_groups =
; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect.
; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original
; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address
; must be separated by a comma. If this value is left blank, connections will be
; accepted from any ip address.
; Default Value: any
;listen.allowed_clients = 127.0.0.1
; Specify the nice(2) priority to apply to the pool processes (only if set)
; The value can vary from -19 (highest priority) to 20 (lower priority)
; Note: - It will only work if the FPM master process is launched as root
; - The pool processes will inherit the master process priority
; unless it specified otherwise
; Default Value: no set
; process.priority = -19
; Set the process dumpable flag (PR_SET_DUMPABLE prctl) even if the process user
; or group is differrent than the master process user. It allows to create process
; core dump and ptrace the process for the pool user.
; Default Value: no
; process.dumpable = yes
; Choose how the process manager will control the number of child processes.
; Possible Values:
; static - a fixed number (pm.max_children) of child processes;
; dynamic - the number of child processes are set dynamically based on the
; following directives. With this process management, there will be
; always at least 1 children.
; pm.max_children - the maximum number of children that can
; be alive at the same time.
; pm.start_servers - the number of children created on startup.
; pm.min_spare_servers - the minimum number of children in 'idle'
; state (waiting to process). If the number
; of 'idle' processes is less than this
; number then some children will be created.
; pm.max_spare_servers - the maximum number of children in 'idle'
; state (waiting to process). If the number
; of 'idle' processes is greater than this
; number then some children will be killed.
; ondemand - no children are created at startup. Children will be forked when
; new requests will connect. The following parameter are used:
; pm.max_children - the maximum number of children that
; can be alive at the same time.
; pm.process_idle_timeout - The number of seconds after which
; an idle process will be killed.
; Note: This value is mandatory.
pm = dynamic
; The number of child processes to be created when pm is set to 'static' and the
; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'.
; This value sets the limit on the number of simultaneous requests that will be
; served. Equivalent to the ApacheMaxClients directive with mpm_prefork.
; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP
; CGI. The below defaults are based on a server without much resources. Don't
; forget to tweak pm.* to fit your needs.
; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand'
; Note: This value is mandatory.
pm.max_children = 5
; The number of child processes created on startup.
; Note: Used only when pm is set to 'dynamic'
; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2
pm.start_servers = 2
; The desired minimum number of idle server processes.
; Note: Used only when pm is set to 'dynamic'
; Note: Mandatory when pm is set to 'dynamic'
pm.min_spare_servers = 1
; The desired maximum number of idle server processes.
; Note: Used only when pm is set to 'dynamic'
; Note: Mandatory when pm is set to 'dynamic'
pm.max_spare_servers = 3
; The number of seconds after which an idle process will be killed.
; Note: Used only when pm is set to 'ondemand'
; Default Value: 10s
;pm.process_idle_timeout = 10s;
; The number of requests each child process should execute before respawning.
; This can be useful to work around memory leaks in 3rd party libraries. For
; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS.
; Default Value: 0
;pm.max_requests = 500
; The URI to view the FPM status page. If this value is not set, no URI will be
; recognized as a status page. It shows the following informations:
; pool - the name of the pool;
; process manager - static, dynamic or ondemand;
; start time - the date and time FPM has started;
; start since - number of seconds since FPM has started;
; accepted conn - the number of request accepted by the pool;
; listen queue - the number of request in the queue of pending
; connections (see backlog in listen(2));
; max listen queue - the maximum number of requests in the queue
; of pending connections since FPM has started;
; listen queue len - the size of the socket queue of pending connections;
; idle processes - the number of idle processes;
; active processes - the number of active processes;
; total processes - the number of idle + active processes;
; max active processes - the maximum number of active processes since FPM
; has started;
; max children reached - number of times, the process limit has been reached,
; when pm tries to start more children (works only for
; pm 'dynamic' and 'ondemand');
; Value are updated in real time.
; Example output:
; pool: www
; process manager: static
; start time: 01/Jul/2011:17:53:49 +0200
; start since: 62636
; accepted conn: 190460
; listen queue: 0
; max listen queue: 1
; listen queue len: 42
; idle processes: 4
; active processes: 11
; total processes: 15
; max active processes: 12
; max children reached: 0
;
; By default the status page output is formatted as text/plain. Passing either
; 'html', 'xml' or 'json' in the query string will return the corresponding
; output syntax. Example:
; http://www.foo.bar/status
; http://www.foo.bar/status?json
; http://www.foo.bar/status?html
; http://www.foo.bar/status?xml
;
; By default the status page only outputs short status. Passing 'full' in the
; query string will also return status for each pool process.
; Example:
; http://www.foo.bar/status?full
; http://www.foo.bar/status?json&full
; http://www.foo.bar/status?html&full
; http://www.foo.bar/status?xml&full
; The Full status returns for each process:
; pid - the PID of the process;
; state - the state of the process (Idle, Running, ...);
; start time - the date and time the process has started;
; start since - the number of seconds since the process has started;
; requests - the number of requests the process has served;
; request duration - the duration in µs of the requests;
; request method - the request method (GET, POST, ...);
; request URI - the request URI with the query string;
; content length - the content length of the request (only with POST);
; user - the user (PHP_AUTH_USER) (or '-' if not set);
; script - the main script called (or '-' if not set);
; last request cpu - the %cpu the last request consumed
; it's always 0 if the process is not in Idle state
; because CPU calculation is done when the request
; processing has terminated;
; last request memory - the max amount of memory the last request consumed
; it's always 0 if the process is not in Idle state
; because memory calculation is done when the request
; processing has terminated;
; If the process is in Idle state, then informations are related to the
; last request the process has served. Otherwise informations are related to
; the current request being served.
; Example output:
; ************************
; pid: 31330
; state: Running
; start time: 01/Jul/2011:17:53:49 +0200
; start since: 63087
; requests: 12808
; request duration: 1250261
; request method: GET
; request URI: /test_mem.php?N=10000
; content length: 0
; user: -
; script: /home/fat/web/docs/php/test_mem.php
; last request cpu: 0.00
; last request memory: 0
;
; Note: There is a real-time FPM status monitoring sample web page available
; It's available in: /usr/share/php/7.0/fpm/status.html
;
; Note: The value must start with a leading slash (/). The value can be
; anything, but it may not be a good idea to use the .php extension or it
; may conflict with a real PHP file.
; Default Value: not set
;pm.status_path = /status
; The ping URI to call the monitoring page of FPM. If this value is not set, no
; URI will be recognized as a ping page. This could be used to test from outside
; that FPM is alive and responding, or to
; - create a graph of FPM availability (rrd or such);
; - remove a server from a group if it is not responding (load balancing);
; - trigger alerts for the operating team (24/7).
; Note: The value must start with a leading slash (/). The value can be
; anything, but it may not be a good idea to use the .php extension or it
; may conflict with a real PHP file.
; Default Value: not set
;ping.path = /ping
; This directive may be used to customize the response of a ping request. The
; response is formatted as text/plain with a 200 response code.
; Default Value: pong
;ping.response = pong
; The access log file
; Default: not set
;access.log = log/$pool.access.log
; The access log format.
; The following syntax is allowed
; %%: the '%' character
; %C: %CPU used by the request
; it can accept the following format:
; - %{user}C for user CPU only
; - %{system}C for system CPU only
; - %{total}C for user + system CPU (default)
; %d: time taken to serve the request
; it can accept the following format:
; - %{seconds}d (default)
; - %{miliseconds}d
; - %{mili}d
; - %{microseconds}d
; - %{micro}d
; %e: an environment variable (same as $_ENV or $_SERVER)
; it must be associated with embraces to specify the name of the env
; variable. Some exemples:
; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e
; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e
; %f: script filename
; %l: content-length of the request (for POST request only)
; %m: request method
; %M: peak of memory allocated by PHP
; it can accept the following format:
; - %{bytes}M (default)
; - %{kilobytes}M
; - %{kilo}M
; - %{megabytes}M
; - %{mega}M
; %n: pool name
; %o: output header
; it must be associated with embraces to specify the name of the header:
; - %{Content-Type}o
; - %{X-Powered-By}o
; - %{Transfert-Encoding}o
; - ....
; %p: PID of the child that serviced the request
; %P: PID of the parent of the child that serviced the request
; %q: the query string
; %Q: the '?' character if query string exists
; %r: the request URI (without the query string, see %q and %Q)
; %R: remote IP address
; %s: status (response code)
; %t: server time the request was received
; it can accept a strftime(3) format:
; %d/%b/%Y:%H:%M:%S %z (default)
; The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag
; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
; %T: time the log has been written (the request has finished)
; it can accept a strftime(3) format:
; %d/%b/%Y:%H:%M:%S %z (default)
; The strftime(3) format must be encapsuled in a %{<strftime_format>}t tag
; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t
; %u: remote user
;
; Default: "%R - %u %t \"%m %r\" %s"
;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%"
; The log file for slow requests
; Default Value: not set
; Note: slowlog is mandatory if request_slowlog_timeout is set
;slowlog = log/$pool.log.slow
; The timeout for serving a single request after which a PHP backtrace will be
; dumped to the 'slowlog' file. A value of '0s' means 'off'.
; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
; Default Value: 0
;request_slowlog_timeout = 0
; The timeout for serving a single request after which the worker process will
; be killed. This option should be used when the 'max_execution_time' ini option
; does not stop script execution for some reason. A value of '0' means 'off'.
; Available units: s(econds)(default), m(inutes), h(ours), or d(ays)
; Default Value: 0
request_terminate_timeout = 1d
; Set open file descriptor rlimit.
; Default Value: system defined value
;rlimit_files = 1024
; Set max core size rlimit.
; Possible Values: 'unlimited' or an integer greater or equal to 0
; Default Value: system defined value
;rlimit_core = 0
; Chroot to this directory at the start. This value must be defined as an
; absolute path. When this value is not set, chroot is not used.
; Note: you can prefix with '$prefix' to chroot to the pool prefix or one
; of its subdirectories. If the pool prefix is not set, the global prefix
; will be used instead.
; Note: chrooting is a great security feature and should be used whenever
; possible. However, all PHP paths will be relative to the chroot
; (error_log, sessions.save_path, ...).
; Default Value: not set
;chroot =
; Chdir to this directory at the start.
; Note: relative path can be used.
; Default Value: current directory or / when chroot
chdir = __FINALPATH__
; Redirect worker stdout and stderr into main error log. If not set, stdout and
; stderr will be redirected to /dev/null according to FastCGI specs.
; Note: on highloaded environement, this can cause some delay in the page
; process time (several ms).
; Default Value: no
;catch_workers_output = yes
; Clear environment in FPM workers
; Prevents arbitrary environment variables from reaching FPM worker processes
; by clearing the environment in workers before env vars specified in this
; pool configuration are added.
; Setting to "no" will make all environment variables available to PHP code
; via getenv(), $_ENV and $_SERVER.
; Default Value: yes
;clear_env = no
; Limits the extensions of the main script FPM will allow to parse. This can
; prevent configuration mistakes on the web server side. You should only limit
; FPM to .php extensions to prevent malicious users to use other extensions to
; execute php code.
; Note: set an empty value to allow all extensions.
; Default Value: .php
;security.limit_extensions = .php .php3 .php4 .php5 .php7
; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from
; the current environment.
; Default Value: clean env
;env[HOSTNAME] = $HOSTNAME
;env[PATH] = /usr/local/bin:/usr/bin:/bin
;env[TMP] = /tmp
;env[TMPDIR] = /tmp
;env[TEMP] = /tmp
; Additional php.ini defines, specific to this pool of workers. These settings
; overwrite the values previously defined in the php.ini. The directives are the
; same as the PHP SAPI:
; php_value/php_flag - you can set classic ini defines which can
; be overwritten from PHP call 'ini_set'.
; php_admin_value/php_admin_flag - these directives won't be overwritten by
; PHP call 'ini_set'
; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no.
; Defining 'extension' will load the corresponding shared extension from
; extension_dir. Defining 'disable_functions' or 'disable_classes' will not
; overwrite previously defined php.ini values, but will append the new value
; instead.
; Note: path INI options can be relative and will be expanded with the prefix
; (pool, global or /usr)
; Default Value: nothing is defined by default except the values in php.ini and
; specified at startup with the -d argument
;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com
;php_flag[display_errors] = off
;php_admin_value[error_log] = /var/log/fpm-php.www.log
;php_admin_flag[log_errors] = on
;php_admin_value[memory_limit] = 32M
; Common values to change to increase file upload limit
; php_admin_value[upload_max_filesize] = 50M
; php_admin_value[post_max_size] = 50M
; php_admin_flag[mail.add_x_header] = Off
; Other common parameters
; php_admin_value[max_execution_time] = 600
; php_admin_value[max_input_time] = 300
; php_admin_value[memory_limit] = 256M
; php_admin_flag[short_open_tag] = On

BIN
doc/.DS_Store vendored Normal file
View file

Binary file not shown.

0
doc/DISCLAIMER.md Normal file
View file

BIN
doc/screenshots/.DS_Store vendored Normal file
View file

Binary file not shown.

BIN
doc/screenshots/dashboard.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 461 KiB

36
manifest.json
View file

@ -3,43 +3,43 @@
"id": "phpipam", "id": "phpipam",
"packaging_format": 1, "packaging_format": 1,
"description": { "description": {
"en": "phpIPAM package for YunoHost.", "en": "Web IP address management application",
"fr": "phpIPAM pour YunoHost." "fr": "Application web de gestion d'adresses IP"
}, },
"version": "1.4", "version": "1.4.3~ynh1",
"url": "https://phpipam.net/", "url": "https://phpipam.net/",
"license": "GPL-3.0", "upstream": {
"license": "GPL-3.0-only",
"website": "https://phpipam.net",
"demo": "http://demo.phpipam.net",
"admindoc": "https://phpipam.net/documents/",
"userdoc": "https://yunohost.org/apps",
"code": "https://github.com/phpipam/phpipam"
},
"license": "GPL-3.0-only",
"maintainer": { "maintainer": {
"name": "liberodark", "name": "liberodark",
"email": "liberodark@gmail.com" "email": "liberodark@gmail.com"
}, },
"requirements": { "requirements": {
"yunohost": ">= 2.7.2" "yunohost": ">= 4.2.4"
}, },
"multi_instance": false, "multi_instance": true,
"services": [ "services": [
"nginx", "nginx",
"php5-fpm", "php7.3-fpm",
"mysql" "mysql"
], ],
"arguments": { "arguments": {
"install": [{ "install": [{
"name": "domain", "name": "domain",
"type": "domain", "type": "domain",
"ask": {
"en": "Choose a domain name for phpIPAM",
"fr": "Choisissez un nom de domaine pour phpIPAM"
},
"example": "example.com" "example": "example.com"
}, },
{ {
"name": "path", "name": "path",
"type": "path", "type": "path",
"ask": {
"en": "Choose a path for phpIPAM /phpipam is accepted",
"fr": "Choisissez un chemin pour phpIPAM /phpipam est accepté"
},
"example": "/phpipam", "example": "/phpipam",
"default": "/phpipam" "default": "/phpipam"
}, },
@ -47,11 +47,7 @@
{ {
"name": "is_public", "name": "is_public",
"type": "boolean", "type": "boolean",
"ask": { "default": true
"en": "Is it a public site ?",
"fr": "Est-ce un site public ?"
},
"default": "true"
} }
] ]
} }

173
scripts/_common.sh
View file

@ -1,112 +1,79 @@
#!/bin/bash #!/bin/bash
# ============================================================================= #=================================================
# YUNOHOST 2.7 FORTHCOMING HELPERS # COMMON VARIABLES
# ============================================================================= #=================================================
# Create a dedicated nginx config YNH_PHP_VERSION="7.3"
extra_php_dependencies="php${YNH_PHP_VERSION}-gmp php${YNH_PHP_VERSION}-mysql php${YNH_PHP_VERSION}-ldap php${YNH_PHP_VERSION}-json php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-opcache php${YNH_PHP_VERSION}-fileinfo php${YNH_PHP_VERSION}-intl php${YNH_PHP_VERSION}-cli php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-xml"
#=================================================
# PERSONAL HELPERS
#=================================================
#=================================================
# EXPERIMENTAL HELPERS
#=================================================
#=================================================
# FUTURE OFFICIAL HELPERS
#=================================================
# Send an email to inform the administrator
# #
# usage: ynh_add_nginx_config # usage: ynh_send_readme_to_admin app_message [recipients]
ynh_add_nginx_config () { # | arg: app_message - The message to send to the administrator.
finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" # | arg: recipients - The recipients of this email. Use spaces to separate multiples recipients. - default: root
ynh_backup_if_checksum_is_different "$finalnginxconf" # example: "root admin@domain"
sudo cp ../conf/nginx.conf "$finalnginxconf" # If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
# example: "root admin@domain user1 user2"
ynh_send_readme_to_admin() {
local app_message="${1:-...No specific information...}"
local recipients="${2:-root}"
# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. # Retrieve the email of users
# Substitute in a nginx config file only if the variable is not empty find_mails () {
if test -n "${path_url:-}"; then local list_mails="$1"
ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" local mail
fi local recipients=" "
if test -n "${domain:-}"; then # Read each mail in argument
ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" for mail in $list_mails
fi do
if test -n "${port:-}"; then # Keep root or a real email address as it is
ynh_replace_string "__PORT__" "$port" "$finalnginxconf" if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@"
fi
if test -n "${app:-}"; then
ynh_replace_string "__NAME__" "$app" "$finalnginxconf"
fi
if test -n "${final_path:-}"; then
ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf"
fi
ynh_store_file_checksum "$finalnginxconf"
sudo systemctl reload nginx
}
# Remove the dedicated nginx config
#
# usage: ynh_remove_nginx_config
ynh_remove_nginx_config () {
ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf"
sudo systemctl reload nginx
}
# Create a dedicated php-fpm config
#
# usage: ynh_add_fpm_config
ynh_add_fpm_config () {
finalphpconf="/etc/php5/fpm/pool.d/$app.conf"
ynh_backup_if_checksum_is_different "$finalphpconf"
sudo cp ../conf/php-fpm.conf "$finalphpconf"
ynh_replace_string "__NAMETOCHANGE__" "$app" "$finalphpconf"
ynh_replace_string "__FINALPATH__" "$final_path" "$finalphpconf"
ynh_replace_string "__USER__" "$app" "$finalphpconf"
sudo chown root: "$finalphpconf"
ynh_store_file_checksum "$finalphpconf"
if [ -e "../conf/php-fpm.ini" ]
then then
finalphpini="/etc/php5/fpm/conf.d/20-$app.ini" recipients="$recipients $mail"
ynh_backup_if_checksum_is_different "$finalphpini" else
sudo cp ../conf/php-fpm.ini "$finalphpini" # But replace an user name without a domain after by its email
sudo chown root: "$finalphpini" if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null)
ynh_store_file_checksum "$finalphpini" then
recipients="$recipients $mail"
fi
fi
done
echo "$recipients"
}
recipients=$(find_mails "$recipients")
local mail_subject="☁️🆈🅽🅷☁️: \`$app\` has important message for you"
local mail_message="This is an automated message from your beloved YunoHost server.
Specific information for the application $app.
$app_message
---
Automatic diagnosis data from YunoHost
$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
# Define binary to use for mail command
if [ -e /usr/bin/bsd-mailx ]
then
local mail_bin=/usr/bin/bsd-mailx
else
local mail_bin=/usr/bin/mail.mailutils
fi fi
sudo systemctl reload php5-fpm # Send the email to the recipients
} echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients"
# Remove the dedicated php-fpm config
#
# usage: ynh_remove_fpm_config
ynh_remove_fpm_config () {
ynh_secure_remove "/etc/php5/fpm/pool.d/$app.conf"
ynh_secure_remove "/etc/php5/fpm/conf.d/20-$app.ini" 2>&1
sudo systemctl reload php5-fpm
}
# Create a dedicated systemd config
#
# usage: ynh_add_systemd_config
ynh_add_systemd_config () {
finalsystemdconf="/etc/systemd/system/$app.service"
ynh_backup_if_checksum_is_different "$finalsystemdconf"
sudo cp ../conf/systemd.service "$finalsystemdconf"
# To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable.
# Substitute in a nginx config file only if the variable is not empty
if test -n "${final_path:-}"; then
ynh_replace_string "__FINALPATH__" "$final_path" "$finalsystemdconf"
fi
if test -n "${app:-}"; then
ynh_replace_string "__APP__" "$app" "$finalsystemdconf"
fi
ynh_store_file_checksum "$finalsystemdconf"
sudo chown root: "$finalsystemdconf"
sudo systemctl enable $app
sudo systemctl daemon-reload
}
# Remove the dedicated systemd config
#
# usage: ynh_remove_systemd_config
ynh_remove_systemd_config () {
finalsystemdconf="/etc/systemd/system/$app.service"
if [ -e "$finalsystemdconf" ]; then
sudo systemctl stop $app
sudo systemctl disable $app
ynh_secure_remove "$finalsystemdconf"
fi
} }

98
scripts/backup
View file

@ -1,33 +1,81 @@
#!/bin/bash #!/bin/bash
# Exit on command errors and treat unset variables as an error #=================================================
set -eu # GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# See comments in install script # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
app=$YNH_APP_INSTANCE_NAME source ../settings/scripts/_common.sh
# Source YunoHost helpers
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
# Backup sources & data #=================================================
# Note: the last argument is where to save this path, see the restore script. # MANAGE SCRIPT FAILURE
ynh_backup "/var/www/${app}" "sources" #=================================================
### MySQL (remove if not used) ### ynh_clean_setup () {
# If a MySQL database is used: ### Remove this function if there's nothing to clean before calling the remove script.
# Dump the database true
dbname=$app }
dbuser=$app # Exit if an error occurs during the execution of the script
dbpass=$(ynh_app_setting_get "$app" mysqlpwd) ynh_abort_if_errors
mysqldump -u "$dbuser" -p"$dbpass" --no-create-db "$dbname" > ./dump.sql
### MySQL end ###
# Copy NGINX configuration #=================================================
domain=$(ynh_app_setting_get "$app" domain) # LOAD SETTINGS
ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf" "nginx.conf" #=================================================
ynh_print_info --message="Loading installation settings..."
### PHP (remove if not used) ### app=$YNH_APP_INSTANCE_NAME
# If a dedicated php-fpm process is used:
# # Copy PHP-FPM pool configuration final_path=$(ynh_app_setting_get --app=$app --key=final_path)
# ynh_backup "/etc/php5/fpm/pool.d/${app}.conf" "php-fpm.conf" domain=$(ynh_app_setting_get --app=$app --key=domain)
### PHP end ### db_name=$(ynh_app_setting_get --app=$app --key=db_name)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#=================================================
# DECLARE DATA AND CONF FILES TO BACKUP
#=================================================
ynh_print_info --message="Declaring files to be backed up..."
#=================================================
# BACKUP THE APP MAIN DIR
#=================================================
ynh_backup --src_path="$final_path"
#=================================================
# BACKUP THE NGINX CONFIGURATION
#=================================================
ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# BACKUP THE PHP-FPM CONFIGURATION
#=================================================
ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
#=================================================
# SPECIFIC BACKUP
#=================================================
# BACKUP LOGROTATE
#=================================================
ynh_backup --src_path="/etc/logrotate.d/$app"
#=================================================
# BACKUP THE MYSQL DATABASE
#=================================================
ynh_print_info --message="Backing up the MySQL database..."
### (However, things like MySQL dumps *do* take some time to run, though the
### copy of the generated dump to the archive still happens later)
ynh_mysql_dump_db --database="$db_name" > db.sql
#=================================================
# END OF SCRIPT
#=================================================
ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)."

121
scripts/change_url Normal file
View file

@ -0,0 +1,121 @@
#!/bin/bash
#=================================================
# GENERIC STARTING
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
source _common.sh
source /usr/share/yunohost/helpers
#=================================================
# RETRIEVE ARGUMENTS
#=================================================
old_domain=$YNH_APP_OLD_DOMAIN
old_path=$YNH_APP_OLD_PATH
new_domain=$YNH_APP_NEW_DOMAIN
new_path=$YNH_APP_NEW_PATH
app=$YNH_APP_INSTANCE_NAME
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --time --weight=1
# Backup the current version of the app
ynh_backup_before_upgrade
ynh_clean_setup () {
# Remove the new domain config file, the remove script won't do it as it doesn't know yet its location.
ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
# Restore it if the upgrade fails
ynh_restore_upgradebackup
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# CHECK WHICH PARTS SHOULD BE CHANGED
#=================================================
change_domain=0
if [ "$old_domain" != "$new_domain" ]
then
change_domain=1
fi
change_path=0
if [ "$old_path" != "$new_path" ]
then
change_path=1
fi
#=================================================
# STANDARD MODIFICATIONS
#=================================================
# MODIFY URL IN NGINX CONF
#=================================================
ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2
nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf
# Change the path in the NGINX config file
if [ $change_path -eq 1 ]
then
# Make a backup of the original NGINX config file if modified
ynh_backup_if_checksum_is_different --file="$nginx_conf_path"
# Set global variables for NGINX helper
domain="$old_domain"
path_url="$new_path"
# Create a dedicated NGINX config
ynh_add_nginx_config
fi
# Change the domain for NGINX
if [ $change_domain -eq 1 ]
then
# Delete file checksum for the old conf file location
ynh_delete_file_checksum --file="$nginx_conf_path"
mv $nginx_conf_path /etc/nginx/conf.d/$new_domain.d/$app.conf
# Store file checksum for the new config file location
ynh_store_file_checksum --file="/etc/nginx/conf.d/$new_domain.d/$app.conf"
fi
#=================================================
# SPECIFIC MODIFICATIONS
#=================================================
ynh_script_progression --message="Configuring $app..." --weight=1
domain="$new_domain"
path_url="$new_path"
domain_path="https://$domain$path_url"
ynh_add_config --template="../conf/config.dist.php" --destination="$final_path/config.php"
#=================================================
# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=2
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Change of URL completed for $app" --last

219
scripts/install
View file

@ -24,180 +24,139 @@ ynh_abort_if_errors
# RETRIEVE ARGUMENTS FROM THE MANIFEST # RETRIEVE ARGUMENTS FROM THE MANIFEST
#================================================= #=================================================
# Retrieve arguments
domain=$YNH_APP_ARG_DOMAIN domain=$YNH_APP_ARG_DOMAIN
path_url=$YNH_APP_ARG_PATH path_url=$YNH_APP_ARG_PATH
is_public=$YNH_APP_ARG_IS_PUBLIC is_public=$YNH_APP_ARG_IS_PUBLIC
### If it's a multi-instance app, meaning it can be installed several times independently
### The id of the app as stated in the manifest is available as $YNH_APP_ID
### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
### The app instance name is available as $YNH_APP_INSTANCE_NAME
### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
### - ynhexample__{N} for the subsequent installations, with N=3,4, ...
### The app instance name is probably what interests you most, since this is
### guaranteed to be unique. This is a good unique identifier to define installation path,
### db names, ...
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
#================================================= #=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#================================================= #=================================================
ynh_script_progression --message="Validating installation parameters..." --weight=1
### If the app uses nginx as web server (written in HTML/PHP in most cases), the final path should be "/var/www/$app".
### If the app provides an internal web server (or uses another application server such as uwsgi), the final path should be "/opt/yunohost/$app"
final_path=/var/www/$app final_path=/var/www/$app
test ! -e "$final_path" || ynh_die "This path already contains a folder" test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
# Normalize the url path syntax
path_url=$(ynh_normalize_url_path "$path_url")
# Check web path availability
ynh_webpath_available "$domain" "$path_url"
# Register (book) web path # Register (book) web path
ynh_webpath_register "$app" "$domain" "$path_url" ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
#================================================= #=================================================
# STORE SETTINGS FROM MANIFEST # STORE SETTINGS FROM MANIFEST
#================================================= #=================================================
ynh_script_progression --message="Storing installation settings..." --weight=1
ynh_app_setting_set "$app" domain "$domain" ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set "$app" path "$path_url" ynh_app_setting_set --app=$app --key=path --value=$path_url
ynh_app_setting_set "$app" is_public "$is_public"
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Installing dependencies..." --weight=9
### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package.
### Those deb packages will be installed as dependencies of this package.
### If you're not using this helper:
### - Remove the section "REMOVE DEPENDENCIES" in the remove script
### - As well as the section "REINSTALL DEPENDENCIES" in the restore script
### - And the section "UPGRADE DEPENDENCIES" in the upgrade script
ynh_install_app_dependencies php7.0-gmp php7.0-snmp php7.0-ldap php7.0-mbstring php7.0-json php7.0-gettext php7.0-xml php7.0-sockets
#=================================================
# CREATE A MYSQL DATABASE
#=================================================
ynh_script_progression --message="Creating a MySQL database..."
### Use these lines if you need a database for the application.
### `ynh_mysql_setup_db` will create a database, an associated user and a ramdom password.
### The password will be stored as 'mysqlpwd' into the app settings,
### and will be available as $db_pwd
### If you're not using these lines:
### - Remove the section "BACKUP THE MYSQL DATABASE" in the backup script
### - Remove also the section "REMOVE THE MYSQL DATABASE" in the remove script
### - As well as the section "RESTORE THE MYSQL DATABASE" in the restore script
db_name=$(ynh_sanitize_dbid "$app")
ynh_app_setting_set "$app" db_name "$db_name"
ynh_mysql_setup_db "$db_name" "$db_name"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE PHPIPAM
#=================================================
ynh_script_progression --message="Setting up source files..." --weight=4
ynh_app_setting_set "$app" final_path "$final_path"
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source "$final_path"
#=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE PHPMAILER
#=================================================
ynh_script_progression --message="Setting up source files..." --weight=4
ynh_app_setting_set "$app" final_path "$final_path"
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source "$final_path/functions/PHPMailer/" "mail"
#=================================================
# IMPORT PHPIPAM DB
#=================================================
ynh_print_info --message="Import SQL..."
ynh_mysql_execute_file_as_root --file="$final_path/db/SCHEMA.sql" --database="$db_name"
#=================================================
# NGINX CONFIGURATION
#=================================================
# Create a dedicated nginx config
ynh_script_progression --message="Configuring nginx web server..." --weight=3
ynh_add_nginx_config
#================================================= #=================================================
# CREATE DEDICATED USER # CREATE DEDICATED USER
#================================================= #=================================================
ynh_script_progression --message="Configuring system user..." --weight=1
# Create a system user # Create a system user
ynh_script_progression --message="Configuring system user..." --weight=3 ynh_system_user_create --username=$app --home_dir="$final_path"
ynh_system_user_create "$app"
#================================================= #=================================================
# MODIFY A CONFIG FILE # DOWNLOAD, CHECK AND UNPACK SOURCE
#================================================= #=================================================
ynh_script_progression --message="Setting up source files..." --weight=3
cp -a ../conf/config.dist.php "$final_path"/config.php ynh_app_setting_set --app=$app --key=final_path --value=$final_path
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path"
ynh_replace_string "yunouser" "$db_name" "$final_path/config.php" chmod 750 "$final_path"
ynh_replace_string "yunopass" "$db_pwd" "$final_path/config.php" chmod -R o-rwx "$final_path"
ynh_replace_string "yunobase" "$db_name" "$final_path/config.php" chown -R $app:www-data "$final_path"
#================================================= #=================================================
# STORE THE CONFIG FILE CHECKSUM # CREATE A MYSQL DATABASE
#================================================= #=================================================
ynh_script_progression --message="Creating a MySQL database..." --weight=2
### `ynh_store_file_checksum` is used to store the checksum of a file. db_name=$(ynh_sanitize_dbid --db_name=$app)
### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`, db_user=$db_name
### you can make a backup of this file before modifying it again if the admin had modified it. ynh_app_setting_set --app=$app --key=db_name --value=$db_name
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name
# Calculate and store the config file checksum into the app settings #=================================================
#ynh_store_file_checksum "/etc/onlyoffice/documentserver/nginx/onlyoffice-documentserver.conf" # NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring NGINX web server..." --weight=1
# Create a dedicated NGINX config
ynh_add_nginx_config
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring PHP-FPM..." --weight=1
# Create a dedicated PHP-FPM config
ynh_add_fpm_config --package="$extra_php_dependencies"
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#=================================================
# ADD A CONFIGURATION
#=================================================
ynh_script_progression --message="Adding a configuration file..." --weight=1
ynh_add_config --template="../conf/config.dist.php" --destination="$final_path/config.php"
chmod 644 "$final_path/config.php"
chown $app:$app "$final_path/config.php"
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================
# SECURE FILES AND DIRECTORIES # SETUP LOGROTATE
#================================================= #=================================================
ynh_script_progression --message="Configuring log rotation..." --weight=1
#ynh_script_progression --message="Configuring phpipam..." # Use logrotate to manage application logfile(s)
ynh_use_logrotate
### For security reason, any app should set the permissions to root: before anything else.
### Then, if write authorization is needed, any access should be given only to directories
### that really need such authorization.
# Remove non utile files
ynh_secure_remove $final_path/config.dist.php
ynh_secure_remove $final_path/config.docker.php
ynh_secure_remove $final_path/INSTALL.txt
ynh_secure_remove $final_path/README.md
ynh_secure_remove $final_path/.htaccess
ynh_secure_remove $final_path/install
ynh_secure_remove $final_path/.gitmodules
ynh_secure_remove $final_path/.github
ynh_secure_remove $final_path/.gitignore
# Set permissions to app files
chown -R www-data: "$final_path"
#================================================= #=================================================
# SETUP SSOWAT # SETUP SSOWAT
#================================================= #=================================================
ynh_script_progression --message="Configuring permissions..." --weight=1
# If app is public, add url to SSOWat conf as skipped_uris # Make app public if necessary
if [ "$is_public" -eq 1 ]; then if [ $is_public -eq 1 ]
# unprotected_uris allows SSO credentials to be passed anyway. then
ynh_app_setting_set "$app" unprotected_uris "/" ynh_permission_update --permission="main" --add="visitors"
fi fi
# Reload services #=================================================
systemctl reload nginx # RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# SEND A README FOR THE ADMIN
#=================================================
ynh_script_progression --message="Sending a readme for the admin..."
message="PHPIPAM was successfully installed :)
Please open your $app domain: https://$domain$path_url
Complete the registration process from the setup page displayed.
Details for MySQL database to be enterted while registration process:
Database login: $app
Database name: $app
Database password: $db_pwd
If you are facing any problem or want to improve this app, please open a new issue here: https://github.com/YunoHost-Apps/phpipam_ynh/issues"
ynh_send_readme_to_admin "$message"
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Installation of $app completed" --last

90
scripts/remove
View file

@ -12,122 +12,68 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
# LOAD SETTINGS # LOAD SETTINGS
#================================================= #=================================================
ynh_print_info "Loading installation settings..." ynh_script_progression --message="Loading installation settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get "$app" domain) domain=$(ynh_app_setting_get --app=$app --key=domain)
port=$(ynh_app_setting_get "$app" port) port=$(ynh_app_setting_get --app=$app --key=port)
db_name=$(ynh_app_setting_get "$app" db_name) db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name db_user=$db_name
final_path=$(ynh_app_setting_get "$app" final_path) final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# STANDARD REMOVE
#=================================================
# REMOVE SERVICE FROM ADMIN PANEL
#=================================================
# Remove a service from the admin panel, added by `yunohost service add`
if yunohost service status "$app" >/dev/null 2>&1
then
ynh_print_info "Removing $app service"
yunohost service remove "$app"
fi
#=================================================
# STOP AND REMOVE SERVICE
#=================================================
ynh_print_info "Stopping and removing the systemd service"
# Remove the dedicated systemd config
ynh_remove_systemd_config
#================================================= #=================================================
# REMOVE THE MYSQL DATABASE # REMOVE THE MYSQL DATABASE
#================================================= #=================================================
ynh_print_info "Removing the MySQL database" ynh_script_progression --message="Removing the MySQL database..." --weight=1
# Remove a database if it exists, along with the associated user # Remove a database if it exists, along with the associated user
ynh_mysql_remove_db "$db_user" "$db_name" ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
#=================================================
# REMOVE DEPENDENCIES
#=================================================
ynh_print_info "Removing dependencies"
# Remove metapackage and its dependencies
ynh_remove_app_dependencies
#================================================= #=================================================
# REMOVE APP MAIN DIR # REMOVE APP MAIN DIR
#================================================= #=================================================
ynh_print_info "Removing app main directory" ynh_script_progression --message="Removing app main directory..." --weight=1
# Remove the app directory securely # Remove the app directory securely
ynh_secure_remove "$final_path" ynh_secure_remove --file="$final_path"
#================================================= #=================================================
# REMOVE NGINX CONFIGURATION # REMOVE NGINX CONFIGURATION
#================================================= #=================================================
ynh_print_info "Removing nginx web server configuration" ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1
# Remove the dedicated nginx config # Remove the dedicated NGINX config
ynh_remove_nginx_config ynh_remove_nginx_config
#================================================= #=================================================
# REMOVE PHP-FPM CONFIGURATION # REMOVE PHP-FPM CONFIGURATION
#================================================= #=================================================
#ynh_print_info "Removing php-fpm configuration" ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=2
# Remove the dedicated php-fpm config # Remove the dedicated PHP-FPM config
#ynh_remove_fpm_config ynh_remove_fpm_config
#================================================= #=================================================
# REMOVE LOGROTATE CONFIGURATION # REMOVE LOGROTATE CONFIGURATION
#================================================= #=================================================
ynh_print_info "Removing logrotate configuration" ynh_script_progression --message="Removing logrotate configuration..." --weight=1
# Remove the app-specific logrotate config # Remove the app-specific logrotate config
ynh_remove_logrotate ynh_remove_logrotate
#=================================================
# CLOSE A PORT
#=================================================
if yunohost firewall list | grep -q "\- $port$"
then
ynh_print_info "Closing port $port"
ynh_exec_warn_less yunohost firewall disallow TCP "$port"
fi
#=================================================
# SPECIFIC REMOVE
#=================================================
# REMOVE THE CRON FILE
#=================================================
# Remove a cron file
ynh_secure_remove "/etc/cron.d/$app"
# Remove a directory securely
ynh_secure_remove "/etc/$app/"
# Remove the log files
ynh_secure_remove "/var/log/$app/"
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
#================================================= #=================================================
# REMOVE DEDICATED USER # REMOVE DEDICATED USER
#================================================= #=================================================
ynh_print_info "Removing the dedicated system user" ynh_script_progression --message="Removing the dedicated system user..." --weight=1
# Delete a system user # Delete a system user
ynh_system_user_delete "$app" ynh_system_user_delete --username=$app
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT
#================================================= #=================================================
ynh_print_info "Removal of $app completed" ynh_script_progression --message="Removal of $app completed" --last

141
scripts/restore
View file

@ -1,52 +1,113 @@
#!/bin/bash #!/bin/bash
# Note: each files and directories you've saved using the ynh_backup helper #=================================================
# will be located in the current directory, regarding the last argument. # GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# Exit on command errors and treat unset variables as an error # Keep this path for calling _common.sh inside the execution's context of backup and restore scripts
set -eu source ../settings/scripts/_common.sh
# See comments in install script
app=$YNH_APP_INSTANCE_NAME
# Source YunoHost helpers
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
# Retrieve old app settings #=================================================
domain=$(ynh_app_setting_get "$app" domain) # MANAGE SCRIPT FAILURE
path_url=$(ynh_app_setting_get "$app" path_url) #=================================================
# Check domain/path availability ynh_clean_setup () {
sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ #### Remove this function if there's nothing to clean before calling the remove script.
|| ynh_die "Path not available: ${domain}${path_url}" true
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
# Restore sources & data #=================================================
src_path="/var/www/${app}" # LOAD SETTINGS
sudo cp -a ./sources "$src_path" #=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
# Restore permissions to app files app=$YNH_APP_INSTANCE_NAME
# you may need to make some file and/or directory writeable by www-data (nginx user)
sudo chown -R root: "$src_path"
### MySQL (remove if not used) ### domain=$(ynh_app_setting_get --app=$app --key=domain)
# If a MySQL database is used: path_url=$(ynh_app_setting_get --app=$app --key=path)
# Create and restore the database final_path=$(ynh_app_setting_get --app=$app --key=final_path)
dbname=$app db_name=$(ynh_app_setting_get --app=$app --key=db_name)
dbuser=$app db_user=$db_name
dbpass=$(ynh_app_setting_get "$app" mysqlpwd) phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
ynh_mysql_create_db "$dbname" "$dbuser" "$dbpass"
ynh_mysql_connect_as "$dbuser" "$dbpass" "$dbname" < ./dump.sql
### MySQL end ###
# Restore NGINX configuration #=================================================
sudo cp -a ./nginx.conf "/etc/nginx/conf.d/${domain}.d/${app}.conf" # CHECK IF THE APP CAN BE RESTORED
#=================================================
ynh_script_progression --message="Validating restoration parameters..." --weight=1
### PHP (remove if not used) ### ynh_webpath_available --domain=$domain --path_url=$path_url \
# If a dedicated php-fpm process is used: || ynh_die --message="Path not available: ${domain}${path_url}"
# # Copy PHP-FPM pool configuration and reload the service test ! -d $final_path \
# sudo cp -a ./php-fpm.conf "/etc/php5/fpm/pool.d/${app}.conf" || ynh_die --message="There is already a directory: $final_path "
# sudo service php5-fpm reload
### PHP end ###
# Restart webserver #=================================================
sudo service nginx reload # STANDARD RESTORATION STEPS
#=================================================
# RESTORE THE NGINX CONFIGURATION
#=================================================
ynh_script_progression --message="Restoring the NGINX configuration..." --weight=1
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf"
#=================================================
# RECREATE THE DEDICATED USER
#=================================================
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
# Create the dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#=================================================
# RESTORE THE APP MAIN DIR
#=================================================
ynh_script_progression --message="Restoring the app main directory..." --weight=5
ynh_restore_file --origin_path="$final_path"
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#=================================================
# RESTORE THE PHP-FPM CONFIGURATION
#=================================================
ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weight=1
ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
#=================================================
# RESTORE THE MYSQL DATABASE
#=================================================
ynh_script_progression --message="Restoring the MySQL database..." --weight=1
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd
ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
#=================================================
# RESTORE THE LOGROTATE CONFIGURATION
#=================================================
ynh_script_progression --message="Restoring the logrotate configuration..." --weight=1
ynh_restore_file --origin_path="/etc/logrotate.d/$app"
#=================================================
# GENERIC FINALIZATION
#=================================================
# RELOAD NGINX AND PHP-FPM
#=================================================
ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=1
ynh_systemd_action --service_name=php$phpversion-fpm --action=reload
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Restoration completed for $app" --last

131
scripts/upgrade
View file

@ -1,46 +1,129 @@
#!/bin/bash #!/bin/bash
# Exit on command errors and treat unset variables as an error #=================================================
set -eu # GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================
# See comments in install script source _common.sh
app=$YNH_APP_INSTANCE_NAME
final_path=/var/www/$app
# Source YunoHost helpers
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# LOAD SETTINGS
#=================================================
ynh_script_progression --message="Loading installation settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#=================================================
# CHECK VERSION
#=================================================
upgrade_type=$(ynh_check_app_version_changed)
#=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#=================================================
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
# Backup the current version of the app
ynh_backup_before_upgrade
ynh_clean_setup () {
# Restore it if the upgrade fails
ynh_restore_upgradebackup
}
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# ENSURE DOWNWARD COMPATIBILITY
#=================================================
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
# Cleaning legacy permissions
if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public
fi
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path"
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
#================================================= #=================================================
ynh_app_setting_set $app final_path $final_path if [ "$upgrade_type" == "UPGRADE_APP" ]
# Download, check integrity, uncompress and patch the source from app.src then
ynh_setup_source "$final_path" ynh_script_progression --message="Upgrading source files..." --weight=1
# Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path"
fi
chmod 750 "$final_path"
chmod -R o-rwx "$final_path"
chown -R $app:www-data "$final_path"
#================================================= #=================================================
# NGINX CONFIGURATION # NGINX CONFIGURATION
#================================================= #=================================================
ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1
# Create a dedicated nginx config # Create a dedicated NGINX config
#ynh_add_nginx_config ynh_add_nginx_config
#================================================= #=================================================
# UPGRADE CONFIG # PHP-FPM CONFIGURATION
#================================================= #=================================================
#cp -a ../conf/loolwsd.xml /etc/loolwsd ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1
#ynh_replace_string "__NEXTCLOUDDOMAIN__" "$nextcloud_domain" "/etc/loolwsd/loolwsd.xml"
#ynh_replace_string "__PASSWORD__" "$password" "/etc/loolwsd/loolwsd.xml"
#systemctl restart loolwsd
# Create a dedicated PHP-FPM config
ynh_add_fpm_config
#=================================================
# UPDATE A CONFIG FILE
#=================================================
ynh_script_progression --message="Updating a configuration file..." --weight=1
# If app is public, add url to SSOWat conf as skipped_uris ynh_add_config --template="../conf/config.dist.php" --destination="$final_path/config.php"
#if [[ $is_public -eq 1 ]]; then
# See install script
# ynh_app_setting_set "$app" unprotected_uris "/"
#fi
# Reload Nginx service chmod 400 "$final_path/config.php"
systemctl reload nginx chown $app:$app "$final_path/config.php"
#=================================================
# GENERIC FINALIZATION
#=================================================
# SETUP LOGROTATE
#=================================================
ynh_script_progression --message="Upgrading logrotate configuration..." --weight=1
# Use logrotate to manage app-specific logfile(s)
ynh_use_logrotate --non-append
#=================================================
# RELOAD NGINX
#=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload
#=================================================
# END OF SCRIPT
#=================================================
ynh_script_progression --message="Upgrade of $app completed" --last