Permalink
Browse files

Work in progress addressing issue 980 regarding text-friendliness

git-svn-id: svn://cherokee-project.com/cherokee/trunk@6393 5dc97367-97f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent fe8a6ed commit bebdecb114304e1aa9e49f895b939fc74beabd5f taher committed Mar 18, 2011
View
@@ -11,6 +11,7 @@ parameters. You should not attempt to do so unless you really know
what you are doing. For most cases the default parameters will work
just fine.
+.Warning
image::media/images/admin_advanced0.png[Cherokee Admin interface]
You should at least read the chapter
@@ -47,6 +48,7 @@ Connections
These allow to configure the range of file sizes that can be sent
with `sendfile()`. Default: [32768 Bytes - 2 GB].
+.Connections
image::media/images/admin_advanced1.png[Cherokee Admin interface]
[[resources]]
@@ -91,6 +93,7 @@ Resources
Time interval in seconds between Nonce cache clean ups. Defaults to
60 seconds.
+.Resources
image::media/images/admin_advanced2.png[Cherokee Admin interface]
[[io_cache]]
@@ -116,6 +119,7 @@ I/O cache
* Lasting _mmap_:
Specifies how long the file contents last cached.
+.IO/Cache
image::media/images/admin_advanced3.png[Cherokee Admin interface]
[[special_files]]
@@ -135,6 +139,7 @@ Special Files
If specified, a PID file will be created in that path. This is
useful to trace what is going on with Cherokee.
+.Special files
image::media/images/admin_advanced4.png[Cherokee Admin interface]
[[tls]]
@@ -144,4 +149,5 @@ TLS
Here you can specify the paths to your Diffie Hellman parameters PEM
files for 512, 1024, 2048 and 4096 bits.
+.TLS
image::media/images/admin_advanced5.png[Cherokee Admin interface]
View
@@ -10,7 +10,8 @@ General Configuration
Network
~~~~~~~
-image::media/images/admin_general_networking.png[General]
+.Network settings
+image::media/images/admin_general_networking.png[Network]
IPv6 support
@@ -60,6 +61,7 @@ the link:other_graphs.html[usage graphs] section for more details.
Ports to listen
~~~~~~~~~~~~~~~
+.Ports
image::media/images/admin_general_ports.png[Ports to listen]
This section allows to configure the ports that the server will be
@@ -68,12 +70,13 @@ whether they will be used for HTTP or HTTPS.
Each binding entry can be configured to listen to a network
interface. In case the text entry is empty, the server will accept
-connection from the port on any interface.
+connections from that port on any interface.
[[server_permissions]]
Server Permissions
~~~~~~~~~~~~~~~~~~
+.Permissions
image::media/images/admin_general_permissions.png[Server Permissions]
User & Group
@@ -126,6 +129,7 @@ link:modules_handlers_dirlist.html[dirlist] handler.
- **Default**: This is the icon that will be shown if any of the
previous ones matched.
+.Icons
image::media/images/admin_general_icons.png[Icons]
@@ -142,4 +146,5 @@ existing ones.
* *Max Age*: defines for how long a file of this type must be cached at
the client's side.
+.MIME Types
image::media/images/admin_general_mime.png[MIME Types]
View
@@ -14,7 +14,8 @@ Cherokee-Admin without leaving the web interface, which might be
convenient particularly if you have launched it using
link:other_bundle_cherokee-admin-launcher.html[cherokee-admin-launcher].
-image::media/images/admin_index.png[Status]
+.Cherokee Admin's home page
+image::media/images/admin_index.png[Home]
This section also enables you to change Cherokee-Admin's current user
language, and allows you to send feedback directly to Cherokee
@@ -62,10 +63,12 @@ You can associate description notes to each saved configuration, and
it will be stored along the date of creation so that you can easily
retrieve it in the future.
+.Backup dialog
image::media/images/admin_index_backup.png[Backup]
And of course, you can restore any previous configuration state at any
given moment. This makes it very easy to experiment with Cherokee,
without ever worrying about breaking your configuration.
+.Restore dialog
image::media/images/admin_index_restore.png[Restore]
@@ -43,6 +43,7 @@ and depending of the situation one or the other setting might not
make much sense. In such occasions `cherokee-admin` will simply hide
whatever options do not apply.
+.PHP information source
image::media/images/admin_info_sources.png[Information Sources]
[[daemonization]]
@@ -19,7 +19,8 @@ When the server receives a request it will try to match the domain
name specified in the virtual server that should handle it. In case no
virtual server matches the request, `default` will be used.
-image::media/images/admin_vserver.png[Virtual server]
+.Host Match
+image::media/images/admin_vserver.png[Host Match]
This section of the admin is divided in a left panel and main contents
section on the right.
@@ -317,6 +318,7 @@ on the rule name, the rule's configuration options will be displayed
in the main content area. If you click anywhere else, you will be able
to drag and drop it into the desired position).
+.Rule list
image::media/images/admin_behavior.png[Virtual server]
Each of these behavior rules must specify the handler that the server
@@ -411,12 +413,14 @@ Several mechanisms exist to handle errors.
Using the 'Custom redirections' error handler we can easily redirect
errors to a custom path or website.
+.Error Handler
image::media/images/admin_vserver_errors.png[Virtual server]
-In this case, the handled errors will be redirected to the specified
-resource, while non-defined errors will trigger an HTTP 500 error. In
-case this is not the desired behavior, you can set a `Default Error`
-to catch and redirect the non-defined ones.
+In this case, the handled errors (400, 401, and 500) will be
+redirected to the specified resources, while non-defined errors will
+trigger an HTTP 500 error. In case this is not the desired behavior,
+you can set a `Default Error` to catch and redirect the non-defined
+ones.
The 'Closest match' error handler should never fail to deliver
something. If a requested resource is not available, the closest match
@@ -439,7 +443,8 @@ and/or formats:
If a virtual server doesn't have a logger set up it will not log anything.
-image::media/images/admin_vserver_loggers.png[Virtual server]
+.Logging
+image::media/images/admin_vserver_loggers.png[Logging configuration]
By default Cherokee ships three loggers implementing three different
logging formats:
@@ -476,6 +481,7 @@ Cherokee fully supports the usage of different certificates for each
virtual server in a given host by using SNI as defined in
link:http://www.rfc-archive.org/getrfc.php?rfc=3546[RFC 3546].
+.Security
image::media/images/admin_vserver_security.png[Certificates]
If you want HTTPS to work, you must remember this:
@@ -489,7 +495,6 @@ If you want HTTPS to work, you must remember this:
link:cookbook_ssl.html#ssl-support[enabling SSL support] on the
SSL/TLS section of the documentation.
-
. If you have several virtual servers, the `Security` section must be
configured for the `default` virtual server besides any other
virtual server you want to support HTTPS. This makes sense, since by
@@ -12,6 +12,7 @@ virtual server is built dynamically, so even if the domains share a
common configuration they can use a number of different Document Root
directories.
+.Basics
image::media/images/admin_vserver_evhost.png[Advanced Virtual Hosting]
The following replacement variables are supported. Let's suppose a
View
@@ -156,13 +156,13 @@ with the default settings.
image::media/images/admin_noconfig.png[cherokee.conf not present]
-That is a good starting point. Right now your web server will not be
-running yet. We will only be using two of the available tabs to adjust
-some more settings: link:config_general.html[General] and
+The regular template is a good starting point. Right now your web
+server will not be running yet. We will only be using two of the
+available tabs to adjust some more settings:
+link:config_general.html[General] and
link:config_virtual_servers.html[Virtual Servers].
-This is an example of what you'll be seeing:
-
+.Sample view
image::media/images/admin_notrunning.png[Server not launched]
Of course, once we're done we will have to apply our changes and
@@ -181,8 +181,7 @@ 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:
-
+.Sample of tab for general settings
image::media/images/admin_general.png[General]
We will only be modifying the *Permissions* tab. It usually is a poor
@@ -191,8 +190,9 @@ choice to run services with super user privileges. Set both *User* and
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[vServers] tab:
+Next is the link:config_virtual_servers.html[vServers] tab.
+.Virtual server tab
image::media/images/admin_vserver.png[Virtual server]
When you start, you will only have one virtual server called
@@ -307,8 +307,17 @@ examples on the different options.
+
Lastly, lets configure a redirection rule by choosing a "Regular
Expression" as the new rule type. Type the following regex: `^/rss.*$`
-Then, within the `Handler` selection tab specify a target: `/feed`
+Then, configure the `Handler` tab with the following settings.
+
+. *Handler*: `Redirection`
+. *Type*: `External`
+. *Regular Expression*: you can leave it empty or specify a series of
+ new matches. The shot has the base regex for ilustration purposes:
+ `^/rss.*$`
+. *Substitution*: this will be the target: `/feed`
+
+
+.Redirection handler
image::media/images/admin_rule_regex.png[Regex]
+
And voilà! A request of the form http://example.net/rss2 would be

0 comments on commit bebdecb

Please sign in to comment.