Permalink
Browse files

Many new features were undocumented

git-svn-id: svn://cherokee-project.com/cherokee/trunk@3723 5dc97367-97f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent 6e2ae59 commit 5f2fcf6b20b122c0a9d3e9b1368cf005ad9fa258 taher committed Oct 16, 2009
View
@@ -94,6 +94,7 @@ modules_handlers_admin.html \
modules_handlers_proxy.html \
modules_handlers_secdownload.html \
modules_handlers_uwsgi.html \
+modules_handlers_empty_gif.html \
modules_loggers.html \
modules_loggers_combined.html \
modules_loggers_ncsa.html \
@@ -128,6 +129,7 @@ media/images/admin_advanced1.png \
media/images/admin_advanced2.png \
media/images/admin_advanced3.png \
media/images/admin_advanced4.png \
+media/images/admin_advanced5.png \
media/images/admin_behaviour.png \
media/images/admin_general.png \
media/images/admin_general_networking.png \
@@ -133,3 +133,12 @@ Special Files
useful to trace what is going on with Cherokee.
image::media/images/admin_advanced4.png[Cherokee Admin interface]
+
+[[tls]]
+TLS
+~~~
+* DH parameters:
+ Here you can specify the paths to your Diffie Hellman parameters PEM
+ files for 512, 1024, 2048 and 4096 bits.
+
+image::media/images/admin_advanced5.png[Cherokee Admin interface]
@@ -88,4 +88,5 @@ And these are the handlers that use balancing:
* link:modules_handlers_proxy.html[Reverse HTTP proxy]
* link:modules_handlers_fcgi.html[FastCGI]
* link:modules_handlers_scgi.html[SCGI]
+* link:modules_handlers_uwsgi.html[uWSGI]
* link:modules_handlers_dbslayer.html[MySQL bridge]
@@ -15,14 +15,18 @@ 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.
-Three main options are accessible through this menu:
+image::media/images/admin_vserver.png[Virtual server]
+
+Four main options are accessible through this menu:
. Virtual Server List
. Add new Virtual Server
. Clone Virtual Server
+. Wizards
+
*Cloning a Virtual Server* is simply a matter of selecting a target name
and a source virtual server currently present. Every setting will be
duplicated. From then onwards changes applied to any of them, be it
@@ -34,7 +38,15 @@ further work.
*To add a new Virtual Server* you have to enter the server name and a
valid Document Root directory.
-image::media/images/admin_vserver.png[Virtual server]
+*As for Wizards, these are configuration assistants that will allow
+you to set up a new virtual server tailored to some application's
+specific needs. The wizard will ask for some basic values, such as the
+name of the new virtual server or anything that might be needed to
+make its job, like deploying a Django application, installing
+Wordpress or whatever task you might have chosen. The wizards can also
+be run on a per-server basis, in which case instead of creating a new
+dedicated virtual server, the required changes will be added to the
+existing one.
--
- *Document Root*
@@ -173,6 +185,9 @@ presented, containing several fields of information:
. *Handler*: The handler that manages the requests that match this
rule. Read on for further details.
+ . *Root*: Indicates if the rule defines an alternative document root
+ path.
+
. *Auth*: Indicates if authentication is used for this rule. This
can be set up through the link:config_virtual_servers_rule.html[Rule
Entry] menu.
@@ -242,6 +257,18 @@ rule types:
mechanism inaccurate. An initial country must be added to the
rule, and more selections can be added in further steps.
+ * **Incoming IP/Port**: If the server is running on several ports,
+ this rule type will let you specify to which port's pettitions
+ will it apply.
+
+ * **Full Path**: Full path request to which content the
+ configuration will be applied. This means you can pinpoint a
+ list of files that will be specifcally targetted by this rule
+ type.
+
+ * **Connected from**: will let you discriminate connections based on
+ the IP or SubNet from which these are originated.
+
It is very important to know that these rules are prioritized. The
higher its priority is, the sooner they are checked. You could
think of a network routing table, it is quite similar. You can set the
@@ -293,6 +320,38 @@ Communicates with FastCGI servers.
+
Communicates with SCGI servers.
+- link:modules_handlers_uwsgi.html[uwsgi] - **uWSGI Server Support**
++
+Communicates with the uWSGI server.
+
+- link:modules_handlers_proxy.html[proxy] - **HTTP Reverse Proxy**
++
+Advanced proxy services.
+
+- link:modules_handlers_streaming.html[streaming] - **Audio/Video streaming**
++
+Media streaming directly within Cherokee.
+
+- link:modules_handlers_ssi.html[ssi] - **Server Side Includes**
++
+Enables Server Side Includes.
+
+- link:modules_handlers_secdownload.html[secdownload] - **Hidden Downloads**
++
+Creates one-time, secure, time-expiring downloads.
+
+- link:modules_handlers_dbslayer[dbslayer] - **MySQL Bridge**
++
+MySQL load-balancing database abstraction layer.
+
+- link:modules_handlers_custom_error.html[custom_error] - **HTTP Error**
++
+Generates customizable HTTP errors.
+
+- link:modules_handlers_empty_gif.html[empty_gif] - **1x1 Transparent GIF**
++
+Returns a 1 pixel transparent image.
+
- link:modules_handlers_server_info.html[Server Info] - **Server
Info**
+
@@ -314,6 +373,10 @@ Each of the mentioned handlers can be fine-tuned through that
menu. Refer to each handler's documentation if you are interested in
the available settings.
+These rules can also be combined with boolean operators, so you can
+apply AND to require two rules, NOT to negate and so forth. These can
+be nested as much as necessary.
+
[NOTE]
It is quite easy to fully specify a virtual server's behavior having
just some notions of Cherokee's way of working. However, there might
@@ -23,6 +23,9 @@ This menu offers the following tabs:
. Security: in this section one can configure *Access Restrictions*
and *Authentication*.
+ . Traffic Shaping: Sets an outbound traffic limit for this rule,
+ specified in bytes per second.
+
[[encoding]]
Encoding
~~~~~~~~
@@ -52,10 +55,15 @@ on the values you have configured. The available options are:
. 2038: Maximum date value representable in POSIX time.
. Custom Value: set a value by hand.
+[[security]]
+Security
+~~~~~~~~
+This section will give acces to access restriction settings and
+authentication settings.
+
[[restrictions]]
Access Restrictions
-~~~~~~~~~~~~~~~~~~~
-
+^^^^^^^^^^^^^^^^^^^
* Only https::
This configuration entry determines that the directory will be
served by the secure server (*https*) only.
@@ -76,7 +84,7 @@ Access Restrictions
[[examples]]
Examples
-^^^^^^^^
+++++++++
- Allow access only from the IPv6 localhost address
+
@@ -105,10 +113,9 @@ addresses and networks if you want
----
-
[[authentication]]
Authentication
-~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^
This parameter allows to configure user/password protected entries. A
validator has to be used in each Auth entry in order to specify the
View
@@ -98,6 +98,7 @@ link:modules.html[Modules]: Information about the standard modules
- link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
- link:modules_handlers_dbslayer.html[MySQL bridge]: MySQL over HTTP bridge.
- link:modules_handlers_admin.html[Remote Administration]: Cherokee administration handler.
+ - link:modules_handlers_empty_gif.html[1x1 Transparent GIF]: Returns a 1x1 pixel transparent GIF.
. link:modules_validators.html[Validators]: Authentication mechanisms.
- link:modules_validators_plain.html[Plain]: Plain file mechanism.
- link:modules_validators_htpasswd.html[htpasswd]: htpasswd mechanism.
View
@@ -17,6 +17,7 @@
- link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
- link:modules_handlers_dbslayer.html[MySQL bridge]: MySQL over HTTP bridge.
- link:modules_handlers_admin.html[Remote Administration]: Cherokee administration handler.
+ - link:modules_handlers_empty_gif.html[1x1 Transparent GIF]: Returns a 1x1 pixel transparent GIF.
. link:modules_validators.html[Validators]: Authentication mechanisms.
- link:modules_validators_plain.html[Plain]: Plain file mechanism.
- link:modules_validators_htpasswd.html[htpasswd]: htpasswd mechanism.
@@ -29,3 +29,4 @@ This is the list of standard handlers provided by Cherokee:
* link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
* link:modules_handlers_dbslayer.html[MySQL bridge]: MySQL over HTTP bridge.
* link:modules_handlers_admin.html[Remote Administration]: Cherokee administration handler.
+- link:modules_handlers_empty_gif.html[1x1 Transparent GIF]: Returns a 1x1 pixel transparent GIF.
@@ -0,0 +1,7 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
+Handler: 1x1 Transparent GIF
+----------------------------
+
+Nothing can be specified for this handler. It just return a 1 pixel
+transparent image.
View
@@ -173,3 +173,9 @@ rule at the beginning of the virtual server that matches the specific
file extensions and has the encoding enabled. Set the rule to be
non-final. That should do the trick.
+[[faq15]]
+=== I can't set TLS/SSL in Cherokee-Admin. There's no TLS/SSL (and
+nothing in the pulldown) for me.
+
+First, make sure openssl in installed. If you are not installing from
+source, most likely you've missed installing libcherokee-mod-libssl

0 comments on commit 5f2fcf6

Please sign in to comment.