JPT/filestorage
0
0
Fork 0
Code Issues Pull Requests Activity

Update README.md

Browse Source
This commit is contained in:
Jan Philipp Timme 2016-11-18 19:08:48 +01:00
parent c54898da7a
commit d8655bf42e
Signed by: JPT
GPG Key ID: 5F2C85EC6F3754B7
1 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,13 +1,23 @@
This is a simple file storage and permanent archive service.
It allows people to drop off files which are then assigned a uuid to link to.
# Filestorage
=Install dependencies=
This is a simple file storage and permanent archive service written in python using pyramid.
It allows people to drop off files through a REST API which are then assigned a UUIDv4 to link to.
This allows to easily achieve permanent links to files.
An easy to use web frontend for the api using jQuery is TBD.
##Install dependencies
```
export VENV=/path/to/venv
python3 -m venv $VENV
$VENV/bin/pip install -e .
```
##Run the application
=Run the application stand-alone=
```
$VENV/bin/pserve settings.ini --reload
```
The `--reload` option is optional and helpful for development purposes.
Also, different wsgi servers can be used. (More about that later)