cherokee at cherokee-project
Nov 15, 2009, 11:15 PM
Post #1 of 1
(121 views)
Permalink
|
|
[3824] cherokee/trunk/doc: Some documentation corrections and additions.
|
|
Revision: 3824
http://svn.cherokee-project.com/changeset/3824
Author: taher
Date: 2009-11-16 08:15:56 +0100 (Mon, 16 Nov 2009)
Log Message:
-----------
Some documentation corrections and additions. Thanks to Richard House for most of these
Modified Paths:
--------------
cherokee/trunk/doc/Makefile.am
cherokee/trunk/doc/basics_installation_svn.txt
cherokee/trunk/doc/basics_requirements.txt
cherokee/trunk/doc/basics_upgrade.txt
cherokee/trunk/doc/basics_why_cherokee.txt
cherokee/trunk/doc/cookbook.txt
cherokee/trunk/doc/index.txt
cherokee/trunk/doc/other_faq.txt
Added Paths:
-----------
cherokee/trunk/doc/cookbook_concrete5.txt
Modified: cherokee/trunk/doc/Makefile.am
===================================================================
--- cherokee/trunk/doc/Makefile.am 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/Makefile.am 2009-11-16 07:15:56 UTC (rev 3824)
@@ -71,6 +71,7 @@
cookbook_streaming.html \
cookbook_uwsgi.html \
cookbook_coldfusion.html \
+cookbook_concrete5.html \
modules.html \
modules_balancers.html \
modules_balancers_ip_hash.html \
Modified: cherokee/trunk/doc/basics_installation_svn.txt
===================================================================
--- cherokee/trunk/doc/basics_installation_svn.txt 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/basics_installation_svn.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -9,7 +9,7 @@
production environments.
Briefly, SVN is a system tool used to store and maintain files and a
-history of their changes over time, and it is an ivaluable development
+history of their changes over time, and it is an invaluable development
tool. The Cherokee source code and related files are kept on a SVN
server at svn.cherokee-project.com.
Modified: cherokee/trunk/doc/basics_requirements.txt
===================================================================
--- cherokee/trunk/doc/basics_requirements.txt 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/basics_requirements.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -31,7 +31,7 @@
several tools and libraries.
* Building tools: Cherokee is built on top of the autoconf and
- automake tools, hence your systems has to have some basic system
+ automake tools, hence your system has to have some basic system
programs like an sh shell, make and an ANSI C compiler. We have
compiled Cherokee in various platforms with different compilers, so
it shouldn't be a problem.
@@ -48,13 +48,13 @@
interpreter installed on your system.
* If you are building Cherokee in a non-POSIX compliant platform such
- as Windows, you will need a POSIX threads implementation. Albeit you can
- disable the usage at compilation time and do without this, it will
- have a dramatic impact in scalability.
+ as Windows, you will need a POSIX threads implementation. Although
+ you can disable the usage at compilation time and do without this,
+ it will have a dramatic impact in scalability.
* If you want to make a build that serves secure content, you will
need TLS libraries. Cherokee ships with support for the OpenSSL
- backend, but the architecture is completly modular and any other
+ backend, but the architecture is completely modular and any other
backend can be implemented. You need to have the development files
of the chosen backend libraries in order to build a package that
suits your needs.
Modified: cherokee/trunk/doc/basics_upgrade.txt
===================================================================
--- cherokee/trunk/doc/basics_upgrade.txt 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/basics_upgrade.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -10,9 +10,31 @@
If you happen to be running an old version of Cherokee and would like
to keep your current configuration settings, you can upgrade your
-cherokee.conf file through the Python scripts provided under
-`contrib`.
+cherokee.conf file.
+Cherokee now supports configuration versioning, so
+from now on, whenever a change is made to the configuration file
+format, Cherokee-Admin will be able to automatically convert yours to
+the new release. You simply have to load Cherokee-Admin and it will be
+converted once you proceed to saving it.
+
+There is also a command line utility that you can use to do the exact
+same thing. It is provided under
+`$prefix/share/cherokee/admin/upgrade_config.py.`
+
+In case you need to do this manually, the usage is as follows:
+
+----
+ /usr/share/cherokee/admin/upgrade_config.py /etc/cherokee/cherokee.conf
+----
+
+If Cherokee-Admin can not make the conversion automatically (because
+it is older than the configuration versioning feature), you still have
+options.
+
+You can attempt to upgrade you configuration file by manually running
+the Python scripts provided under `contrib`.
+
The usage is quite simple, and works the same way for all the
scripts:
@@ -25,12 +47,12 @@
whole chain of conversions.
Note that some of the available prepackaged versions of Cherokee
-are set to offer the possibillity of automatically running these scripts
+are set to offer the possibility of automatically running these scripts
to upgrade the configuration if files from a prior release are detected
in the system.
Every effort is made to bulletproof the upgrade scripts. If any of
-them does not work for you, do not hesitate to send a bug report.
+them does not work for you, please send a bug report.
However, Cherokee is a very active project and has been steadily
advancing and incorporating technical improvements. You should really be
using link:bundle_cherokee-admin.html[cherokee-admin] to configure your
@@ -38,3 +60,4 @@
the upgrade process is successful, you should use the new configuration
file as a start point and go through the normal configuration process
using link:bundle_cherokee-admin.html[cherokee-admin].
+
Modified: cherokee/trunk/doc/basics_why_cherokee.txt
===================================================================
--- cherokee/trunk/doc/basics_why_cherokee.txt 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/basics_why_cherokee.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -12,7 +12,7 @@
FastCGI, SCGI, PHP, CGI, SSI, TLS and SSL encrypted connections,
Virtual hosts, Authentication, on the fly encoding, Load Balancing,
Apache compatible log files, Data Base Balancer, downtime-free updates
-and upgrades, Reverse HTTP Proxy , and much more.
+and upgrades, Reverse HTTP Proxy, and much more.
It is highly efficient, extremely lightweight and provides rock solid
stability. Among its many features there is one that deserves special
@@ -26,10 +26,10 @@
image::media/images/admin_index.png[Cherokee Admin interface]
Unlike many other web servers out there, Cherokee gracefully handles
-many concurrent connections, has a low memory footprint and provides
+many concurrent connections, has a low memory footprint, and provides
load balancing facilities. As such, it is suitable for usage among a
wide variety of systems, from tiny embedded devices to huge enterprise
-grade infrastructures. It is also multiplatform, offering native
+grade infrastructures. It is also multi-platform, offering native
performance for Unix, Linux and Windows systems.
By simply upgrading your existing web server to Cherokee, you can
@@ -40,7 +40,7 @@
Best of all, Cherokee is free software, has a thoroughly designed
architecture, is completely modular and has a clean and neat code
base. Anyone and everyone can have access to the code for study and
-tinkering, thus allowing you to customize, modify or extend everything
+tinkering, thus allowing you to customize, modify, or extend everything
to suit specific needs. It is also very actively maintained, and every
interesting feature request is carefully considered.
Modified: cherokee/trunk/doc/cookbook.txt
===================================================================
--- cherokee/trunk/doc/cookbook.txt 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/cookbook.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -28,6 +28,7 @@
. link:cookbook_phpbb.html[phpBB]: How to run phpBB on Cherokee.
. link:cookbook_phpmyadmin.html[phpMyAdmin]: How to run phpMyAdmin on Cherokee.
. link:cookbook_sugarcrm.html[SugarCRM]: How to run SugarCRM on Cherokee.
+ . link:cookbook_concrete5.html[Concrete5]: How to run Concrete5 on Cherokee.
. link:cookbook_symfony.html[Symfony]: How to run Symfony apps with Cherokee.
. link:cookbook_trac.html[Trac]: How to run Trac on Cherokee.
. link:cookbook_zend.html[Zend]: How to run Zend apps with Cherokee.
Added: cherokee/trunk/doc/cookbook_concrete5.txt
===================================================================
--- cherokee/trunk/doc/cookbook_concrete5.txt (rev 0)
+++ cherokee/trunk/doc/cookbook_concrete5.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -0,0 +1,95 @@
+== link:index.html[Index] -> link:cookbook.html[Cookbook]
+///////////////////////////////////////////////////////////////////
+Last checks:
+* Cherokee 0.99.28b
+* Concrete5 3.3.1
+///////////////////////////////////////////////////////////////////
+
+Cookbook: Setting up Concrete5
+------------------------------
+
+Setting up link:http://www.concrete5.org/[Concrete5] with Cherokee is really
+easy. A configuration wizard is provided that can either be used to
+install Concrete5 as a new dedicated Virtual Server, or to set it up
+inside a Directory.
+
+This recipe contains three sections detailing how to:
+. Configure Cherokee for either installation mode using the Wizard.
+. Install Concrete5 v3.3.1 which is the last one available at the time
+of writing.
+. Configure Cherokee manually.
+
+[[wizard_configuration]]
+Configure Cheroke using the Wizard
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Two common scenarios are contemplated: installation on a dedicated
+virtual server (http://concrete5.example.net/, for instance) or under a
+subdirectory on an existing virtual servar (as could be
+http://example.net/concrete5/).
+
+[[cherokee_vserver]]
+==== Setting up Concrete5 as a new Virtual Server
+
+The first step would be to go to the virtual server list page. Once in
+there, you'll have to click the `Wizards` button:
+
+image::media/images/admin_vservers_wizard.png[Virtual Server Wizards]
+
+Now, you will have to select the `CMS` category, and run the Concrete5
+wizard. At this stage the Concrete5 wizard will ask you for some basic
+parameters about the installation. It will try to auto-fill as many
+entries of the form as possible. For instance, if it finds Concrete5
+installed in a standard location it will use that path as the default
+directory.
+
+The new virtual server will be created after this form is submitted.
+The virtual server configuration will cover the vast majority of the
+cases. Most probably it will cover your needs, although you are free
+to modify it as you will.
+
+[[cherokee_dir]]
+==== Setting up Concrete5 inside a Directory
+
+Concrete5 can also be configured inside a directory. Let's suppose we
+want to set up Concrete5 inside the `/blog` directory of one of our
+virtual servers.
+
+In this case, the first thing you will have to do is to enter the
+virtual server configuration you'd like to configure Concrete5 in. Once
+in there, click the `Wizards` button:
+
+image::media/images/admin_vserver_wizard.png[Virtual Server Wizards]
+
+As in the previous case, this wizard will ask some very basic
+information, including the public web directory where Concrete5 will be
+set up and the local Concrete5 source directory.
+
+
+[[package_installation]]
+Installing Concrete5
+~~~~~~~~~~~~~~~~~~~~
+
+Once Cherokee is ready, only the database issue remains to be able to
+install Concrete5. Log in to MySQL: `mysql -u root -p`
+
+And create the database for Concrete5. We will be using the name
+'concrete5', the user 'concrete5user' and the password 'concrete5password', but
+you should set up your own.
+
+------------------------------------------------------------------------
+CREATE DATABASE concrete5;
+GRANT ALL PRIVILEGES ON concrete5.* TO concrete5user [at] localhos IDENTIFIED BY 'concrete5password';
+GRANT ALL PRIVILEGES ON concrete5.* TO concrete5user [at] localhost IDENTIFIED BY 'concrete5password';
+FLUSH PRIVILEGES;
+quit;
+------------------------------------------------------------------------
+
+Then point your web browser to the point specified when you ran the
+wizard (i.e. `http://localhost/concrete5`, `http://example.com/`, etc)
+and follow the instructions provided by the Concrete5 installer.
+
+There is not much else you must do for Cherokee to work with
+Concrete5. If you follow the Concrete5 installer's instructions -providing
+valid database information in most cases will suffice-, you will be
+done in an instante.
Modified: cherokee/trunk/doc/index.txt
===================================================================
--- cherokee/trunk/doc/index.txt 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/index.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -73,6 +73,7 @@
. link:cookbook_phpbb.html[phpBB]: How to run phpBB on Cherokee.
. link:cookbook_phpmyadmin.html[phpMyAdmin]: How to run phpMyAdmin on Cherokee.
. link:cookbook_sugarcrm.html[SugarCRM]: How to run SugarCRM on Cherokee.
+ . link:cookbook_concrete5.html[Concrete5]: How to run Concrete5 on Cherokee.
. link:cookbook_symfony.html[Symfony]: How to run Symfony apps with Cherokee.
. link:cookbook_trac.html[Trac]: How to run Trac on Cherokee.
. link:cookbook_zend.html[Zend]: How to run Zend apps with Cherokee.
Modified: cherokee/trunk/doc/other_faq.txt
===================================================================
--- cherokee/trunk/doc/other_faq.txt 2009-11-15 22:04:00 UTC (rev 3823)
+++ cherokee/trunk/doc/other_faq.txt 2009-11-16 07:15:56 UTC (rev 3824)
@@ -182,34 +182,10 @@
[[faq16]]
=== Can I use an old configuration file with a new Cherokee release?
-The answer is yes. Cherokee now supports configuration versioning, so
-from now on, whenever a change is made to the configuration file
-format, Cherokee-Admin will be able to automatically convert yours to
-the new release. You simply have to load Cherokee-Admin and it will be
-converted once you proceed to saving it.
+The answer is yes. Please refer to the
+link:basics_upgrade.html[Upgrading Cherokee] section of the
+documentation.
-There is also a command line utility that you can use to do the exact
-same thing. It is provided under
-`$prefix/share/cherokee/admin/upgrade_config.py.`
-
-In case you need to do this manually, the usage is as follows:
-
-----
- /usr/share/cherokee/admin/upgrade_config.py /etc/cherokee/cherokee.conf
-----
-
-If Cherokee-Admin can not make the conversion automatically (because
-it is older than the configuration versioning feature), you still have
-options.
-
-Back when we transitioned from 0.5.x to 0.6, the configuration file
-format changed drastically. We have always tried to provide conversion
-scripts that would let you upgrade the old configuration files you
-had. They are made available under the `contrib` subdirectory. If it
-is really old, you might need to apply several of them, one after
-another (i.e. from 0.5 to 0.6, from 0.6 to 0.7, and so on).
-
-
[[faq17]]
=== I'm using *BSD and can't compile Cherokee. What's wrong?
|
