Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision		 Previous revision
install_22_4 [2024/02/08 16:17] – [Modify Nginx] systeminstall_22_4 [2026/08/16 10:26] (current) – system
Line 1: Line 1:
 +<nav type="pills" justified="false">
 +  * [[:user_manuals|Back to Documentation]]
 +  * [[:install_22_4|Install on Ubuntu 22.04]]
 +</nav>
 +
 +----
 +
 ====== Installation of RADIUSdesk on Ubuntu 22.04 with Nginx ====== ====== Installation of RADIUSdesk on Ubuntu 22.04 with Nginx ======
 ===== Skills required for the installation ===== ===== Skills required for the installation =====
Line 11: Line 18:
  
   * Nginx is a web server that seems to have overtaken Apache in terms of popularity and number of active websites on the Internet.   * Nginx is a web server that seems to have overtaken Apache in terms of popularity and number of active websites on the Internet.
-  *  It is new, lightweight, fast, highly scalable and capable of handling a large load without overloading your system.+  * It is new, lightweight, fast, highly scalable and capable of handling a large load without overloading your system.
   * Nginx is the new Apache so to speak.   * Nginx is the new Apache so to speak.
   * This section describes the steps you need to take to get RADIUSdesk up and running with a LEMP stack on Ubuntu 22.04   * This section describes the steps you need to take to get RADIUSdesk up and running with a LEMP stack on Ubuntu 22.04
Line 17: Line 24:
  
 <alert type="info"> <alert type="info">
-  * We recently switched from CakePHPv3 to CakePHPv4. +  * We **(not so recently)** switched from CakePHPv3 to CakePHPv4. 
-  *  If you manage devices with MESHdesk and APdesk, make sure you also run the instructions that include cake3 so that your system is backwards compatible.+  * If you manage devices with MESHdesk and APdesk, make sure you also run the instructions that include cake3 so that your system is backwards compatible.
   * The firmware on these devices may still point to the cake3 directory, so we need to include support for this directory.   * The firmware on these devices may still point to the cake3 directory, so we need to include support for this directory.
 </alert> </alert>
Line 26: Line 33:
 ===== What we need ===== ===== What we need =====
  
-  *A standard Nginx installation on Ubuntu is actually very simple. +  * A standard Nginx installation on Ubuntu is actually very simple. 
-  *  The more complicated part is customizing Nginx for the following tasks:+  * The more complicated part is customizing Nginx for the following tasks:
  
 <panel type="default" no-body="true"> <panel type="default" no-body="true">
Line 157: Line 164:
 === php-fpm === === php-fpm ===
   * The default installation of Nginx does not support serving .php files.   * The default installation of Nginx does not support serving .php files.
-  * We will install a program (actually a service) called **php-fpm**. +  * We will install a program (actually a service) called **php-fpm**.
   * This service waits for requests for interpretation.   * This service waits for requests for interpretation.
-  * Install the php-fpm service by installing the default version 8.1 of the packages +  * Since Ubuntu 22.04 is quite dated by now, we can not use the standard version of PHP (8.1) that comes with Ubuntu. 
 +  * RADIUSdesk's CakePHP app is now using CakePHPv5 which requires a minimum of PHP 8.2. 
 +  * We will add an external, well maintained, repository from which we will install PHP 8.3. 
 +  * PHP 8.3 is the default version on Ubuntu 24.04, so it keeps things predictable and according to a convention.
 <code bash> <code bash>
-sudo apt-get -y install php-fpm +sudo apt update && sudo apt upgrade -y 
-sudo systemctl enable php8.1-fpm +sudo apt install software-properties-common -y 
-sudo systemctl start php8.1-fpm+sudo add-apt-repository ppa:ondrej/php -y 
 +sudo apt install php8.3 -y 
 +sudo apt install php8.3-fpm 
 +sudo systemctl enable php8.3-fpm 
 +sudo systemctl start php8.3-fpm
 </code> </code>
  
Line 177: Line 191:
 index index.php index.html index.htm index.nginx-debian.html; index index.php index.html index.htm index.nginx-debian.html;
 </code> </code>
-  * Enable PHP processing by leaving this section uncommented. Note that we are using the UNIX socket and that we are using 8.1 and not 7.4, which was originally specified in the configuration file.+  * Enable PHP processing by leaving this section uncommented. Note that we are using the UNIX socket and that we are using 8.3 and not 7.4, which was originally specified in the configuration file.
 <code bash> <code bash>
 # Pass PHP scripts to FastCGI server # Pass PHP scripts to FastCGI server
Line 185: Line 199:
     #     #
     #       # With php-fpm (or other unix sockets):     #       # With php-fpm (or other unix sockets):
-    fastcgi_pass unix:/var/run/php/php8.1-fpm.sock;+    fastcgi_pass unix:/var/run/php/php8.3-fpm.sock;
     #       # With php-cgi (or other tcp sockets):     #       # With php-cgi (or other tcp sockets):
     #       fastcgi_pass 127.0.0.1:9000;     #       fastcgi_pass 127.0.0.1:9000;
Line 218: Line 232:
 ==== Install MariaDB ==== ==== Install MariaDB ====
 === Why MariaDB? === === Why MariaDB? ===
-  * We have found that the version of MySQL that is delivered by default with Ubuntu 22.04 causes problems with RADIUSdesk.+  * We have found that the version of MySQL that is comes by default with Ubuntu 22.04 causes problems with RADIUSdesk.
   * For this reason, we have installed MariaDB as an alternative.   * For this reason, we have installed MariaDB as an alternative.
   * MariaDB is an open-source relational database management system that is often used as an alternative to MySQL as the database part of the popular LAMP stack (Linux, Apache, MySQL, PHP/Python/Perl).   * MariaDB is an open-source relational database management system that is often used as an alternative to MySQL as the database part of the popular LAMP stack (Linux, Apache, MySQL, PHP/Python/Perl).
-  * It is intended as a drop-in replacement for MySQL. +  * It is intended as an immediate replacement for MySQL. 
-  * Make sure to provide a root password for the MariaDB database when asked for it if you are security conscious, otherwise just press the ESC key.+  * Be sure to provide a root password for the MariaDB database when prompted if you are security conscious, otherwise just hit the ESC key. 
 <code bash> <code bash>
-sudo apt-get -y install mariadb-server php8.1-mysql+sudo apt-get -y install mariadb-server php8.3-mysql
 sudo systemctl enable mariadb sudo systemctl enable mariadb
 sudo systemctl restart mariadb sudo systemctl restart mariadb
Line 230: Line 245:
 </code> </code>
  
-=== Disable strict mode === +=== Deactivate strict mode === 
-  * With Ubuntu 22.04, the bundled version of MariaDB is on version 10.3, which has introduced some strict modes that have some issues with the RADIUSdesk database implementation.+  * On Ubuntu 22.04, the bundled version of MariaDB is on version 10.3, which has introduced some strict modes that have some issues with the RADIUSdesk database implementation.
   * We will disable the strict SQL mode in MariaDB by creating a new file /etc/mysql/conf.d/disable_strict_mode.cnf   * We will disable the strict SQL mode in MariaDB by creating a new file /etc/mysql/conf.d/disable_strict_mode.cnf
 <code bash> <code bash>
Line 241: Line 256:
 sql_mode=IGNORE_SPACE,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION sql_mode=IGNORE_SPACE,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION
 </code> </code>
-  * Save the file and restart the MySQL Server+=== Enable the Event Scheduler === 
 +  * MariaDB and MySQL has a built in Event Scheduler (like CRON for a database) which is disabled by default. 
 +  * We make use of this feature to automatically optimize some of the database tables. 
 +  * We will enable the Event Scheduler in MariaDB by creating a new file /etc/mysql/conf.d/enable_event_scheduler.cnf 
 +<code bash> 
 +sudo vi /etc/mysql/conf.d/enable_event_scheduler.cnf 
 +</code> 
 +  * Enter these two lines: 
 +<code bash> 
 +[mysqld] 
 +event_scheduler=on 
 +</code> 
 +  * Save the file. 
 +  *  Restart the MySQL server
 <code bash> <code bash>
 sudo systemctl restart mariadb sudo systemctl restart mariadb
 +</code>
 +  * You can confirm that it is now enabled by checking the following from the SQL terminal:
 +<code bash>
 +sudo mysql -u root 
 +MariaDB [(none)]> SHOW GLOBAL VARIABLES LIKE 'event_scheduler';
 ++-----------------+-------+
 +| Variable_name   | Value |
 ++-----------------+-------+
 +| event_scheduler | ON    |
 ++-----------------+-------+
 +1 row in set (0.001 sec)
 </code> </code>
  
 ----- -----
-==== Performance tune Nginx ==== +==== Performance tuning for Nginx ==== 
-=== Modify expiry date for certain files === +=== Change the expiry date for certain files === 
-  * Edit the ///etc/nginx/sites-available/default// file:+  * Edit the file ///etc/nginx/sites-available/default// file:
 <code bash> <code bash>
 sudo vi /etc/nginx/sites-available/default sudo vi /etc/nginx/sites-available/default
 </code> </code>
-  * Add the following inside the server section:+  * Add the following within the server section:
 <code bash> <code bash>
 location ~ ^/cake4/.+\.(jpg|jpeg|gif|png|ico|js|css)$ { location ~ ^/cake4/.+\.(jpg|jpeg|gif|png|ico|js|css)$ {
Line 263: Line 302:
 } }
 </code> </code>
-  * Add below only if you require backward compatibility (MESHdesk and APdesk).+  * Only add the following information if you require backward compatibility (MESHdesk and APdesk).
 <code bash> <code bash>
 location ~ ^/cake3/.+\.(jpg|jpeg|gif|png|ico|js|css)$ { location ~ ^/cake3/.+\.(jpg|jpeg|gif|png|ico|js|css)$ {
Line 284: Line 323:
   * RADIUSdesk consists of three components.   * RADIUSdesk consists of three components.
     * **rd** directory with its contents contains all the HTML and JavaScript code and is used as the presentation layer.     * **rd** directory with its contents contains all the HTML and JavaScript code and is used as the presentation layer.
-    * **cake4** is a CakePHPv4 application and can be considered the engine room. Here the data is processed before being presented by the presentation layer. +    * **cake4** is a CakePHPv5 (used to be CakePHPv4) application and can be considered the engine room. This is where the data is processed before it is displayed by the presentation layer. 
-    * **login** is a directory with various login pages which are centrally managed through the RADIUSdesk **Dynamic Login Pages** applet. +    * **login** is a directory with various login pages that are managed centrally via the **RADIUSdesk Dynamic Login Pages** applet. 
-  * Later we will create various symbolic links from locations inside the **rdcore** directory to locations inside the web server's document root directory.+  * Later we will create various symbolic links from locations within the **rdcore** directory to locations within the document root directory of the web server.
  
 === Required packages === === Required packages ===
-  * Make sure the following packages are installed.+  * Make sure that the following packages are installed.
 <code bash> <code bash>
-sudo apt-get -y install php-cli php-mysql php-gd php-curl php-xml php-mbstring php-intl php-sqlite3 git wget +sudo apt-get -y install php8.3-cli php8.3-mysql php8.3-gd php8.3-curl php8.3-xml php8.3-mbstring php8.3-intl php8.3-sqlite3 git wget 
-sudo systemctl restart php8.1-fpm+sudo systemctl restart php8.3-fpm
 </code> </code>
-  *  Check out the **rdcore** git repository.+  * Check out the **rdcore** git repository.
 <code bash> <code bash>
 cd /var/www cd /var/www
 sudo git clone https://github.com/RADIUSdesk/rdcore.git sudo git clone https://github.com/RADIUSdesk/rdcore.git
 </code> </code>
-  *  This will create an **rdcore** directory that contains some subfolders.+  * This will create an **rdcore** directory containing some subfolders. 
 +  * Check out the CakePHPv5 API back-end application 
 +<code bash> 
 +cd /var/www  
 +sudo git clone https://github.com/RADIUSdesk/rd_cake5.git 
 +</code>
   * It is recommended that you also include the RD Mobile UI.   * It is recommended that you also include the RD Mobile UI.
   * Check out the **rd_mobile** git repository.   * Check out the **rd_mobile** git repository.
Line 307: Line 351:
 </code> </code>
  
-=== Create softlinks ===+=== Create soft links ===
   * We will create softlinks in the directory where Nginx provides the RADIUSdesk content.   * We will create softlinks in the directory where Nginx provides the RADIUSdesk content.
 <code bash> <code bash>
 cd /var/www/html cd /var/www/html
 sudo ln -s ../rdcore/rd ./rd sudo ln -s ../rdcore/rd ./rd
-sudo ln -s ../rdcore/cake4 ./cake4+sudo ln -s ../rd_cake5 ./cake4
 #If backward compatibility is required for older firmware of MESHdesk #If backward compatibility is required for older firmware of MESHdesk
-sudo ln -s ../rdcore/cake4 ./cake3+sudo ln -s ../rd_cake5 ./cake3
 sudo ln -s ../rdcore/login ./login sudo ln -s ../rdcore/login ./login
 sudo ln -s ../rdcore/AmpConf/build/production/AmpConf ./conf_dev sudo ln -s ../rdcore/AmpConf/build/production/AmpConf ./conf_dev
-sudo ln -s ../rdcore/cake4/rd_cake/setup/scripts/reporting ./reporting+sudo ln -s ../rd_cake5/rd_cake/setup/scripts/reporting ./reporting
 #For the RD Mobile UI #For the RD Mobile UI
 sudo ln -s ../rd_mobile/build/production/RdMobile ./rd_mobile sudo ln -s ../rd_mobile/build/production/RdMobile ./rd_mobile
Line 323: Line 367:
  
 === Change ownership === === Change ownership ===
-  * Change the ownership of the following files to www-data so Nginx can make changes to the files/directories+  * Change the ownership of the following files to www-data so that Nginx can make changes to the files/directories
 <code bash> <code bash>
 sudo mkdir -p  /var/www/html/cake4/rd_cake/logs sudo mkdir -p  /var/www/html/cake4/rd_cake/logs
Line 338: Line 382:
 </code> </code>
  
-=== The Database ===+=== The database ===
   * Make sure that the time zone on the server is set to UTC   * Make sure that the time zone on the server is set to UTC
   * Fill the time zone data in the DB   * Fill the time zone data in the DB
 <code bash> <code bash>
-#NOTE FAILING THIS STEP will break the RADIUS graphs +#NOTE FAILING TO DO THIS STEP will break the RADIUS graphs 
-#There might be some error messages in the output which is fine - no need to be alarmed+#Some error messages may appear in the output, which is not a problem - no need to worry
 sudo su sudo su
 mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root  mysql mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root  mysql
Line 364: Line 408:
 <alert type="warning"> <alert type="warning">
   * RADIUSdesk is under active development and sometimes we add SQL patches.   * RADIUSdesk is under active development and sometimes we add SQL patches.
-  * The SQL patches are located at **/var/www/html/cake4/rd_cake/setup/db/**.+  * The SQL patches are located under **/var/www/html/cake4/rd_cake/setup/db/**.
   * These patches are non-destructive and you can run them against the database   * These patches are non-destructive and you can run them against the database
-  * See the sample below+  * See the example below
 <code bash> <code bash>
-sudo mysql -u root rd < /var/www/rdcore/cake4/rd_cake/setup/db/8.068_add_email_sms_histories.sql +sudo mysql -u root rd < /var/www/html/cake4/rd_cake/setup/db/8.068_add_email_sms_histories.sql  
 +</code> 
 +  * Some of these patches may add new columns to existing database tables. In this case, it is recommended to clear the CakePHP models (tables) cache to ensure that the latest changes are also applied there: 
 +<code bash> 
 +sudo su 
 +cd /var/www/rdcore/html/rd_cake/tmp/cache/models 
 +rm * 
 +exit
 </code> </code>
 </alert> </alert>
- 
  
 === Configure Nginx === === Configure Nginx ===
  
-  * Configure Nginx to rewrite some RdCore URLs starting with ///cake4/rd_cake//.+  * Configure Nginx to rewrite some RdCore URLs that start with ///cake4/rd_cake//.
   * Edit ///etc/nginx/sites-enabled/default//   * Edit ///etc/nginx/sites-enabled/default//
 <code bash> <code bash>
 sudo vi /etc/nginx/sites-enabled/default sudo vi /etc/nginx/sites-enabled/default
 </code> </code>
-  * Add this once section directly below **server_name** item. (This is so that this rule is **hit** first for the reporting side. We do not use CakePHP for the reporting anymore due to performance issues.+  * Insert this section directly under the **server_name** entry. (This is so that this rule is **hit** first for the reporting side. Due to performance issues, we no longer use CakePHP for reporting.
 <code bash> <code bash>
 server_name _; server_name _;
Line 387: Line 437:
 } }
 </code> </code>
-  * If you need backward compatibility support (MESHdesk and APdesk) also add this section:+  * If you need support for backward compatibility (MESHdesk and APdesk), add this section as well:
 <code bash> <code bash>
 location /cake3/rd_cake/node-reports/submit_report.json { location /cake3/rd_cake/node-reports/submit_report.json {
Line 393: Line 443:
 } }
 </code> </code>
-  * Add the following configuration block inside the server section (This you can add towards the end):+  * Insert the following configuration block into the server section (you can add this towards the end):
 <code bash> <code bash>
 location /cake4/rd_cake { location /cake4/rd_cake {
Line 400: Line 450:
 } }
 </code> </code>
-  * If you need backward compatibility support (MESHdesk and APdesk) also add this section:+  *  If you need support for backward compatibility (MESHdesk and APdesk), add this section as well:
 <code bash> <code bash>
 location /cake3/rd_cake { location /cake3/rd_cake {
Line 413: Line 463:
  
 === Important URLs ===   === Important URLs ===  
-  * The following URLs are important to reach the UI +  * The following URLs are important to reach the user interface 
-  * To load the optimized UI, go to http://127.0.0.1/rd/build/production/Rd/ +  * To load the optimized user interface, go to http://127.0.0.1/rd/build/production/Rd/ 
-  * If you want to serve the content directly out of the webroot, do the following:+  * If you want to deliver the content directly from the webroot, proceed as follows:
 <code bash> <code bash>
 sudo cp -R /var/www/html/rd/build/production/Rd/* /var/www/html/ sudo cp -R /var/www/html/rd/build/production/Rd/* /var/www/html/
Line 421: Line 471:
   * To load the RD Mobile UI, go to http://127.0.0.1/rd_mobile   * To load the RD Mobile UI, go to http://127.0.0.1/rd_mobile
  
-== Login Credentials == +== Login credentials == 
   * By default you can log in with the following credentials   * By default you can log in with the following credentials
 Username: **root** Password: **admin** Username: **root** Password: **admin**
Line 431: Line 481:
   * To activate the cron scripts, execute the following command, which adds the **RADIUSdesk** cron scripts to the cron system   * To activate the cron scripts, execute the following command, which adds the **RADIUSdesk** cron scripts to the cron system
 <code bash> <code bash>
-sudo cp /var/www/html/cake4/rd_cake/setup/cron/cron4 /etc/cron.d/+sudo cp /var/www/html/cake4/rd_cake/setup/cron/rd_cake5 /etc/cron.d/
 </code> </code>
   * If you want to change the default intervals at which the scripts are executed, simply edit the file /etc/cron.d/cron3.   * If you want to change the default intervals at which the scripts are executed, simply edit the file /etc/cron.d/cron3.
  
 ===== Add LETSENCRYPT certificate ===== ===== Add LETSENCRYPT certificate =====
-  * Instead of repeating the existing documentation, we simply add a URL with the appropriate instructions. +  * Instead of repeating the existing documentation, we simply add a URL with the corresponding instructions 
-  * You may want to do the following first before following the instructions in the URL +  * Before you follow the instructions in the URL, you should first do the following
 <code bash> <code bash>
 sudo apt-get update sudo apt-get update
Line 445: Line 494:
   * https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-22-04   * https://www.digitalocean.com/community/tutorials/how-to-secure-nginx-with-let-s-encrypt-on-ubuntu-22-04
 ===== Next steps ===== ===== Next steps =====
-  * Be sure to also install **FreeRADIUS**+  * Make sure that you also install **FreeRADIUS**.
   * [[install_22_4_freeradius|Install FreeRADIUS]]   * [[install_22_4_freeradius|Install FreeRADIUS]]
  • install_22_4.1707401861.txt.gz
  • Last modified: 2024/02/08 16:17
  • by system