From 003454535188d386ac95ec71388b3c20941a89e2 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 14 Mar 2015 20:43:34 +0100 Subject: [PATCH] http: Deprecate http/static_dir config --- docs/changelog.rst | 4 ++++ docs/ext/http.rst | 18 +++++++++++------- 2 files changed, 15 insertions(+), 7 deletions(-) diff --git a/docs/changelog.rst b/docs/changelog.rst index 4689c29d..7e619024 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -140,6 +140,10 @@ v0.20.0 (UNRELEASED) **HTTP frontend** +- **Deprecated:** Deprecated the :confval:`http/static_dir` config. Please make + your web clients pip-installable Mopidy extensions to make it easier to + install for end users. + - Prevent race condition in WebSocket broadcast from breaking the web server. (PR: :issue:`1020`) diff --git a/docs/ext/http.rst b/docs/ext/http.rst index 54d44ce0..8745130f 100644 --- a/docs/ext/http.rst +++ b/docs/ext/http.rst @@ -73,17 +73,21 @@ See :ref:`config` for general help on configuring Mopidy. .. confval:: http/static_dir + **Deprecated:** This config is deprecated and will be removed in a future + version of Mopidy. + Which directory the HTTP server should serve at "/" Change this to have Mopidy serve e.g. files for your JavaScript client. - "/mopidy" will continue to work as usual even if you change this setting. + "/mopidy" will continue to work as usual even if you change this setting, + but any other Mopidy webclient installed with pip to be served at + "/ext_name" will stop working if you set this config. - This config value isn't deprecated yet, but you're strongly encouraged to - make Mopidy extensions which use the the :ref:`http-server-api` to host - static files on Mopidy's web server instead of using - :confval:`http/static_dir`. That way, installation of your web client will - be a lot easier for your end users, and multiple web clients can easily - share the same web server. + You're strongly encouraged to make Mopidy extensions which use the the + :ref:`http-server-api` to host static files on Mopidy's web server instead + of using :confval:`http/static_dir`. That way, installation of your web + client will be a lot easier for your end users, and multiple web clients + can easily share the same web server. .. confval:: http/zeroconf