debian cleanup (#205)

David Coutadeur · David Coutadeur · commit 514ede309aa1 · 2026-01-23T19:28:00.000+01:00
diff --git a/conf/.gitignore b/conf/.gitignore
@@ -0,0 +1,3 @@
+*
+!.gitignore
+!config.inc.php
diff --git a/docs/configuration-apache.rst b/docs/configuration-apache.rst
@@ -1,6 +1,39 @@
+.. _apache_configuration:
+
 Apache configuration
 ====================
 
+
+Apache or Nginx is not installed by default. You must choose one.
+
+Current section explains how to install and configure Apache.
+
+Install and configure Apache
+----------------------------
+
+On Debian:
+
+.. code-block:: shell
+
+  apt install apache2
+
+  # configure php-fpm for apache2
+  a2enmod proxy_fcgi setenvif
+  a2enconf php*-fpm.conf
+
+  # enable the default website
+  a2ensite service-desk
+
+Then you can configure your virtual host. A default one is provided in ``/etc/apache2/sites-available``
+
+On RHEL systems:
+
+.. code-block:: shell
+
+  dnf install httpd
+
+Then you can configure your virtual host. A default one is provided in ``/etc/httpd/conf.d/``
+
 Virtual host
 ------------
 
diff --git a/docs/general-parameters.rst b/docs/general-parameters.rst
@@ -4,7 +4,7 @@ General parameters
 Configuration files
 -------------------
 
-To configure White Pages, you need to create a local configuration file named ``config.inc.local.php`` in ``white-pages/conf``. For example : 
+To configure White Pages, you need to create a local configuration file named ``config.inc.local.php`` in ``/etc/white-pages/``. For example :
 
 .. code-block:: php
 
@@ -13,7 +13,7 @@ To configure White Pages, you need to create a local configuration file named ``
 
     ?>
 
-White Pages default configuration file is ``white-pages/conf/config.inc.php``. It includes ``config.inc.local.php``. Consequently, you can override all parameters in ``config.inc.local.php``. This prevents you to be disturbed by an upgrade.
+White Pages default configuration file is ``/etc/white-pages/config.inc.php``. It includes ``config.inc.local.php``. Consequently, you can override all parameters in ``config.inc.local.php``. This prevents you to be disturbed by an upgrade.
 
 .. warning:: 
   Do not copy ``config.inc.php`` into ``config.inc.local.php``, as the first one includes the second.
@@ -30,7 +30,7 @@ This feature is disabled by default. To enable it:
    $header_name_extra_config = "WP-Extra-Config";
 
 Then if you send the header ``WP-Extra-Config: domain1``, the file
-``conf/config.inc.domain1.php`` will be loaded.
+``/etc/white-pages/config.inc.domain1.php`` will be loaded.
 
 Using Apache, we may set such header using the following:
 
@@ -39,19 +39,20 @@ Using Apache, we may set such header using the following:
     <VirtualHost *:80>
        ServerName wp.domain1.com
        RequestHeader setIfEmpty WP-Extra-Config domain1
-       [...]
+       # ...
     </VirtualHost>
 
 Using Nginx, we could use instead:
 
 .. code-block:: nginx
 
    server {
-       [...]
+       # ...
        location ~ \.php {
            fastcgi_param WP-Extra-Config domain1;
-           [...]
+           # ...
        }
+   }
 
 Language
 --------
@@ -70,7 +71,12 @@ Available languages are:
 * French (fr)
 * Italian (it)
 
-.. tip:: You can override messages by creating lang files in ``conf/``, for example ``conf/en.inc.php``.
+.. tip:: You can override messages by creating lang files in configuration directory:
+
+* ``conf/`` directory for white-pages archive
+* ``/etc/white-pages`` directory for rpm/deb packages
+
+For example, you can create a customized file: ``/etc/white-pages/en.inc.php``.
 
 In order to restrict languages to a specific set add ``$allowed_lang`` array as follows:
 
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,6 +9,7 @@ LDAP Tool Box White Pages documentation
 
    presentation.rst
    installation.rst
+   upgrade.rst
    authentication.rst
    configuration-apache.rst
    general-parameters.rst
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -6,11 +6,11 @@ From tarball
 
 Prerequisites:
 
-* php (version 7.4 or higher)
 * php-ldap
 * php-gd
-* Smarty (version 3 or higher)
 * composer
+* php-fpm
+* smarty (version 3 or 4)
 
 Tarball can be downloaded from `LTB project website <https://ltb-project.org/download.html>`_.
 
@@ -94,10 +94,12 @@ You are now ready to install:
 
     apt install white-pages
 
+You should now proceed to :ref:`webserver installation and configuration <apache_configuration>`
+
 CentOS / RedHat
 ---------------
 
-.. warning:: You need to install first the package `php-Smarty`_ which is not in official repositories.
+.. warning::  You must install the package `php-Smarty`_. You can get it from EPEL repositories.
 
 .. _php-Smarty: https://pkgs.org/download/php-Smarty
 
@@ -120,7 +122,7 @@ Then update:
 
 .. prompt:: bash #
 
-    yum update
+    dnf update
 
 Import repository key:
 
@@ -132,7 +134,9 @@ You are now ready to install:
 
 .. prompt:: bash #
 
-    yum install white-pages
+    dnf install white-pages
+
+You should now proceed to :ref:`webserver installation and configuration <apache_configuration>`
 
 Docker
 ------
@@ -147,25 +151,3 @@ Start container, mounting that configuration file:
         -v /home/test/whitepages.conf.php:/var/www/conf/config.inc.local.php \
         -it docker.io/ltbproject/white-pages:latest
 
-Upgrade Notes
--------------
-
-If you upgrade from an older version, read the following instructions:
-
-Version 0.4
-~~~~~~~~~~~
-
-* Parameter `$ldap_user_regex` is now disbaled by default, means that the object type detection is done with configured LDAP filters.
-
-* The new map feature is disabled by default, as it requires to request OpenStreetMap API. Check the documentation before enabling it.
-
-Version 0.3
-~~~~~~~~~~~
-
-There is a new parameter: `$ldap_user_regex`.
-
-If the default value does not fit your LDAP directory configuration, you must unset the default value, or adapt it. To unset it, put in your config.inc.local.php:
-
-```unset($ldap_user_regex);```
-
-See also the ldap parameters page.
diff --git a/docs/upgrade.rst b/docs/upgrade.rst
@@ -0,0 +1,87 @@
+Upgrade
+=======
+
+If you upgrade from an older version, read the following instructions:
+
+From 0.4 to 0.5
+---------------
+
+bundled dependencies
+~~~~~~~~~~~~~~~~~~~~
+
+The dependencies are now explicitly listed in the white-pages package, including the bundled ones.
+
+You can find bundled dependencies list:
+
+* in package description in debian package
+* in Provides field in rpm package
+
+
+configuration
+~~~~~~~~~~~~~
+
+The configuration files are now in ``/etc/white-pages`` directory.
+
+During the upgrade process towards 0.5, the previous configuration files present in ``/usr/share/white-pages/conf`` (all .php files) are migrated to ``/etc/white-pages/``:
+
+* ``config.inc.php`` is migrated as a ``config.inc.php.bak`` file,
+* all other php file names are preserved. (including local conf, domain conf, and customized lang files)
+
+Please take in consideration that ``config.inc.php`` is now replaced systematically by the version in the RPM package. A .rpmsave backup will be done with the current version. The deb package will continue asking which file to use, it is advised to replace the current one with the version in the package.
+
+Avoid as much as possible editing the ``/etc/white-pages/config.inc.php`` file. Prefer modifying the ``/etc/white-pages/config.inc.local.php``.
+
+cache cleaning
+~~~~~~~~~~~~~~
+
+Now the cache is being cleaned-up during white-pages upgrade / install.
+
+This is intended to avoid smarty problems due to white-pages templates upgrade, and possibly smarty upgrade itself.
+
+
+dependencies update
+~~~~~~~~~~~~~~~~~~~
+
+Removed packaged dependencies:
+
+* old php module for apache2/httpd is no more required. The migration is done towards php-fpm.
+* apache2/httpd is not required any more. You can installed nginx or httpd by hand.
+
+Packaged dependencies:
+
+* smarty is now a required package. white-pages will work with either version 3 or 4. On debian, ``config.inc.php`` will be configured to use smarty4 if available
+* php-fpm >= 7.3 is now a required dependency, replacing old php module for apache/httpd. On debian, if apache2 is already installed, php-fpm configuration for apache2 will be done automatically
+* php-ldap has been kept as dependency
+
+Bundled dependencies:
+
+* js-bootstrap has been updated from version 3.2.0 to version v5.3.6
+* js-jquery has been updated from version v1.10.2 to version v3.7.1
+* js-datatables.net-datatables.net has been updated from version 1.10.16 to version 2.1.2
+* js-datatables.net-datatables.net-bs5 has been updated from version 1.10.16 to version 2.0.8
+* js-datatables.net-datatables.net-buttons has been updated from version 1.5.1 to version 3.1.0
+* js-datatables.net-datatables.net-buttons-bs5 has been updated from version 1.5.1 to version 3.0.2
+* fontawesome-fonts has been updated from version 4.7.0 to version 6.5.2
+* php-ltb-project-ltb-common has been updated from version 0.1 to version 0.5.0
+* php-phpmailer has been updated from version 6.8.0 to version v6.9.1
+
+Note that hidden files (.gitignore,...) from bundled dependencies are now removed from packages.
+
+
+From 0.3 to 0.4
+---------------
+
+* Parameter `$ldap_user_regex` is now disbaled by default, means that the object type detection is done with configured LDAP filters.
+
+* The new map feature is disabled by default, as it requires to request OpenStreetMap API. Check the documentation before enabling it.
+
+From 0.2 to 0.3
+---------------
+
+There is a new parameter: `$ldap_user_regex`.
+
+If the default value does not fit your LDAP directory configuration, you must unset the default value, or adapt it. To unset it, put in your config.inc.local.php:
+
+```unset($ldap_user_regex);```
+
+See also the ldap parameters page.
diff --git a/packaging/debian/changelog b/packaging/debian/changelog
@@ -1,3 +1,9 @@
+ltb-project-white-pages (0.5-1) unstable; urgency=low
+
+    * gh#205: debian cleanup
+
+ -- Clement Oudot <clem@ltb-project.org>  Fri, 23 Jan 2026 12:00:00 +0200
+
 ltb-project-white-pages (0.4-2) unstable; urgency=low
 
     * gh#126: Missing bin/ directory in packages
diff --git a/packaging/debian/conffiles b/packaging/debian/conffiles
diff --git a/packaging/debian/copyright b/packaging/debian/copyright
@@ -4,22 +4,25 @@ Maintainer: Clement Oudot <clem@ltb-project.org>
 Source: http://ltb-project.org/wiki/documentation/white-pages
 
 Files: htdocs/vendor/bootstrap
-Copyright: 2011-2014 Twitter, Inc.
+Copyright: Copyright (c) 2011-2024 The Bootstrap Authors
 
 Files: htdocs/vendor/bootstrap-datepicker
 Copyright: 2012 Stefan Petre
 
 Files: htdocs/vendor/font-awesome
-Copyright: @davegandy - http://fontawesome.io - @fontawesome
+Copyright: Font Awesome by Dave Gandy - http://fontawesome.io
 
 Files: htdocs/vendor/hover
 Copyright: 2014 Ian Lunn
 
 Files: htdocs/vendor/jquery
-Copyright: 2005, 2013 jQuery Foundation, Inc.
+Copyright: Copyright OpenJS Foundation and other contributors, https://openjsf.org/
+
+Files: htdocs/vendor/datatables
+Copyright: Copyright (C) 2008-2024, SpryMedia Ltd.
 
 Files: *
-Copyright: 2009-2025 LTB-Project, Worteks, Clement Oudot, David Coutadeur
+Copyright: 2009-2026 LTB-Project, Worteks, Clement Oudot, David Coutadeur
 
 License: GPL
     This program is free software; you can redistribute it and/or modify
diff --git a/tests/LangTest.php b/tests/LangTest.php
@@ -10,7 +10,7 @@ public function testTranslations()
 
         # Available languages
         $languages = array();
-        if ($handle = opendir('lang')) {
+        if ($handle = opendir(__DIR__ . '/../lang')) {
             while (false !== ($entry = readdir($handle))) {
                 if ($entry != "." && $entry != "..") {
                     array_push($languages, str_replace(".inc.php", "", $entry));
@@ -19,13 +19,14 @@ public function testTranslations()
             closedir($handle);
 	}
 
-        require("lang/en.inc.php");
+        require(__DIR__ . "/../conf/config.inc.php");
+        require(__DIR__ . "/../lang/en.inc.php");
         $reference = $messages;
         $error = '';
 
         foreach ($languages as $lang) {
             $messages = array();
-            require("lang/$lang.inc.php");
+            require(__DIR__ . "/../lang/$lang.inc.php");
 
             $missing = array_diff(array_keys($reference), array_keys($messages));
             if (!empty($missing)) {

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+*`
	`2`	`+!.gitignore`
	`3`	`+!config.inc.php`