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 #16 from YunoHost-Apps/version-2

Browse source 
Version 2
This commit is contained in:
Éric Gaspar 2023-05-22 19:35:34 +02:00 committed by GitHub
commit 985a04271f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 330 additions and 1166 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -16,7 +16,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
## Overview ## Overview
Web IP address management application phpIPAM is an open-source web IP address management application. Its goal is to provide light and simple IP address management application. It is ajax-based using jQuery libraries, it uses php scripts and javascript and some HTML5/CSS3 features, so some modern browser is preferred to be able to display javascript quickly and correctly.
**Shipped version:** 1.5.2~ynh1 **Shipped version:** 1.5.2~ynh1

2
README_fr.md
View file

@ -16,7 +16,7 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po
## Vue d’ensemble ## Vue d’ensemble
Application web de gestion d'adresses IP phpIPAM is an open-source web IP address management application. Its goal is to provide light and simple IP address management application. It is ajax-based using jQuery libraries, it uses php scripts and javascript and some HTML5/CSS3 features, so some modern browser is preferred to be able to display javascript quickly and correctly.
**Version incluse :** 1.5.2~ynh1 **Version incluse :** 1.5.2~ynh1

23
check_process
View file

@ -1,23 +0,0 @@
;; Test complet
; Manifest
domain="domain.tld"
path="/path"
is_public=1
; Checks
pkg_linter=1
setup_sub_dir=1
setup_root=1
setup_nourl=0
setup_private=1
setup_public=1
upgrade=1
backup_restore=1
multi_instance=1
change_url=1
;;; Options
Email=
Notification=none
;;; Upgrade options
; commit=CommitHash
name=Name and date of the commit.
manifest_arg=domain=DOMAIN&path=PATH&admin=USER&is_public=1&

170
conf/SCHEMA.sql
View file

@ -21,14 +21,14 @@ CREATE TABLE `customers` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT, `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`title` varchar(128) NOT NULL DEFAULT '', `title` varchar(128) NOT NULL DEFAULT '',
`address` varchar(255) DEFAULT NULL, `address` varchar(255) DEFAULT NULL,
`postcode` int(8) DEFAULT NULL, `postcode` VARCHAR(32) NULL DEFAULT NULL,
`city` varchar(255) DEFAULT NULL, `city` varchar(255) DEFAULT NULL,
`state` varchar(255) DEFAULT NULL, `state` varchar(255) DEFAULT NULL,
`lat` varchar(12) DEFAULT NULL, `lat` varchar(31) DEFAULT NULL,
`long` varchar(12) DEFAULT NULL, `long` varchar(31) DEFAULT NULL,
`contact_person` text DEFAULT NULL, `contact_person` text DEFAULT NULL,
`contact_phone` varchar(32) DEFAULT NULL, `contact_phone` varchar(32) DEFAULT NULL,
`contact_mail` varchar(255) DEFAULT NULL, `contact_mail` varchar(254) DEFAULT NULL,
`note` text DEFAULT NULL, `note` text DEFAULT NULL,
`status` set('Active','Reserved','Inactive') DEFAULT 'Active', `status` set('Active','Reserved','Inactive') DEFAULT 'Active',
PRIMARY KEY (`id`), PRIMARY KEY (`id`),
@ -44,7 +44,7 @@ CREATE TABLE `ipaddresses` (
`id` int(11) NOT NULL AUTO_INCREMENT, `id` int(11) NOT NULL AUTO_INCREMENT,
`subnetId` INT(11) UNSIGNED NULL DEFAULT NULL, `subnetId` INT(11) UNSIGNED NULL DEFAULT NULL,
`ip_addr` varchar(100) NOT NULL, `ip_addr` varchar(100) NOT NULL,
`is_gateway` TINYINT(1) NULL DEFAULT '0', `is_gateway` BOOL NOT NULL DEFAULT '0',
`description` varchar(64) DEFAULT NULL, `description` varchar(64) DEFAULT NULL,
`hostname` varchar(255) DEFAULT NULL, `hostname` varchar(255) DEFAULT NULL,
`mac` varchar(20) DEFAULT NULL, `mac` varchar(20) DEFAULT NULL,
@ -55,8 +55,8 @@ CREATE TABLE `ipaddresses` (
`port` varchar(32) DEFAULT NULL, `port` varchar(32) DEFAULT NULL,
`note` text, `note` text,
`lastSeen` DATETIME NULL DEFAULT '1970-01-01 00:00:01', `lastSeen` DATETIME NULL DEFAULT '1970-01-01 00:00:01',
`excludePing` BINARY NULL DEFAULT '0', `excludePing` BOOL NOT NULL DEFAULT '0',
`PTRignore` BINARY NULL DEFAULT '0', `PTRignore` BOOL NOT NULL DEFAULT '0',
`PTR` INT(11) UNSIGNED NULL DEFAULT '0', `PTR` INT(11) UNSIGNED NULL DEFAULT '0',
`firewallAddressObject` VARCHAR(100) NULL DEFAULT NULL, `firewallAddressObject` VARCHAR(100) NULL DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP, `editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
@ -93,8 +93,8 @@ CREATE TABLE `logs` (
`date` varchar(32) DEFAULT NULL, `date` varchar(32) DEFAULT NULL,
`username` varchar(255) DEFAULT NULL, `username` varchar(255) DEFAULT NULL,
`ipaddr` varchar(64) DEFAULT NULL, `ipaddr` varchar(64) DEFAULT NULL,
`command` varchar(128) DEFAULT '0', `command` text DEFAULT NULL,
`details` varchar(1024) DEFAULT NULL, `details` text DEFAULT NULL,
PRIMARY KEY (`id`) PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
@ -108,6 +108,7 @@ CREATE TABLE `requests` (
`subnetId` INT(11) UNSIGNED NULL DEFAULT NULL, `subnetId` INT(11) UNSIGNED NULL DEFAULT NULL,
`ip_addr` varchar(100) DEFAULT NULL, `ip_addr` varchar(100) DEFAULT NULL,
`description` varchar(64) DEFAULT NULL, `description` varchar(64) DEFAULT NULL,
`mac` varchar(20) DEFAULT NULL,
`hostname` varchar(255) DEFAULT NULL, `hostname` varchar(255) DEFAULT NULL,
`state` INT NULL DEFAULT '2', `state` INT NULL DEFAULT '2',
`owner` varchar(128) DEFAULT NULL, `owner` varchar(128) DEFAULT NULL,
@ -134,6 +135,7 @@ CREATE TABLE `sections` (
`subnetOrdering` VARCHAR(16) NULL DEFAULT NULL, `subnetOrdering` VARCHAR(16) NULL DEFAULT NULL,
`order` INT(3) NULL DEFAULT NULL, `order` INT(3) NULL DEFAULT NULL,
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP, `editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`showSubnet` BOOL NOT NULL DEFAULT '1',
`showVLAN` BOOL NOT NULL DEFAULT '0', `showVLAN` BOOL NOT NULL DEFAULT '0',
`showVRF` BOOL NOT NULL DEFAULT '0', `showVRF` BOOL NOT NULL DEFAULT '0',
`showSupernetOnly` BOOL NOT NULL DEFAULT '0', `showSupernetOnly` BOOL NOT NULL DEFAULT '0',
@ -156,7 +158,7 @@ CREATE TABLE `settings` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT, `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`siteTitle` varchar(64) DEFAULT NULL, `siteTitle` varchar(64) DEFAULT NULL,
`siteAdminName` varchar(64) DEFAULT NULL, `siteAdminName` varchar(64) DEFAULT NULL,
`siteAdminMail` varchar(64) DEFAULT NULL, `siteAdminMail` varchar(254) DEFAULT NULL,
`siteDomain` varchar(32) DEFAULT NULL, `siteDomain` varchar(32) DEFAULT NULL,
`siteURL` varchar(64) DEFAULT NULL, `siteURL` varchar(64) DEFAULT NULL,
`siteLoginText` varchar(128) DEFAULT NULL, `siteLoginText` varchar(128) DEFAULT NULL,
@ -179,6 +181,7 @@ CREATE TABLE `settings` (
`enablePSTN` TINYINT(1) NULL DEFAULT '0', `enablePSTN` TINYINT(1) NULL DEFAULT '0',
`enableChangelog` TINYINT(1) NOT NULL DEFAULT '1', `enableChangelog` TINYINT(1) NOT NULL DEFAULT '1',
`enableCustomers` TINYINT(1) NOT NULL DEFAULT '1', `enableCustomers` TINYINT(1) NOT NULL DEFAULT '1',
`enableVaults` TINYINT(1) NOT NULL DEFAULT '1',
`link_field` VARCHAR(32) NULL DEFAULT '0', `link_field` VARCHAR(32) NULL DEFAULT '0',
`version` varchar(5) DEFAULT NULL, `version` varchar(5) DEFAULT NULL,
`dbversion` INT(8) NOT NULL DEFAULT '0', `dbversion` INT(8) NOT NULL DEFAULT '0',
@ -199,9 +202,9 @@ CREATE TABLE `settings` (
`api` BINARY NOT NULL DEFAULT '0', `api` BINARY NOT NULL DEFAULT '0',
`scanPingPath` VARCHAR(64) NULL DEFAULT '/bin/ping', `scanPingPath` VARCHAR(64) NULL DEFAULT '/bin/ping',
`scanFPingPath` VARCHAR(64) NULL DEFAULT '/bin/fping', `scanFPingPath` VARCHAR(64) NULL DEFAULT '/bin/fping',
`scanPingType` SET('ping','pear','fping') NOT NULL DEFAULT 'ping', `scanPingType` ENUM('none','ping','pear','fping') NOT NULL DEFAULT 'ping',
`scanMaxThreads` INT(4) NULL DEFAULT '128', `scanMaxThreads` INT(4) NULL DEFAULT '128',
`prettyLinks` SET("Yes","No") NOT NULL DEFAULT 'No', `prettyLinks` ENUM('Yes','No') NOT NULL DEFAULT 'No',
`hiddenCustomFields` text NULL, `hiddenCustomFields` text NULL,
`inactivityTimeout` INT(5) NOT NULL DEFAULT '3600', `inactivityTimeout` INT(5) NOT NULL DEFAULT '3600',
`updateTags` TINYINT(1) NULL DEFAULT '0', `updateTags` TINYINT(1) NULL DEFAULT '0',
@ -211,13 +214,13 @@ CREATE TABLE `settings` (
`decodeMAC` TINYINT(1) NULL DEFAULT '1', `decodeMAC` TINYINT(1) NULL DEFAULT '1',
`tempShare` TINYINT(1) NULL DEFAULT '0', `tempShare` TINYINT(1) NULL DEFAULT '0',
`tempAccess` TEXT NULL, `tempAccess` TEXT NULL,
`log` SET('Database','syslog', 'both') NOT NULL DEFAULT 'Database', `log` ENUM('Database','syslog', 'both') NOT NULL DEFAULT 'Database',
`subnetView` TINYINT NOT NULL DEFAULT '0', `subnetView` TINYINT NOT NULL DEFAULT '0',
`enableCircuits` TINYINT(1) NULL DEFAULT '1', `enableCircuits` TINYINT(1) NULL DEFAULT '1',
`enableRouting` TINYINT(1) NULL DEFAULT '0', `enableRouting` TINYINT(1) NULL DEFAULT '0',
`permissionPropagate` TINYINT(1) NULL DEFAULT '1', `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\":\"#,_,-,!,[,],=,~\"}', `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_provider` ENUM('none','Google_Authenticator') NULL DEFAULT 'none',
`2fa_name` VARCHAR(32) NULL DEFAULT 'phpipam', `2fa_name` VARCHAR(32) NULL DEFAULT 'phpipam',
`2fa_length` INT(2) NULL DEFAULT '16', `2fa_length` INT(2) NULL DEFAULT '16',
`2fa_userchange` BOOL NOT NULL DEFAULT '1', `2fa_userchange` BOOL NOT NULL DEFAULT '1',
@ -235,15 +238,15 @@ DROP TABLE IF EXISTS `settingsMail`;
CREATE TABLE `settingsMail` ( CREATE TABLE `settingsMail` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT, `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`mtype` set('localhost','smtp') NOT NULL DEFAULT 'localhost', `mtype` ENUM('localhost','smtp') NOT NULL DEFAULT 'localhost',
`msecure` SET('none','ssl','tls') NOT NULL DEFAULT 'none', `msecure` ENUM('none','ssl','tls') NOT NULL DEFAULT 'none',
`mauth` set('yes','no') NOT NULL DEFAULT 'no', `mauth` ENUM('yes','no') NOT NULL DEFAULT 'no',
`mserver` varchar(128) DEFAULT NULL, `mserver` varchar(128) DEFAULT NULL,
`mport` int(5) DEFAULT '25', `mport` int(5) DEFAULT '25',
`muser` varchar(64) DEFAULT NULL, `muser` varchar(254) DEFAULT NULL,
`mpass` varchar(64) DEFAULT NULL, `mpass` varchar(128) DEFAULT NULL,
`mAdminName` varchar(64) DEFAULT NULL, `mAdminName` varchar(128) DEFAULT NULL,
`mAdminMail` varchar(64) DEFAULT NULL, `mAdminMail` varchar(254) DEFAULT NULL,
PRIMARY KEY (`id`) PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */ /* insert default values */
@ -266,21 +269,22 @@ CREATE TABLE `subnets` (
`firewallAddressObject` VARCHAR(100) NULL DEFAULT NULL, `firewallAddressObject` VARCHAR(100) NULL DEFAULT NULL,
`vrfId` INT(11) UNSIGNED NULL DEFAULT NULL, `vrfId` INT(11) UNSIGNED NULL DEFAULT NULL,
`masterSubnetId` INT(11) UNSIGNED NOT NULL default 0, `masterSubnetId` INT(11) UNSIGNED NOT NULL default 0,
`allowRequests` tinyint(1) DEFAULT '0', `allowRequests` BOOL NOT NULL DEFAULT '0',
`vlanId` INT(11) UNSIGNED NULL DEFAULT NULL, `vlanId` INT(11) UNSIGNED NULL DEFAULT NULL,
`showName` tinyint(1) DEFAULT '0', `showName` BOOL NOT NULL DEFAULT '0',
`device` INT UNSIGNED NULL DEFAULT '0', `device` INT UNSIGNED NULL DEFAULT '0',
`permissions` varchar(1024) DEFAULT NULL, `permissions` varchar(1024) DEFAULT NULL,
`pingSubnet` BOOL NULL DEFAULT '0', `pingSubnet` BOOL NOT NULL DEFAULT '0',
`discoverSubnet` BINARY(1) NULL DEFAULT '0', `discoverSubnet` BOOL NOT NULL DEFAULT '0',
`resolveDNS` TINYINT(1) NULL DEFAULT '0', `resolveDNS` BOOL NOT NULL DEFAULT '0',
`DNSrecursive` TINYINT(1) NULL DEFAULT '0', `DNSrecursive` BOOL NOT NULL DEFAULT '0',
`DNSrecords` TINYINT(1) NULL DEFAULT '0', `DNSrecords` BOOL NOT NULL DEFAULT '0',
`nameserverId` INT(11) NULL DEFAULT '0', `nameserverId` INT(11) NULL DEFAULT '0',
`scanAgent` INT(11) DEFAULT NULL, `scanAgent` INT(11) DEFAULT NULL,
`customer_id` INT(11) unsigned NULL default NULL, `customer_id` INT(11) unsigned NULL default NULL,
`isFolder` BOOL NULL DEFAULT '0', `isFolder` BOOL NOT NULL DEFAULT '0',
`isFull` TINYINT(1) NULL DEFAULT '0', `isFull` BOOL NOT NULL DEFAULT '0',
`isPool` BOOL NOT NULL DEFAULT '0',
`state` INT(3) NULL DEFAULT '2', `state` INT(3) NULL DEFAULT '2',
`threshold` int(3) NULL DEFAULT 0, `threshold` int(3) NULL DEFAULT 0,
`location` INT(11) UNSIGNED NULL DEFAULT NULL, `location` INT(11) UNSIGNED NULL DEFAULT NULL,
@ -370,28 +374,28 @@ CREATE TABLE `users` (
`groups` varchar(1024) COLLATE utf8_bin DEFAULT NULL, `groups` varchar(1024) COLLATE utf8_bin DEFAULT NULL,
`role` text CHARACTER SET utf8, `role` text CHARACTER SET utf8,
`real_name` varchar(128) CHARACTER SET utf8 DEFAULT NULL, `real_name` varchar(128) CHARACTER SET utf8 DEFAULT NULL,
`email` varchar(64) CHARACTER SET utf8 DEFAULT NULL, `email` varchar(254) CHARACTER SET utf8 DEFAULT NULL,
`domainUser` binary(1) DEFAULT '0', `domainUser` binary(1) DEFAULT '0',
`widgets` VARCHAR(1024) NULL DEFAULT 'statistics;favourite_subnets;changelog;top10_hosts_v4', `widgets` VARCHAR(1024) NULL DEFAULT 'statistics;favourite_subnets;changelog;top10_hosts_v4',
`lang` INT(11) UNSIGNED NULL DEFAULT '9', `lang` INT(11) UNSIGNED NULL DEFAULT '9',
`favourite_subnets` VARCHAR(1024) NULL DEFAULT NULL, `favourite_subnets` VARCHAR(1024) NULL DEFAULT NULL,
`disabled` SET('Yes','No') NOT NULL DEFAULT 'No', `disabled` ENUM('Yes','No') NOT NULL DEFAULT 'No',
`mailNotify` SET('Yes','No') NULL DEFAULT 'No', `mailNotify` ENUM('Yes','No') NOT NULL DEFAULT 'No',
`mailChangelog` SET('Yes','No') NULL DEFAULT 'No', `mailChangelog` ENUM('Yes','No') NOT NULL DEFAULT 'No',
`passChange` SET('Yes','No') NOT NULL DEFAULT 'No', `passChange` ENUM('Yes','No') NOT NULL DEFAULT 'No',
`editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP, `editDate` TIMESTAMP NULL ON UPDATE CURRENT_TIMESTAMP,
`lastLogin` TIMESTAMP NULL, `lastLogin` TIMESTAMP NULL,
`lastActivity` TIMESTAMP NULL, `lastActivity` TIMESTAMP NULL,
`compressOverride` SET('default','Uncompress') NOT NULL DEFAULT 'default', `compressOverride` ENUM('default','Uncompress') NOT NULL DEFAULT 'default',
`hideFreeRange` tinyint(1) DEFAULT '0', `hideFreeRange` tinyint(1) DEFAULT '0',
`menuType` SET('Static','Dynamic') NULL DEFAULT 'Dynamic', `menuType` ENUM('Static','Dynamic') NOT NULL DEFAULT 'Dynamic',
`menuCompact` TINYINT NULL DEFAULT '1', `menuCompact` TINYINT NULL DEFAULT '1',
`2fa` BOOL NOT NULL DEFAULT '0', `2fa` BOOL NOT NULL DEFAULT '0',
`2fa_secret` VARCHAR(32) NULL DEFAULT NULL, `2fa_secret` VARCHAR(32) NULL DEFAULT NULL,
`theme` VARCHAR(32) NULL DEFAULT '', `theme` VARCHAR(32) NULL DEFAULT '',
`token` VARCHAR(24) NULL DEFAULT NULL, `token` VARCHAR(24) NULL DEFAULT NULL,
`token_valid_until` DATETIME 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"}', `module_permissions` varchar(255) COLLATE utf8_bin DEFAULT '{"vlan":"1","l2dom":"1","vrf":"1","pdns":"1","circuits":"1","racks":"1","nat":"1","pstn":"1","customers":"1","locations":"1","devices":"1","routing":"1","vaults":"1"}',
`compress_actions` TINYINT(1) NULL DEFAULT '1', `compress_actions` TINYINT(1) NULL DEFAULT '1',
PRIMARY KEY (`username`), PRIMARY KEY (`username`),
UNIQUE KEY `id_2` (`id`) UNIQUE KEY `id_2` (`id`)
@ -424,9 +428,11 @@ VALUES
(7, 'es_ES.UTF-8', 'Español'), (7, 'es_ES.UTF-8', 'Español'),
(8, 'cs_CZ.UTF-8', 'Czech'), (8, 'cs_CZ.UTF-8', 'Czech'),
(9, 'en_US.UTF-8', 'English (US)'), (9, 'en_US.UTF-8', 'English (US)'),
(10,'ru_RU.UTF-8', 'Russian'), (10, 'ru_RU.UTF-8', 'Russian'),
(11,'zh_CN.UTF-8', 'Chinese'), (11, 'zh_CN.UTF-8', 'Chinese'),
(12,'ja_JP.UTF-8', 'Japanese'); (12, 'ja_JP.UTF-8', 'Japanese'),
(13, 'zh_TW.UTF-8', 'Chinese traditional (繁體中文)'),
(14, 'it_IT.UTF-8', 'Italian');
# Dump of table vlans # Dump of table vlans
@ -536,10 +542,10 @@ CREATE TABLE `changelog` (
`ctype` set('ip_addr','subnet','section') NOT NULL DEFAULT '', `ctype` set('ip_addr','subnet','section') NOT NULL DEFAULT '',
`coid` int(11) unsigned NOT NULL, `coid` int(11) unsigned NOT NULL,
`cuser` int(11) unsigned NOT NULL, `cuser` int(11) unsigned NOT NULL,
`caction` set('add','edit','delete','truncate','resize','perm_change') NOT NULL DEFAULT 'edit', `caction` ENUM('add','edit','delete','truncate','resize','perm_change') NOT NULL DEFAULT 'edit',
`cresult` set('error','success') NOT NULL DEFAULT '', `cresult` ENUM('error','success') NOT NULL DEFAULT 'success',
`cdate` datetime NOT NULL, `cdate` datetime NOT NULL,
`cdiff` varchar(2048) DEFAULT NULL, `cdiff` text DEFAULT NULL,
PRIMARY KEY (`cid`), PRIMARY KEY (`cid`),
KEY `coid` (`coid`), KEY `coid` (`coid`),
KEY `ctype` (`ctype`) KEY `ctype` (`ctype`)
@ -582,7 +588,8 @@ VALUES
(15, 'Locations', 'Shows map of locations', 'locations', NULL, 'yes', '6', 'no', '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'), (16, 'Bandwidth calculator', 'Calculate bandwidth', 'bw_calculator', NULL, 'no', '6', 'no', 'yes'),
(17, 'Customers', 'Shows customer list', 'customers', NULL, 'yes', '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'); (18, 'User Instructions', 'Shows user instructions', 'instructions', NULL, 'yes', '6', 'no', 'yes'),
(19, 'MAC lookup', 'Shows MAC address vendor', 'mac-lookup', NULL, 'yes', '6', 'no', 'yes');
@ -630,9 +637,9 @@ DROP TABLE IF EXISTS `usersAuthMethod`;
CREATE TABLE `usersAuthMethod` ( CREATE TABLE `usersAuthMethod` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT, `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`type` set('local','http','AD','LDAP','NetIQ','Radius','SAML2') NOT NULL DEFAULT 'local', `type` ENUM('local','http','AD','LDAP','NetIQ','Radius','SAML2') NOT NULL DEFAULT 'local',
`params` varchar(2048) DEFAULT NULL, `params` text DEFAULT NULL,
`protected` set('Yes','No') NOT NULL DEFAULT 'Yes', `protected` ENUM('Yes','No') NOT NULL DEFAULT 'Yes',
`description` text, `description` text,
PRIMARY KEY (`id`) PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
@ -709,6 +716,7 @@ DROP TABLE IF EXISTS `firewallZoneSubnet`;
CREATE TABLE `firewallZoneSubnet` ( CREATE TABLE `firewallZoneSubnet` (
`zoneId` INT NOT NULL, `zoneId` INT NOT NULL,
`subnetId` INT(11) NOT NULL, `subnetId` INT(11) NOT NULL,
PRIMARY KEY (`zoneId`,`subnetId`),
INDEX `fk_zoneId_idx` (`zoneId` ASC), INDEX `fk_zoneId_idx` (`zoneId` ASC),
INDEX `fk_subnetId_idx` (`subnetId` ASC), INDEX `fk_subnetId_idx` (`subnetId` ASC),
CONSTRAINT `fk_zoneId` CONSTRAINT `fk_zoneId`
@ -807,8 +815,8 @@ CREATE TABLE `locations` (
`name` varchar(128) NOT NULL DEFAULT '', `name` varchar(128) NOT NULL DEFAULT '',
`description` text, `description` text,
`address` VARCHAR(128) NULL DEFAULT NULL, `address` VARCHAR(128) NULL DEFAULT NULL,
`lat` varchar(12) DEFAULT NULL, `lat` varchar(31) DEFAULT NULL,
`long` varchar(12) DEFAULT NULL, `long` varchar(31) DEFAULT NULL,
PRIMARY KEY (`id`) PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
@ -913,7 +921,8 @@ DROP TABLE IF EXISTS `circuitsLogicalMapping`;
CREATE TABLE `circuitsLogicalMapping` ( CREATE TABLE `circuitsLogicalMapping` (
`logicalCircuit_id` int(11) unsigned NOT NULL, `logicalCircuit_id` int(11) unsigned NOT NULL,
`circuit_id` int(11) unsigned NOT NULL, `circuit_id` int(11) unsigned NOT NULL,
`order` int(10) unsigned DEFAULT NULL `order` int(10) unsigned DEFAULT NULL,
PRIMARY KEY (`logicalCircuit_id`, `circuit_id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8; ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
@ -990,9 +999,64 @@ CREATE TABLE `routing_subnets` (
) ENGINE=InnoDB DEFAULT CHARSET=utf8; ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table vaults
# ------------------------------------------------------------
DROP TABLE IF EXISTS `vaults`;
CREATE TABLE `vaults` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`name` varchar(64) NOT NULL DEFAULT '',
`type` enum('passwords','certificates') NOT NULL DEFAULT 'passwords',
`description` text,
`test` char(128) NOT NULL DEFAULT '',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table vaultItems
# ------------------------------------------------------------
DROP TABLE IF EXISTS `vaultItems`;
CREATE TABLE `vaultItems` (
`id` int(11) unsigned NOT NULL AUTO_INCREMENT,
`vaultId` int(11) unsigned NOT NULL,
`type` enum('password','certificate') NOT NULL DEFAULT 'password',
`type_certificate` enum('public','pkcs12','certificate','website') NOT NULL DEFAULT 'public',
`values` text,
PRIMARY KEY (`id`),
KEY `vaultId` (`vaultId`),
CONSTRAINT `vaultItems_ibfk_1` FOREIGN KEY (`vaultId`) REFERENCES `vaults` (`id`) ON DELETE CASCADE ON UPDATE CASCADE
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table nominatim
# ------------------------------------------------------------
DROP TABLE IF EXISTS `nominatim`;
CREATE TABLE `nominatim` (
`id` int(11) UNSIGNED NOT NULL AUTO_INCREMENT,
`url` varchar(255) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
/* insert default values */
INSERT INTO `nominatim` (`id`, `url`) VALUES (1, 'https://nominatim.openstreetmap.org/search');
# Dump of table nominatim_cache
# ------------------------------------------------------------
DROP TABLE IF EXISTS `nominatim_cache`;
CREATE TABLE `nominatim_cache` (
`sha256` binary(32) NOT NULL,
`date` timestamp NOT NULL DEFAULT current_timestamp(),
`query` text NOT NULL,
`lat_lng` text NOT NULL,
PRIMARY KEY (`sha256`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
# Dump of table -- for autofix comment, leave as it is # Dump of table -- for autofix comment, leave as it is
# ------------------------------------------------------------ # ------------------------------------------------------------
UPDATE `settings` SET `version` = "1.43"; UPDATE `settings` SET `version` = "1.52";
UPDATE `settings` SET `dbversion` = 25; UPDATE `settings` SET `dbversion` = 39;

7
conf/app.src
View file

@ -1,7 +0,0 @@
SOURCE_URL=https://github.com/phpipam/phpipam/releases/download/v1.5.1/phpipam-v1.5.1.zip
SOURCE_SUM=9ced23778f6455d3db8975e09bc5b2f605add9f7feda1568b716803850d19c58
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=zip
SOURCE_IN_SUBDIR=true
SOURCE_EXTRACT=true
SOURCE_FILENAME=phpipam.zip

67
conf/config.dist.php
View file

@ -33,19 +33,15 @@ $db['webhost'] = '%';
php 5.3.7 required php 5.3.7 required
******************************/ ******************************/
$db['ssl'] = false; // true/false, enable or disable SSL as a whole $db['ssl'] = false; // true/false, enable or disable SSL as a whole
$db['ssl_key'] = '/path/to/cert.key'; // path to an SSL key file. Only makes sense combined with ssl_cert // $db['ssl_key'] = '/path/to/cert.key'; // path to an SSL key file. Only makes sense combined with ssl_cert
$db['ssl_cert'] = '/path/to/cert.crt'; // path to an SSL certificate file. Only makes sense combined with ssl_key // $db['ssl_cert'] = '/path/to/cert.crt'; // path to an SSL certificate file. Only makes sense combined with ssl_key
$db['ssl_ca'] = '/path/to/ca.crt'; // path to a file containing SSL CA certs // $db['ssl_ca'] = '/path/to/ca.crt'; // path to a file containing SSL CA certs
$db['ssl_capath'] = '/path/to/ca_certs'; // path to a directory containing CA certs // $db['ssl_capath'] = '/path/to/ca_certs'; // path to a directory containing CA certs
$db['ssl_cipher'] = 'DHE-RSA-AES256-SHA:AES128-SHA'; // one or more SSL Ciphers // $db['ssl_cipher'] = 'HIGH:!PSK:!SHA:!MD5:!RC4:!aNULL'; // one or more SSL Ciphers, see openssl ciphers -v '....'
$db['ssl_verify'] = 'true'; // Verify Common Name (CN) of server certificate? // $db['ssl_verify'] = 'true'; // Verify Common Name (CN) of server certificate?
$db['tmptable_engine_type'] = "MEMORY"; // Temporary table type to construct complex queries (MEMORY, InnoDB)
/** $db['use_cte'] = 1; // Use recursive CTE queries [>=MariaDB 10.2.2, >=MySQL 8.0] (0=disabled, 1=autodetect, 2=force enable)
* temporary table type to create slave subnets table
* (MEMORY, InnoDB)
******************************/
$db['tmptable_engine_type'] = "MEMORY";
/** /**
@ -64,6 +60,7 @@ $config['removed_addresses_timelimit'] = 86400 * 7; // int, after how many seco
# resolveIPaddresses.php script parameters # resolveIPaddresses.php script parameters
$config['resolve_emptyonly'] = true; // if true it will only update the ones without DNS entry! $config['resolve_emptyonly'] = true; // if true it will only update the ones without DNS entry!
$config['resolve_verbose'] = true; // verbose response - prints results, cron will email it to you! $config['resolve_verbose'] = true; // verbose response - prints results, cron will email it to you!
$config['disable_main_login_form'] = false; // disable main login form if you want use another authentification method by default (SAML, LDAP, etc.)
/** /**
@ -75,9 +72,12 @@ $config['resolve_verbose'] = true; // verbose response - print
$debugging = false; $debugging = false;
/* /*
* API Crypt security provider. "mcrypt" or "openssl" * API Crypt security provider. "mcrypt" or "openssl*"
* Supported methods:
* openssl-128-cbc (alias openssl, openssl-128) *default
* openssl-256-cbc (alias openssl-256)
* *
* default as of 1.3.2 "openssl" * default as of 1.3.2 "openssl-128-cbc"
******************************/ ******************************/
// $api_crypt_encryption_library = "mcrypt"; // $api_crypt_encryption_library = "mcrypt";
@ -99,8 +99,8 @@ $phpsessname = "phpipam";
/** /**
* Cookie SameSite settings ("None", "Lax"=Default, "Strict") * Cookie SameSite settings ("None", "Lax"=Default, "Strict")
* - "Strict" increases security * - "Strict" increases security
* - "Lax" required for SAML2 * - "Lax" required for SAML2, some SAML topologies may require "None".
* - "None" requires HTTPS * - "None" requires HTTPS (implies "Secure;")
*/ */
$cookie_samesite = "Lax"; $cookie_samesite = "Lax";
@ -109,7 +109,7 @@ $cookie_samesite = "Lax";
* *
* @var string * @var string
*/ */
$session_storage = "files"; $session_storage = "database";
/** /**
@ -133,32 +133,11 @@ define('BASE', "__PATH__/");
if(!defined('MCUNIQUE')) if(!defined('MCUNIQUE'))
define('MCUNIQUE', "section"); define('MCUNIQUE', "section");
/**
* SAML mappings
******************************/
if(!defined('MAP_SAML_USER'))
define('MAP_SAML_USER', true); // Enable SAML username mapping
if(!defined('SAML_USERNAME'))
define('SAML_USERNAME', 'admin'); // Map SAML to explicit user
/** /**
* Permit private subpages - private apps under /app/tools/custom/<custom_app_name>/index.php * Permit private subpages - private apps under /app/tools/custom/<custom_app_name>/index.php
******************************/ ******************************/
$private_subpages = array(); $private_subpages = array();
/**
* Google MAPs API key for locations to display map
*
* Obtain key: Go to your Google Console (https://console.developers.google.com) and enable "Google Maps JavaScript API"
* from overview tab, so go to Credentials tab and make an API key for your project.
******************************/
$gmaps_api_key = "";
$gmaps_api_geocode_key = "";
/** /**
* proxy connection details * proxy connection details
******************************/ ******************************/
@ -169,12 +148,22 @@ $proxy_user = 'USERNAME'; // Proxy Username
$proxy_pass = 'PASSWORD'; // Proxy Password $proxy_pass = 'PASSWORD'; // Proxy Password
$proxy_use_auth = false; // Enable/Disable Proxy authentication $proxy_use_auth = false; // Enable/Disable Proxy authentication
$offline_mode = false; // Offline mode, disable server-side Internet requests (proxy/OpenStreetMap)
/**
* Failed access
* Message to log into webserver logs in case of failed access, for further processing by tools like Fail2Ban
* The message can contain a %u parameter which will be replaced with the login user identifier.
******************************/
// $failed_access_message = '';
/** /**
* General tweaks * General tweaks
******************************/ ******************************/
$config['logo_width'] = 220; // logo width $config['logo_width'] = 220; // logo width
$config['requests_public'] = true; // Show IP request module on login page $config['requests_public'] = true; // Show IP request module on login page
$config['split_ip_custom_fields'] = false; // Show custom fields in separate table when editing IP address $config['split_ip_custom_fields'] = false; // Show custom fields in separate table when editing IP address
$config['footer_message'] = ""; // Custom message included in the footer of every page
/** /**
* PHP CLI binary for scanning and network discovery. * PHP CLI binary for scanning and network discovery.
@ -182,7 +171,7 @@ $config['split_ip_custom_fields'] = false; // Show custom field
* The default behaviour is to use the system wide default php version symlinked to php in PHP_BINDIR (/usr/bin/php). * The default behaviour is to use the system wide default php version symlinked to php in PHP_BINDIR (/usr/bin/php).
* 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.4';
/** /**
* Path to mysqldump binary * Path to mysqldump binary

4
conf/extra_php-fpm.conf Normal file
View file

@ -0,0 +1,4 @@
; Additional php.ini defines, specific to this pool of workers.
php_admin_value[upload_max_filesize] = 256M
php_admin_value[post_max_size] = 256M

11
conf/nginx.conf
View file

@ -2,11 +2,13 @@
location __PATH__/ { location __PATH__/ {
# Path to source # Path to source
alias __FINALPATH__/ ; alias __INSTALL_DIR__/;
index index.php; index index.php;
client_max_body_size 256M;
try_files $uri $uri/ __PATH__/index.php;
try_files $uri $uri/ index.php;
location ~ [^/]\.php(/|$) { location ~ [^/]\.php(/|$) {
fastcgi_split_path_info ^(.+?\.php)(/.*)$; fastcgi_split_path_info ^(.+?\.php)(/.*)$;
fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
@ -16,8 +18,13 @@ location __PATH__/ {
fastcgi_param REMOTE_USER $remote_user; fastcgi_param REMOTE_USER $remote_user;
fastcgi_param PATH_INFO $fastcgi_path_info; fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param SCRIPT_FILENAME $request_filename; fastcgi_param SCRIPT_FILENAME $request_filename;
fastcgi_pass_header Authorization;
} }
# Include SSOWAT user panel. # Include SSOWAT user panel.
include conf.d/yunohost_panel.conf.inc; include conf.d/yunohost_panel.conf.inc;
} }
location __PATH__/api/ {
try_files $uri $uri/ __PATH__/api/index.php;
}

430
conf/php-fpm.conf
View file

@ -1,430 +0,0 @@
; 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

1
doc/DESCRIPTION.md Normal file
View file

@ -0,0 +1 @@
phpIPAM is an open-source web IP address management application. Its goal is to provide light and simple IP address management application. It is ajax-based using jQuery libraries, it uses php scripts and javascript and some HTML5/CSS3 features, so some modern browser is preferred to be able to display javascript quickly and correctly.

0
doc/DISCLAIMER.md
View file

1
doc/POST_INSTALL.md Normal file
View file

@ -0,0 +1 @@
The Default credentials for a new instance of phpIPAM are: Admin / ipamadmin

51
manifest.json
View file

@ -1,51 +0,0 @@
{
"name": "phpIPAM",
"id": "phpipam",
"packaging_format": 1,
"description": {
"en": "Web IP address management application",
"fr": "Application web de gestion d'adresses IP"
},
"version": "1.5.2~ynh1",
"url": "https://phpipam.net/",
"upstream": {
"license": "GPL-3.0-only",
"website": "https://phpipam.net",
"demo": "http://demo.phpipam.net",
"admindoc": "https://phpipam.net/documents/",
"code": "https://github.com/phpipam/phpipam"
},
"license": "GPL-3.0-only",
"maintainer": {
"name": "liberodark",
"email": "liberodark@gmail.com"
},
"requirements": {
"yunohost": ">= 11.0.9"
},
"multi_instance": true,
"services": [
"nginx",
"php7.4-fpm",
"mysql"
],
"arguments": {
"install": [
{
"name": "domain",
"type": "domain"
},
{
"name": "path",
"type": "path",
"example": "/phpipam",
"default": "/phpipam"
},
{
"name": "is_public",
"type": "boolean",
"default": true
}
]
}
}

61
manifest.toml Normal file
View file

@ -0,0 +1,61 @@
packaging_format = 2
id = "phpipam"
name = "phpIPAM"
description.en = "Web IP address management application"
description.fr = "Application web de gestion d'adresses IP"
version = "1.5.2~ynh1"
maintainers = [""]
[upstream]
license = "GPL-3.0-only"
website = "https://phpipam.net"
demo = "http://demo.phpipam.net"
admindoc = "https://phpipam.net/documents/"
code = "https://github.com/phpipam/phpipam"
[integration]
yunohost = ">= 11.1.19"
architectures = "all"
multi_instance = true
ldap = false
sso = false
disk = "50M"
ram.build = "50M"
ram.runtime = "50M"
[install]
[install.domain]
type = "domain"
[install.path]
type = "path"
default = "/phpipam"
[install.init_main_permission]
type = "group"
default = "visitors"
[resources]
[resources.sources.main]
url = "https://github.com/phpipam/phpipam/releases/download/v1.5.1/phpipam-v1.5.1.zip"
sha256 = "9ced23778f6455d3db8975e09bc5b2f605add9f7feda1568b716803850d19c58"
autoupdate.strategy = "latest_github_tag"
[resources.system_user]
[resources.install_dir]
[resources.permissions]
main.url = "/"
api.url = "/api"
api.show_tile = false
api.allowed = "visitors"
[resources.apt]
packages = "mariadb-server php7.4-gmp php7.4-mysql php7.4-ldap php7.4-gd php7.4-opcache php7.4-fileinfo php7.4-intl php7.4-json php7.4-cli php7.4-mbstring php7.4-xml"
[resources.database]
type = "mysql"

61
scripts/_common.sh
View file

@ -4,10 +4,6 @@
# COMMON VARIABLES # COMMON VARIABLES
#================================================= #=================================================
YNH_PHP_VERSION="7.4"
pkg_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 # PERSONAL HELPERS
#================================================= #=================================================
@ -19,60 +15,3 @@ pkg_dependencies="php${YNH_PHP_VERSION}-gmp php${YNH_PHP_VERSION}-mysql php${YNH
#================================================= #=================================================
# FUTURE OFFICIAL HELPERS # FUTURE OFFICIAL HELPERS
#================================================= #=================================================
# Send an email to inform the administrator
#
# usage: ynh_send_readme_to_admin app_message [recipients]
# | arg: app_message - The message to send to the administrator.
# | arg: recipients - The recipients of this email. Use spaces to separate multiples recipients. - default: root
# example: "root admin@domain"
# 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}"
# Retrieve the email of users
find_mails () {
local list_mails="$1"
local mail
local recipients=" "
# Read each mail in argument
for mail in $list_mails
do
# Keep root or a real email address as it is
if [ "$mail" = "root" ] || echo "$mail" | grep --quiet "@"
then
recipients="$recipients $mail"
else
# But replace an user name without a domain after by its email
if mail=$(ynh_user_get_info "$mail" "mail" 2> /dev/null)
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
# Send the email to the recipients
echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients"
}

21
scripts/backup
View file

@ -10,25 +10,6 @@
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# LOAD SETTINGS
#=================================================
ynh_print_info --message="Loading installation settings..."
app=$YNH_APP_INSTANCE_NAME
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
domain=$(ynh_app_setting_get --app=$app --key=domain)
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 # DECLARE DATA AND CONF FILES TO BACKUP
#================================================= #=================================================
@ -38,7 +19,7 @@ ynh_print_info --message="Declaring files to be backed up..."
# BACKUP THE APP MAIN DIR # BACKUP THE APP MAIN DIR
#================================================= #=================================================
ynh_backup --src_path="$final_path" ynh_backup --src_path="$install_dir"
#================================================= #=================================================
# BACKUP THE NGINX CONFIGURATION # BACKUP THE NGINX CONFIGURATION

94
scripts/change_url
View file

@ -9,61 +9,6 @@
source _common.sh source _common.sh
source /usr/share/yunohost/helpers 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_user=$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 # STANDARD MODIFICATIONS
#================================================= #=================================================
@ -71,29 +16,7 @@ fi
#================================================= #=================================================
ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2 ynh_script_progression --message="Updating NGINX web server configuration..." --weight=2
nginx_conf_path=/etc/nginx/conf.d/$old_domain.d/$app.conf ynh_change_url_nginx_config
# 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 # SPECIFIC MODIFICATIONS
@ -101,19 +24,10 @@ fi
ynh_script_progression --message="Configuring $app..." --weight=1 ynh_script_progression --message="Configuring $app..." --weight=1
domain="$new_domain" domain="$new_domain"
path_url="$new_path" path="$new_path"
domain_path="https://$domain$path_url" domain_path="https://$domain$path"
ynh_add_config --template="../conf/config.dist.php" --destination="$final_path/config.php" ynh_add_config --template="../conf/config.dist.php" --destination="$install_dir/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 # END OF SCRIPT

142
scripts/install
View file

@ -9,80 +9,33 @@
source _common.sh source _common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST
#=================================================
domain=$YNH_APP_ARG_DOMAIN
path_url=$YNH_APP_ARG_PATH
is_public=$YNH_APP_ARG_IS_PUBLIC
phpversion=$YNH_PHP_VERSION
app=$YNH_APP_INSTANCE_NAME
#=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#=================================================
ynh_script_progression --message="Validating installation parameters..." --weight=1
final_path=/var/www/$app
test ! -e "$final_path" || ynh_die --message="This path already contains a folder"
# Register (book) web path
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url
#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================
ynh_script_progression --message="Storing installation settings..." --weight=1
ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set --app=$app --key=path --value=$path_url
#=================================================
# INSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Installing dependencies..." --weight=1
ynh_install_app_dependencies $pkg_dependencies
#=================================================
# CREATE DEDICATED USER
#=================================================
ynh_script_progression --message="Configuring system user..." --weight=1
# Create a system user
ynh_system_user_create --username=$app --home_dir="$final_path"
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
#================================================= #=================================================
ynh_script_progression --message="Setting up source files..." --weight=3 ynh_script_progression --message="Setting up source files..." --weight=3
ynh_app_setting_set --app=$app --key=final_path --value=$final_path
# Download, check integrity, uncompress and patch the source from app.src # Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path" ynh_setup_source --dest_dir="$install_dir"
chmod 750 "$final_path" chmod -R o-rwx "$install_dir"
chmod -R o-rwx "$final_path" chown -R $app:www-data "$install_dir"
chown -R $app:www-data "$final_path"
#================================================= #=================================================
# CREATE A MYSQL DATABASE # ADD A CONFIGURATION
#================================================= #=================================================
ynh_script_progression --message="Creating a MySQL database..." --weight=2 ynh_script_progression --message="Adding a configuration file..." --weight=1
db_name=$(ynh_sanitize_dbid --db_name=$app) ynh_add_config --template="../conf/config.dist.php" --destination="$install_dir/config.php"
db_user=$db_name
ynh_app_setting_set --app=$app --key=db_name --value=$db_name chmod 644 "$install_dir/config.php"
ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name chown $app: "$install_dir/config.php"
#=================================================
# DATABASE CONFIGURATION
#=================================================
ynh_script_progression --message="Adding database configuration..." --weight=1
ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < $install_dir/db/SCHEMA.sql
#================================================= #=================================================
# NGINX CONFIGURATION # NGINX CONFIGURATION
@ -92,73 +45,12 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=1
# Create a dedicated NGINX config # Create a dedicated NGINX config
ynh_add_nginx_config ynh_add_nginx_config
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_script_progression --message="Configuring PHP-FPM..." --weight=1
# Create a dedicated PHP-FPM config # Create a dedicated PHP-FPM config
ynh_add_fpm_config ynh_add_fpm_config --usage=low --footprint=low
ynh_app_setting_set --app=$app --key=phpversion --value=$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: "$final_path/config.php"
#=================================================
# GENERIC FINALIZATION
#=================================================
# SETUP LOGROTATE
#=================================================
ynh_script_progression --message="Configuring log rotation..." --weight=1
# Use logrotate to manage application logfile(s) # Use logrotate to manage application logfile(s)
ynh_use_logrotate ynh_use_logrotate
#=================================================
# SETUP SSOWAT
#=================================================
ynh_script_progression --message="Configuring permissions..." --weight=1
# Make app public if necessary
if [ $is_public -eq 1 ]
then
ynh_permission_update --permission="main" --add="visitors"
fi
#=================================================
# 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 # END OF SCRIPT
#================================================= #=================================================

57
scripts/remove
View file

@ -9,43 +9,6 @@
source _common.sh source _common.sh
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)
port=$(ynh_app_setting_get --app=$app --key=port)
db_name=$(ynh_app_setting_get --app=$app --key=db_name)
db_user=$db_name
final_path=$(ynh_app_setting_get --app=$app --key=final_path)
#=================================================
# REMOVE THE MYSQL DATABASE
#=================================================
ynh_script_progression --message="Removing the MySQL database..." --weight=1
# Remove a database if it exists, along with the associated user
ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
#=================================================
# REMOVE DEPENDENCIES
#=================================================
ynh_script_progression --message="Removing dependencies..." --weight=1
# Remove metapackage and its dependencies
ynh_remove_app_dependencies
#=================================================
# REMOVE APP MAIN DIR
#=================================================
ynh_script_progression --message="Removing app main directory..." --weight=1
# Remove the app directory securely
ynh_secure_remove --file="$final_path"
#================================================= #=================================================
# REMOVE NGINX CONFIGURATION # REMOVE NGINX CONFIGURATION
#================================================= #=================================================
@ -54,32 +17,12 @@ ynh_script_progression --message="Removing NGINX web server configuration..." --
# Remove the dedicated NGINX config # Remove the dedicated NGINX config
ynh_remove_nginx_config ynh_remove_nginx_config
#=================================================
# REMOVE 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
#=================================================
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
#=================================================
# GENERIC FINALIZATION
#=================================================
# REMOVE DEDICATED USER
#=================================================
ynh_script_progression --message="Removing the dedicated system user..." --weight=1
# Delete a system user
ynh_system_user_delete --username=$app
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT
#================================================= #=================================================

54
scripts/restore
View file

@ -10,35 +10,6 @@
source ../settings/scripts/_common.sh source ../settings/scripts/_common.sh
source /usr/share/yunohost/helpers source /usr/share/yunohost/helpers
#=================================================
# MANAGE SCRIPT FAILURE
#=================================================
# Exit if an error occurs during the execution of the script
ynh_abort_if_errors
#=================================================
# 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_user=$db_name
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#=================================================
# CHECK IF THE APP CAN BE RESTORED
#=================================================
ynh_script_progression --message="Validating restoration parameters..." --weight=1
test ! -d $final_path \
|| ynh_die --message="There is already a directory: $final_path "
#================================================= #=================================================
# STANDARD RESTORATION STEPS # STANDARD RESTORATION STEPS
#================================================= #=================================================
@ -48,24 +19,15 @@ ynh_script_progression --message="Restoring the NGINX configuration..." --weight
ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" 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 # RESTORE THE APP MAIN DIR
#================================================= #=================================================
ynh_script_progression --message="Restoring the app main directory..." --weight=5 ynh_script_progression --message="Restoring the app main directory..." --weight=5
ynh_restore_file --origin_path="$final_path" ynh_restore_file --origin_path="$install_dir"
chmod 750 "$final_path" chmod -R o-rwx "$install_dir"
chmod -R o-rwx "$final_path" chown -R $app:www-data "$install_dir"
chown -R $app:www-data "$final_path"
#================================================= #=================================================
# RESTORE THE PHP-FPM CONFIGURATION # RESTORE THE PHP-FPM CONFIGURATION
@ -74,21 +36,11 @@ ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weig
ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
#=================================================
# REINSTALL DEPENDENCIES
#=================================================
ynh_script_progression --message="Reinstalling dependencies..." --weight=1
# Define and install dependencies
ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# RESTORE THE MYSQL DATABASE # RESTORE THE MYSQL DATABASE
#================================================= #=================================================
ynh_script_progression --message="Restoring the MySQL database..." --weight=1 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 ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql
#================================================= #=================================================

96
scripts/upgrade
View file

@ -9,61 +9,12 @@
source _common.sh source _common.sh
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_user=$db_name
db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#================================================= #=================================================
# CHECK VERSION # CHECK VERSION
#================================================= #=================================================
upgrade_type=$(ynh_check_app_version_changed) 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
#================================================= #=================================================
@ -73,12 +24,11 @@ then
ynh_script_progression --message="Upgrading source files..." --weight=1 ynh_script_progression --message="Upgrading source files..." --weight=1
# Download, check integrity, uncompress and patch the source from app.src # Download, check integrity, uncompress and patch the source from app.src
ynh_setup_source --dest_dir="$final_path" ynh_setup_source --dest_dir="$install_dir"
fi fi
chmod 750 "$final_path" chmod -R o-rwx "$install_dir"
chmod -R o-rwx "$final_path" chown -R $app:www-data "$install_dir"
chown -R $app:www-data "$final_path"
#================================================= #=================================================
# NGINX CONFIGURATION # NGINX CONFIGURATION
@ -88,47 +38,21 @@ ynh_script_progression --message="Upgrading NGINX web server configuration..." -
# Create a dedicated NGINX config # Create a dedicated NGINX config
ynh_add_nginx_config ynh_add_nginx_config
#=================================================
# UPGRADE DEPENDENCIES
#=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=1
ynh_install_app_dependencies $pkg_dependencies
#=================================================
# PHP-FPM CONFIGURATION
#=================================================
ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1
# Create a dedicated PHP-FPM config # Create a dedicated PHP-FPM config
ynh_add_fpm_config ynh_add_fpm_config --usage=low --footprint=low
# Use logrotate to manage app-specific logfile(s)
ynh_use_logrotate --non-append
#================================================= #=================================================
# UPDATE A CONFIG FILE # UPDATE A CONFIG FILE
#================================================= #=================================================
ynh_script_progression --message="Updating a configuration file..." --weight=1 ynh_script_progression --message="Updating a configuration file..." --weight=1
ynh_add_config --template="../conf/config.dist.php" --destination="$final_path/config.php" ynh_add_config --template="../conf/config.dist.php" --destination="$install_dir/config.php"
chmod 400 "$final_path/config.php" chmod 400 "$install_dir/config.php"
chown $app: "$final_path/config.php" chown $app: "$install_dir/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 # END OF SCRIPT

3
tests.toml Normal file
View file

@ -0,0 +1,3 @@
test_format = 1.0
[default]