Difference between revisions of "Configuring a LAMPP server for PHP development/Linux desktop"

From Joomla! Documentation

< Configuring a LAMPP server for PHP development
(Corrected some URLs. Other formatting changes including Words2Watch compliance.)
 
(62 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{inuse}}
+
{{needs|technical review|Needs updating to latest PHP/MySQL Versions}}
{{RightTOC}}
 
  
== Introduction ==
+
This article provides detailed instructions for configuring a LAMP server, not only for Joomla! but it also should work fine for PHP development in general. For information on installing other stacks see [[Installing_Joomla_on_Debian_Linux]]
  
This article provides detailed instructions for configuring a LAMPP server, not only for Joomla! it also should work fine for PHP development in general.
+
These instructions should work fine on any Linux-based distribution such as Debian, Ubuntu, Linux Mint, Xubuntu, Kubuntu and others.
  
Theses instructions should work fine on any Debian based distribution such as Debian, Ubuntu, LinuxMint, Xubuntu, Kbuntu and others.
+
<span style="color:red;">'''NOTE''' To complement the security of your computer, install a firewall to block external incoming traffic to your Web service. You may also have to change some directives on your site configuration file to serve only requests to the localhost address.</span>
  
 
== Installation ==
 
== Installation ==
'''NOTE:''' You need a stable Internet connection for this tutorial
+
'''NOTE''' You need a stable internet connection for this tutorial. If you previously tried to install the LAMP stack and failed for any reason, visit [https://help.ubuntu.com/community/ApacheMySQLPHP#Starting_over:_How_to_remove_the_LAMP_stack How to remove the LAMP stack] and follow the instructions to delete any server configuration and start from scratch.
  
The installation of a LAMPP server on Linux is extremely easy, just follow this instructions:
+
The installation of a LAMP server on Linux is easy. Just follow these instructions:
  
 
*Open a terminal and type:
 
*Open a terminal and type:
  
  <tt>sudo apt-get install apache2 php5-mysql libapache2-mod-php5 mysql-server phpmyadmin libapache2-mod-suphp</tt>
+
  <pre>sudo apt-get install apache2 php5-mysql libapache2-mod-php5 mysql-server phpmyadmin php5-curl</pre>
  
*Say yes [Y] when the package manager ask you download and install the packages, this step will take some time depending on your connection speed
+
*Say yes [Y] when the package manager asks you download and install the packages. This step will take some time.
*At some point the installer will ask you for the MySQL root password use any password you like, but for this example we are going to use "myadmin"
+
*At some point the installer will ask you for the MySQL root password. Use any password you like. For this example we are going to use ''myadmin''.
*The installer will ask for "the web server that should be automatically configured to run phpmyadmin", press [spacebar] to choose "apache2" and press [enter], '''NOTE:''' make sure the selection is marked with and asterisk [*]  
+
*The installer will ask for ''the Web server that should be automatically configured to run PHPMyAdmin''.  Press the [spacebar] to choose ''apache2'' and press [enter]'''NOTE''' Make sure the selection is marked with an asterisk [*].
*The installer will ask for "Configure database for phpmyadmin with dbconfig-common", choose "<yes>" and press [enter]
+
*The installer will ask for ''Configure database for PHPMyAdmin with dbconfig-common''.  Choose ''<yes>'' and press [enter].
*The installer will ask for "password of the database's administrative user", use any password you like, but for this example we are going to use "myadmin"
+
*The installer will ask for ''password of the database's administrative user''. Use any password you like, but for this example we are going to use ''myadmin''.
*The installer will ask for "mysql application password for phpmyadmin", use any password you like, but for this example we are going to use "myadmin"
+
*The installer will ask for ''MySQL application password for PHPMyAdmin''. Use any password you like, but for this example we are going to use admin''.
*If no errors have being displayed then the installation is finish
+
*If no errors have being displayed, the installation is finished.
  
=== 1st test for Apache ===
+
=== Apache Installation Test ===
 
+
*Open your Web browser and type in the address bar ''localhost'' and press [enter].
*Open your web browser and type in the address bar "localhost" and press [enter]
+
*Normally Apache display a test page with some text such as:
*Normally Apache display a test page with some text like this:
 
  
 
  It works!
 
  It works!
  This is the default web page for this server.
+
  This is the default Web page for this server.
  The web server software is running but no content has been added, yet.
+
  The Web server software is running but no content has been added yet.
  
=== 1st test for PHP server ===
+
=== PHP Installation Test ===
 +
To verify that the PHP server is working, create a quick test file using the command line.
  
To test if PHP server is working lets create a quick test file using the command line
+
*Open a terminal and type:
  
*Open a terminal and type
+
<pre>echo "<?php phpinfo(); ?>" | sudo tee /var/www/html/test.php </pre>
  
<tt>echo "<?php phpinfo(); ?>" | sudo tee /var/www/test.php </tt>
+
*Open your Web browser and type in the address bar ''localhost/test.php'' and press [enter].
 +
*The next thing you should see in your browser is a long page displaying information about the PHP server. If not, the installation was not successful.
 +
*Once the PHP server is working fine, we don't need that test file anymore. Type the following command in your terminal to delete the file:
  
*Open your web browser and type in the address bar "localhost/test.php" and press [enter]
+
<pre>sudo rm /var/www/html/test.php</pre>
*The next thing you should see in your browser is a really long page displaying information about the PHP server, if not then something went wrong
 
*Now that we know the PHP server is working fine we don't need that test file anymore, type the following command in your terminal to delete the file
 
  
<tt>sudo rm /var/www/test.php</tt>
+
=== PHPMyAdmin Installation Test ===
 +
*Open your Web browser and type in the address bar ''localhost/phpmyadmin'' and press [enter].
 +
*The next thing you should see is the PHPMyAdmin login page. If not, then most likely you skipped or did not mark the option ''apache2'' at the question ''Web server that should be automatically configured to run PHPMyAdmin''. To fix this problem, purge the installation and start over again.
 +
*Login to PHPMyAdmin with the following credentials:
 +
**username = root
 +
**password = myadmin
 +
*You should be able to login normally and have no error messages.
  
=== 1st test for phpMyAdmin ===
+
== Understanding the Folder Structure ==
 +
There are several folders and files that the LAMP server uses to store the configurations of the LAMP services and to store the files of your hosted Websites.
  
*Open your web browser and type in the address bar "localhost/phpmyadmin" and press [enter]
+
=== Apache Default Web Site Folder ===
*The next thing you should see is the phpMyadmin login page, if not then something went wrong, most likely you skip or not marked the option "apache2" at the question "web server that should be automatically configured to run phpmyadmin", to fix this problem just purge the installation and start over again the installation steps
+
Location: ''/var/www/''
*Login to phpmyadmin with the following credentials
 
**username = root
 
**password = myadmin
 
*You should be able to login normally and have no error messages at all
 
  
== Understanding the folder structure ==
+
Description: By default the Apache server enables a test website and stores the website files in that location. Every time you visit the page '''<nowiki>http://localhost</nowiki>''', the browser displays the page located at ''/var/www/''.
  
There are several folders and files that the LAMP server uses to store the configurations of the LAMP services and to store the files of your hosted websites
+
With your file browser, navigate to ''/var/www/''. There should be a file called ''index.html''. Change the content of the file to whatever you want and refresh the Web page to see the changes.
  
=== Apache default web site folder ===  
+
=== Apache Web Sites Configuration Files ===  
 +
Location: ''/etc/apache2/sites-available/''
  
Location: "/var/www/"
+
Description: You can host multiple sites on the same server. This folder contains a configuration file for each site.
  
Description: by default the Apache server enables a test website and store the website files in that location, so every time you visit the page local host, the browser display the html page located there..
+
=== Apache Configuration Files ===
 +
Location: ''/etc/apache2/apache2.conf''
 +
Location: ''/etc/apache2/envvars''
  
With your file browser navigate to "/var/www/" there should be a file called "index.html", change the content of the file for whatever you want and refresh the web page to see the changes.  
+
Description: These files contain important information about the Apache service.
  
=== Apache web sites configuration files ===  
+
=== Apache Ports Configuration File ===  
 +
Location: ''/etc/apache2/ports.conf''
  
Location: "/etc/apache2/sites-available/"
+
Description: This file configures which port the Apache server will listen to for HTTP requests. By default, HTTP requests are assigned to port 80 but you can modify or add more ports.
  
Description: You can host multiples sites in the same server, this folder a configuration file for each site.
+
=== Apache Log Files ===
 +
Location: ''/var/log/apache2/''
  
=== Apache configuration file ===
+
Description: This folder contains several files to keep track of events on your Apache Web server such as errors in the services, errors in the code of your site and failed authentication attempts. This is a good place to look when something is not working or you suspect someone is trying to breach your server security.
  
Location: "/etc/apache2/apache2.conf"
+
== Configuration ==
Location: "/etc/apache2/envvars"
+
=== Enabling mod_rewrite ===
 +
The mod_rewrite module uses a rule-based rewriting engine based on a PCRE regular expression parser to rewrite requested URLs on the fly. By default, mod_rewrite maps a URL to a filesystem path. However, it can also be used to redirect one URL to another URL, or to invoke an internal proxy fetch.
  
Description: This files contains very important information about the Apache service.
+
For more information, visit the [https://httpd.apache.org/docs/current/mod/mod_rewrite.html Apache mod_rewrite page].
  
=== Apache ports configuration file ===
+
* Open a terminal and type:
  
Location: "/etc/apache2/ports.conf"
+
<pre>sudo a2enmod rewrite</pre>
  
Description: This files configure what port will Apache server listen to for http requests, by default http request are assigned to the port 80 but you can modify or add more ports.
+
* Now that the rewrite module is enabled, restart Apache.
  
=== Apache log files ===
+
<pre>sudo service apache2 restart</pre>
  
Location: "/var/log/apache2/"
+
* done
  
Description: That folder contain several files to keep track of several events on your Apache web server, such as errors in the services, errors in code of your site, failed authentication attempts and more, this is a good place to look at when something is not working file or you suspect some is trying to breach your server security
+
=== Deploying a New Site Folder Structure ===
 +
By default the Web server is hosting the files in the location ''/var/www'', but for security reasons and to avoid ownership problems, we are going to use another place to host our website files.
  
== Configuration ==
+
Let's create a new folder to store the web files and the log files of the site.
  
=== Deploying a new site location ===
+
Open a terminal and type:
 +
<pre>
 +
mkdir /home/youruser/lamp/
 +
mkdir /home/youruser/lamp/public_html/
 +
mkdir /home/youruser/lamp/logs/
 +
</pre>
  
By default the web server is hosting the files in the location "/var/www" but for security reason and for the sake of avoid ownership problems we are going to use another place to host our web site files
+
'''NOTE''' You can place your new site folders at any location. This is just an example. Replace ''youruser'' with an actual Linux username.
  
Lets create a new folder to store the web files and the log files of the server
+
To store the Website files we are going to use the folder ''public_html''. For our log files, we are going to use the folder ''logs''.
  
* open a terminal and type
+
=== Creating the New Site ===
 +
To create and enable a new site in your server follow these steps:
  
<tt>mkdir /home/youruser/lamp/
+
'''NOTE''' gedit is a common Linux editor but you can use another alternative such as geany, nano, vim, pico etc.
mkdir /home/youruser/lamp/public_html/
 
mkdir /home/youruser/lamp/logs/</tt>
 
  
'''NOTE:''' You can place your new site folders on any location you desire, this is just an example, replace "youruser" with your actual Linux username
+
*Open a terminal an type:
  
To store the web site files we are going to use the folder "plublic_html" and for our log files we are going to use the folder "logs"
+
<pre>sudo cp /etc/apache2/sites-available/000-default.conf /etc/apache2/sites-available/mydevsite.conf</pre>
  
=== Creating the new site ===
+
'''NOTE''' ''mydevsite'' is the name of the new site used in this example. You can use any other name you like.
  
To create and enable a new site in your server follow this steps:
+
*Open the site configuration
  
'''NOTE:''' gedit is a common Linux editor but you can use any other alternative you like such as geany, nano, vim, pico, etc...
+
<pre>sudo gedit /etc/apache2/sites-available/mydevsite.conf</pre>
  
*open a terminal an type
+
*The content of that file should be something like this:
  
  <tt>cp /etc/apache2/sites-available/default /etc/apache2/sites-available/mydevsite</tt>
+
<pre>
 +
  <VirtualHost *:80>
 +
# The ServerName directive sets the request scheme, hostname and port that
 +
# the server uses to identify itself. This is used when creating
 +
# redirection URLs. In the context of virtual hosts, the ServerName
 +
# specifies what hostname must appear in the request's Host: header to
 +
# match this virtual host. For the default virtual host (this file) this
 +
# value is not decisive as it is used as a last resort host regardless.
 +
# However, you must set it for any further virtual host explicitly.
 +
#ServerName www.example.com
  
'''NOTE:''' "mydevsite" is the name of the new site used in this example, you can use any other name you like
+
ServerAdmin webmaster@localhost
 +
DocumentRoot /var/www/html
  
*Open the site configuration
+
# Available loglevels: trace8, ..., trace1, debug, info, notice, warn,
 +
# error, crit, alert, emerg.
 +
# It is also possible to configure the loglevel for particular
 +
# modules, e.g.
 +
#LogLevel info ssl:warn
  
<tt>sudo gedit /etc/apache2/sites-available/mydevsite</tt>
+
ErrorLog ${APACHE_LOG_DIR}/error.log
 +
CustomLog ${APACHE_LOG_DIR}/access.log combined
  
*The content of that file should be something like this
+
# For most configuration files from conf-available/, which are
 +
# enabled or disabled at a global level, it is possible to
 +
# include a line for only one particular virtual host. For example the
 +
# following line enables the CGI configuration for this host only
 +
# after it has been globally disabled with "a2disconf".
 +
#Include conf-available/serve-cgi-bin.conf
 +
</VirtualHost>
  
<tt>
+
# vim: syntax=apache ts=4 sw=4 sts=4 sr noet
<VirtualHost *:80>
+
</pre>
ServerAdmin webmaster@localhost
 
 
DocumentRoot /var/www
 
<Directory />
 
Options FollowSymLinks
 
AllowOverride None
 
</Directory>
 
<Directory /var/www/>
 
Options Indexes FollowSymLinks MultiViews
 
AllowOverride None
 
Order allow,deny
 
allow from all
 
</Directory>
 
 
ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/
 
<Directory "/usr/lib/cgi-bin">
 
AllowOverride None
 
Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
 
Order allow,deny
 
Allow from all
 
</Directory>
 
 
ErrorLog ${APACHE_LOG_DIR}/error.log
 
 
# Possible values include: debug, info, notice, warn, error, crit,
 
# alert, emerg.
 
LogLevel warn
 
 
CustomLog ${APACHE_LOG_DIR}/access.log combined
 
 
    Alias /doc/ "/usr/share/doc/"
 
    <Directory "/usr/share/doc/">
 
        Options Indexes MultiViews FollowSymLinks
 
        AllowOverride None
 
        Order deny,allow
 
        Deny from all
 
        Allow from 127.0.0.0/255.0.0.0 ::1/128
 
    </Directory>
 
 
</VirtualHost>
 
</tt>
 
  
*Make some modifications to make it looks like this, or simply copy and paste it
+
*Make some modifications to make it look like this, or simply copy and paste it:
  
<tt>
+
<pre>
  <VirtualHost *:80 *:8080>
+
  <VirtualHost *:80>
 
  ServerAdmin webmaster@localhost
 
  ServerAdmin webmaster@localhost
 
   
 
   
 
  DocumentRoot /home/youruser/lamp/public_html
 
  DocumentRoot /home/youruser/lamp/public_html
 
  <Directory />
 
  <Directory />
Options FollowSymLinks
+
                Options Indexes FollowSymLinks MultiViews
AllowOverride All
 
</Directory>
 
<Directory /home/youruser/lamp/public_html>
 
Options Indexes FollowSymLinks MultiViews
 
 
  AllowOverride All
 
  AllowOverride All
Order allow,deny
+
                Order allow,deny
allow from all
+
                Allow from all
 +
                Require all granted
 
  </Directory>
 
  </Directory>
 
   
 
   
Line 216: Line 206:
 
         Allow from 127.0.0.0/255.0.0.0 ::1/128
 
         Allow from 127.0.0.0/255.0.0.0 ::1/128
 
     </Directory>
 
     </Directory>
 
 
  </VirtualHost>
 
  </VirtualHost>
</tt>
+
</pre>
  
'''NOTE:''' Replace "yourname" with your current user name
+
'''NOTE''' Replace ''youruser'' with your current user name.
  
*Save changes
+
*Save your changes.
*No we need to enable the site, in a terminal type  
+
*Now we need to enable the site. In a terminal type:
  
  <tt>sudo a2ensite mydevsite</tt>
+
  <pre>sudo a2ensite mydevsite</pre>
  
*Lets disable the default site, we don't need it anymore
+
*Let's disable the default site, since we don't need it anymore.
  
  <tt>sudo a2dissite default</tt>
+
  <pre>sudo a2dissite 000-default</pre>
  
*Restart Apache to complete the process, in a terminal type
+
*Restart Apache to complete the process. In a terminal type:
 
   
 
   
  <tt>sudo service apache2 restart</tt>
+
  <pre>sudo service apache2 restart</pre>
 +
 
 +
*To test our new site, let's create a quick test file. In a terminal type:
 +
 
 +
<pre>echo "<?php echo 'Hello world, today is is: '.date('Y/m/d'); ?>" | tee /home/youruser/lamp/public_html/today.php </pre>
 +
 
 +
'''NOTE''' Replace ''yourname'' with your current user name.
  
*To test out our new site lets create a quick test file, in a terminal type
+
*Open your browser and navigate to ''localhost/today.php''.
 +
*If everything is working okay, you should see something like this:
  
  <tt>echo "<?php echo 'Hello world, today is is: '.echo date('Y/m/d'); ?>" | tee /home/youruser/lamp/public_html/today.php </tt>
+
  <pre>Hello world, today is is: 2022/07/10</pre>
  
'''NOTE:''' Replace "yourname" with your current user name
+
=== Enabling Additional Ports ===
 +
Note: If you have no plans to show your local site to another person over the Internet, skip this section.
  
*Open your browser an navigate to "localhost/today.php"
+
With the last configuration you should be able to access your page and access it from another computer connected to your LAN. If your computer is connected to the Internet and also has an assigned Public IP, you can access your site using that IP from any Web browser. Note that some ISPs do not allow HTTP traffic (HTTP = port 80) over dynamic IP addresses. To solve this, you need to configure Apache to reply to requests from a different port. In this case we are going to use the port number 8080 which is easy to remember.
*If everything is working ok you should see something like this  
 
  
<tt>Hello world, today is is: 2012/05/05</tt>
+
If you are using a router to connect to the Internet, you have to configure a port forwarding setting on your router to let other people see your local site. Google ''how to do port forwarding'' on your current router model. If you don't know the difference between a Static IP, Dynamic IP, Private IP and a Public IP, we recommend you to do a Wikipedia reading about these topics.
  
=== Preventing ownership problems ===
+
*Open a terminal and type:
  
By default in some Linux installations the Apache server runs under the user "www-data" which is also in the "www-data" group, this behavior will bring us problems in the future because any file modified or created by the server will have a different ownership, in other words you wouldn't be able to edit some files created or modified by the server unless you manually change the permissions of each file to something like 777 or execute your editor as "super user" which both are really bad ideas.
+
<pre>sudo gedit /etc/apache2/ports.conf</pre>
  
==== Method 1: Implementing suPHP ====
+
*Find the line ''listen 80'' and insert this line underneath:
  
suPHP is an Apache module used to execute PHP scripts with the permissions of their file owners
+
<pre>Listen 8080</pre>
  
This is how the server will work thanks to suPHP
+
*Save the changes.
  
*If a PHP file have the owner "dexter" suPHP will execute that file as "dexter" and not as the Apache user aka "www-data",
+
*Open your new site configuration.
*If another file PHP file have the owner "adam" suPHP will execute that file as "adam" and not as the Apache user aka "www-data"
 
*If another file PHP file have the owner "www-data" suPHP will execute that file as "www-data" which is the Apache user
 
*If a folder have the owner "dexter" and it have a PHP file inside it with the owner "adam" the server will throw a "500" error when some one tries to request that file because it does not belong to "dexter"
 
*If a any PHP script tries to read or write files or folders outside the server's document root, then the server will deny the action
 
*If a file have too permissive permissions such as "chmod 666", then the server will throw a "500" error because suPHP don't allow too permissive permissions for security reasons
 
  
We already have suPHP installed, to Configure it follow this steps:
+
<pre>sudo gedit /etc/apache2/sites-available/mydevsite</pre>
  
*Open a terminal and Type
+
*Find this directive ''<VirtualHost *:80>'' and make the following modification:
  
  <tt>sudo gedit /etc/suphp/suphp.conf</tt>
+
  <pre> <VirtualHost *:80 *:8080> </pre>
  
*Open a terminal and Type
+
*Save the changes.
  
<tt>sudo gedit /etc/suphp/suphp.conf</tt>
+
*Restart Apache to complete the process. In a terminal type:
  
*Find the option "docroot" and set the location of your public_html folder, like this
+
<pre>sudo service apache2 restart</pre>
  
<tt>docroot= /home/youruser/lamp/public_html</tt>
+
*To test your new configuration, try to access your site from another computer over internet. Just type your IP address in the browser's address bar and press enter. If the request fails, try the new alternative port like this: ''xxx.xxx.xxx.xxx:8080''
  
'''NOTE:''' You can place your new site folders on any location you desire, this is just an example, replace "youruser" with your actual Linux username
+
=== Preventing Ownership and Permissions Problems ===
 +
On Linux machines, file permissions are an important thing. Linux uses a mechanism to control what users can do and cannot do with folders, files and even the execution of applications. This mechanism consists of parameters, the ownership and the permissions.
  
*Save changes
+
==== Files and Folders Ownership ====
*Type in your terminal
+
Ownership has two parameters: The owner and the group.
  
<tt>sudo gedit /etc/apache2/mods-available/php5.conf</tt>
+
The ''owner'' is the user that owns the file or folder and is represented by a ''username''. In Linux persons, applications and services use usernames. On most Linux distributions, the Apache service runs under the username ''www-data''.
  
*On your editor create a new empty line at the first line of the document and add this text there
+
The ''group'' is used to associate users into an logical group. This figure is useful when an administrator needs to grant or deny permissions to several users with one single command and not user by user.
  
<tt><Directory /usr/share></tt>
+
==== Files and Folders Permissions ====
 +
The permissions have three parameters that represent file and folder permissions for the owner, the group and others. These number range from 0 to 7, and mean the following:
  
*Then at the end of the document create another empty line and add this text there
+
* 4 = permission to read
 +
* 2 = permission to write
 +
* 1 = permission to execute
 +
* 0 = no permissions at all
  
<tt></Directory></tt>
+
Note: ''Others'' represents everybody. This parameter is used to grant permission to everyone no matter the user or the group they belong to. This parameter should be set with care. Granting incorrect permissions to sensitive files and folders can cause security problems.
  
*Save changes
+
For example, if we have a file with permissions such as ''644'', it means ''(owner=read+write) (group=read) (others=read)''.
*Type in your terminal
 
  
<tt>sudo service apache2 restart</tt>
+
To get more information about the Linux file systems and file permissions read the [https://docs.joomla.org/How_do_UNIX_file_permissions_work%3f How do UNIX file permissions work?] article.
  
*Now suPHP should be up and running, now we need to adjust the proper file ownership to the server document root
+
==== Adding Yourself to the Apache Group and Modifying Permissions ====
*Type in your terminal
+
For this example, your username will be ''youruser''. On most Linux distributions, the Apache service runs on the user ''www-data'' and the group ''www-data''. We need to include our user ''youruser'' in the ''www-data'' group to be able to set permissions to the Web server files and have no problems when we have to edit them.
  
<tt>sudo find . -type f -exec chmod 644 {} \;
+
*To add ''youruser'' to the Apache group, open a terminal and type:
sudo find . -type d -exec chmod 755 {} \;
 
sudo chown youruser:youruser -R /home/youruser/lamp/public_html/</tt>
 
  
'''NOTE:''' You can place your new site folders on any location you desire, this is just an example, replace "youruser" with your actual Linux username
+
<pre>sudo adduser youruser www-data</pre>
  
*Lets create a file to do a quick test to see if suPHP is working correctly, type in your terminal
+
*Now we need to change the owner and group of all our Web server files to owner ''www-data'' and group ''www-data''.
  
  <tt>echo "<?php echo 'whoim = '.exec('/usr/bin/whoami');?>" | tee /home/myadmin/lamp/public_html/whomi.php
+
  <pre>sudo chown -R www-data:www-data /home/youruser/lamp/public_html</pre>
chmod 644 /home/myadmin/lamp/public_html/whomi.php</tt>
 
  
*Open your browser and navigate to "localhost/whomi.php", you should see something like this
+
*Finally, we have to set the correct folder permissions so both Apache and our user can edit the files with no problems. On a terminal type:
  
  whomi = youruser
+
  <pre>sudo chmod -R 775 /home/youruser/lamp/public_html</pre>
  
That means the script is being executed with your user and not the Apache user
+
==== Common Problems and Confusions ====
 +
When Joomla creates files on extension installations or any other operation, it uses the default mask 755 for folders and 644 for files. These permissions are correct and secure for production servers but it will give us problems on our local server because our editor will not be able to edit those files and folders. To fix these problems, simply run this command again:
  
==== Method 2: Changing Apache user and group ====
+
<pre>sudo chmod -R 775 /home/youruser/lamp/public_html</pre>
  
<span style="color:red; font-weight:bold;"> '''NOTE:'''This method is highly discouraged, do not implement in a computer with personal or sensitive information, install a firewall to block external incoming traffic to your web server.</span>
+
In case you manually move files from your personal folders to the server Web folder ''public_html'', those new files most likely will be owned by your username. This can cause problems if the server needs to modify or delete information. To prevent this problem, every time you move or copy information to your server web folder you have to set the correct owner and group permissions for all those new files. Open a terminal and run this command:
  
To make Apache execute under your current user and group you got to edit some parameters in the Apache configuration file and make it execute under our current user and group, this will solve our file ownership problems '''but opens a severe security hole'''.
+
  <pre>sudo chown -R www-data:www-data /home/youruser/lamp/public_html</pre>
  
To change the user and group of the Apache service, follow these instructions:
+
Note: If your server has too many files, these commands could be slow but you can always set a more specific path to apply permission in fewer files.
  
*open a terminal and type
+
Another option is to configure the default Apache owner and group. For all new files created by the server these settings are used. We can change the in the environment variables file. Run this command to open and edit the file:
  
  <tt>sudo gedit /etc/apache2/envvars</tt>
+
  <pre>sudo gedit /etc/apache2/envvars</pre>
  
*Find the lines
+
Find the following lines and change them this way (replacing ''youruser'' with your current username):
 +
<pre>
 +
export APACHE_RUN_USER=youruser
 +
export APACHE_RUN_GROUP=www-data
 +
</pre>
  
<tt>export APACHE_RUN_USER=www-data
+
Restart Apache with the following command:
export APACHE_RUN_GROUP=www-data</tt>
+
<pre>sudo service apache2 restart</pre>
  
*Replace the "www-data" with your current username in both lines
+
=== Other Configurations ===
*Save changes
+
*Open a terminal and type:
*Type in your terminal
 
  
  <tt>sudo service apache2 restart</tt>
+
  <pre> sudo gedit /etc/php5/apache2/php.ini</pre>
  
*Lets create a file to do a quick test to see if the new configuration is working correctly, type in your terminal
+
*Find the line:
 +
 
 +
<pre>output_buffering =</pre>
 +
 
 +
*Set the value to ''= Off''.
 +
 
 +
*Find the line:
 +
 
 +
<pre>post_max_size =</pre>
 +
 
 +
*Set the value to ''= 20M''.
 +
 
 +
*Find the line:
 +
 
 +
<pre>upload_max_filesize =</pre>
 +
 
 +
*Set the value to ''= 20M''.
 +
 
 +
* Save the changes.
 +
 
 +
*Type in your terminal:
 +
 
 +
<pre>sudo service apache2 restart</pre>
 +
 
 +
=== Enforcing Security ===
 +
Since your computer is now running web services, these services are listening for requests and will reply to anyone who has the correct IP and port. In other words, other people in your LAN and the internet can access your local site without your permission or they can even try to crack or hack your workstation. To prevent this, you need to install a firewall and ''deny'' by default any external incoming requests to your computer.
 +
 
 +
For Linux users, there is a nice and simple firewall called ''Uncomplicated Firewall''. To install the user interface and manage the firewall from your desktop, just follow these steps:
 +
 
 +
*Open a terminal and type:
  
  <tt>echo "<?php echo 'whoim = '.exec('/usr/bin/whoami');?>" | tee /home/myadmin/lamp/public_html/whomi.php</tt>
+
  <pre>sudo apt-get install gufw</pre>
  
*Open your browser and navigate to "localhost/whomi.php", you should see something like this
+
Note: You can also install the application from the Software Manager.
  
whomi = youruser
+
*Open the application. When the installation finishes, press the ''unlock'' button and type your administrative password.
  
That means the script is being executed with the new user (you)
+
*Set ''Status = On'' and ''Incoming = Deny''. Leave the rest of the settings at their default values.
  
== Further reading ==
+
*To test your firewall, just try to connect to your local site from a local computer on your LAN or a remote computer over the internet. When the firewall status is ''Status = On'', you shouldn't be able to connect at all.
  
* ApacheMySQLPHP - Community Ubuntu Documentation [https://help.ubuntu.com/community/ApacheMySQLPHP link]
+
*Now ''temporarily'' change the status of your firewall to ''Status = Off'' and try to connect again. People should be able to see your local site just fine. Remember to set ''Status = On'' after this test.
* Running phpmyadmin and suphp [http://serverfault.com/questions/211935/running-phpmyadmin-and-suphp/211942#211942 link]
 
  
== Fine tuning ==
+
Note: In this tutorial we are denying any incoming external requests to any port. As a side note, you can also Deny all incoming requests and manually allow incoming requests to few specific ports if you wish, but those kinds of settings are up to you. Since a PC workstation is not a server, it is okay to deny all incoming traffic by default.
to do ...
 
  
[[Category:Development]]
+
[[Category:Server configurations]]

Latest revision as of 16:40, 10 July 2022

Copyedit.png
This Article Needs Your Help

This article is tagged because it TECHNICAL REVIEW. You can help the Joomla! Documentation Wiki by contributing to it.
More pages that need help similar to this one are here. NOTE-If you feel the need is satistified, please remove this notice.

Reason: Needs updating to latest PHP/MySQL Versions


This article provides detailed instructions for configuring a LAMP server, not only for Joomla! but it also should work fine for PHP development in general. For information on installing other stacks see Installing_Joomla_on_Debian_Linux

These instructions should work fine on any Linux-based distribution such as Debian, Ubuntu, Linux Mint, Xubuntu, Kubuntu and others.

NOTE To complement the security of your computer, install a firewall to block external incoming traffic to your Web service. You may also have to change some directives on your site configuration file to serve only requests to the localhost address.

Installation[edit]

NOTE You need a stable internet connection for this tutorial. If you previously tried to install the LAMP stack and failed for any reason, visit How to remove the LAMP stack and follow the instructions to delete any server configuration and start from scratch.

The installation of a LAMP server on Linux is easy. Just follow these instructions:

  • Open a terminal and type:
sudo apt-get install apache2 php5-mysql libapache2-mod-php5 mysql-server phpmyadmin php5-curl
  • Say yes [Y] when the package manager asks you download and install the packages. This step will take some time.
  • At some point the installer will ask you for the MySQL root password. Use any password you like. For this example we are going to use myadmin.
  • The installer will ask for the Web server that should be automatically configured to run PHPMyAdmin. Press the [spacebar] to choose apache2 and press [enter]. NOTE Make sure the selection is marked with an asterisk [*].
  • The installer will ask for Configure database for PHPMyAdmin with dbconfig-common. Choose <yes> and press [enter].
  • The installer will ask for password of the database's administrative user. Use any password you like, but for this example we are going to use myadmin.
  • The installer will ask for MySQL application password for PHPMyAdmin. Use any password you like, but for this example we are going to use admin.
  • If no errors have being displayed, the installation is finished.

Apache Installation Test[edit]

  • Open your Web browser and type in the address bar localhost and press [enter].
  • Normally Apache display a test page with some text such as:
It works!
This is the default Web page for this server.
The Web server software is running but no content has been added yet.

PHP Installation Test[edit]

To verify that the PHP server is working, create a quick test file using the command line.

  • Open a terminal and type:
echo "<?php phpinfo(); ?>" | sudo tee /var/www/html/test.php 
  • Open your Web browser and type in the address bar localhost/test.php and press [enter].
  • The next thing you should see in your browser is a long page displaying information about the PHP server. If not, the installation was not successful.
  • Once the PHP server is working fine, we don't need that test file anymore. Type the following command in your terminal to delete the file:
sudo rm /var/www/html/test.php

PHPMyAdmin Installation Test[edit]

  • Open your Web browser and type in the address bar localhost/phpmyadmin and press [enter].
  • The next thing you should see is the PHPMyAdmin login page. If not, then most likely you skipped or did not mark the option apache2 at the question Web server that should be automatically configured to run PHPMyAdmin. To fix this problem, purge the installation and start over again.
  • Login to PHPMyAdmin with the following credentials:
    • username = root
    • password = myadmin
  • You should be able to login normally and have no error messages.

Understanding the Folder Structure[edit]

There are several folders and files that the LAMP server uses to store the configurations of the LAMP services and to store the files of your hosted Websites.

Apache Default Web Site Folder[edit]

Location: /var/www/

Description: By default the Apache server enables a test website and stores the website files in that location. Every time you visit the page http://localhost, the browser displays the page located at /var/www/.

With your file browser, navigate to /var/www/. There should be a file called index.html. Change the content of the file to whatever you want and refresh the Web page to see the changes.

Apache Web Sites Configuration Files[edit]

Location: /etc/apache2/sites-available/

Description: You can host multiple sites on the same server. This folder contains a configuration file for each site.

Apache Configuration Files[edit]

Location: /etc/apache2/apache2.conf Location: /etc/apache2/envvars

Description: These files contain important information about the Apache service.

Apache Ports Configuration File[edit]

Location: /etc/apache2/ports.conf

Description: This file configures which port the Apache server will listen to for HTTP requests. By default, HTTP requests are assigned to port 80 but you can modify or add more ports.

Apache Log Files[edit]

Location: /var/log/apache2/

Description: This folder contains several files to keep track of events on your Apache Web server such as errors in the services, errors in the code of your site and failed authentication attempts. This is a good place to look when something is not working or you suspect someone is trying to breach your server security.

Configuration[edit]

Enabling mod_rewrite[edit]

The mod_rewrite module uses a rule-based rewriting engine based on a PCRE regular expression parser to rewrite requested URLs on the fly. By default, mod_rewrite maps a URL to a filesystem path. However, it can also be used to redirect one URL to another URL, or to invoke an internal proxy fetch.

For more information, visit the Apache mod_rewrite page.

  • Open a terminal and type:
sudo a2enmod rewrite
  • Now that the rewrite module is enabled, restart Apache.
sudo service apache2 restart
  • done

Deploying a New Site Folder Structure[edit]

By default the Web server is hosting the files in the location /var/www, but for security reasons and to avoid ownership problems, we are going to use another place to host our website files.

Let's create a new folder to store the web files and the log files of the site.

Open a terminal and type:

 mkdir /home/youruser/lamp/
 mkdir /home/youruser/lamp/public_html/
 mkdir /home/youruser/lamp/logs/

NOTE You can place your new site folders at any location. This is just an example. Replace youruser with an actual Linux username.

To store the Website files we are going to use the folder public_html. For our log files, we are going to use the folder logs.

Creating the New Site[edit]

To create and enable a new site in your server follow these steps:

NOTE gedit is a common Linux editor but you can use another alternative such as geany, nano, vim, pico etc.

  • Open a terminal an type:
sudo cp /etc/apache2/sites-available/000-default.conf /etc/apache2/sites-available/mydevsite.conf

NOTE mydevsite is the name of the new site used in this example. You can use any other name you like.

  • Open the site configuration
sudo gedit /etc/apache2/sites-available/mydevsite.conf
  • The content of that file should be something like this:
 <VirtualHost *:80>
	# The ServerName directive sets the request scheme, hostname and port that
	# the server uses to identify itself. This is used when creating
	# redirection URLs. In the context of virtual hosts, the ServerName
	# specifies what hostname must appear in the request's Host: header to
	# match this virtual host. For the default virtual host (this file) this
	# value is not decisive as it is used as a last resort host regardless.
	# However, you must set it for any further virtual host explicitly.
	#ServerName www.example.com

	ServerAdmin webmaster@localhost
	DocumentRoot /var/www/html

	# Available loglevels: trace8, ..., trace1, debug, info, notice, warn,
	# error, crit, alert, emerg.
	# It is also possible to configure the loglevel for particular
	# modules, e.g.
	#LogLevel info ssl:warn

	ErrorLog ${APACHE_LOG_DIR}/error.log
	CustomLog ${APACHE_LOG_DIR}/access.log combined

	# For most configuration files from conf-available/, which are
	# enabled or disabled at a global level, it is possible to
	# include a line for only one particular virtual host. For example the
	# following line enables the CGI configuration for this host only
	# after it has been globally disabled with "a2disconf".
	#Include conf-available/serve-cgi-bin.conf
</VirtualHost>

# vim: syntax=apache ts=4 sw=4 sts=4 sr noet
  • Make some modifications to make it look like this, or simply copy and paste it:
 <VirtualHost *:80>
 	ServerAdmin webmaster@localhost
 
 	DocumentRoot /home/youruser/lamp/public_html
 	<Directory />
                Options Indexes FollowSymLinks MultiViews
 		AllowOverride All
                Order allow,deny
                Allow from all
                Require all granted
 	</Directory>
 
 	ScriptAlias /cgi-bin/ /usr/lib/cgi-bin/
 	<Directory "/usr/lib/cgi-bin">
 		AllowOverride All
 		Options +ExecCGI -MultiViews +SymLinksIfOwnerMatch
 		Order allow,deny
 		Allow from all
 	</Directory>
 
 	ErrorLog /home/youruser/lamp/logs/error.log
 
 	# Possible values include: debug, info, notice, warn, error, crit,
 	# alert, emerg.
 	LogLevel warn
 
 	CustomLog /home/youruser/lamp/logs/access.log combined
 
     Alias /doc/ "/usr/share/doc/"
     <Directory "/usr/share/doc/">
         Options Indexes MultiViews FollowSymLinks
         AllowOverride All
         Order deny,allow
         Deny from all
         Allow from 127.0.0.0/255.0.0.0 ::1/128
     </Directory>
 </VirtualHost>

NOTE Replace youruser with your current user name.

  • Save your changes.
  • Now we need to enable the site. In a terminal type:
sudo a2ensite mydevsite
  • Let's disable the default site, since we don't need it anymore.
sudo a2dissite 000-default
  • Restart Apache to complete the process. In a terminal type:
sudo service apache2 restart
  • To test our new site, let's create a quick test file. In a terminal type:
echo "<?php echo 'Hello world, today is is: '.date('Y/m/d'); ?>" | tee /home/youruser/lamp/public_html/today.php 

NOTE Replace yourname with your current user name.

  • Open your browser and navigate to localhost/today.php.
  • If everything is working okay, you should see something like this:
Hello world, today is is: 2022/07/10

Enabling Additional Ports[edit]

Note: If you have no plans to show your local site to another person over the Internet, skip this section.

With the last configuration you should be able to access your page and access it from another computer connected to your LAN. If your computer is connected to the Internet and also has an assigned Public IP, you can access your site using that IP from any Web browser. Note that some ISPs do not allow HTTP traffic (HTTP = port 80) over dynamic IP addresses. To solve this, you need to configure Apache to reply to requests from a different port. In this case we are going to use the port number 8080 which is easy to remember.

If you are using a router to connect to the Internet, you have to configure a port forwarding setting on your router to let other people see your local site. Google how to do port forwarding on your current router model. If you don't know the difference between a Static IP, Dynamic IP, Private IP and a Public IP, we recommend you to do a Wikipedia reading about these topics.

  • Open a terminal and type:
sudo gedit /etc/apache2/ports.conf
  • Find the line listen 80 and insert this line underneath:
Listen 8080
  • Save the changes.
  • Open your new site configuration.
sudo gedit /etc/apache2/sites-available/mydevsite
  • Find this directive <VirtualHost *:80> and make the following modification:
 <VirtualHost *:80 *:8080> 
  • Save the changes.
  • Restart Apache to complete the process. In a terminal type:
sudo service apache2 restart
  • To test your new configuration, try to access your site from another computer over internet. Just type your IP address in the browser's address bar and press enter. If the request fails, try the new alternative port like this: xxx.xxx.xxx.xxx:8080

Preventing Ownership and Permissions Problems[edit]

On Linux machines, file permissions are an important thing. Linux uses a mechanism to control what users can do and cannot do with folders, files and even the execution of applications. This mechanism consists of parameters, the ownership and the permissions.

Files and Folders Ownership[edit]

Ownership has two parameters: The owner and the group.

The owner is the user that owns the file or folder and is represented by a username. In Linux persons, applications and services use usernames. On most Linux distributions, the Apache service runs under the username www-data.

The group is used to associate users into an logical group. This figure is useful when an administrator needs to grant or deny permissions to several users with one single command and not user by user.

Files and Folders Permissions[edit]

The permissions have three parameters that represent file and folder permissions for the owner, the group and others. These number range from 0 to 7, and mean the following:

  • 4 = permission to read
  • 2 = permission to write
  • 1 = permission to execute
  • 0 = no permissions at all

Note: Others represents everybody. This parameter is used to grant permission to everyone no matter the user or the group they belong to. This parameter should be set with care. Granting incorrect permissions to sensitive files and folders can cause security problems.

For example, if we have a file with permissions such as 644, it means (owner=read+write) (group=read) (others=read).

To get more information about the Linux file systems and file permissions read the How do UNIX file permissions work? article.

Adding Yourself to the Apache Group and Modifying Permissions[edit]

For this example, your username will be youruser. On most Linux distributions, the Apache service runs on the user www-data and the group www-data. We need to include our user youruser in the www-data group to be able to set permissions to the Web server files and have no problems when we have to edit them.

  • To add youruser to the Apache group, open a terminal and type:
sudo adduser youruser www-data
  • Now we need to change the owner and group of all our Web server files to owner www-data and group www-data.
sudo chown -R www-data:www-data /home/youruser/lamp/public_html
  • Finally, we have to set the correct folder permissions so both Apache and our user can edit the files with no problems. On a terminal type:
sudo chmod -R 775 /home/youruser/lamp/public_html

Common Problems and Confusions[edit]

When Joomla creates files on extension installations or any other operation, it uses the default mask 755 for folders and 644 for files. These permissions are correct and secure for production servers but it will give us problems on our local server because our editor will not be able to edit those files and folders. To fix these problems, simply run this command again:

sudo chmod -R 775 /home/youruser/lamp/public_html

In case you manually move files from your personal folders to the server Web folder public_html, those new files most likely will be owned by your username. This can cause problems if the server needs to modify or delete information. To prevent this problem, every time you move or copy information to your server web folder you have to set the correct owner and group permissions for all those new files. Open a terminal and run this command:

sudo chown -R www-data:www-data /home/youruser/lamp/public_html

Note: If your server has too many files, these commands could be slow but you can always set a more specific path to apply permission in fewer files.

Another option is to configure the default Apache owner and group. For all new files created by the server these settings are used. We can change the in the environment variables file. Run this command to open and edit the file:

sudo gedit /etc/apache2/envvars

Find the following lines and change them this way (replacing youruser with your current username):

export APACHE_RUN_USER=youruser
export APACHE_RUN_GROUP=www-data

Restart Apache with the following command:

sudo service apache2 restart

Other Configurations[edit]

  • Open a terminal and type:
 sudo gedit /etc/php5/apache2/php.ini
  • Find the line:
output_buffering =
  • Set the value to = Off.
  • Find the line:
post_max_size =
  • Set the value to = 20M.
  • Find the line:
upload_max_filesize =
  • Set the value to = 20M.
  • Save the changes.
  • Type in your terminal:
sudo service apache2 restart

Enforcing Security[edit]

Since your computer is now running web services, these services are listening for requests and will reply to anyone who has the correct IP and port. In other words, other people in your LAN and the internet can access your local site without your permission or they can even try to crack or hack your workstation. To prevent this, you need to install a firewall and deny by default any external incoming requests to your computer.

For Linux users, there is a nice and simple firewall called Uncomplicated Firewall. To install the user interface and manage the firewall from your desktop, just follow these steps:

  • Open a terminal and type:
sudo apt-get install gufw

Note: You can also install the application from the Software Manager.

  • Open the application. When the installation finishes, press the unlock button and type your administrative password.
  • Set Status = On and Incoming = Deny. Leave the rest of the settings at their default values.
  • To test your firewall, just try to connect to your local site from a local computer on your LAN or a remote computer over the internet. When the firewall status is Status = On, you shouldn't be able to connect at all.
  • Now temporarily change the status of your firewall to Status = Off and try to connect again. People should be able to see your local site just fine. Remember to set Status = On after this test.

Note: In this tutorial we are denying any incoming external requests to any port. As a side note, you can also Deny all incoming requests and manually allow incoming requests to few specific ports if you wish, but those kinds of settings are up to you. Since a PC workstation is not a server, it is okay to deny all incoming traffic by default.