Description

This Flask application implements a server for uploading files according to XEP-0363.

It is supposed to be used with Prosody’s community module http_upload_external. Both, version 1 and 2 of the auth token validation are supported.

Requirements

To run this application Python 3.6 or higher is required.

Installation

1. Clone the repository to a suitable directory

2. Create a virtual environment:

   python3 -m venv venv
   

3. Install the required packages into the virtual environment:

   ./venv/bin/pip install -r requirements.txt
   

Configuration

A configuration file with the name config.py must exist in the root of the code directory. An example config.py.example with all available settings is provided in the repository.

The following settings can be changed:

SECRET_KEY

Required. It must have the same value as the setting in the mod_http_upload_external configuration.

XMPP_HTTP_UPLOAD_ROOT

Required. Path to the root directory where all files will be stored.

XMPP_HTTP_UPLOAD_USE_CORS

Optional. Flag to toggle CORS headers, which are required by web interfaces.

Usage

For testing purposes the application can be started with run.py or simply flask run. For production a WSGI server like uWSGI or mod_wsgi is recommended.

Contributing

Pull requests are always welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

AGPL

By submitting a pull request for this project, you agree to license your contribution under the AGPL license to this project.