github/supysonic
1
0
Fork 0
mirror of https://github.com/spl0k/supysonic.git synced 2024-12-22 17:06:17 +00:00
Code Issues Releases Wiki Activity

Updated README

Browse Source
This commit is contained in:
spl0k 2014-06-12 16:06:46 +02:00
parent 5aca224616
commit f77fefbf9b
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -24,10 +24,10 @@ or as a WSGI application (on Apache for instance). But first:
* Python 2.7 * Python 2.7
* [Flask](http://flask.pocoo.org/) >= 0.9 (`pip install flask`) * [Flask](http://flask.pocoo.org/) >= 0.9 (`pip install flask`)
* [SQLAlchemy](http://www.sqlalchemy.org/) (`apt-get install python-sqlalchemy`) * [Storm](https://storm.canonical.com/) (`apt-get install python-storm`)
* Python Imaging Library (`apt-get install python-imaging`) * Python Imaging Library (`apt-get install python-imaging`)
* simplejson (`apt-get install python-simplejson`) * simplejson (`apt-get install python-simplejson`)
* [requests](http://docs.python-requests.org/) >= 0.12.1 (`pip install requests`) * [requests](http://docs.python-requests.org/) >= 1.0.0 (`pip install requests`)
* [mutagen](https://code.google.com/p/mutagen/) (`apt-get install python-mutagen`) * [mutagen](https://code.google.com/p/mutagen/) (`apt-get install python-mutagen`)
### Configuration ### Configuration
@ -38,8 +38,9 @@ or `KEY: VALUE` syntax.
Available settings are: Available settings are:
* Section **base**: * Section **base**:
* **database_uri**: required, a SQLAlchemy [database URI](http://docs.sqlalchemy.org/en/rel_0_8/core/engines.html#database-urls). * **database_uri**: required, a Storm [database URI](https://storm.canonical.com/Manual#Databases).
I personally use SQLite (`sqlite:////var/supysonic/supysonic.db`), but it might not be the brightest idea for large libraries. I personally use SQLite (`sqlite:////var/supysonic/supysonic.db`), but it might not be the brightest idea for large libraries.
Note that to use PostgreSQL you'll need *psycopg2* version 2.4 (not 2.5!) or [patch storm](https://bugs.launchpad.net/storm/+bug/1170063).
* **cache_dir**: path to a cache folder. Mostly used for resized cover art images. Defaults to `<system temp dir>/supysonic`. * **cache_dir**: path to a cache folder. Mostly used for resized cover art images. Defaults to `<system temp dir>/supysonic`.
* **log_file**: path and base name of a rolling log file. * **log_file**: path and base name of a rolling log file.
* **scanner_extensions**: space-separated list of file extensions the scanner is restricted to. If omitted, files will be scanned * **scanner_extensions**: space-separated list of file extensions the scanner is restricted to. If omitted, files will be scanned
@ -51,6 +52,11 @@ Available settings are:
* Section **mimetypes**: extension to content-type mappings. Designed to help the system guess types, to help clients relying on * Section **mimetypes**: extension to content-type mappings. Designed to help the system guess types, to help clients relying on
the content-type. See [the list of common types](https://en.wikipedia.org/wiki/Internet_media_type#List_of_common_media_types). the content-type. See [the list of common types](https://en.wikipedia.org/wiki/Internet_media_type#List_of_common_media_types).
### Database initialization
Supysonic does not issue the `CREATE TABLE` commands for the tables it needs. Thus the tables must be created prior to
running the application. Table creation scripts are provided in the *schema* folder for SQLite, MySQL and PostgreSQL.
Running the application Running the application
----------------------- -----------------------
@ -63,8 +69,8 @@ To start the server, just run the `debug_server.py` script.
python debug_server.py python debug_server.py
By default, it will listen on the loopback interface (127.0.0.1) on port 5000, but you can specify another address on the command line, By default, it will listen on the loopback interface (127.0.0.1) on port 5000, but you can specify another address on
for instance on all the IPv6 interfaces: the command line, for instance on all the IPv6 interfaces:
python debug_server.py :: python debug_server.py ::