Difference between revisions of "Moving sensitive files outside the web root"

From Joomla! Documentation

m (using new category inclusion)
 
(24 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{review}}
+
{{archived|68318|Where can you learn more about file permissions?|Security Checklist|reason=As the page notice indicated, the security information on this page is generally accepted by the security moderators as no longer relevant and provides no additional or very minimal additional security to a website.|cat=Security,FAQ,Tutorials}}
 
 
== while under review, please see this [http://forum.joomla.org/viewtopic.php?f=432&t=490901 forum topic] ==
 
 
 
 
 
 
 
 
 
One challenge in Joomla! is ensuring that certain PHP files in ''public_html'' (or otherwise known as ''httpdocs'' or'' www'' depending on your server setup) containing executable code or confidential data are protected from direct Internet access.
 
 
 
There are various ways to protect such files, but most are not optimal. Many users and developer groups, such as [http://gallery.menalto.com/ Gallery2] and [http://www.apache.org/ Apache.org] strongly recommend against keeping vulnerable files and confidential data inside public_html.
 
 
 
The following method seems to be the simplest and most elegant way to protect read-only files that, for whatever reason, must be stored in public_html. In this example, we protect configuration.php, perhaps the most confidential file of any Joomla! site.
 
Using this method, even if the Web server somehow delivers the contents of PHP files, for example due to a misconfiguration, nobody can see the contents of the real configuration file.
 
 
 
=== Directions ===
 
 
 
<font color="#ff0000">'''WARNING:''' Do not attempt this procedure unless, after reading several times, you understand it. This is not for beginners, ensure you have a back up of your site before attempting.
 
</font>
 
 
 
1. Create a directory in your domain outside of your public_html directory. You can name it anything you want. We used the name '''design2-files''' for the directory name in this example.
 
Note: If you have multiple Joomla installs then each Joomla install you have should have its own directory outside of public_html to contain its configuration.php file.
 
 
 
2. Move configuration.php to the '''design2-files''' directory and ''rename it'' to whatever you want. We used the name '''joomla.conf''' for the configuration file in this example.
 
 
 
3. If your Joomla site is installed in the root of the public_html directory and not in a subdirectory under public_html, then create a new configuration.php file for your joomla install in the public_html directory containing only the following code:
 
<source lang="php">
 
<?php
 
require( dirname( __FILE__ ) . '/../design2-files/joomla.conf' );
 
?>
 
</source>
 
If Joomla has been installed in a subdirectory under public_html ( public_html/subdirectory/ )
 
then create a configuration.php file containing only the following code.
 
<source lang="php">
 
<?php
 
require( dirname( __FILE__ ) . '/../../design2-files/joomla.conf' );
 
?>
 
</source>
 
 
 
'''Important!'''
 
Do not include blank lines or any characters (including blank spaces) before the php start tag or after the php end tag. If you make this mistake, you very likely will see the following error.
 
<pre>
 
Warning: Cannot modify header information - headers already sent by (output started at
 
/home/xxxxx/public_html/configuration.php:2) in /home/xxxxx/public_html/index.php on line 250
 
</pre>
 
 
 
In order to prevent this you can also not include the closing ?> tag. In PHP it is not required and avoids putting extra unintentioned blank spaces or newlines in the output.
 
 
 
4. Make sure the new configuration.php file is set to permissions of 644.
 
 
 
=== Editing and saving/applying ===
 
 
<font color="#ff0000">'''Warning!!'''
 
Do not use the Joomla web administrator interface global configuration button to edit the global configuration.</font>
 
 
 
If you need to change configuration settings, do so manually by downloading the relocated joomla.conf file, making the needed edits and uploading it back.
 
 
 
Making edits to the global configuration in the Joomla web administration interface will overwrite the 3 line configuration.php file pointing to the real configuration file with the real configuration.php file contents upon saving or applying the edits. This will undo your efforts to move and protect the configuration.php file by placing it in a directory outside of public_html.
 
 
 
 
 
[[Category:FAQ]]
 
[[Category:Administration FAQ]]
 
[[Category:Installation FAQ]]
 
[[Category:Version 1.5 FAQ]]
 
[[Category:Tutorials]][[Category:Security]]
 

Latest revision as of 08:51, 29 November 2012