changeset 1816:e5d723afd6ba

mod_http_upload: Add README
author Kim Alvefur <zash@zash.se>
date Tue, 01 Sep 2015 12:22:43 +0200 (2015-09-01)
parents abacf6698d97
children 1971ff719e72
files mod_http_upload/README.markdown
diffstat 1 files changed, 35 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_http_upload/README.markdown	Tue Sep 01 12:22:43 2015 +0200
@@ -0,0 +1,35 @@
+Introduction
+============
+
+This module provides a space for clients to upload files over HTTP, as
+used by [Conversations](http://conversations.im/).
+
+Configuration
+=============
+
+The module can either be configured as a component or added to an
+existing host or component.
+
+Component
+---------
+
+Standalone component:
+
+    Component "upload.example.org" "http_upload"
+
+Existing component
+------------------
+
+    Component "proxy.example.org" "proxy65"
+    modules_enabled = {
+      "http_upload";
+    }
+
+On VirtualHosts
+---------------
+
+    -- In the Global section or under a specific VirtualHosts line
+    modules_enabled = {
+      -- other modules
+      "http_upload";
+    }