uploadr/README.md

23 lines
795 B
Markdown
Raw Normal View History

2017-10-24 22:00:04 +00:00
# uploadr
Upload files to a server on your local network for faster and simpler file transfers across a network.
2017-10-25 12:02:59 +00:00
## 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
uploads = '/home/dannydevito/uploads' # uploaded files will be stored
qrcodes = '/home/dannydevito/qrcodes' # qr codes will be stored
2017-10-25 12:02:59 +00:00
# gunicorn
bind = "0.0.0.0:" + uploadr.port
```
## dependencies
uploadr uses the following modules:
- `flask`
- `qrcode`
- `werkzeug`