prosody-modules: mod_http_upload/README.markdown@1266f5c17c0d (annotated)

1917 188c38c1a711 mod_http_upload/README: Update with XEP reference, stage, description Kim Alvefur <zash@zash.se> parents: 1866 diff changeset	1	---
188c38c1a711 mod_http_upload/README: Update with XEP reference, stage, description Kim Alvefur <zash@zash.se> parents: 1866 diff changeset	2	description: HTTP File Upload
2288 1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	3	labels: 'Stage-Alpha'
1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	4	---
1917 188c38c1a711 mod_http_upload/README: Update with XEP reference, stage, description Kim Alvefur <zash@zash.se> parents: 1866 diff changeset	5
1820 e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	6	Introduction
e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	7	============
e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	8
2288 1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	9	This module implements [XEP-0363], which lets clients upload files
1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	10	over HTTP.
1820 e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	11
e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	12	Configuration
e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	13	=============
e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	14
1844 3bd265f7a95f mod_http_upload/README: Point to Prosodys HTTP docs Kim Alvefur <zash@zash.se> parents: 1820 diff changeset	15	mod\_http\_upload relies on Prosodys HTTP server and mod\_http for
2288 1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	16	serving HTTP requests. See [Prosodys HTTP server documentation][doc:http]
1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	17	for information about how to configure ports, HTTP Host names etc.
1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	18
1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	19	The module can be added as a new Component definition:
1844 3bd265f7a95f mod_http_upload/README: Point to Prosodys HTTP docs Kim Alvefur <zash@zash.se> parents: 1820 diff changeset	20
2288 1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	21	``` {.lua}
1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	22	Component "upload.example.org" "http_upload"
1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	23	```
1820 e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	24
2288 1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	25	Alternatively it can be added to `modules_enabled` like other modules.
1820 e5d723afd6ba mod_http_upload: Add README Kim Alvefur <zash@zash.se> parents: diff changeset	26
1855 03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	27	Limits
03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	28	------
03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	29
03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	30	A maximum file size can be set by:
03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	31
03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	32	``` {.lua}
2056 ad2966b932ed mod_http_upload/README: Mention default upload size limit and change example to something that nobody should copy Kim Alvefur <zash@zash.se> parents: 1971 diff changeset	33	http_upload_file_size_limit = 123 -- bytes
1855 03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	34	```
03c5639882a7 mod_http_upload: Add support for a file size limit Kim Alvefur <zash@zash.se> parents: 1851 diff changeset	35
2288 1266f5c17c0d mod_http_upload: Mention modules_enabled, but no example Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	36	Default is 1MB (1024\*1024).
2056 ad2966b932ed mod_http_upload/README: Mention default upload size limit and change example to something that nobody should copy Kim Alvefur <zash@zash.se> parents: 1971 diff changeset	37
1971 2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	38	Path
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	39	----
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	40
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	41	By default, uploaded files are put in a sub-directory of the default
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	42	Prosody storage path (usually `/var/lib/prosody`). This can be changed:
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	43
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	44	``` {.lua}
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	45	http_upload_path = "/path/to/uploded/files"
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	46	```
2ce2b194d501 mod_http_upload: Make file system path configurable Kim Alvefur <zash@zash.se> parents: 1917 diff changeset	47
1851 cd98a1103ecf mod_http_upload/README: Say it works with 0.9+ Kim Alvefur <zash@zash.se> parents: 1844 diff changeset	48	Compatibility
cd98a1103ecf mod_http_upload/README: Say it works with 0.9+ Kim Alvefur <zash@zash.se> parents: 1844 diff changeset	49	=============
cd98a1103ecf mod_http_upload/README: Say it works with 0.9+ Kim Alvefur <zash@zash.se> parents: 1844 diff changeset	50
cd98a1103ecf mod_http_upload/README: Say it works with 0.9+ Kim Alvefur <zash@zash.se> parents: 1844 diff changeset	51	Works with Prosody 0.9.x and later.

author	Kim Alvefur <zash@zash.se>
	Sat, 20 Aug 2016 18:33:43 +0200
changeset 2288	1266f5c17c0d
parent 2219	e276ed33bc1a
child 2330	8fad27d568aa
permissions	-rw-r--r--