alvierahman90/uploadr
1
0
Fork 0
mirror of https://github.com/alvierahman90/uploadr.git synced 2025-01-12 10:14:21 +00:00
Code Issues Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
alvierahman90 2017-10-25 13:02:59 +01:00
parent 7fb8dc7a0c
commit ea5f4528e0
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -1,2 +1,21 @@
# uploadr # uploadr
Upload files to a server on your local network for faster and simpler file transfers across a network. Upload files to a server on your local network for faster and simpler file transfers across a network.
## config
The config file for uploadr is very simple. It should be in a class called `uploadr` in a file called `config.py`. It should be valid python and the two options needed are `domain` and `port` which are both used for the creation of QR code links. The file can also be used as the config file for
gunicorn. Here is an example below:
```python
class uploadr:
domain = "example.com"
port = 8005
# gunicorn
bind = "0.0.0.0:" + uploadr.port
```
## dependencies
uploadr uses the following modules:
- `flask`
- `qrcode`
- `werkzeug`