Browse Source

added server configuration to install docs

Shawn McCool 12 years ago
parent
commit
d08db5c26b
2 changed files with 26 additions and 2 deletions
  1. 1 0
      laravel/documentation/contents.md
  2. 25 2
      laravel/documentation/install.md

+ 1 - 0
laravel/documentation/contents.md

@@ -4,6 +4,7 @@
 - [Installation & Setup](/docs/install)
 	- [Requirements](/docs/install#requirements)
 	- [Installation](/docs/install#installation)
+	- [Server Configuration: Why Public?](/docs/install#server-configuration)
 	- [Basic Configuration](/docs/install#basic-configuration)
 	- [Environments](/docs/install#environments)
 	- [Cleaner URLs](/docs/install#cleaner-urls)

+ 25 - 2
laravel/documentation/install.md

@@ -4,6 +4,7 @@
 
 - [Requirements](#requirements)
 - [Installation](#installation)
+- [Server Configuration: Why Public?](#server-configuration)
 - [Basic Configuration](#basic-configuration)
 - [Environments](#environments)
 - [Cleaner URLs](#cleaner-urls)
@@ -37,8 +38,30 @@ Installing the following goodies will help you take full advantage of Laravel, b
 
 If you are having problems installing, try the following:
 
-- Make sure the **public** directory is the document root of your web server.
+- Make sure the **public** directory is the document root of your web server. (see: Server Configuration below)
 - If you are using mod_rewrite, set the **index** option in **application/config/application.php** to an empty string.
+- Verify that your storage folder and the folders within in are writable by your web server.
+
+<a name="server-configuration"></a>
+## Server Configuration: Why Public?
+
+Like most web-development frameworks, Laravel is designed to protect your application code, bundles, and local storage by placing only files that are necessarily public in the web server's DocumentRoot. This prevents some types of server misconfiguration from making your code (including database passwords and other configuration data) accessible through the web server. It's best to be safe.
+
+In this example let's imagine that we installed Laravel to the directory **/Users/JonSnow/Sites/MySite**.
+
+A very basic example of an Apache VirtualHost configuration for MySite might look like this.
+
+	<VirtualHost *:80>
+		DocumentRoot /Users/JonSnow/Sites/MySite/public
+		ServerName mysite.local
+	</VirtualHost>
+
+Notice that while we installed to **/Users/JonSnow/Sites/MySite** our DocumentRoot points to **/Users/JonSnow/Sites/MySite/public**.
+
+Pointing the DocumentRoot to the public folder is a commonly used best-practice. However, you may need to use Laravel on a host that does not allow you to update your DocumentRoot. This is possible, but before resigning to this option it's best to contact your host and verify that you are unable to change your DocumentRoot to increase the security of your application.
+
+More information about how to use the public folder can be found on the [Laravel Forums](http://forums.laravel.com/viewtopic.php?pid=10023#p10023).
+
 
 <a name="basic-configuration"></a>
 ## Basic Configuration
@@ -70,7 +93,7 @@ Next, create an **application/config/local** directory. Any files and options yo
 
 	);
 
-In this example, the local **URL** option will override the **URL** option in **application/config/application.php**. Notice that you only need to specify the options you wish to override. 
+In this example, the local **URL** option will override the **URL** option in **application/config/application.php**. Notice that you only need to specify the options you wish to override.
 
 Isn't it easy? Of course, you are free to create as many environments as you wish!