From 2259d3e0a12b73b2e9054174f5faeb37d1bc6cd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sun, 4 Jun 2017 14:00:24 -0400 Subject: [PATCH 01/18] make dependencies clearer --- README.md | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5c06ca4..16172dc 100644 --- a/README.md +++ b/README.md @@ -22,14 +22,24 @@ or as a WSGI application (on Apache for instance). But first: ### Prerequisites +You'll need these to run Supysonic: + * Python 2.7 -* [Flask](http://flask.pocoo.org/) >= 0.9 (`pip install flask`) -* [Storm](https://storm.canonical.com/) (`apt-get install python-storm`) -* Python Imaging Library (`apt-get install python-imaging`) -* simplejson (`apt-get install python-simplejson`) -* [requests](http://docs.python-requests.org/) >= 1.0.0 (`pip install requests`) -* [mutagen](https://code.google.com/p/mutagen/) (`apt-get install python-mutagen`) -* [watchdog](https://github.com/gorakhargosh/watchdog) (`pip install watchdog`) +* [Flask](http://flask.pocoo.org/) >= 0.9 +* [Storm](https://storm.canonical.com/) +* [Python Imaging Library](https://github.com/python-pillow/Pillow) +* [simplejson](https://simplejson.readthedocs.io/en/latest/) +* [requests](http://docs.python-requests.org/) +* [mutagen](https://mutagen.readthedocs.io/en/latest/) +* [watchdog](https://github.com/gorakhargosh/watchdog) + +On a Debian-like OS (Debian, Ubuntu, Linux Mint, etc.), you can install them +this way: + + apt-get install python-flask python-storm python-imaging python-simplesjon python-requests python-mutagen python-watchdog + +You may also need a database specific package. For example, if you choose to +use MySQL, you will need to install `python-mysqldb`. ### Configuration From b27e04c66ae985e1c3fe3496880dad35533b3120 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 14:04:23 -0400 Subject: [PATCH 02/18] new link for UltraSonic, replace Subsonic app (deprecated) by DSub --- supysonic/templates/home.html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/supysonic/templates/home.html b/supysonic/templates/home.html index 91e0ae4..6191741 100644 --- a/supysonic/templates/home.html +++ b/supysonic/templates/home.html @@ -36,8 +36,8 @@
  • Android apps
    • From bd06173b4fc0a06ffa5e0a485bb72ae357da0114 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 14:06:34 -0400 Subject: [PATCH 03/18] make the installation process clearer --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 16172dc..2975b2a 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,9 @@ Installation ------------ Supysonic can run as a standalone application (not recommended for a "production" server) -or as a WSGI application (on Apache for instance). But first: +or as a WSGI application (on Apache for instance). To install it, run: + + python setup.py install ### Prerequisites From 1cee47850123dca1069ad721c2db5957c5ae7e88 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 14:12:54 -0400 Subject: [PATCH 04/18] use ATX headers instead of Setex since we are using more than 2 levels --- README.md | 19 ++++++------------- 1 file changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 2975b2a..c58e8bd 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Supysonic -========= +# Supysonic Supysonic is a Python implementation of the [Subsonic](http://www.subsonic.org/) server API. @@ -14,8 +13,7 @@ Current supported features are: For more details, go check the [API implementation status wiki page](https://github.com/spl0k/supysonic/wiki/API-implementation-status). -Installation ------------- +## Installation Supysonic can run as a standalone application (not recommended for a "production" server) or as a WSGI application (on Apache for instance). To install it, run: @@ -75,8 +73,7 @@ Available settings are: Supysonic does not issue the `CREATE TABLE` commands for the tables it needs. Thus the database and 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 ### As a standalone debug server @@ -127,8 +124,7 @@ As with WSGI, you might need to edit those file to suit your system configuratio Here are some quick docs on how to configure your server for [FastCGI](http://flask.pocoo.org/docs/deploying/fastcgi/) or [CGI](http://flask.pocoo.org/docs/deploying/cgi/). -Quickstart ----------- +## Quickstart To start using Supysonic, you'll first have to specify where your music library is located and create a user to allow calls to the API. @@ -140,17 +136,14 @@ rights to the user. Once the folder is created, don't forget to scan it to build take a while depending on your library size, so be patient). Once scanning is done, you can enjoy your music with the client of your choice. -Scanner daemon --------------- +## Scanner daemon Instead of manually running a scan every time your library changes, you can run a daemon that will listen to any library change and update the database accordingly. The daemon is `bin/supysonic-watcher` and can be run as an *init.d* script. -Upgrading ---------- +## Upgrading Some commits might introduce changes in the database schema. When that's the case migration scripts will be provided in the *schema/migration* folder, prefixed by the date of commit that introduced the changes. Those scripts shouldn't be used when initializing a new database, only when upgrading from a previous schema. - From eb8581f08c976bbdb4fc00566eed9493fff2b559 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 14:15:03 -0400 Subject: [PATCH 05/18] replace tabs by spaces for consistency --- README.md | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index c58e8bd..3f7904f 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ You'll need these to run Supysonic: On a Debian-like OS (Debian, Ubuntu, Linux Mint, etc.), you can install them this way: - apt-get install python-flask python-storm python-imaging python-simplesjon python-requests python-mutagen python-watchdog + apt-get install python-flask python-storm python-imaging python-simplesjon python-requests python-mutagen python-watchdog You may also need a database specific package. For example, if you choose to use MySQL, you will need to install `python-mysqldb`. @@ -82,36 +82,36 @@ hacking on the source. A standalone won't be able to serve more than one request To start the server, just run the `cgi-bin/server.py` script. - python cgi-bin/server.py + python cgi-bin/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, for instance on all the IPv6 interfaces: - python cgi-bin/server.py :: + python cgi-bin/server.py :: ### As an Apache WSGI application Supysonic can run as a WSGI application with the `cgi-bin/supysonic.wsgi` file. To run it within an Apache2 server, first you need to install the WSGI module and enable it. - apt-get install libapache2-mod-wsgi - a2enmod wsgi + apt-get install libapache2-mod-wsgi + a2enmod wsgi Next, edit the Apache configuration to load the application. Here's a basic example of what it looks like: - WSGIScriptAlias /supysonic /path/to/supysonic/cgi-bin/supysonic.wsgi - - WSGIApplicationGroup %{GLOBAL} - WSGIPassAuthorization On - Order deny,allow - Allow from all - + WSGIScriptAlias /supysonic /path/to/supysonic/cgi-bin/supysonic.wsgi + + WSGIApplicationGroup %{GLOBAL} + WSGIPassAuthorization On + Order deny,allow + Allow from all + You might also need to run Apache using the system default locale, as the one it uses might cause problems while scanning the library. To do so, edit the `/etc/apache2/envvars` file, comment the line `export LANG=C` and uncomment the `. /etc/default/locale` line. Then you can restart Apache. - service apache2 restart + service apache2 restart With that kind of configuration, the server address will look like *http://server/supysonic/* From 78b795dc4c2800e8abb3d894ba254258023be57c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 14:24:10 -0400 Subject: [PATCH 06/18] add a table of contents --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index 3f7904f..cf65c27 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,20 @@ Current supported features are: For more details, go check the [API implementation status wiki page](https://github.com/spl0k/supysonic/wiki/API-implementation-status). +## Table of contents + +* [Installation](#installation) + + [Prerequisites](#prerequisites) + + [Configuration](#configuration) + + [Database initialization](#database-initialization) +* [Running the application](#running-the-application) + + [As a standalone debug server](#as-a-standalone-debug-server) + + [As an Apache WSGI application](#as-an-apache-wsgi-application) + + [Other options](#other-options) +* [Quickstart](#quickstart) +* [Scanner daemon](#scanner-daemon) +* [Upgrading](#upgrading) + ## Installation Supysonic can run as a standalone application (not recommended for a "production" server) From 34fa03f719c718f144d23ddd2ea88481f45b8df9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 15:23:50 -0400 Subject: [PATCH 07/18] merge the wiki with the README --- README.md | 243 ++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 236 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index cf65c27..3a799bb 100644 --- a/README.md +++ b/README.md @@ -23,16 +23,20 @@ For more details, go check the [API implementation status wiki page](https://git + [As a standalone debug server](#as-a-standalone-debug-server) + [As an Apache WSGI application](#as-an-apache-wsgi-application) + [Other options](#other-options) +* [Transcoding](#transcoding) +* [Command line parameters](#command-line-parameters) + + [Examples](#examples) * [Quickstart](#quickstart) * [Scanner daemon](#scanner-daemon) * [Upgrading](#upgrading) +* [Current target API version](#current-target-api-version) ## Installation Supysonic can run as a standalone application (not recommended for a "production" server) or as a WSGI application (on Apache for instance). To install it, run: - python setup.py install + $ python setup.py install ### Prerequisites @@ -50,7 +54,7 @@ You'll need these to run Supysonic: On a Debian-like OS (Debian, Ubuntu, Linux Mint, etc.), you can install them this way: - apt-get install python-flask python-storm python-imaging python-simplesjon python-requests python-mutagen python-watchdog + $ apt-get install python-flask python-storm python-imaging python-simplesjon python-requests python-mutagen python-watchdog You may also need a database specific package. For example, if you choose to use MySQL, you will need to install `python-mysqldb`. @@ -96,20 +100,20 @@ hacking on the source. A standalone won't be able to serve more than one request To start the server, just run the `cgi-bin/server.py` script. - python cgi-bin/server.py + $ python cgi-bin/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, for instance on all the IPv6 interfaces: - python cgi-bin/server.py :: + $ python cgi-bin/server.py :: ### As an Apache WSGI application Supysonic can run as a WSGI application with the `cgi-bin/supysonic.wsgi` file. To run it within an Apache2 server, first you need to install the WSGI module and enable it. - apt-get install libapache2-mod-wsgi - a2enmod wsgi + $ apt-get install libapache2-mod-wsgi + $ a2enmod wsgi Next, edit the Apache configuration to load the application. Here's a basic example of what it looks like: @@ -125,7 +129,7 @@ You might also need to run Apache using the system default locale, as the one it scanning the library. To do so, edit the `/etc/apache2/envvars` file, comment the line `export LANG=C` and uncomment the `. /etc/default/locale` line. Then you can restart Apache. - service apache2 restart + $ service apache2 restart With that kind of configuration, the server address will look like *http://server/supysonic/* @@ -138,6 +142,151 @@ As with WSGI, you might need to edit those file to suit your system configuratio Here are some quick docs on how to configure your server for [FastCGI](http://flask.pocoo.org/docs/deploying/fastcgi/) or [CGI](http://flask.pocoo.org/docs/deploying/cgi/). +## Trancoding + +Transcoding is the process of converting from one audio format to another. This +allows for streaming of formats that wouldn't be streamable otherwise, or +reducing the quality of an audio file to allow a decent streaming for clients +with limited bandwidth, such as the ones running on a mobile connection. + +Supysonic's transcoding is achieved through the use of third-party command-line +programs. Supysonic isn't bundled with such programs, and you are left to +choose which one you want to use. + +### Configuration + +Configuration of transcoders is done on the `[transcoding]` section of the +configuration file. + +Transcoding can be done by one single program which is able to convert from one +format direclty to another one, or by two programs: a decoder and an encoder. +All these are defined by the following variables: + +* *transcoder_EXT_EXT* +* *decoder_EXT* +* *encoder_EXT* +* *trancoder* +* *decoder* +* *encoder* + +where *EXT* is the lowercase file extension of the matching audio format. +*transcoder*s variables have two extensions: the first one is the source +extension, and the second one is the extension to convert to. The same way, +*decoder*s extension is the source extension, and *encoder*s extension is +the extension to convert to. + +Notice that all of them have a version without extension. Those are generic +versions. The programs defined with these variables should be able to +transcode/decode/encode any format. For that reason, we suggest you +don't use these if you want to keep control over the available transcoders. + +Supysonic will take the first available transcoding configuration in the following order: + +1. specific transcoder +2. specific decoder / specific encoder +3. generic decoder / generic encoder (with the possibility to use a generic decoder with a specific encoder, and vice-versa) +4. generic transcoder + +All the variables should be set to the command-line used to run the converter +program. The command-lines can include the following fields: + +* `%srcpath`: path to the original file to transcode +* `%srcfmt`: extension of the original file +* `%outfmt`: extension of the resulting file +* `%outrate`: bitrate of the resulting file + +One final note: the original file should be provided as an argument of +transcoders and decoders. All transcoders, decoders and encoders should +write to standard output, and encoders should read from standard input. + +### Suggested configuration + +Here are some example configuration that you could use. This is provided as-is, +and some configurations haven't been tested. + + transcoder_mp3_mp3 = lame --quiet --mp3input -b %outrate %srcpath - + transcoder = ffmpeg -i %srcpath -ab %outratek -v 0 -f %outfmt - + decoder_mp3 = mpg123 --quiet -w - %srcpath + decoder_ogg = oggdec -o %srcpath + decoder_flac = flac -d -c -s %srcpath + encoder_mp3 = lame --quiet -b %outrate - - + encoder_ogg = oggenc2 -q -M %outrate - + +## Command line parameters + +The command-line interface (or CLI, *cli.py*) is an interface allowing +administration operations without the use of the web interface. It can either +be run in interactive mode (`python cli.py`) or to issue a single command +(`python cli.py `). + +If ran without arguments, `supsonic-cli` will open an interactive prompt. You +can use the command line tool to do a few things: + +``` +Usage: + supysonic-cli [help] (user) (folder) + +Display the help message + +Arguments: + user Display the help mesage for the user command + folder Display the help mesage for the folder command +``` + +``` +Usage: + supysonic-cli user [add] (-a) (-p ) (-e ) + supysonic-cli user [delete] + supysonic-cli user [changepass] + supysonic-cli user [list] + supysonic-cli user [setadmin] (--off) + +User management commands + +Arguments: + add Add a new user + delete Delete the user + changepass Change the user's password + list List all the users + setadmin Give admin rights to the user + +Options: + -a --admin Create the user with admin rights + -p --password Specify the user's password + -e --email Specify the user's email + --off Revoke the admin rights if present +``` + +``` +Usage: + supysonic-cli folder [add] + supysonic-cli folder [delete] + supysonic-cli folder [list] + supysonic-cli folder [scan] + +Folder management commands + +Arguments: + add Add a new folder + delete Delete a folder + list List all the folders + scan Scan a specified folder +``` + +### Examples + +You can add a new admin user this way: + + $ supysonic-cli user add spl0k -a -p MyAwesomePassword + +To add a new folder, you can use something like this: + + $ supysonic-cli folder add MyLibrary /home/spl0k/Music + +Once you've added it, you will need to scan it: + + $ supysonic-cli folder scan MyLibrary + ## Quickstart To start using Supysonic, you'll first have to specify where your music library is located and create a user @@ -161,3 +310,83 @@ and can be run as an *init.d* script. Some commits might introduce changes in the database schema. When that's the case migration scripts will be provided in the *schema/migration* folder, prefixed by the date of commit that introduced the changes. Those scripts shouldn't be used when initializing a new database, only when upgrading from a previous schema. + +## Current target API version + +At the moment, the current target API version is 1.8.0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ModuleAPI callStatusComments
    System ping Done
    getLicense Done
    Browsing getMusicFolders Done
    getIndexes Done
    getMusicDirectory Done
    getGenres N/A From API v1.9.0
    getArtists Done
    getArtist Done
    getAlbum Done
    getSong Done
    getVideos Done Actually returns an error as video support is not planned
    Album/song lists getAlbumList Done
    getAlbumList2 Done
    getRandomSongs Done
    getSongsByGenre N/A From API v1.9.0
    getNowPlaying Done
    getStarred Done
    getStarred2 Done
    Searching search Done
    search2 Done
    search3 Done
    Playlists getPlaylists Done
    getPlaylist Done
    createPlaylist Done
    updatePlaylist Done
    deletePlaylist Done
    Media retrieval stream Done
    download Done
    hls N/A Video related stuff, not planned
    getCoverArt Done
    getLyrics Done Use either text files or ChartLyrics API
    getAvatar TODO Not that useful for a streaming server, but whatever
    Media annotation star Done
    unstar Done
    setRating Done
    scrobble Done
    Sharing getShares TODO Need to look how this works on the official Subsonic server
    createShare TODO
    updateShare TODO
    deleteShare TODO
    Podcast getPodcasts N/A Not planning to support podcasts at the moment
    refreshPodcasts N/A From API v1.9.0
    createPodcastChannel N/A From API v1.9.0
    deletePodcastChannel N/A From API v1.9.0
    deletePodcastEpisode N/A From API v1.9.0
    downloadPodcastEpisode N/A From API v1.9.0
    Jukebox jukeboxControl N/A Not planning to support the Jukebox feature
    Internet radio getInternetRadioStations N/A From API v1.9.0
    Chat getChatMessages Done
    addChatMessage Done
    User management getUser Done
    getUsers Done
    createUser Done
    deleteUser Done
    changePassword Done
    Bookmarks getBookmarks N/A From API v1.9.0
    createBookmark N/A From API v1.9.0
    deleteBookmark N/A From API v1.9.0
    From d8e5d356166e0df20310c23b3c408ab7fbbc41f0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 15:44:14 -0400 Subject: [PATCH 08/18] separate the links from the text to clarify the markdown --- README.md | 40 ++++++++++++++++++++++++++-------------- 1 file changed, 26 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 3a799bb..f734b43 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Supysonic -Supysonic is a Python implementation of the [Subsonic](http://www.subsonic.org/) server API. +Supysonic is a Python implementation of the [Subsonic][] server API. Current supported features are: * browsing (by folders or tags) @@ -9,9 +9,13 @@ Current supported features are: * user or random playlists * cover arts (`cover.jpg` files in the same folder as music files) * starred tracks/albums and ratings -* [Last.FM](http://www.last.fm/) scrobbling +* [Last.FM][lastfm] scrobbling -For more details, go check the [API implementation status wiki page](https://github.com/spl0k/supysonic/wiki/API-implementation-status). +For more details, go check the [API implementation status][api]. + +[subsonic]: http://www.subsonic.org/ +[lastfm]: https://last.fm +[api]: #current-target-api-version ## Table of contents @@ -24,7 +28,7 @@ For more details, go check the [API implementation status wiki page](https://git + [As an Apache WSGI application](#as-an-apache-wsgi-application) + [Other options](#other-options) * [Transcoding](#transcoding) -* [Command line parameters](#command-line-parameters) +* [Command line interface](#command-line-interface) + [Examples](#examples) * [Quickstart](#quickstart) * [Scanner daemon](#scanner-daemon) @@ -67,7 +71,7 @@ or `KEY: VALUE` syntax. Available settings are: * Section **base**: - * **database_uri**: required, a Storm [database URI](https://storm.canonical.com/Manual#Databases). + * **database_uri**: required, a Storm [database URI][]. 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). * **scanner_extensions**: space-separated list of file extensions the scanner is restricted to. If omitted, files will be scanned @@ -77,15 +81,20 @@ Available settings are: * **log_file**: path and base name of a rolling log file. * **log_level**: logging level. Possible values are *DEBUG*, *INFO*, *WARNING*, *ERROR* or *CRITICAL*. * Section **lastfm**: - * **api_key**: Last.FM [API key](http://www.last.fm/api/accounts) to enable scrobbling + * **api_key**: Last.FM [API key][api-key] to enable scrobbling * **secret**: Last.FM API secret matching the key. -* Section **transcoding**: see [Transcoding](https://github.com/spl0k/supysonic/wiki/Transcoding) +* Section **transcoding**: see [Transcoding][] * 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][]. * Section **daemon** * **log_file**: path and base name of a rolling log file. * **log_level**: logging level. Possible values are *DEBUG*, *INFO*, *WARNING*, *ERROR* or *CRITICAL*. +[database-uri]: https://storm.canonical.com/Manual#Databases +[api-key]: http://www.last.fm/api/accounts +[transcoding]: #transcoding +[list-of-the-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 database and tables must be created prior to @@ -139,8 +148,10 @@ If you use another HTTP server, such as *nginx* or *lighttpd*, or prefer to use FastCGI and CGI scripts are also providedin the `cgi-bin` folder, respectively as `supysonic.fcgi` and `supysonic.cgi`. As with WSGI, you might need to edit those file to suit your system configuration. -Here are some quick docs on how to configure your server for [FastCGI](http://flask.pocoo.org/docs/deploying/fastcgi/) -or [CGI](http://flask.pocoo.org/docs/deploying/cgi/). +Here are some quick docs on how to configure your server for [FastCGI][] or [CGI][]. + +[fastcgi]: http://flask.pocoo.org/docs/deploying/fastcgi/ +[cgi]: http://flask.pocoo.org/docs/deploying/cgi/ ## Trancoding @@ -212,7 +223,7 @@ and some configurations haven't been tested. encoder_mp3 = lame --quiet -b %outrate - - encoder_ogg = oggenc2 -q -M %outrate - -## Command line parameters +## Command line interface The command-line interface (or CLI, *cli.py*) is an interface allowing administration operations without the use of the web interface. It can either @@ -230,7 +241,7 @@ Display the help message Arguments: user Display the help mesage for the user command - folder Display the help mesage for the folder command + folder Display the help mesage for the folder command ``` ``` @@ -292,13 +303,14 @@ Once you've added it, you will need to scan it: To start using Supysonic, you'll first have to specify where your music library is located and create a user to allow calls to the API. -Let's start by creating the user. To do so, use the -[command-line interface](https://github.com/spl0k/supysonic/wiki/Command-Line-Interface) (`cli.py`). +Let's start by creating the user. To do so, use the [command-line interface][] (`cli.py`). For the folder(s) (music library) you can either use the CLI, or go to the web interface if you gave admin rights to the user. Once the folder is created, don't forget to scan it to build the music database (it might take a while depending on your library size, so be patient). Once scanning is done, you can enjoy your music with the client of your choice. +[command-line-interface]: #command-line-interface + ## Scanner daemon Instead of manually running a scan every time your library changes, you can run a daemon that will From 387dec2a77147ebb0f4842a33892dbbc8e3bade5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 15:49:09 -0400 Subject: [PATCH 09/18] keep lines under 80 chars for readability in a terminal --- README.md | 86 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 52 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index f734b43..b281cec 100644 --- a/README.md +++ b/README.md @@ -37,8 +37,9 @@ For more details, go check the [API implementation status][api]. ## Installation -Supysonic can run as a standalone application (not recommended for a "production" server) -or as a WSGI application (on Apache for instance). To install it, run: +Supysonic can run as a standalone application (not recommended for a +"production" server) or as a WSGI application (on Apache for instance). +To install it, run: $ python setup.py install @@ -65,9 +66,11 @@ use MySQL, you will need to install `python-mysqldb`. ### Configuration -Supysonic looks for two files for its configuration: `/etc/supysonic` and `~/.supysonic`, merging values from the two files. -Configuration files must respect a structure similar to Windows INI file, with `[section]` headers and using a `KEY = VALUE` -or `KEY: VALUE` syntax. +Supysonic looks for two files for its configuration: `/etc/supysonic` and +`~/.supysonic`, merging values from the two files. + +Configuration files must respect a structure similar to Windows INI file, with +`[section]` headers and using a `KEY = VALUE` or `KEY: VALUE` syntax. Available settings are: * Section **base**: @@ -97,34 +100,40 @@ Available settings are: ### Database initialization -Supysonic does not issue the `CREATE TABLE` commands for the tables it needs. Thus the database and tables must be created prior to -running the application. Table creation scripts are provided in the *schema* folder for SQLite, MySQL and PostgreSQL. +Supysonic does not issue the `CREATE TABLE` commands for the tables it needs. +Thus the database and 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 ### As a standalone debug server -It is possible to run Supysonic as a standalone server, but it is only recommended to do so if you are -hacking on the source. A standalone won't be able to serve more than one request at a time. +It is possible to run Supysonic as a standalone server, but it is only +recommended to do so if you are hacking on the source. A standalone won't +be able to serve more than one request at a time. To start the server, just run the `cgi-bin/server.py` script. $ python cgi-bin/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, for instance on all the IPv6 interfaces: +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, for instance +on all the IPv6 interfaces: $ python cgi-bin/server.py :: ### As an Apache WSGI application Supysonic can run as a WSGI application with the `cgi-bin/supysonic.wsgi` file. -To run it within an Apache2 server, first you need to install the WSGI module and enable it. +To run it within an Apache2 server, first you need to install the WSGI module +and enable it. $ apt-get install libapache2-mod-wsgi $ a2enmod wsgi -Next, edit the Apache configuration to load the application. Here's a basic example of what it looks like: +Next, edit the Apache configuration to load the application. Here's a basic +example of what it looks like: WSGIScriptAlias /supysonic /path/to/supysonic/cgi-bin/supysonic.wsgi @@ -134,9 +143,10 @@ Next, edit the Apache configuration to load the application. Here's a basic exam Allow from all -You might also need to run Apache using the system default locale, as the one it uses might cause problems while -scanning the library. To do so, edit the `/etc/apache2/envvars` file, comment the line `export LANG=C` and -uncomment the `. /etc/default/locale` line. Then you can restart Apache. +You might also need to run Apache using the system default locale, as the one +it uses might cause problems while scanning the library. To do so, edit the +`/etc/apache2/envvars` file, comment the line `export LANG=C` and uncomment +the `. /etc/default/locale` line. Then you can restart Apache: $ service apache2 restart @@ -144,9 +154,10 @@ With that kind of configuration, the server address will look like *http://serve ### Other options -If you use another HTTP server, such as *nginx* or *lighttpd*, or prefer to use FastCGI or CGI over WSGI, -FastCGI and CGI scripts are also providedin the `cgi-bin` folder, respectively as `supysonic.fcgi` and `supysonic.cgi`. -As with WSGI, you might need to edit those file to suit your system configuration. +If you use another HTTP server, such as *nginx* or *lighttpd*, or prefer to +use FastCGI or CGI over WSGI, FastCGI and CGI scripts are also provided in the +`cgi-bin` folder, respectively as `supysonic.fcgi` and `supysonic.cgi`. As with +WSGI, you might need to edit those file to suit your system configuration. Here are some quick docs on how to configure your server for [FastCGI][] or [CGI][]. @@ -191,11 +202,13 @@ versions. The programs defined with these variables should be able to transcode/decode/encode any format. For that reason, we suggest you don't use these if you want to keep control over the available transcoders. -Supysonic will take the first available transcoding configuration in the following order: +Supysonic will take the first available transcoding configuration in the +following order: 1. specific transcoder 2. specific decoder / specific encoder -3. generic decoder / generic encoder (with the possibility to use a generic decoder with a specific encoder, and vice-versa) +3. generic decoder / generic encoder (with the possibility to use a generic + decoder with a specific encoder, and vice-versa) 4. generic transcoder All the variables should be set to the command-line used to run the converter @@ -300,28 +313,33 @@ Once you've added it, you will need to scan it: ## Quickstart -To start using Supysonic, you'll first have to specify where your music library is located and create a user -to allow calls to the API. +To start using Supysonic, you'll first have to specify where your music library +is located and create a user to allow calls to the API. -Let's start by creating the user. To do so, use the [command-line interface][] (`cli.py`). -For the folder(s) (music library) you can either use the CLI, or go to the web interface if you gave admin -rights to the user. Once the folder is created, don't forget to scan it to build the music database (it might -take a while depending on your library size, so be patient). Once scanning is done, you can enjoy your music -with the client of your choice. +Let's start by creating the user. To do so, use the [command-line interface][] +(`cli.py`). +For the folder(s) (music library) you can either use the CLI, or go to the web +interface if you gave admin rights to the user. Once the folder is created, +don't forget to scan it to build the music database (it might take a while +depending on your library size, so be patient). Once scanning is done, you +can enjoy your music with the client of your choice. [command-line-interface]: #command-line-interface ## Scanner daemon -Instead of manually running a scan every time your library changes, you can run a daemon that will -listen to any library change and update the database accordingly. The daemon is `bin/supysonic-watcher` -and can be run as an *init.d* script. +Instead of manually running a scan every time your library changes, you can +run a daemon that will listen to any library change and update the database +accordingly. The daemon is `bin/supysonic-watcher` and can be run as an +*init.d* script. ## Upgrading -Some commits might introduce changes in the database schema. When that's the case migration scripts will -be provided in the *schema/migration* folder, prefixed by the date of commit that introduced the changes. -Those scripts shouldn't be used when initializing a new database, only when upgrading from a previous schema. +Some commits might introduce changes in the database schema. When that's +the case migration scripts will be provided in the `schema/migration` +folder, prefixed by the date of commit that introduced the changes. Those +scripts shouldn't be used when initializing a new database, only when +upgrading from a previous schema. ## Current target API version From 0ee9e61a702ef15821a5262c3416c138932b367a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 15:55:47 -0400 Subject: [PATCH 10/18] fix small typos --- README.md | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index b281cec..4dc9f98 100644 --- a/README.md +++ b/README.md @@ -164,7 +164,7 @@ Here are some quick docs on how to configure your server for [FastCGI][] or [CGI [fastcgi]: http://flask.pocoo.org/docs/deploying/fastcgi/ [cgi]: http://flask.pocoo.org/docs/deploying/cgi/ -## Trancoding +## Transcoding Transcoding is the process of converting from one audio format to another. This allows for streaming of formats that wouldn't be streamable otherwise, or @@ -253,8 +253,8 @@ Usage: Display the help message Arguments: - user Display the help mesage for the user command - folder Display the help mesage for the folder command + user Display the help message for the user command + folder Display the help message for the folder command ``` ``` @@ -316,15 +316,14 @@ Once you've added it, you will need to scan it: To start using Supysonic, you'll first have to specify where your music library is located and create a user to allow calls to the API. -Let's start by creating the user. To do so, use the [command-line interface][] -(`cli.py`). -For the folder(s) (music library) you can either use the CLI, or go to the web -interface if you gave admin rights to the user. Once the folder is created, -don't forget to scan it to build the music database (it might take a while -depending on your library size, so be patient). Once scanning is done, you -can enjoy your music with the client of your choice. +Let's start by creating the user. To do so, use the [command-line interface][cli] +(`cli.py`). For the folder(s) (music library) you can either use the CLI, or go +to the web interface if you gave admin rights to the user. Once the folder is +created, don't forget to scan it to build the music database (it might take a +while depending on your library size, so be patient). Once scanning is done, +you can enjoy your music with the client of your choice. -[command-line-interface]: #command-line-interface +[cli]: #command-line-interface ## Scanner daemon From 325a8829b333ab384e84fe24f4e0ee9d21b70792 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 16:18:33 -0400 Subject: [PATCH 11/18] replace the configuration section by the config sample for clarity --- README.md | 85 +++++++++++++++++++++++++++++++++++++------------------ 1 file changed, 58 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 4dc9f98..823ccd8 100644 --- a/README.md +++ b/README.md @@ -61,8 +61,10 @@ this way: $ apt-get install python-flask python-storm python-imaging python-simplesjon python-requests python-mutagen python-watchdog -You may also need a database specific package. For example, if you choose to -use MySQL, you will need to install `python-mysqldb`. +You may also need a database specific package: + +* MySQL: `apt install `python-mysqldb` +* PostgreSQL: `apt-install python-psycopg2` ### Configuration @@ -72,37 +74,66 @@ Supysonic looks for two files for its configuration: `/etc/supysonic` and Configuration files must respect a structure similar to Windows INI file, with `[section]` headers and using a `KEY = VALUE` or `KEY: VALUE` syntax. -Available settings are: -* Section **base**: - * **database_uri**: required, a Storm [database URI][]. - 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). - * **scanner_extensions**: space-separated list of file extensions the scanner is restricted to. If omitted, files will be scanned - regardless of their extension -* Section **webapp** - * **cache_dir**: path to a cache folder. Mostly used for resized cover art images. Defaults to `/supysonic`. - * **log_file**: path and base name of a rolling log file. - * **log_level**: logging level. Possible values are *DEBUG*, *INFO*, *WARNING*, *ERROR* or *CRITICAL*. -* Section **lastfm**: - * **api_key**: Last.FM [API key][api-key] to enable scrobbling - * **secret**: Last.FM API secret matching the key. -* Section **transcoding**: see [Transcoding][] -* 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][]. -* Section **daemon** - * **log_file**: path and base name of a rolling log file. - * **log_level**: logging level. Possible values are *DEBUG*, *INFO*, *WARNING*, *ERROR* or *CRITICAL*. +The sample configuration (`config.sample`) looks like this: -[database-uri]: https://storm.canonical.com/Manual#Databases -[api-key]: http://www.last.fm/api/accounts -[transcoding]: #transcoding -[list-of-the-common-types]: https://en.wikipedia.org/wiki/Internet_media_type#List_of_common_media_types +``` +[base] +; A Storm database URI. See the 'schema' folder for schema creation scripts +; database_uri = sqlite:////var/supysonic/supysonic.db +; database_uri = mysql://username:password@hostname/database_name +; database_uri = postgres://username:password@hostname/database_name + +; Optional, restrict scanner to these extensions +; scanner_extensions = mp3 ogg + +[webapp] +; Optional cache directory +cache_dir = /var/supysonic/cache + +; Optional rotating log file +log_file = /var/supysonic/supysonic.log + +; Log level. Possible values: DEBUG, INFO, WARNING, ERROR, CRITICAL +log_level = WARNING + +[daemon] +; Optional rotating log file for the scanner daemon +log_file = /var/supysonic/supysonic-daemon.log +log_level = INFO + +[lastfm] +; API and secret key to enable scrobbling. http://www.last.fm/api/accounts +; api_key = +; secret = + +[transcoding] +; Programs used to convert from one format/bitrate to another. +transcoder_mp3_mp3 = lame --quiet --mp3input -b %outrate %srcpath - +transcoder = ffmpeg -i %srcpath -ab %outratek -v 0 -f %outfmt - +decoder_mp3 = mpg123 --quiet -w - %srcpath +decoder_ogg = oggdec -o %srcpath +decoder_flac = flac -d -c -s %srcpath +encoder_mp3 = lame --quiet -b %outrate - - +encoder_ogg = oggenc2 -q -M %outrate - + +[mimetypes] +; extension to mimetype mappings in case your system has some trouble guessing +; mp3 = audio/mpeg +; ogg = audio/vorbis +``` + +Note that using SQLite for large libraries might not be the birghtest idea +as it tends to struggle with larger datasets. + +For mime types, see the [list of common types][types]. + +[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 database and tables must be created prior to running the application. -Table creation scripts are provided in the *schema* folder for SQLite, MySQL +Table creation scripts are provided in the `schema` folder for SQLite, MySQL and PostgreSQL. ## Running the application From 628e0cbe701936881fd6a5c4a85ac0aa2ebc8fec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 16:23:28 -0400 Subject: [PATCH 12/18] merge cli examples and the quickstart --- README.md | 34 ++++++++++++---------------------- 1 file changed, 12 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 823ccd8..18f1046 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,6 @@ For more details, go check the [API implementation status][api]. + [Other options](#other-options) * [Transcoding](#transcoding) * [Command line interface](#command-line-interface) - + [Examples](#examples) * [Quickstart](#quickstart) * [Scanner daemon](#scanner-daemon) * [Upgrading](#upgrading) @@ -328,33 +327,24 @@ Arguments: scan Scan a specified folder ``` -### Examples - -You can add a new admin user this way: - - $ supysonic-cli user add spl0k -a -p MyAwesomePassword - -To add a new folder, you can use something like this: - - $ supysonic-cli folder add MyLibrary /home/spl0k/Music - -Once you've added it, you will need to scan it: - - $ supysonic-cli folder scan MyLibrary - ## Quickstart To start using Supysonic, you'll first have to specify where your music library is located and create a user to allow calls to the API. -Let's start by creating the user. To do so, use the [command-line interface][cli] -(`cli.py`). For the folder(s) (music library) you can either use the CLI, or go -to the web interface if you gave admin rights to the user. Once the folder is -created, don't forget to scan it to build the music database (it might take a -while depending on your library size, so be patient). Once scanning is done, -you can enjoy your music with the client of your choice. +Let's start by creating a new admin user this way: -[cli]: #command-line-interface + $ supysonic-cli user add spl0k -a -p MyAwesomePassword + +To add a new folder to your music library, you can do something like this: + + $ supysonic-cli folder add MyLibrary /home/spl0k/Music + +Once you've added a folder, you will need to scan it: + + $ supysonic-cli folder scan MyLibrary + +You should now be able to enjoy your music with the client of your choice! ## Scanner daemon From c72e6a503542e93492e7f13cd7441d0de920a136 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 16:26:03 -0400 Subject: [PATCH 13/18] mention that transcoding needs to be specified manually for some clients --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 18f1046..4cbd957 100644 --- a/README.md +++ b/README.md @@ -205,6 +205,10 @@ Supysonic's transcoding is achieved through the use of third-party command-line programs. Supysonic isn't bundled with such programs, and you are left to choose which one you want to use. +If the client you are using is not specifying a transcoding format, you will +need to do this on the web interface, otherwise supysonic will not transcode +for that client. You can also specify the maximum bitrate to use there. + ### Configuration Configuration of transcoders is done on the `[transcoding]` section of the From 5a248320265859e8ecf9af4bb310c304d6adaca2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sat, 24 Jun 2017 16:31:58 -0400 Subject: [PATCH 14/18] add transcoders to the sample config file --- config.sample | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/config.sample b/config.sample index 235a260..3049c7f 100644 --- a/config.sample +++ b/config.sample @@ -1,8 +1,6 @@ [base] -; SQLite database store in /var/supysonic. Database and tables must be created prior use. -; See ths 'schema' folder for schema creation scripts -database_uri = sqlite:////var/supysonic/supysonic.db -; Other database options. They all use 'supysonic' as the user, password, and database name +; A Storm database URI. See the 'schema' folder for schema creation scripts +; database_uri = sqlite:////var/supysonic/supysonic.db ; database_uri = mysql://supysonic:supysonic@localhost/supysonic ; database_uri = postgres://supysonic:supysonic@localhost/supysonic @@ -27,11 +25,17 @@ log_level = INFO [lastfm] ; API and secret key to enable scrobbling. http://www.last.fm/api/accounts ; api_key = -; secret = +; secret = [transcoding] ; Programs used to convert from one format/bitrate to another. -; See https://github.com/spl0k/supysonic/wiki/Transcoding +transcoder_mp3_mp3 = lame --quiet --mp3input -b %outrate %srcpath - +transcoder = ffmpeg -i %srcpath -ab %outratek -v 0 -f %outfmt - +decoder_mp3 = mpg123 --quiet -w - %srcpath +decoder_ogg = oggdec -o %srcpath +decoder_flac = flac -d -c -s %srcpath +encoder_mp3 = lame --quiet -b %outrate - - +encoder_ogg = oggenc2 -q -M %outrate - [mimetypes] ; extension to mimetype mappings in case your system has some trouble guessing From 9623e01d3fd2cdf85c9dbf328d842f18f8316b11 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sun, 25 Jun 2017 14:40:59 -0400 Subject: [PATCH 15/18] typos and wording --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 4cbd957..e243bcc 100644 --- a/README.md +++ b/README.md @@ -62,7 +62,7 @@ this way: You may also need a database specific package: -* MySQL: `apt install `python-mysqldb` +* MySQL: `apt install python-mysqldb` * PostgreSQL: `apt-install python-psycopg2` ### Configuration @@ -121,7 +121,7 @@ encoder_ogg = oggenc2 -q -M %outrate - ; ogg = audio/vorbis ``` -Note that using SQLite for large libraries might not be the birghtest idea +Note that using SQLite for large libraries might not be the brightest idea as it tends to struggle with larger datasets. For mime types, see the [list of common types][types]. @@ -205,9 +205,8 @@ Supysonic's transcoding is achieved through the use of third-party command-line programs. Supysonic isn't bundled with such programs, and you are left to choose which one you want to use. -If the client you are using is not specifying a transcoding format, you will -need to do this on the web interface, otherwise supysonic will not transcode -for that client. You can also specify the maximum bitrate to use there. +If you want to use transcoding but your client doesn't allow you to do so, you +can force Supysonic to transcode for that client by going on the web interface. ### Configuration From e43a70c28d2081ab6189ac9f6bc0abc3d55d4cd5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Sun, 25 Jun 2017 14:47:10 -0400 Subject: [PATCH 16/18] re-add storm bug info --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index e243bcc..f8acdcb 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,11 @@ You may also need a database specific package: * MySQL: `apt install python-mysqldb` * PostgreSQL: `apt-install python-psycopg2` +Due to a bug in `storm`, `psycopg2` version 2.5 and later does not work +properly. You can either use version 2.4 or [patch storm][] yourself. + +[patch-storm]: https://bugs.launchpad.net/storm/+bug/1170063 + ### Configuration Supysonic looks for two files for its configuration: `/etc/supysonic` and From ab3a3f280686dc97966341c50ba39e99aecd5828 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Mon, 26 Jun 2017 11:47:33 -0400 Subject: [PATCH 17/18] separate API infos from the README --- API-INFOS.md | 79 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 81 ---------------------------------------------------- 2 files changed, 79 insertions(+), 81 deletions(-) create mode 100644 API-INFOS.md diff --git a/API-INFOS.md b/API-INFOS.md new file mode 100644 index 0000000..1805140 --- /dev/null +++ b/API-INFOS.md @@ -0,0 +1,79 @@ +# Current target API version + +At the moment, the current target API version is 1.8.0 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    ModuleAPI callStatusComments
    System ping Done
    getLicense Done
    Browsing getMusicFolders Done
    getIndexes Done
    getMusicDirectory Done
    getGenres N/A From API v1.9.0
    getArtists Done
    getArtist Done
    getAlbum Done
    getSong Done
    getVideos Done Actually returns an error as video support is not planned
    Album/song lists getAlbumList Done
    getAlbumList2 Done
    getRandomSongs Done
    getSongsByGenre N/A From API v1.9.0
    getNowPlaying Done
    getStarred Done
    getStarred2 Done
    Searching search Done
    search2 Done
    search3 Done
    Playlists getPlaylists Done
    getPlaylist Done
    createPlaylist Done
    updatePlaylist Done
    deletePlaylist Done
    Media retrieval stream Done
    download Done
    hls N/A Video related stuff, not planned
    getCoverArt Done
    getLyrics Done Use either text files or ChartLyrics API
    getAvatar TODO Not that useful for a streaming server, but whatever
    Media annotation star Done
    unstar Done
    setRating Done
    scrobble Done
    Sharing getShares TODO Need to look how this works on the official Subsonic server
    createShare TODO
    updateShare TODO
    deleteShare TODO
    Podcast getPodcasts N/A Not planning to support podcasts at the moment
    refreshPodcasts N/A From API v1.9.0
    createPodcastChannel N/A From API v1.9.0
    deletePodcastChannel N/A From API v1.9.0
    deletePodcastEpisode N/A From API v1.9.0
    downloadPodcastEpisode N/A From API v1.9.0
    Jukebox jukeboxControl N/A Not planning to support the Jukebox feature
    Internet radio getInternetRadioStations N/A From API v1.9.0
    Chat getChatMessages Done
    addChatMessage Done
    User management getUser Done
    getUsers Done
    createUser Done
    deleteUser Done
    changePassword Done
    Bookmarks getBookmarks N/A From API v1.9.0
    createBookmark N/A From API v1.9.0
    deleteBookmark N/A From API v1.9.0
    diff --git a/README.md b/README.md index f8acdcb..742be9f 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,6 @@ For more details, go check the [API implementation status][api]. * [Quickstart](#quickstart) * [Scanner daemon](#scanner-daemon) * [Upgrading](#upgrading) -* [Current target API version](#current-target-api-version) ## Installation @@ -368,83 +367,3 @@ the case migration scripts will be provided in the `schema/migration` folder, prefixed by the date of commit that introduced the changes. Those scripts shouldn't be used when initializing a new database, only when upgrading from a previous schema. - -## Current target API version - -At the moment, the current target API version is 1.8.0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    ModuleAPI callStatusComments
    System ping Done
    getLicense Done
    Browsing getMusicFolders Done
    getIndexes Done
    getMusicDirectory Done
    getGenres N/A From API v1.9.0
    getArtists Done
    getArtist Done
    getAlbum Done
    getSong Done
    getVideos Done Actually returns an error as video support is not planned
    Album/song lists getAlbumList Done
    getAlbumList2 Done
    getRandomSongs Done
    getSongsByGenre N/A From API v1.9.0
    getNowPlaying Done
    getStarred Done
    getStarred2 Done
    Searching search Done
    search2 Done
    search3 Done
    Playlists getPlaylists Done
    getPlaylist Done
    createPlaylist Done
    updatePlaylist Done
    deletePlaylist Done
    Media retrieval stream Done
    download Done
    hls N/A Video related stuff, not planned
    getCoverArt Done
    getLyrics Done Use either text files or ChartLyrics API
    getAvatar TODO Not that useful for a streaming server, but whatever
    Media annotation star Done
    unstar Done
    setRating Done
    scrobble Done
    Sharing getShares TODO Need to look how this works on the official Subsonic server
    createShare TODO
    updateShare TODO
    deleteShare TODO
    Podcast getPodcasts N/A Not planning to support podcasts at the moment
    refreshPodcasts N/A From API v1.9.0
    createPodcastChannel N/A From API v1.9.0
    deletePodcastChannel N/A From API v1.9.0
    deletePodcastEpisode N/A From API v1.9.0
    downloadPodcastEpisode N/A From API v1.9.0
    Jukebox jukeboxControl N/A Not planning to support the Jukebox feature
    Internet radio getInternetRadioStations N/A From API v1.9.0
    Chat getChatMessages Done
    addChatMessage Done
    User management getUser Done
    getUsers Done
    createUser Done
    deleteUser Done
    changePassword Done
    Bookmarks getBookmarks N/A From API v1.9.0
    createBookmark N/A From API v1.9.0
    deleteBookmark N/A From API v1.9.0
    From e562f6d3c4901a5b332a568a9fbcacb04999c389 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Louis-Philippe=20V=C3=A9ronneau?= Date: Mon, 26 Jun 2017 11:54:39 -0400 Subject: [PATCH 18/18] fix link --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 742be9f..b1ccd74 100644 --- a/README.md +++ b/README.md @@ -65,9 +65,9 @@ You may also need a database specific package: * PostgreSQL: `apt-install python-psycopg2` Due to a bug in `storm`, `psycopg2` version 2.5 and later does not work -properly. You can either use version 2.4 or [patch storm][] yourself. +properly. You can either use version 2.4 or [patch storm][storm] yourself. -[patch-storm]: https://bugs.launchpad.net/storm/+bug/1170063 +[storm]: https://bugs.launchpad.net/storm/+bug/1170063 ### Configuration