Update doc for Nginx (#163)

* Update doc for Nginx * Remove dependencies * Update docs/installation.rst Co-authored-by: Clément "KPTN" OUDOT <[email protected]> * Update docs/configuration-nginx.rst Co-authored-by: Clément "KPTN" OUDOT <[email protected]> * Update docs/installation.rst Co-authored-by: Clément "KPTN" OUDOT <[email protected]> * Update docs/configuration-nginx.rst Co-authored-by: Clément "KPTN" OUDOT <[email protected]> --------- Co-authored-by: Clément "KPTN" OUDOT <[email protected]>
ltb-project · Aug 21, 2024 · 342ee73 · 342ee73
1 parent 6fbbacb
commit 342ee73
Show file tree

Hide file tree

Showing 5 changed files with 80 additions and 15 deletions.
diff --git a/docs/audit.rst b/docs/audit.rst
@@ -40,33 +40,36 @@ Set the file where actions are logged:
 
 .. tip:: The file must be writable by the PHP or WebServer process
 
+
 Admin name
 ----------
 
 The admin name must be set into an HTTP header.
 
+Using Apache, we could use instead:
+
 .. code-block:: php
 
-   $header_name_audit_admin = "Auth-User";
+  $header_name_audit_admin = "Auth-User";
 
 Using Nginx, we could use instead:
 
 .. code-block:: php
 
-    $header_name_audit_admin = "AUTH_USER";
+  $header_name_audit_admin = "AUTH_USER";
 
 In nginx.conf:
 
 .. code-block:: nginx
-  
-   server {
-       [...]
-       location ~ \.php {
-           fastcgi_param HTTP_AUTH_USER $http_auth_user;
-           [...]
-       }
-       [...]
-   }
+
+  server {
+          [...]
+          location ~ \.php$ {
+                  fastcgi_param HTTP_AUTH_USER $http_auth_user;
+                  [...]
+          }
+          [...]
+  }
 
 .. warning:: Using Nginx, headers with underscores in their names are discarded by default. In order for these headers to be considered valid, we need to add ``underscores_in_headers on`` to ``nginx.conf``.
 

diff --git a/docs/config_mail.rst → docs/configuration-mail.rst b/docs/config_mail.rst → docs/configuration-mail.rst
diff --git a/docs/configuration-nginx.rst b/docs/configuration-nginx.rst
@@ -0,0 +1,60 @@
+.. _nginx_configuration:
+
+Nginx configuration
+====================
+
+Apache or Nginx is not installed by default. You must choose one.
+
+Current section explains how to install and configure Nginx.
+
+Install and configure Nginx
+----------------------------
+
+On Debian:
+
+.. code-block:: shell
+
+  apt install nginx php-fpm
+
+  # configure php-fpm for Nginx
+  a2enmod proxy_fcgi setenvif
+  a2enconf php*-fpm.conf
+
+  # enable the default website
+  cd /etc/nginx/sites-enabled/ && ln -s ../sites-availables/service-desk
+
+On RHEL systems:
+
+.. code-block:: shell
+
+  dnf install nginx php-fpm
+
+Virtual host configuration
+------------
+
+Here is a sample block server configuration:
+
+.. code-block:: nginx
+
+  server {
+          listen 80;
+          server_name sd.example.com;
+          root /usr/share/service-desk/htdocs;
+  
+          index index.php;
+  
+          location ~ \.php$ {
+                  try_files $uri $uri/ =404;
+                  fastcgi_pass unix:/run/php/php-fpm.sock;
+                  include /etc/nginx/fastcgi_params;
+                  fastcgi_param SCRIPT_FILENAME   $request_filename;
+          }
+  } 
+
+.. warning:: You must protect the access to the application, else everyone will be able to reset any user password!
+
+External authentication
+-----------------------
+
+You can use any authentication source and authentication protocols supported by Nginx.
+Configuring these solutions is out of scope of the current documentation.
diff --git a/docs/index.rst b/docs/index.rst
@@ -16,6 +16,7 @@ LDAP Tool Box Service Desk documentation
    installation.rst
    upgrade.rst
    configuration-apache.rst
+   configuration-nginx.rst
    general-parameters.rst
    ldap-parameters.rst
    attributes.rst
@@ -26,5 +27,5 @@ LDAP Tool Box Service Desk documentation
    lockaccount.rst
    hook.rst
    dashboards.rst
-   config_mail.rst
+   configuration-mail.rst
    audit.rst
diff --git a/docs/installation.rst b/docs/installation.rst
@@ -41,7 +41,6 @@ Configure the repository:
 
 .. code-block:: ini
 
-
     deb [arch=amd64 signed-by=/usr/share/keyrings/ltb-project-openldap-archive-keyring.gpg] https://ltb-project.org/debian/stable stable main
 
 Then update:
@@ -56,7 +55,8 @@ You are now ready to install:
 
     apt install service-desk
 
-You should now proceed to :ref:`webserver installation and configuration <apache_configuration>`
+You should now proceed to :ref:`Apache installation and configuration <apache_configuration>`
+or to :ref:`Nginx installation and configuration <nginx_configuration>`
 
 CentOS / RedHat
 ---------------
@@ -97,7 +97,8 @@ You are now ready to install:
 
     dnf install service-desk
 
-You should now proceed to :ref:`webserver installation and configuration <apache_configuration>`
+You should now proceed to :ref:`Apache installation and configuration <apache_configuration>`
+or to :ref:`Nginx installation and configuration <nginx_configuration>`
 
 Docker
 ------