sqozz/schort
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Update README.md

Browse source 
More README!
This commit is contained in:
Sqozz 2016-02-11 00:10:38 +01:00
parent 755c539960
commit 1547fdb95a
1 changed files with 19 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
README.md
View file

@ -1,4 +1,20 @@
# schort
schort is a tiny link shortener written in python3 and flask
# schort - It's just is a tiny link shortener
## Installation instructions:
1. Clone this repo into e.g. /opt/schort
2. Create a "data" folder inside the repo which is writable by the webserver
2. Install requirements (see below)
3. Configure your wsgi or fcgi server
4. Configure your webserver that he talks to your wsgi/fcgi server
You need to create a directory /data/ which is writable by the webserver, which will contain the link database.
## Requirements:
| Module | Explanation |
| ------------- |---------------|
| Flask | Flask handels all HTTP-stuff in this application |
| sqlite3 | In gentoo this useflag needs to be set while compiling python3 |
## µWSGI
The schort.wsgi file can be set as UWSGI_PROGRAM if you use uWSGI.
Keep in mind, that the UWSGI_DIR needs to be set to the path where schort.py resists.
This is because schort is not installed in a global scope. Since schort.wsgi imports schort.py it needs his workspace in the same folder.