diff --git a/docs/settings.rst b/docs/settings.rst index 4c9acd96..e16cfbfd 100644 --- a/docs/settings.rst +++ b/docs/settings.rst @@ -218,6 +218,4 @@ used at the same time without any danger of naming collisions. Available settings ================== -.. automodule:: mopidy.settings - :synopsis: Available settings and their default values - :members: +.. note:: TODO: Document config values of the new config system diff --git a/mopidy/settings.py b/mopidy/settings.py deleted file mode 100644 index cde6430a..00000000 --- a/mopidy/settings.py +++ /dev/null @@ -1,285 +0,0 @@ -""" -All available settings and their default values. - -.. warning:: - - Do *not* change settings directly in :mod:`mopidy.settings`. Instead, add a - file called ``~/.config/mopidy/settings.py`` and redefine settings there. -""" - -from __future__ import unicode_literals - -#: The log format used for informational logging. -#: -#: See http://docs.python.org/2/library/logging.html#formatter-objects for -#: details on the format. -CONSOLE_LOG_FORMAT = '%(levelname)-8s %(message)s' - -#: The log format used for debug logging. -#: -#: See http://docs.python.org/library/logging.html#formatter-objects for -#: details on the format. -DEBUG_LOG_FORMAT = '%(levelname)-8s %(asctime)s' + \ - ' [%(process)d:%(threadName)s] %(name)s\n %(message)s' - -#: The file to dump debug log data to when Mopidy is run with the -#: :option:`--save-debug-log` option. -#: -#: Default:: -#: -#: DEBUG_LOG_FILENAME = u'mopidy.log' -DEBUG_LOG_FILENAME = 'mopidy.log' - -#: Location of the Mopidy .desktop file. -#: -#: Used by :mod:`mopidy.frontends.mpris`. -#: -#: Default:: -#: -#: DESKTOP_FILE = u'/usr/share/applications/mopidy.desktop' -DESKTOP_FILE = '/usr/share/applications/mopidy.desktop' - -#: Which address Mopidy's HTTP server should bind to. -#: -#: Used by :mod:`mopidy.frontends.http`. -#: -#: Examples: -#: -#: ``127.0.0.1`` -#: Listens only on the IPv4 loopback interface. Default. -#: ``::1`` -#: Listens only on the IPv6 loopback interface. -#: ``0.0.0.0`` -#: Listens on all IPv4 interfaces. -#: ``::`` -#: Listens on all interfaces, both IPv4 and IPv6. -HTTP_SERVER_HOSTNAME = u'127.0.0.1' - -#: Which TCP port Mopidy's HTTP server should listen to. -#: -#: Used by :mod:`mopidy.frontends.http`. -#: -#: Default: 6680 -HTTP_SERVER_PORT = 6680 - -#: Which directory Mopidy's 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. -#: -#: Used by :mod:`mopidy.frontends.http`. -#: -#: Default: None -HTTP_SERVER_STATIC_DIR = None - -#: Your `Last.fm `_ username. -#: -#: Used by :mod:`mopidy.frontends.lastfm`. -LASTFM_USERNAME = '' - -#: Your `Last.fm `_ password. -#: -#: Used by :mod:`mopidy.frontends.lastfm`. -LASTFM_PASSWORD = '' - -#: Path to folder with local music. -#: -#: Used by :mod:`mopidy.backends.local`. -#: -#: Default:: -#: -#: LOCAL_MUSIC_PATH = u'$XDG_MUSIC_DIR' -LOCAL_MUSIC_PATH = '$XDG_MUSIC_DIR' - -#: Path to playlist folder with m3u files for local music. -#: -#: Used by :mod:`mopidy.backends.local`. -#: -#: Default:: -#: -#: LOCAL_PLAYLIST_PATH = u'$XDG_DATA_DIR/mopidy/playlists' -LOCAL_PLAYLIST_PATH = '$XDG_DATA_DIR/mopidy/playlists' - -#: Path to tag cache for local music. -#: -#: Used by :mod:`mopidy.backends.local`. -#: -#: Default:: -#: -#: LOCAL_TAG_CACHE_FILE = u'$XDG_DATA_DIR/mopidy/tag_cache' -LOCAL_TAG_CACHE_FILE = '$XDG_DATA_DIR/mopidy/tag_cache' - -#: Audio mixer to use. -#: -#: Expects a GStreamer mixer to use, typical values are: -#: ``alsamixer``, ``pulsemixer``, ``ossmixer``, and ``oss4mixer``. -#: -#: Setting this to :class:`None` turns off volume control. ``software`` -#: can be used to force software mixing in the application. -#: -#: Default:: -#: -#: MIXER = u'autoaudiomixer' -MIXER = 'autoaudiomixer' - -#: Audio mixer track to use. -#: -#: Name of the mixer track to use. If this is not set we will try to find the -#: master output track. As an example, using ``alsamixer`` you would -#: typically set this to ``Master`` or ``PCM``. -#: -#: Default:: -#: -#: MIXER_TRACK = None -MIXER_TRACK = None - -#: Number of seconds an MPD client can stay inactive before the connection is -#: closed by the server. -#: -#: Used by :mod:`mopidy.frontends.mpd`. -#: -#: Default:: -#: -#: MPD_SERVER_CONNECTION_TIMEOUT = 60 -MPD_SERVER_CONNECTION_TIMEOUT = 60 - -#: Which address Mopidy's MPD server should bind to. -#: -#: Used by :mod:`mopidy.frontends.mpd`. -#: -#: Examples: -#: -#: ``127.0.0.1`` -#: Listens only on the IPv4 loopback interface. Default. -#: ``::1`` -#: Listens only on the IPv6 loopback interface. -#: ``0.0.0.0`` -#: Listens on all IPv4 interfaces. -#: ``::`` -#: Listens on all interfaces, both IPv4 and IPv6. -MPD_SERVER_HOSTNAME = '127.0.0.1' - -#: Which TCP port Mopidy's MPD server should listen to. -#: -#: Used by :mod:`mopidy.frontends.mpd`. -#: -#: Default: 6600 -MPD_SERVER_PORT = 6600 - -#: The password required for connecting to the MPD server. -#: -#: Used by :mod:`mopidy.frontends.mpd`. -#: -#: Default: :class:`None`, which means no password required. -MPD_SERVER_PASSWORD = None - -#: The maximum number of concurrent connections the MPD server will accept. -#: -#: Used by :mod:`mopidy.frontends.mpd`. -#: -#: Default: 20 -MPD_SERVER_MAX_CONNECTIONS = 20 - -#: Audio output to use. -#: -#: Expects a GStreamer sink. Typical values are ``autoaudiosink``, -#: ``alsasink``, ``osssink``, ``oss4sink``, ``pulsesink``, and ``shout2send``, -#: and additional arguments specific to each sink. -#: -#: Default:: -#: -#: OUTPUT = u'autoaudiosink' -OUTPUT = 'autoaudiosink' - -#: Path to the Spotify cache. -#: -#: Used by :mod:`mopidy.backends.spotify`. -#: -#: Default:: -#: -#: SPOTIFY_CACHE_PATH = u'$XDG_CACHE_DIR/mopidy/spotify' -SPOTIFY_CACHE_PATH = '$XDG_CACHE_DIR/mopidy/spotify' - -#: Your Spotify Premium username. -#: -#: Used by :mod:`mopidy.backends.spotify`. -SPOTIFY_USERNAME = '' - -#: Your Spotify Premium password. -#: -#: Used by :mod:`mopidy.backends.spotify`. -SPOTIFY_PASSWORD = '' - -#: Spotify preferred bitrate. -#: -#: Available values are 96, 160, and 320. -#: -#: Used by :mod:`mopidy.backends.spotify`. -#: -#: Default:: -#: -#: SPOTIFY_BITRATE = 160 -SPOTIFY_BITRATE = 160 - -#: Spotify proxy host. -#: -#: Used by :mod:`mopidy.backends.spotify`. -#: -#: Example:: -#: -#: SPOTIFY_PROXY_HOST = u'protocol://host:port' -#: -#: Default:: -#: -#: SPOTIFY_PROXY_HOST = None -SPOTIFY_PROXY_HOST = None - -#: Spotify proxy username. -#: -#: Used by :mod:`mopidy.backends.spotify`. -#: -#: Default:: -#: -#: SPOTIFY_PROXY_USERNAME = None -SPOTIFY_PROXY_USERNAME = None - -#: Spotify proxy password. -#: -#: Used by :mod:`mopidy.backends.spotify`. -#: -#: Default:: -#: -#: SPOTIFY_PROXY_PASSWORD = None -SPOTIFY_PROXY_PASSWORD = None - -#: Max number of seconds to wait for Spotify operations to complete. -#: -#: Used by :mod:`mopidy.backends.spotify`. -#: -#: Default:: -#: -#: SPOTIFY_TIMEOUT = 10 -SPOTIFY_TIMEOUT = 10 - -#: Whitelist of URIs to support streaming from. -#: -#: Used by :mod:`mopidy.backends.stream`. -#: -#: Default:: -#: -#: STREAM_PROTOCOLS = ( -#: u'http', -#: u'https', -#: u'mms', -#: u'rtmp', -#: u'rtmps', -#: u'rtsp', -#: ) -STREAM_PROTOCOLS = ( - 'http', - 'https', - 'mms', - 'rtmp', - 'rtmps', - 'rtsp', -)