cherokee at cherokee-project
Oct 9, 2009, 9:56 AM
Post #1 of 1
(165 views)
Permalink
|
|
[3691] cherokee/trunk/doc: Documentation needed some more serious updating
|
|
Revision: 3691
http://svn.cherokee-project.com/changeset/3691
Author: taher
Date: 2009-10-09 18:56:47 +0200 (Fri, 09 Oct 2009)
Log Message:
-----------
Documentation needed some more serious updating
Modified Paths:
--------------
cherokee/trunk/doc/Makefile.am
cherokee/trunk/doc/config.txt
cherokee/trunk/doc/cookbook_alfresco.txt
cherokee/trunk/doc/cookbook_dbslayer.txt
cherokee/trunk/doc/cookbook_glassfish.txt
cherokee/trunk/doc/cookbook_joomla.txt
cherokee/trunk/doc/cookbook_liferay.txt
cherokee/trunk/doc/cookbook_phpbb.txt
cherokee/trunk/doc/cookbook_phpmyadmin.txt
cherokee/trunk/doc/cookbook_sugarcrm.txt
cherokee/trunk/doc/cookbook_symfony.txt
cherokee/trunk/doc/cookbook_trac.txt
cherokee/trunk/doc/cookbook_zend.txt
cherokee/trunk/doc/index.txt
Added Paths:
-----------
cherokee/trunk/doc/config_wizards.txt
Modified: cherokee/trunk/doc/Makefile.am
===================================================================
--- cherokee/trunk/doc/Makefile.am 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/Makefile.am 2009-10-09 16:56:47 UTC (rev 3691)
@@ -36,6 +36,7 @@
config_advanced.html \
config_info_sources.html \
config_status.html \
+config_wizards.html \
cookbook.html \
cookbook_managing_logs.html \
cookbook_optimizations.html \
Modified: cherokee/trunk/doc/config.txt
===================================================================
--- cherokee/trunk/doc/config.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/config.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -9,5 +9,5 @@
. link:config_icons.html[Icons]: Icon managment.
. link:config_mime_types.html[Mime Types]: Setting up the MIME types.
. link:config_advanced.html[Advanced]: Advanced tweaking. Not for the faint of heart.
+ . link:config_wizards.html[Wizards]: Configuration assistants for many known scenarios.
-
Added: cherokee/trunk/doc/config_wizards.txt
===================================================================
--- cherokee/trunk/doc/config_wizards.txt (rev 0)
+++ cherokee/trunk/doc/config_wizards.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -0,0 +1,100 @@
+== link:index.html[Index] -> link:config.html[Configuration]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+///////////////////////////////////////////////////////////////////
+
+Configuration Wizards
+---------------------
+
+A whole lot of effort has been invested in making Cherokee as painless
+to configure as possible. To this extent, its nifty configuration
+interface is shipped with a bunch of configuration assistants.
+
+These will help you to set up Cherokee to work with several popular
+applications, frameworks and programming languages, and hopefully your
+task will be performed with just a couple of clicks.
+
+Even if they might not apply exactly to your what you are trying to
+accomplish, they can always be used as a template that you can fine
+tune afterwards.
+
+Some of the wizards can only be applied to new virtual servers, others
+can only be used inside pre-existent ones. Most of them, however, are
+good for both scenarios.
+
+Using them is as simple as clicking on the `Wizards` button located
+under the list of `Virtual servers` or `Behavior rules`. The former
+applies to new dedicated virtual servers, and is located on its
+homonymous tab of the main interface. The latter is found on a tab by
+the same name that exists for every virtual server defined on your
+configuration.
+
+Most of the wizards are documented on their corresponding recipes in
+the link:cookbook.html[Cookbook].
+
+The wizards are loosly organized on several categories: CMS,
+platforms, tasks, misc, etc. Take a look at them. You might find
+something interesting in the place least expected.
+
+These are the wizards currently implemented:
+
+Available Wizards
+~~~~~~~~~~~~~~~~~
+
+* link:cookbook_alfresco.html[Alfresco]: open source ECM.
+
+* CommonStatic: adds the usual rules to manage static contents.
+
+* link:cookbook_django.html[Django]: high-level Python Web framework.
+
+* link:cookbook_drupal.html[Drupal]: open source content management
+
+* link:cookbook_glassfish.html[GlassFish]: open source enterprise Java
+ EE software
+
+* HotLinking: prevent your files from being hot-linked.
+
+* Icons: adds the usual icon rules.
+
+* link:cookbook_joomla.html[Joomla]: dynamic portal engine and content
+ management system.
+
+* link:cookbook_liferay.html[Liferay]: Enterprise Open Source Portal,
+ CMS, Web Publishing, Collaboration, and Social Networking Software.
+
+* link:cookbook_mailman.html[Mailman]: Mailman is free software for
+ managing electronic mail discussion and e-newsletter lists.
+
+* link:cookbook_moodle.html[Moodle]: Course Management System.
+
+* link:cookbook_phpbb.html[phpBB]: Forum software.
+
+* link:cookbook_phpmyadmin.html[phpMyAdmin]: MySQL administration web
+ interface.
+
+* link:cookbook_php.html[PHP]: PHP configuration.
+
+* Redirect: assits in configurin redirections.
+
+* link:cookbook_ror.html[RoR]: Ruby on Rails configuration.
+
+* rTorrent: BitTorrent client.
+
+* link:cookbook_streaming.html[Streaming]: assists in media streaming
+ configuration.
+
+* link:cookbook_sugarcrm.html[Sugar]: open-source Customer
+ Relationship Management.
+
+* link:cookbook_symfony.html[Symfony]: Symfony PHP web development
+ framework.
+
+
+* link:cookbook_trac.html[Trac]: open source, web-based project
+ management and bug-tracking tool.
+
+* link:cookbook_wordpress.html[WordPress]: blog publishing application
+ and content management system.
+
+* link:cookbook_zend.html[Zend]: PHP web development framework.
Modified: cherokee/trunk/doc/cookbook_alfresco.txt
===================================================================
--- cherokee/trunk/doc/cookbook_alfresco.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_alfresco.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,4 +1,9 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+* Alfresco Labs 3c
+///////////////////////////////////////////////////////////////////
Cookbook: Setting up Alfresco
-----------------------------
@@ -106,16 +111,23 @@
Phase two: Cherokee
~~~~~~~~~~~~~~~~~~~
-Now to set up Cherokee as reverse proxy. You can either create a new
-virtual server with a matching rule (be it `default` or anything else)
-if you are sharing the proxy machine, or dedicate another machine
-to the Proxy Handler. This will be our choice, since typically you
-will be wanting to get the best possible performance, the Java
-application server is heavy by definition, and you could be using the
-proxy machine also to serve other contents. We are only going to set
-Cherokee's HTTP reverse proxy handler to hit the server running
-Alfresco at port 8080.
+Now to set up Cherokee. To do this, use the provided `Wizard`. Launch
+Cherokee-Admin on your proxy machine and then you will find this
+assistant under the `CMS` category of the Wizards. Click, answer a few
+questions and you are done. You can then skip the rest of this
+document.
+Should you have any problem with the assitant, you can perform the
+same tasks manually. Simply set up Cherokee as reverse proxy. You can
+either create a new virtual server with a matching rule (be it
+`default` or anything else) if you are sharing the proxy machine, or
+dedicate another machine to the Proxy Handler. This will be our
+choice, since typically you will be wanting to get the best possible
+performance, the Java application server is heavy by definition, and
+you could be using the proxy machine also to serve other contents. We
+are only going to set Cherokee's HTTP reverse proxy handler to hit the
+server running Alfresco at port 8080.
+
Launch Cherokee-Admin on your proxy machine, create a rule that
matches the desired path on your web server hierarchy -`/share` for
instance- in your virtual server of choice, and define the `HTTP
@@ -143,7 +155,7 @@
[options="header"]
|Type |Nick |Connection
-|Remote host |liferay |192.168.1.100:8080
+|Remote host |alfresco |192.168.1.100:8080
Refer to the link:modules_handlers_proxy.html[HTTP reverse proxy]
Modified: cherokee/trunk/doc/cookbook_dbslayer.txt
===================================================================
--- cherokee/trunk/doc/cookbook_dbslayer.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_dbslayer.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -152,7 +152,7 @@
Refer to the link:config_info_sources.html[information sources]
section for details on how to do this. In this case, the MySQL servers
-are running in on port 3306 of the hosts 10.0.0.100 and 10.0.0.101, so
+are running on port 3306 of the hosts 10.0.0.100 and 10.0.0.101, so
that is what we will use.
image::media/images/cookbook_dbslayer2.png[MySQL Bridge, step 2]
Modified: cherokee/trunk/doc/cookbook_glassfish.txt
===================================================================
--- cherokee/trunk/doc/cookbook_glassfish.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_glassfish.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -133,6 +133,26 @@
Configuring Cherokee
~~~~~~~~~~~~~~~~~~~~
+Cherokee provides a wizard that will assist you on this task. You can
+either dedicate a new virtual server to the task, or use a preexisting
+one. It is your choice, since the Wizard contemplates both scenarios.
+For the former you'll have to access the Wizard from the list of
+available ones within the `Virtual Servers` tab of Cherokee-Admin. The
+latter is accessed through the same list of Wizards, this time within
+the `Behaviour` tab of any given virtual server.
+
+The wizard will simply ask for the host to be proxied and will set it
+up for you to see. Should you need to add more machines to your
+cluster, you can add extra informtion sources to your Cherokee
+configuration and let it deal with all the load balancing.
+
+No extra steps are necessary. You can skip directly to the
+link:#deployment[deployment] section of this recipe. If for any reason
+the Wizard doesn't work for you, you can always use the manual method
+described below.
+
+Manual method
+^^^^^^^^^^^^^
You can either create a new virtual server with a matching rule (be it
`default` or anything else) if you are sharing the proxy machine, or
completely dedicate a machine to the Proxy Handler. This will be our
Modified: cherokee/trunk/doc/cookbook_joomla.txt
===================================================================
--- cherokee/trunk/doc/cookbook_joomla.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_joomla.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,8 +1,8 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
///////////////////////////////////////////////////////////////////
Last checked:
-* Cherokee: 0.99.25
-* Joomla 1.5.14
+* Cherokee 0.99.25
+* Joomla 1.5.14
///////////////////////////////////////////////////////////////////
Cookbook: Setting up Joomla
Modified: cherokee/trunk/doc/cookbook_liferay.txt
===================================================================
--- cherokee/trunk/doc/cookbook_liferay.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_liferay.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,4 +1,9 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+* Liferay
+///////////////////////////////////////////////////////////////////
Cookbook: Setting up Liferay
----------------------------
@@ -67,16 +72,23 @@
Phase two: Cherokee
~~~~~~~~~~~~~~~~~~~
-Now to set up Cherokee as reverse proxy. You can either create a new
-virtual server with a matching rule (be it `default` or anything else)
-if you are sharing the proxy machine, or dedicate another machine
-to the Proxy Handler. This will be our choice, since typically you
-will be wanting to get the best possible performance, the Java
-application server is heavy by definition, and you could be using the
-proxy machine also to serve other contents. We are only going to set
-Cherokee's HTTP reverse proxy handler to hit the server running
-Lifreay at port 8080.
+Now to set up Cherokee. To do this, use the provided `Wizard`. Launch
+Cherokee-Admin on your proxy machine and then you will find this
+assistant under the `CMS` category of the Wizards. Click, answer a few
+questions and you are done. You can then skip the rest of this
+document.
+Should you have any problem with the assitant, you can perform the
+same tasks manually. Simply set up Cherokee as reverse proxy. You can
+either create a new virtual server with a matching rule (be it
+`default` or anything else) if you are sharing the proxy machine, or
+dedicate another machine to the Proxy Handler. This will be our
+choice, since typically you will be wanting to get the best possible
+performance, the Java application server is heavy by definition, and
+you could be using the proxy machine also to serve other contents. We
+are only going to set Cherokee's HTTP reverse proxy handler to hit the
+server running Lifreay at port 8080.
+
Launch Cherokee-Admin on your proxy machine, create a rule that
matches the desired path on your web server hierarchy -`/liferay` for
instance- in your virtual server of choice, and define the `HTTP
Modified: cherokee/trunk/doc/cookbook_phpbb.txt
===================================================================
--- cherokee/trunk/doc/cookbook_phpbb.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_phpbb.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,4 +1,9 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+* phpBB 3.0.5
+///////////////////////////////////////////////////////////////////
Cookbook: Setting up phpBB
--------------------------
@@ -82,7 +87,7 @@
image::media/images/cookbook_phpbb_4_admin.png["phpBB step4"]
.Configuration file
-image::media/images/cookbook_phpbb_5_config.png["phpBB step5"}
+image::media/images/cookbook_phpbb_5_config.png["phpBB step5"]
.Advanced settings
image::media/images/cookbook_phpbb_6_advanced.png["phpBB step6"]
Modified: cherokee/trunk/doc/cookbook_phpmyadmin.txt
===================================================================
--- cherokee/trunk/doc/cookbook_phpmyadmin.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_phpmyadmin.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,4 +1,9 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+* phpMyAdmin 3.1.2
+///////////////////////////////////////////////////////////////////
Cookbook: Setting up phpMyAdmin
-------------------------------
@@ -35,9 +40,13 @@
* Web browser with cookies enabled.
This means that you don't need to modify Cherokee at all provided you
-have PHP with MySQL support and you are using a default Cherokee
-configuration.
+have PHP with MySQL support.
+Simply use Cherokee-Admin's phpMyAdmin Wizard, located under the
+`Database` category. It checks for the presence of phpMyAdmin, so you
+better have the package installed prior to using the Wizard, or else
+the Wizard will not let you proceed.
+
Express setup
~~~~~~~~~~~~~
The only thing you need to do is make phpMyAdmin accessible by
@@ -52,7 +61,6 @@
.Debian installation
-----
# apt-get install php5-cgi php5-mysql mysql-server-5.0 phpmyadmin
-# ln -s /usr/share/phpmyadmin/ /var/www/phpmyadmin
-----
Since Cherokee doesn't appear in the list of web servers provided by
@@ -83,10 +91,10 @@
site] and follow the `Quick Install` notes in the
link:http://www.phpmyadmin.net/documentation/[phpMyAdmin
documentation]. As before, you simply need to make the program
-accessible to your web server, so either install directly under your
-`document root` or make a symbolic link.
+accessible to your web server, so simply use the Wizard and fill in
+the required information. Alternatively you can either install
+directly under your `document root` or make a symbolic link.
-
Considerations
~~~~~~~~~~~~~~
@@ -103,14 +111,15 @@
or alternatively by using Cherokee's authentication features. Refer
to the link:http://www.phpmyadmin.net/documentation/[phpMyAdmin
documentation] for more details on the former, or to our
- link;cookbook_authentication.html[authentication recipe] for the
+ link:cookbook_authentication.html[authentication recipe] for the
latter.
* It is generally good idea to protect public phpMyAdmin installation
against access by robots as they usually can not do anything good
there. You can do this using robots.txt file in root.
-* You should deny access to the `./libraries` and `./setup/lib`
+* The Wizard already takes care of this, but if you have installed it
+ manually you should deny access to the `./libraries` and `./setup/lib`
subfolders in Cherokee's configuration. Such configuration prevents
from possible path exposure and cross side scripting vulnerabilities
that might happen to be found in that code. To do so, configure
Modified: cherokee/trunk/doc/cookbook_sugarcrm.txt
===================================================================
--- cherokee/trunk/doc/cookbook_sugarcrm.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_sugarcrm.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -28,10 +28,29 @@
Adjusting Cherokee
~~~~~~~~~~~~~~~~~~
-First, we Create the directory you that will be used when installing
+You can either read through this whole section to install it manually,
+or you can follow the recommended method and use the provided
+installation Wizard.
+
+To do this, you'll have to locate the Wizard, available for
+installation under a subdirectory or using a new dedicated virtual
+server. In both cases you'll find a Wizard option: the former one will
+have it available within every available virtual server, and the
+latter will directly be present under the `Virtual Servers` section of
+the admin.
+
+Once the Wizard list is visible, simply go to the `Management`
+section, click on `Sugar`, provide the basic information and you can
+skip the rest of this section and jump directly to
+link:#installation[Package installation]
+
+If you choose not to follow the recommended method, you'll just have
+to go through these steps:
+
+
+First, create the directory that will be used when installing
SugarCRM.
-.Create installation path
----
# mkdir /var/www/sugar
----
@@ -74,7 +93,7 @@
~~~~~~~~~~~~~~~~~~~~
Uncompress SugarCRM to your web document root and rename the directory
-to whatever you like. We will choose `/var/www/sugar` as installation
+to whatver you like. We will choose `/var/www/sugar` as installation
directory for this recipe.
Then remember setting up file permissions. Some files and directories
Modified: cherokee/trunk/doc/cookbook_symfony.txt
===================================================================
--- cherokee/trunk/doc/cookbook_symfony.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_symfony.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,16 +1,29 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+* Symfony 1.2.9
+///////////////////////////////////////////////////////////////////
Cookbook: Setting up Symfony Framework
--------------------------------------
+If you need to deploy a Symfony application with Cherokee, the
+configuration is trivial. You will find a `Wizard` that can be used
+both to deploy the application under a dedicated `Virtual Server` and
+under a web folder from one already existent.
+[[package_configuration]]
+Prepare your Symfony project
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The link:http://www.symfony-project.org/[Symfony Framework] is a PHP
framework focused on building more secure, reliable, and modern Web
2.0 applications.
It is essential that Cherokee supports PHP before starting with this
-recipe. That should not be a problem since it comes preconfigured by
-default. However, you can follow the link:cookbook_php.html[setting up
-PHP] recipe for further hints on fine tuning this feature.
+recipe. That should not be a problem since Cherokee-Admin provides a
+PHP configuration Wizard. However, you can follow the
+link:cookbook_php.html[setting up PHP] recipe for further hints on
+fine tuning this feature.
To make sure the recipe works, we'll initialize a simple symfony
application.
@@ -43,14 +56,50 @@
rules for the web server. Specially important will be the rewrite
rules.
+
+[[wizard_configuration]]
+Configure Cheroke using the Wizard
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
Launch cherokee-admin, and proceed to the
-link:config_virtual_servers.html[Virtual servers] section. Select or
-create the virtual server that you will be configuring and go to the
-`Behavior` tab to set up the rules. Remember that the document root
-for this virtual server should be the `web` folder in your demo
-project.
+link:config_virtual_servers.html[Virtual servers] section and either
+enter the chosen one to install under a web folder, or directly click
+on the `Symfony Wizard` to create a customised one.
+In either case you will be asked for the basic information and
+everything will be handled for you. The two main data pieces will be
+the location of the public web folder of your Symfony project (that
+is, the part that you wish to make publicly accesible, not the whole
+project), and the path to the installed release of Symfony in your
+system.
+There is nothing else you need to do on Cherokee.
+
+You may need to edit your "hosts" file to include the domain name you
+call the virtual server. Your symfony application should then be
+accessible. You can find more information about setting up symfony
+applications in the symfony manual.
+
+.Running application
+image::media/images/cookbook_symfony.png[Symfony Application]
+
+Note that the Wizard configures Cherokee for your project's production
+frontend. Should you wish to access the development environment simply
+adjust the redirection to the appropriate forntend.
+
+
+[[manual_configuration]]
+Configure Cheroke manually
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+In case you are wondering, these are manual steps you would have to
+follow if you opted for not using the configuration Wizard.
+
+Select or create the virtual server that you will be configuring and
+go to the `Behavior` tab to set up the rules. Remember that the
+document root for this virtual server should be the `web` folder in
+your demo project.
+
.Steps
. You will need to keep the rule for the `php` extension. If this rule
is not present, create it as described in
@@ -104,11 +153,3 @@
Note that the document root for the /sf directory depends on your
installation. The value given above corresponds to a pear installation
of symfony on an Ubuntu 8.10 (Intrepid Ibex) system.
-
-You may need to edit your "hosts" file to include the domain name you
-call the virtual server. Your symfony application should then be
-accessible. You can find more information about setting up symfony
-applications in the symfony manual.
-
-.Running application
-image::media/images/cookbook_symfony.png[Symfony Application]
Modified: cherokee/trunk/doc/cookbook_trac.txt
===================================================================
--- cherokee/trunk/doc/cookbook_trac.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_trac.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,4 +1,9 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+* Trac 0.11.1
+///////////////////////////////////////////////////////////////////
Cookbook: Setting up Trac
-------------------------
@@ -44,9 +49,23 @@
Cherokee
~~~~~~~~
-The configuration on Cherokee's side is quite simple. You will only
-need to know that you can spawn Trac as an SCGI process.
+The configuration on Cherokee's side is quite simple. In fact, the
+configuration of Cherokee is so simple that you only have to click on
+the Trac Wizard with Cherokee-Admin. You will be asked for the minimal
+information required, and everything else will be handled for you.
+
+By now, your Trac installation should be up and running. Try it out!
+
+.Complete Trac installation
+image::media/images/cookbook_trac.png[Trac]
+
+If you used the Wizard, you can skip the rest of the document. It only
+details what manual steps must be taken. You might find it interesting
+to know exactly what the wizard does for you, though.
+
+You will only need to know that you can spawn Trac as an SCGI process.
+
.Command to launch Trac
-------
/usr/bin/tracd --single-env --daemonize --protocol=scgi /
@@ -100,8 +119,3 @@
.Static files
image::media/images/cookbook_trac_static.png[Static files]
-
-By now, your Trac installation should be up and running. Try it out!
-
-.Complete Trac installation
-image::media/images/cookbook_trac.png[Trac]
Modified: cherokee/trunk/doc/cookbook_zend.txt
===================================================================
--- cherokee/trunk/doc/cookbook_zend.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/cookbook_zend.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -1,4 +1,9 @@
== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checked:
+* Cherokee 0.99.25
+* Zend 1.9.3PL1
+///////////////////////////////////////////////////////////////////
Cookbook: Setting up Zend Framework
-----------------------------------
@@ -14,9 +19,9 @@
To make sure the recipe works, we'll be using the demo provided by the
link:http://framework.zend.com/docs/quickstart[Zend Framework
-Quickstart]. At the time of writing, it was
-link:http://framework.zend.com/demos/ZendFrameworkQuickstart-20080915.tar.gz[demo
-20080915].
+Quickstart]. Last time this document was edited, it was
+link:http://framework.zend.com/demos/ZendFrameworkQuickstart-20090430.tar.gz[demo
+20090430].
Uncompress its contents to a directory and set up the `public`
subdirectory as your web document root. In our example, it will be
@@ -48,39 +53,30 @@
*********************************************************************
-Launch cherokee-admin, and proceed to the
-link:config_virtual_servers.html[Virtual servers] section. Select the
-virtual server that you will be configuring and go to the `Behavior`
-tab to set up the rules.
+[[wizard_configuration]]
+Configure Cheroke using the Wizard
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.Steps
-. You will need to keep the rule for the `php` extension.
+[[manual_configuration]]
+Configure Cheroke using the Wizard
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-. Next, configure a rule with the handler `File Exists` that should be
- set to a priority lower than that of the `php` rule. This one can
- be set to match whatever files you like, but the important thing is
- to check the `Match any file` checkbox. Let this rule be handled by
- the link:modules_handlers_common.html[List & Send] handler. Note that
- we're not using the link:modules_handlers_file.html[Static Content]
- handler. This is because it doesn't support indexes, so it wouldn't
- allow you to browse the website at http://hostname.tld/, but only at
- http://hostname.tld/index.php.
+Cherokee is shipped with a configuration `Wizard` that can be used
+both to deploy the application under a dedicated `Virtual Server` and
+under a web folder from one already existent.
-. And last, modify your `Default` rule by configuring the
- link:modules_handlers_redir.html[redirection handler], through the
- `Handler` tab.
-+
-[options="header"]
-|==========================================
-|Type |Regular Expression |Substitution
-|Internal |^.*$ |/index.php
-|==========================================
+Launch cherokee-admin, and proceed to the
+link:config_virtual_servers.html[Virtual servers] section.
-This will take care of redirecting the requests to Zend.
+Now you can either enter the chosen one to install under a web folder,
+or directly click on the `Symfony Wizard` to create a customised one.
-You are done with the configuration! You can now access your
-application. The demo provided by Zend will look like this:
+After that you will be asked for the minimal information required to
+correctly configure your server in a totally transparent way.
+And that's it. You are done with the configuration! You can now access
+your application. The demo provided by Zend will look like this:
+
image::media/images/cookbook_zend1.png[Demo]
Of course, you'll have to follow the complete tutorial if you expect
Modified: cherokee/trunk/doc/index.txt
===================================================================
--- cherokee/trunk/doc/index.txt 2009-10-09 16:55:44 UTC (rev 3690)
+++ cherokee/trunk/doc/index.txt 2009-10-09 16:56:47 UTC (rev 3691)
@@ -39,6 +39,7 @@
. link:config_icons.html[Icons]: Icon managment.
. link:config_mime_types.html[Mime Types]: Setting up the MIME types.
. link:config_advanced.html[Advanced]: Advanced tweaking. Not for the faint of heart.
+ . link:config_wizards.html[Wizards]: Configuration assistants for many known scenarios.
*********************************
link:cookbook.html[Cookbook]: Recipes for specific tasks
|
