Moving sensitive files outside the web root
From Joomla! Documentation
Revision as of 05:25, 13 December 2009 by Mandville
This article is tagged because it NEEDS 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.
This article or section is in the process of an expansion or major restructuring, and is not yet ready for use. You are welcome to assist in its construction by editing it as well. This template was placed by. If this article or section
Moving sensitive files outside the public_html
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 Gallery2 and 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.
- 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.
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 it's own directory outside of public_html to contain it's configuration.php file.
2. Move configuration.php to the design2-files directory and rename it 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:
<?php require( dirname( __FILE__ ) . '/../design2-files/joomla.conf' ); ?>
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.
<?php require( dirname( __FILE__ ) . '/../../design2-files/joomla.conf' ); ?>
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.
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
4. Make sure the new configuration.php file is set to permissions of 644.
Editing and saving/applying
Warning!! Do not use the Joomla web administrator interface global configuration button to edit the global configuration.
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.