Permalink
Browse files

Documentation should now be up to date

git-svn-id: svn://cherokee-project.com/cherokee/trunk@6319 5dc97367-97f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent 0b1756e commit ea33b0866ba8a88cb845f30f1fa2acf475b9b958 taher committed Feb 17, 2011
@@ -1,6 +1,6 @@
== link:index.html[Index] -> link:basics.html[Getting started] -> link:basics_installation.html[Installation]
////
-Last checked: 2011/01/14 Cherokee 1.0.17b
+Last checked: 2011/02/16 Cherokee 1.0.21b
////
Easy installation
@@ -10,13 +10,13 @@ for easy installations. It compiles and installs the latest version of
the server with a single command:
----
-wget http://www.cherokee-project.com/install && python install
+wget http://cherokee-project.com/install && python install
----
or
----
-curl http://www.cherokee-project.com/install -o install && python install
+curl -LO http://cherokee-project.com/install && python install
----
The easy installation script is the express way to make a Cherokee
@@ -40,14 +40,14 @@ The easy installation script supports several parameters. To see a
full list of parameters, just add the `--help` parameter:
----
-wget http://www.cherokee-project.com/install && python install --help
+wget http://cherokee-project.com/install && python install --help
----
The only one really worth mentioning is the one to trigger the
`development mode`:
----
-wget http://www.cherokee-project.com/install && python install --devel
+wget http://cherokee-project.com/install && python install --devel
----
This will build a bleeding edge release, taking the sources from the
View
@@ -1,6 +1,6 @@
== link:index.html[Index] -> Configuration
- . link:config_quickstart.html[Quickstart]: Overview and walkthrough.
+ . link:config_quickstart.html[Walkthrough]: Overview and walkthrough.
. link:config_index.html[Home]: Main section.
. link:config_status.html[Status]: Server status information.
. link:config_general.html[General]: General settings.
View
@@ -1,16 +1,17 @@
== link:index.html[Index] -> link:config.html[Configuration]
////
-Last checked: 2010/04/26 Cherokee 0.99.46b
+Last checked: 2011/02/17 Cherokee 1.0.21b
////
-Configuration Quickstart
-------------------------
+Configuration Walkthrough
+-------------------------
-This section briefly describes the whole administration web interface
-provided by link:other_bundle_cherokee-admin.html[cherokee-admin]. This is
-the recommended way of configuring Cherokee. If you are looking for
+This section briefly describes a typical usage of the administration
+web interface provided by
+link:other_bundle_cherokee-admin.html[cherokee-admin]. This is the
+recommended way of configuring Cherokee. If you are looking for
development information relevant to your automation and scripting
-needs, you should refer to the appropriate section, especially the
+needs, you should refer to the appropriate section, specifically the
link:dev_cherokee.conf.html[cherokee.conf] file specification.
We will first show a quick overview of the available options, followed
@@ -44,14 +45,14 @@ Overview
will listen to, the default timeout, whether to support keep-alive
connections, default icon and MIME type definitions and so on.
-* link:config_virtual_servers.html[Virtual servers]:
+* link:config_virtual_servers.html[vServers]:
If you want your web server to work with more than one domain you
will have to create link:config_virtual_servers.html[Virtual
servers] other than the `default` one. Each one will have a
completely independent configuration: paths, behavior, logging
facilities, etc.
-* link:config_info_sources.html[Information Sources]:
+* link:config_info_sources.html[Sources]:
Define the resources that will be providing information. For
instance, PHP.
@@ -68,10 +69,11 @@ There is very little set up you must do to have a perfectly functional
web server out of the box. Cherokee's default configuration can be
used to serve any typical static website. For dynamic contents you
should check the wizards, available using the buttons located at the
-top section of the left panel. This panel can either display
-information relevant to every virtual host in your system, or rule
-management information specific to a given virtual host. In the first
-scenario, the wizards will be able to create new virtual servers
+top section of the left panel in the `vServers` section. This panel
+can either display information relevant to every virtual host in your
+system, or rule management information specific to a given virtual
+host if you are browsing a specific virtual host at the moment. In the
+first scenario, the wizards will be able to create new virtual servers
customized for a specific need, while the second case would apply to
the -preexisting- selected virtual host.
@@ -99,8 +101,8 @@ link:other_bundle_cherokee-admin-launcher.html[cherokee-admin-launcher].
Launching the admin through cherokee-admin-launcher
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Assuming you are using a desktop environment, you can follow the
-launcher approach.
+Assuming you are using a desktop environment on the same host where
+Cherokee is installed, you can follow the launcher approach.
----
# cherokee-admin-launcher
@@ -112,9 +114,9 @@ Connecting.. OK
This will automatically open a web browser window pointing at
http://localhost:9090, so you will be able to begin using
`cherokee-admin` right away. If there is no web browser registered in
-your system, you will need to leave out the launcher option, and run
-`cherokee-admin` directly. If this is not your case, you can skip the
-details for the manual launch.
+your system, you will have to forget about using the launcher option,
+and run `cherokee-admin` directly. If this is not your case, you can
+skip the details for the manual launch.
[[manual-launch]]
Manually launching cherokee-admin
@@ -167,44 +169,44 @@ Of course, once we're done we will have to apply our changes and
launch the server. The configuration changes must be submitted to the
server, be it automatically if possible or by using the appropriate
form submitting buttons. But no change is reflected in the
-configuration file until you `Save` the changes. You can be sure of
-not damaging anything while playing around with `cherokee-admin`. At
-least not until you `Save` the changes by using the `SAVE` button on
-the main toolbar. Note that, if the Cherokee server is running, the
-applied modifications will only affect the instance being executed if
-either `Graceful restart` or `Hard restart` are selected. `No
-restart` simply modifies the configuration file, but doesn't affect
-the currently running instance. A `graceful restart` will preserve the
-old set-up for any prior connections, while a `hard restart` will kill
-every connection and instantly apply the changes.
+configuration file until you actually `Save` the changes. You can be
+sure of not damaging anything while playing around with
+`cherokee-admin`. At least not until you `Save` the changes by using
+the `SAVE` button on the main toolbar. Note that, if the Cherokee
+server is running, the applied modifications will only affect the
+instance being executed if either `Graceful restart` or `Hard restart`
+are selected. `No restart` simply modifies the configuration file,
+but doesn't affect the currently running instance. A `graceful
+restart` will preserve the old set-up for any prior connections, while
+a `hard restart` will kill every connection and instantly apply the
+changes.
This is what the `General` tab looks like:
image::media/images/admin_general.png[General]
-We will only be modifying the *Server Permissions*. It usually is a
-poor choice to run services with super user privileges. Set both
-*User* and *Group* to `www-data`. Your system might already have
-another user account specifically for the purpose of running a
-webserver. Use that instead if so, or create the `www-data` user if
-you don't already have one.
+We will only be modifying the *Permissions* tab. It usually is a poor
+choice to run services with super user privileges. Set both *User* and
+*Group* to `www-data`. Your system might already have another user account
+specifically for the purpose of running a webserver. Use that instead
+if so, or create the `www-data` user if you don't already have one.
-Next is the link:config_virtual_servers.html[Virtual Servers] tab:
+Next is the link:config_virtual_servers.html[vServers] tab:
image::media/images/admin_vserver.png[Virtual server]
When you start, you will only have one virtual server called
`default`. You can begin by cloning it as `example`. This can be
achieved with the `Clone Selected Virtual Server` button, which is
placed in the upper side of the left panel, adjacent to the `Virtual
-Servers` title and the `Add New Virtual Server` button.
+Servers` label and the `Add New Virtual Server` button.
While you are at it you should also append the following line to your
`/etc/hosts` file (in Windows you will find this as
`%WINDIR%\system32\drivers\etc\hosts`).
----
-127.0.0.1 example.net example.org
+127.0.0.1 example.com example.net example.org
----
This is to allow your system to resolve requests for `example.net` or
@@ -261,24 +263,24 @@ Management` button to see the `Behavior` panel that will enable you to
modify the rules of your virtual host.
+
For now this virtual server is an exact copy of the untouched
-`default` virtual server. Create some new directories
+`default` virtual server. Create some new directories by hand:
'/var/www/example' and '/var/www/example/auth', and configure the
-first one as default document root path. This is easy using the `Add`
-button of the panel, which is marked with a `+ (plus)` symbol at the
-top of the panel.
+first one as default document root path. Just access the `Basics` tab,
+and set the `Document Root` field to '/var/www/example'.
+
-Next, setup `example.net` and `example.com` in the `Host match`
-tab. To do so just choose `Wildcards` as method and add both names as
-wildcard strings. We'll erase everything in the *Targets* list within
-the `Behavior` tab, except the `default` rule. With this we'll only be
-able to serve static content.
+Next, setup `example.net` and `example.com` in the `Host match` tab,
+so that requests to both domains can be managed byt your `example`
+virtual server. To do so just choose `Wildcards` as method, and add
+both names as wildcard strings. We'll erase everything in the
+*Targets* list within the `Behavior` tab, except the `default`
+rule. With this we'll only be able to serve static content.
+
Accessing the URL http://example.org should now show a list of
available files and directories under '/var/www/example/'.
+
-Now lets password protect the `auth` directory. Add a new `Directory`
-class rule pointing to `/auth`. Then, through the `Security` tab, add
-a `Validation Mechanism` under `Authentication`.
+Now lets password protect the `auth` directory. Add a new
+`Directory`-type rule pointing to `/auth`. Then, through the
+`Security` tab, add a `Validation Mechanism` under `Authentication`.
+
The field `Realm` is mandatory. Lets set it as `Secured Area`.
If you choose `PAM` and impose no more restrictions, only users with
@@ -321,11 +323,11 @@ details.
+
Note that the `Type` of the *Redirection* is `External`. This means
the server will instruct the requesting web client to fetch the
-redirected URL, which means the client will always know what the
-final URL is. This also means the redirection can be done to servers
-other than your own. If it were internal, the redirection would be
-invisible (not showing the target URL), but it would be limited to
-the same `virtual server`.
+redirected URL, which in turn means the client will always know what
+the final URL is. This also means the redirection can be done to
+servers other than your own. If it were internal, the redirection
+would be invisible (not showing the target URL), but it would be
+limited to the same `virtual server`.
+
A much more general redirection could be one using these values:
+
View
@@ -20,7 +20,7 @@ link:basics.html[Getting started]: Cherokee basics
link:config.html[Configuration]: Set up process explained
*********************************
- . link:config_quickstart.html[Quickstart]: Overview and walkthrough.
+ . link:config_quickstart.html[Walkthrough]: Overview and walkthrough.
. link:config_index.html[Home]: Main section.
. link:config_status.html[Status]: Server status information.
. link:config_general.html[General]: General settings.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ea33b08

Please sign in to comment.