Permalink
Browse files

Cleanup screenshots and add tables for readability

git-svn-id: svn://cherokee-project.com/cherokee/trunk@6395 5dc97367-97f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent 4a0eff0 commit f7368c53bca50676a1932a347f521a187472a7d0 taher committed Mar 21, 2011
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.
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.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
@@ -63,6 +63,20 @@ This is a pretty common example. It defines a directory called `cgi`
that points to a path out of the Sever root directory where the
CGI programs are located.
+.Handler CGI configuration
+[cols="50%,50%"]
+|====================================================================
+|Handler | CGI
+|Document Root | /usr/lib/cgi-bin
+|Script Alias | None
+|Change UID | Disabled
+|Error handler | Disabled
+|Check file | Enabled
+|Pass Request Headers | Enabled
+|Allow X-Sendfile | Disabled
+|====================================================================
+
+.Handler CGI intreface
image::media/images/admin_handler_cgi.png[CGI]
.Script Alias
@@ -45,7 +45,23 @@ Examples
Here is a basic example.
-.Configuration
+.Sample configuration
+|====================================================================
+|Field |Value
+|Handler | `Only listing`
+|Document Root | None
+|Show Size | Enabled
+|Show Date | Enabled
+|Show User | Disabled
+|Show Group | Disabled
+|Show Backup files | Disabled
+|Show Hidden files | Disabled
+|Allow symbolic links | Enabled
+|Redirect symbolic links | Disabled
+|Theme | `default`
+|====================================================================
+
+.Configuration screenshot
image::media/images/admin_handler_dirlist.png[Dirlist configuration]
.Actual output
@@ -24,16 +24,37 @@ image::media/images/admin_handler_custom_error.png[Handler Custom Error]
|=====================================
|Code |Description
|400 |Bad Request
+|401 |Unauthorized
+|402 |Payment Required
|403 |Forbidden
|404 |Not Found
|405 |Method Not Allowed
+|406 |Not Acceptable
+|407 |Proxy Auth Required
+|408 |Request Timeout
+|409 |Conflict
+|410 |Gone
+|411 |Length Required
+|412 |Precondition Failed
|413 |Request Entity too large
|414 |Request-URI too long
+|415 |Unsupported Media Type
|416 |Requested range not satisfiable
+|417 |Expectation Failed
+|422 |Unprocessable Entity
+|423 |Locked
+|424 |Failed Dependency
+|425 |Unordered Collection
+|426 |Upgrade Required
+|449 |Retry With
|500 |Internal Server Error
|501 |Not Implemented
|502 |Bad gateway
|503 |Service Unavailable
|504 |Gateway Timeout
|505 |HTTP Version Not Supported
+|506 |Variant Also Negotiates
+|507 |Insufficient Storage
+|509 |Bandwidth Limit Exceeded
+|510 |Not Extended
|=====================================
@@ -27,6 +27,7 @@ bandwidth.
. More languages available: besides JSON, the handler can also return
the information to be used directly by Python, Ruby and PHP.
+.Interface example
image::media/images/admin_handler_dbslayer.png[DBSlayer]
It also makes use of a link:modules_balancers.html[balancing strategy]
@@ -16,8 +16,11 @@ Parameters: Listing
|Parameters |Type |Description
|`size` |boolean |Optional. Display the size of files in the
listings. Default: `Enabled`.
-|`date` |boolean |Optional. Display the last modification date of the files and directories in the listings.
+
+|`date` |boolean |Optional. Display the last modification date of
+ the files and directories in the listings.
Default: `Enabled`.
+
|`user` |boolean |Optional. Display the owner of the files and
directories in the listings.
Default: `Disabled`.
@@ -60,10 +63,28 @@ the listed files and you'll be able to select it in `cherokee-admin`.
Examples
~~~~~~~~
-This configuration
+This is just one of many possible configurations.
+
+.Sample configuration
+|====================================================================
+|Field |Value
+|Handler | `Only listing`
+|Document Root | None
+|Show Size | Enabled
+|Show Date | Enabled
+|Show User | Disabled
+|Show Group | Disabled
+|Show Backup files | Disabled
+|Show Hidden files | Disabled
+|Allow symbolic links | Enabled
+|Redirect symbolic links | Disabled
+|Theme | `default`
+|====================================================================
+.Sample configuration screenshot
image::media/images/admin_handler_onlylisting.png[Only listing configuration]
-will return something like
+The output given by such configuration is a simple directory listing
+that can be sorted by any of its columns.
image::media/images/admin_handler_onlylisting_ex.png[Only listing example]
@@ -49,4 +49,5 @@ examples on how to configure this
handler. The recipe about link:cookbook_php.html[setting up PHP] is a
good starting point.
+.FastCGI Interface
image::media/images/admin_handler_fastcgi1.png[FastCGI]
@@ -28,6 +28,14 @@ Examples
~~~~~~~~
Lets imagine your virtual server DocumentRoot points to /var/www.
+[cols="25%,75%"]
+|===================================================
+|Handler | `Static Content`
+|Document Root | No custom Document Root will fall back to the default one defined for the virtual server.
+|Use I/O cache | `Enabled`
+|===================================================
+
+.Handler Static Content
image::media/images/admin_handler_file.png[Handler file]
This is a simple example that will make Cherokee able of serving each
@@ -39,21 +39,21 @@ steps.
rules. It then dispatches the request to one of the machines in the
pool of specified `information sources`.
+.Phase 1
image::media/images/proxy_phase1.png[Phase 1]
* Phase 2: Once the server that has received the request sends back the
response, the reverse proxy deletes the unnecessary return HTTP
headers and sends the response back to the requesting client.
+.Phase 2
image::media/images/proxy_phase2.png[Phase 2]
To use the HTTP reverse proxy handler you simply have to specify
several parameters. First define a series of
link:config_info_sources.html[information sources]. Those will be the
ones handling the requests in the end.
-image::media/images/admin_handler_proxy.png[Reverse Proxy]
-
Then you will have to specify the Reverse Proxy Settings by adjusting
the following settings.
@@ -107,3 +107,5 @@ Back-end Servers
sources, which are all the servers from the set to be used in the
cluster of web servers.
+.Reverse Proxy
+image::media/images/admin_handler_proxy.png[Reverse Proxy]
@@ -81,6 +81,15 @@ handled by **Hidden Downloads**. We set a shared secret string
(`Abracadabra`), and the document root where the real ISO files are
located (`/mnt/isos`):
+.Configuration for directory /downloads
+[cols="50%,50%"]
+|==================================================================
+|Handler | `Hidden Downloads`
+|Document Root| /mnt/isos
+|Secret | Abracadabra
+|==================================================================
+
+.Hidden downloads configuration
image::media/images/admin_handler_secdownload.png[Hidden Downloads configuration]
To summarize, its a four step process:
@@ -30,8 +30,7 @@ Some can only handle one of those mechanisms because of technical
limitations. In case the module supports both of them, the interface
allows to choose whether one or both are to be used.
-Here is an interface example from a simple validator:
-
+.Interface sample for simple validator
image::media/images/admin_validators_pam.png[Validator PAM]
Refer to the link:cookbook_authentication.html[Authentication] recipe
@@ -28,6 +28,7 @@ The parameter that specifies the file containing the pairs
You can and should place the password file outside the web tree to
prevent remote users from accessing the list.
+.Security tab
image::media/images/admin_validators_plain.png[Validator Plain]
This could be the contents of the the file `/var/www/passwd` specified

0 comments on commit f7368c5

Please sign in to comment.