Permalink
Browse files

Documentation updates

git-svn-id: svn://cherokee-project.com/cherokee/trunk@5241 5dc97367-97f1-0310-9951-d761b3857238
  • Loading branch information...
1 parent 2a4166a commit 4afe5e69a535cdf4eac105882ba75139a1c8fdff taher committed Jun 24, 2010
View
@@ -93,6 +93,7 @@ modules_handlers_fcgi.html \
modules_handlers_scgi.html \
modules_handlers_server_info.html \
modules_handlers_ssi.html \
+modules_handlers_postreport.html \
modules_handlers_streaming.html \
modules_handlers_admin.html \
modules_handlers_proxy.html \
@@ -100,11 +100,11 @@ each distribution offers its own tools to do so.
[[APT]]
APT
~~~
+
This section is intended for those who use Debian and Ubuntu and want
-to use the latest
-If the latest and greatest version of Cherokee is not yet available on
-your APT repositories, you can do several things besides installing
-manually.
+to use the latest -and greatest- version of Cherokee when it is not
+yet available on the APT repositories. You can do several things
+besides installing manually.
For Ubuntu users, simply use the PPA repository. Normally when a new
Cherokee version is released, the repository will have it almost in
@@ -158,3 +158,54 @@ This will probably pull newer versions of libssl-dev, libssl0.9.8 and
mysql-common to fulfill dependencies. Of course, this _might_ break
other packages depending on those specific versions, but it is not
very likely.
+
+
+[[debian_from_source]]
+Debian package from source
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+PPA and Unstable repositories keep up to date with the latest Cherokee
+releases. Usually the time lapse between releasing a new version and
+having the repositories updated is really short.
+
+However, in the event that they arent, some options remain if you want
+to enjoy the latest Cherokee enhancements. Besides building directly
+from our SVN repository, you can build from source for
+Debian/Ubuntu. You will be able to build it cleanly in a `.deb`
+package with dependencies, and push the new release as fast as
+possible to production.
+
+The process is very straight forward. As with any Debian package, it
+should be enough just to download the source package, get its
+build-dependencies, and build.
+
+----
+$ apt-get source cherokee
+(...)
+$ sudo apt-get build-dep cherokee
+(...)
+$ cd cherokee-* # depending on your version
+$ debuild
+----
+
+Of course, if you want to contribute to Debian/Ubuntu packaging, it is
+a _bit_ more involved.
+
+You should instead clone the Git repository at
+link:git://git.debian.org/collab-maint/cherokee.git[git://git.debian.org/collab-maint/cherokee.git]
+
+After that, the process for building is very similar. You only need to
+get Cherokee's official sources, which can be done running the
+following command within the Cherokee tree:
+
+----
+$ uscan --force
+----
+
+And build using git-buildpackage:
+
+----
+$ git-buildpackage
+----
+
+That's it.
View
@@ -33,21 +33,23 @@ straightforward actions is order to enable it:
. The first step is to enable a TLS/SSL engine. The option is
located in the link:config_general.html[General] configuration
- setting. Cherokee is shipped with an libssl plug-in.
+ setting. Cherokee is shipped with a libssl plug-in.
. Once the engine is configured, a new
link:config_general.html#ports_to_listen[binding port] must be
configured. By default, HTTPS uses the port 443. Remember to add
this port, and to check the TLS toggle button.
. The last step would be to assign SSL certificates to the virtual
- servers, starting with the default virtual server.
- Cherokee uses SNI to distinguish between virtual servers, the
- certificate specified in the default server will be used in the
- first negotiation. If not present, the startup sequence will
- fail. The configuration is found inside each
+ servers, starting with the default virtual server. Cherokee uses
+ SNI to distinguish between virtual servers. The certificate
+ specified in the default server will be used in the first
+ negotiation. If not present, the startup sequence will fail. The
+ configuration is found inside each
link:config_virtual_servers.html#security[virtual server]
- configuration, under the Security tab.
+ configuration, under the Security tab. This part is _very
+ important_: you have to concatenate your certificates into a
+ single file in order to use them in Cherokee.
.How to manually test HTTP/HTTPS?
View
@@ -97,6 +97,7 @@ link:modules.html[Modules]: Information about the standard modules
- link:modules_handlers_uwsgi.html[uWSGI]: uWSGI protocol.
- link:modules_handlers_proxy.html[HTTP reverse proxy]: Surrogate/reverse proxy handler.
- link:modules_handlers_ssi.html[Server Side Includes]: SSI Server Support.
+ - link:modules_handlers_postreport.html[Upload Reporting]: Show an upload progress bar.
- link:modules_handlers_streaming.html[Audio/Video Streaming]: Media streamer.
- link:modules_handlers_secdownload.html[Hidden Downloads]: Secure, Time expiring downloads.
- link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
View
@@ -12,6 +12,7 @@
- link:modules_handlers_uwsgi.html[uWSGI]: uWSGI protocol.
- link:modules_handlers_proxy.html[HTTP reverse proxy]: Surrogate/reverse proxy handler.
- link:modules_handlers_ssi.html[Server Side Includes]: SSI Server Support.
+ - link:modules_handlers_postreport.html[Upload Reporting]: Show an upload progress bar.
- link:modules_handlers_streaming.html[Audio/Video Streaming]: Media streamer.
- link:modules_handlers_secdownload.html[Hidden Downloads]: Secure, Time expiring downloads.
- link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
View
@@ -24,6 +24,7 @@ This is the list of standard handlers provided by Cherokee:
* link:modules_handlers_uwsgi.html[uWSGI]: uWSGI protocol.
* link:modules_handlers_proxy.html[HTTP reverse proxy]: Surrogate/reverse proxy handler.
* link:modules_handlers_ssi.html[Server Side Includes]: SSI Server Support.
+* link:modules_handlers_postreport.html[Upload Reporting]: Show an upload progress bar.
* link:modules_handlers_streaming.html[Audio/Video Streaming]: Media streamer.
* link:modules_handlers_secdownload.html[Hidden Downloads]: Secure, Time expiring downloads.
* link:modules_handlers_server_info.html[Server Info]: Provide info about Cherokee.
@@ -0,0 +1,25 @@
+== link:index.html[Index] -> link:modules.html[Modules] -> link:modules_handlers.html[Handlers]
+
+Handler: Upload Reporting
+-------------------------
+
+The 'Upload Progress' plug-in provides feedback to the web browser
+about the status of an ongoing POST request.
+
+To make it more convenient, it is implemented so that you don't have
+to change a single line of code in your applications. It is compatible
+with Lighttpd's mod_uploadprogress, Nginx's
+NginxHttpUploadProgressModule, and Apache's equivalent, so chances are
+you'll be able to do a seamless migration.
+
+To make use of the plugin you'll need some code on the client
+side. Many Javascript snippets and Flash modules are available for
+free. The
+link:http://github.com/drogus/jquery-upload-progress[jQuery-upload-progress]
+module has given fairly good results in the past, but there are many
+other options available.
+
+
+////
+Example required: Add code snippet.
+////

0 comments on commit 4afe5e6

Please sign in to comment.