Переглянути джерело

Minor - Added documentation about override at install

Yannick Warnier 12 роки тому
батько
коміт
524d0a8a10
3 змінених файлів з 29 додано та 18 видалено
  1. 2 2
      documentation/installation_guide.html
  2. 3 1
      index.php
  3. 24 15
      web/index.php

+ 2 - 2
documentation/installation_guide.html

@@ -110,7 +110,7 @@ single-database mode.</span><br />
 
 <hr style="width: 100%; height: 2px;" />
 <h2><a name="2._Installation_of_Chamilo_LMS"></a><span style="font-weight: bold;">2. Installation of Chamilo LMS</span></h2>
-<h3>Configuring your web server to allow rewrites</h3>
+<h3>Configuring your web server to allow overrides</h3>
 If you are using Apache, and due to new friendly URL features added in 1.10, you will be required to <b>AllowOverride All</b> (and possibly install the ModRewrite extension for Apache). This means that, inside your Apache configuration (or your VirtualHost configuration), you will need to have a block similar to this (the directory given is the same as in the <i>DocumentRoot</i> directive):
 <pre>
   &lt;Directory /var/www/chamilo&gt;
@@ -120,7 +120,7 @@ If you are using Apache, and due to new friendly URL features added in 1.10, you
     allow from all
   &lt;/Directory&gt;
 </pre>
-In particular, the "AllowOverride All" clause is the one that matters. This will allow PHP to send the user from one page to another freely, thus allowing for a more user-friendly experience.<br />
+In particular, the "AllowOverride All" clause is the one that matters. This will allow PHP to send the user from one page to another freely, thus allowing for more user-friendly URLs.<br />
 Once you've made sure "AllowOverride" says "All", you can safely save the file, get out of it and reload the web server (<i>sudo service apache2 reload</i> under Debian/Ubuntu, or click right on the WAMP/XAMP/EasyPHP icon and "reload web server" under Windows).
 <h3>Downloading and installing Chamilo</h3>
 <ol>

+ 3 - 1
index.php

@@ -1,5 +1,7 @@
 <?php
 /* For licensing terms, see /license.txt */
 // Redirect calls to web/index
+// Please make sure you read the installation manual in the documentation/
+// folder if your installation doesn't work. Hint: you need to allow overrides
 header('Location: web/index');
-exit;
+exit;

+ 24 - 15
web/index.php

@@ -1,22 +1,31 @@
 <?php
 /* For licensing terms, see /license.txt */
-
-/** Classic global.inc.php file now returns a Application object*/
+/**
+ * Classic global.inc.php file now returns a Application object
+ * Make sure you read the documentation/installation_guide.html to learn how
+ * to configure your VirtualHost to allow for overrides.
+ */
+/**
+ * Inclusion of main setup script
+ */
 $app = require_once '../main/inc/global.inc.php';
-
 /**
-In order to execute Chamilo, $app->run() is needed.
-$app->run(); shows a page depending of the URL for example when entering in "/web/index"
-Chamilo will render the controller IndexController->indexAction() this is because a router was assign at the end of
-global.inc.php:
-
-    $app->get('/index', 'index.controller:indexAction')->bind('index');
-
-The "index.controller:indexAction" string is transformed (due a controller - service approach) into
-ChamiloLMS\Controller\IndexController->indexAction() see more at: http://silex.sensiolabs.org/doc/providers/service_controller.html
-The class is loaded automatically (no require_once needed) thanks to the namespace ChamiloLMS added in Composer.
-The location of the file is src\ChamiloLMS\Controller\IndexController.php following the PSR-1 standards.
-*/
+ * In order to execute Chamilo, you need a call to $app->run().
+ * $app->run(); shows a page depending of the URL for example when entering 
+ * in "/web/index"
+ * Chamilo will render the controller IndexController->indexAction(). This is 
+ * because a router was assigned at the end of global.inc.php:
+ *   $app->get('/index', 'index.controller:indexAction')->bind('index');
+ * 
+ * The "index.controller:indexAction" string is transformed (due a 
+ * controller - service approach) into 
+ * ChamiloLMS\Controller\IndexController->indexAction() see more 
+ * at: http://silex.sensiolabs.org/doc/providers/service_controller.html
+ * The class is loaded automatically (no require_once needed) thanks to the 
+ * namespace ChamiloLMS added in Composer.
+ * The location of the file is src\ChamiloLMS\Controller\IndexController.php
+ * following the PSR-1 standards.
+ */
 /** @var Application */
 $app->run();
 //$app['http_cache']->run();