view mod_http_upload/README.markdown @ 2215:e276ed33bc1a

mod_http_upload/README: Simplify instructions, show only one method
author Kim Alvefur <zash@zash.se>
date Fri, 24 Jun 2016 14:35:14 +0200
parents 40056a27f394
children 1266f5c17c0d
line wrap: on
line source

---
labels: Stage-Alpha
description: HTTP File Upload
...

Introduction
============

This module implements [XEP-0363], which lets clients upload files over
HTTP.

Configuration
=============

mod\_http\_upload relies on Prosodys HTTP server and mod\_http for
serving HTTP requests. See [Prosodys HTTP server
documentation](https://prosody.im/doc/http) for information about how to
configure ports, HTTP Host names etc.

Simply add a new Component definition:

    Component "upload.example.org" "http_upload"

Limits
------

A maximum file size can be set by:

``` {.lua}
http_upload_file_size_limit = 123 -- bytes
```

Default is 1MB (1024*1024).

Path
----

By default, uploaded files are put in a sub-directory of the default
Prosody storage path (usually `/var/lib/prosody`). This can be changed:

``` {.lua}
http_upload_path = "/path/to/uploded/files"
```

Compatibility
=============

Works with Prosody 0.9.x and later.