moparisthebest/HttpUploadComponent
1
0
Fork 0
mirror of https://github.com/moparisthebest/HttpUploadComponent synced 2024-11-28 03:42:15 -05:00
Code Issues Releases Wiki Activity

edited readme

Browse Source
This commit is contained in:
Daniel Gultsch 2015-07-20 18:21:16 +02:00
parent dfc2c26bce
commit 4dde390ae5
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -13,12 +13,15 @@ Configuration happens in config.yml and is pretty straight forward.
```get_url``` and ```put_url``` are prefixes to the URLs. The put_url is usually a combination of your hostname and the port (Port can be ommited if HTTP default ports are being used) The GET URL can use a different host if you want to serve files using a standard nginx or another HTTP server that might be more suitable for serving files than a python script. ```get_url``` and ```put_url``` are prefixes to the URLs. The put_url is usually a combination of your hostname and the port (Port can be ommited if HTTP default ports are being used) The GET URL can use a different host if you want to serve files using a standard nginx or another HTTP server that might be more suitable for serving files than a python script.
For security purposes you should put the python script behind an HTTPS proxy or stunnel (remember to adapt the URLs) For security purposes you should put the python script behind an HTTPS proxy or stunnel (remember to adapt the URLs).
For quicker results you can also use the build in TLS encryption by setting the ```keyfile``` and ```certfile``` in the config file.
###Run ###Run
Running the component is as easy as invoking ```python server.py``` Running the component is as easy as invoking ```python server.py```
Some (unoffical) init scripts can be found in the contrib directory.
Feel free to write your own init scripts if necessary and contribute them back by creating a pull request. Feel free to write your own init scripts if necessary and contribute them back by creating a pull request.
###Clients ###Clients
Currently the only client with build in support is [Conversations](http://conversations.im). (unreleased version 1.5). Conversations uses this to send files to Multi User Conferences and to multiple resources in 1 on 1 chats. Currently the only client with build in support is [Conversations](http://conversations.im) where it is being used to send files to Multi User Conferences and to multiple resources in 1 on 1 chats.