From e91d33374f84464569f9b12b961996018e7ba5d4 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Mon, 23 Aug 2010 20:48:01 +0200 Subject: [PATCH] docs: Split installation/settings/running into three pages --- docs/index.rst | 2 ++ docs/installation/index.rst | 60 ++++--------------------------------- docs/running.rst | 13 ++++++++ docs/settings.rst | 57 +++++++++++++++++++++++++++++++++++ 4 files changed, 77 insertions(+), 55 deletions(-) create mode 100644 docs/running.rst create mode 100644 docs/settings.rst diff --git a/docs/index.rst b/docs/index.rst index 19053ed5..7a4dc27d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,6 +7,8 @@ User documentation :maxdepth: 3 installation/index + settings + running clients/index changes authors diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 26b864d2..14ebdebc 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -70,6 +70,9 @@ To later upgrade to the latest release:: If you for some reason can't use ``pip``, try ``easy_install``. +Next, you need to set a couple of :doc:`settings `, and then you're +ready to :doc:`run Mopidy `. + Install development version =========================== @@ -92,58 +95,5 @@ To later update to the very latest version:: For an introduction to ``git``, please visit `git-scm.com `_. - -Settings -======== - -Mopidy reads settings from the file ``~/.mopidy/settings.py``, where ``~`` -means your *home directory*. If your username is ``alice`` and you are running -Linux, the settings file should probably be at -``/home/alice/.mopidy/settings.py``. - -You can either create this file yourself, or run the ``mopidy`` command, and it -will create an empty settings file for you. - -Music from Spotify ------------------- - -If you are using the Spotify backend, which is the default, enter your Spotify -Premium account's username and password into the file, like this:: - - SPOTIFY_USERNAME = u'myusername' - SPOTIFY_PASSWORD = u'mysecret' - -Music from local storage ------------------------- - -If you want use Mopidy to play music you have locally at your machine instead -of using Spotify, you need to change the backend from the default to -:mod:`mopidy.backends.local` by adding the following line to your settings -file:: - - BACKENDS = (u'mopidy.backends.local.LocalBackend',) - -You may also want to change some of the ``LOCAL_*`` settings. See -:mod:`mopidy.settings`, for a full list of available settings. - -Connecting from other machines on the network ---------------------------------------------- - -As a secure default, Mopidy only accepts connections from ``localhost``. If you -want to open it for connections from other machines on your network, see -the documentation for :attr:`mopidy.settings.MPD_SERVER_HOSTNAME`. - - -Running Mopidy -============== - -To start Mopidy, simply open a terminal and run:: - - mopidy - -When Mopidy says ``MPD server running at [127.0.0.1]:6600`` it's ready to -accept connections by any MPD client. You can find tons of MPD clients at -http://mpd.wikia.com/wiki/Clients. We use GMPC and ncmpcpp during development. -The first is a GUI client, and the second is a terminal client. - -To stop Mopidy, press ``CTRL+C``. +Next, you need to set a couple of :doc:`settings `, and then you're +ready to :doc:`run Mopidy `. diff --git a/docs/running.rst b/docs/running.rst new file mode 100644 index 00000000..4912512f --- /dev/null +++ b/docs/running.rst @@ -0,0 +1,13 @@ +************** +Running Mopidy +************** + +To start Mopidy, simply open a terminal and run:: + + mopidy + +When Mopidy says ``MPD server running at [127.0.0.1]:6600`` it's ready to +accept connections by any MPD client. Check out our non-exhaustive +:doc:`/clients/mpd` list to find recommended clients. + +To stop Mopidy, press ``CTRL+C``. diff --git a/docs/settings.rst b/docs/settings.rst new file mode 100644 index 00000000..6545a6b1 --- /dev/null +++ b/docs/settings.rst @@ -0,0 +1,57 @@ +******** +Settings +******** + +Mopidy reads settings from the file ``~/.mopidy/settings.py``, where ``~`` +means your *home directory*. If your username is ``alice`` and you are running +Linux, the settings file should probably be at +``/home/alice/.mopidy/settings.py``. + +You can either create this file yourself, or run the ``mopidy`` command, and it +will create an empty settings file for you. + + +Music from Spotify +================== + +If you are using the Spotify backend, which is the default, enter your Spotify +Premium account's username and password into the file, like this:: + + SPOTIFY_USERNAME = u'myusername' + SPOTIFY_PASSWORD = u'mysecret' + + +Music from local storage +======================== + +If you want use Mopidy to play music you have locally at your machine instead +of using Spotify, you need to change the backend from the default to +:mod:`mopidy.backends.local` by adding the following line to your settings +file:: + + BACKENDS = (u'mopidy.backends.local.LocalBackend',) + +You may also want to change some of the ``LOCAL_*`` settings. See +:mod:`mopidy.settings`, for a full list of available settings. + + +Connecting from other machines on the network +============================================= + +As a secure default, Mopidy only accepts connections from ``localhost``. If you +want to open it for connections from other machines on your network, see +the documentation for :attr:`mopidy.settings.MPD_SERVER_HOSTNAME`. + + +Running Mopidy +============== + +To start Mopidy, simply open a terminal and run:: + + mopidy + +When Mopidy says ``MPD server running at [127.0.0.1]:6600`` it's ready to +accept connections by any MPD client. Check out our non-exhaustive +:doc:`/clients/mpd` list to find recommended clients. + +To stop Mopidy, press ``CTRL+C``.