From bba1f0a84070c9a2d26dc324534d683e4510af83 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sun, 12 Jan 2014 23:31:47 +0100 Subject: [PATCH] docs: Update install docs for OS X and source install --- docs/installation/index.rst | 159 +++++++++++++++++++----------------- 1 file changed, 82 insertions(+), 77 deletions(-) diff --git a/docs/installation/index.rst b/docs/installation/index.rst index fb3de75b..73c2f08f 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -105,11 +105,11 @@ package found in AUR. then you're ready to :doc:`run Mopidy `. -OS X: Install from Homebrew and Pip +OS X: Install from Homebrew and pip =================================== If you are running OS X, you can install everything needed with Homebrew and -Pip. +pip. #. Install `Homebrew `_. @@ -127,7 +127,7 @@ Pip. #. Install the required packages from Homebrew:: - brew install gst-python010 gst-plugins-good010 gst-plugins-ugly010 libspotify + brew install gst-python010 gst-plugins-good010 gst-plugins-ugly010 #. Make sure to include Homebrew's Python ``site-packages`` directory in your ``PYTHONPATH``. If you don't include this, Mopidy will not find GStreamer @@ -142,32 +142,48 @@ Pip. PYTHONPATH=$(brew --prefix)/lib/python2.7/site-packages mopidy -#. Next up, you need to install some Python packages. To do so, we use Pip. If +#. Next up, you need to install some Python packages. To do so, we use pip. If you don't have the ``pip`` command, you can install it now:: sudo easy_install pip -#. Then get, build, and install the latest release of pyspotify, pylast, - and Mopidy using Pip:: +#. Then, install the latest release of Mopidy using pip:: - sudo pip install -U pyspotify pylast cherrypy ws4py mopidy + sudo pip install -U mopidy + +#. Optionally, install additional extensions to Mopidy. + + For HTTP frontend support, so you can run Mopidy web clients:: + + sudo pip install -U mopidy[http] + + For playing music from Spotify:: + + brew install libspotify + sudo pip install -U mopidy-spotify + + For scrobbling to Last.fm:: + + sudo pip install -U mopidy-scrobbler + + For more extensions, see :ref:`ext`. #. Finally, you need to set a couple of :doc:`config values `, and then you're ready to :doc:`run Mopidy `. -Otherwise: Install from source using Pip +Otherwise: Install from source using pip ======================================== If you are on on Linux, but can't install from the APT archive or from AUR, you -can install Mopidy from PyPI using Pip. +can install Mopidy from PyPI using pip. #. First of all, you need Python 2.7. Check if you have Python and what version by running:: python --version -#. When you install using Pip, you need to make sure you have Pip. You'll also +#. When you install using pip, you need to make sure you have pip. You'll also need a C compiler and the Python development headers to build pyspotify later. @@ -183,49 +199,63 @@ can install Mopidy from PyPI using Pip. sudo yum install -y gcc python-devel python-pip -#. Then you'll need to install all of Mopidy's hard non-Python dependencies: + .. note:: - - GStreamer 0.10 (>= 0.10.31, < 0.11), with Python bindings. GStreamer is - packaged for most popular Linux distributions. Search for GStreamer in - your package manager, and make sure to install the Python bindings, and - the "good" and "ugly" plugin sets. + On Fedora Linux, you must replace ``pip`` with ``pip-python`` in the + following steps. - If you use Debian/Ubuntu you can install GStreamer like this:: +#. Then you'll need to install GStreamer 0.10 (>= 0.10.31, < 0.11), with Python + bindings. GStreamer is packaged for most popular Linux distributions. Search + for GStreamer in your package manager, and make sure to install the Python + bindings, and the "good" and "ugly" plugin sets. - sudo apt-get install python-gst0.10 gstreamer0.10-plugins-good \ - gstreamer0.10-plugins-ugly gstreamer0.10-tools + If you use Debian/Ubuntu you can install GStreamer like this:: - If you use Arch Linux, install the following packages from the official - repository:: + sudo apt-get install python-gst0.10 gstreamer0.10-plugins-good \ + gstreamer0.10-plugins-ugly gstreamer0.10-tools - sudo pacman -S gstreamer0.10-python gstreamer0.10-good-plugins \ - gstreamer0.10-ugly-plugins + If you use Arch Linux, install the following packages from the official + repository:: - If you use Fedora you can install GStreamer like this:: + sudo pacman -S gstreamer0.10-python gstreamer0.10-good-plugins \ + gstreamer0.10-ugly-plugins - sudo yum install -y python-gst0.10 gstreamer0.10-plugins-good \ - gstreamer0.10-plugins-ugly gstreamer0.10-tools + If you use Fedora you can install GStreamer like this:: - If you use Gentoo you need to be careful because GStreamer 0.10 is in - a different lower slot than 1.0, the default. Your emerge commands will - need to include the slot:: + sudo yum install -y python-gst0.10 gstreamer0.10-plugins-good \ + gstreamer0.10-plugins-ugly gstreamer0.10-tools - emerge -av gst-python gst-plugins-bad:0.10 gst-plugins-good:0.10 \ - gst-plugins-ugly:0.10 gst-plugins-meta:0.10 + If you use Gentoo you need to be careful because GStreamer 0.10 is in a + different lower slot than 1.0, the default. Your emerge commands will need + to include the slot:: - gst-plugins-meta:0.10 is the one that actually pulls in the plugins - you want, so pay attention to the use flags, e.g. ``alsa``, ``mp3``, etc. + emerge -av gst-python gst-plugins-bad:0.10 gst-plugins-good:0.10 \ + gst-plugins-ugly:0.10 gst-plugins-meta:0.10 + + ``gst-plugins-meta:0.10`` is the one that actually pulls in the plugins you + want, so pay attention to the use flags, e.g. ``alsa``, ``mp3``, etc. + +#. Install the latest release of Mopidy:: + + sudo pip install -U mopidy + + To upgrade Mopidy to future releases, just rerun this command. + + Alternatively, if you want to track Mopidy development closer, you may + install a snapshot of Mopidy's ``develop`` Git branch using pip:: + + sudo pip install mopidy==dev + +#. Optional: If you want to use the HTTP frontend and web clients, you need + some additional dependencies:: + + sudo pip install -U mopidy[http] #. Optional: If you want Spotify support in Mopidy, you'll need to install - libspotify and the Python bindings, pyspotify. + libspotify and the Mopidy-Spotify extension. - #. First, check `pyspotify's changelog `_ to - see what's the latest version of libspotify which it supports. The - versions of libspotify and pyspotify are tightly coupled, so you'll need - to get this right. - - #. Download and install the appropriate version of libspotify for your OS - and CPU architecture from `Spotify + #. Download and install the latest version of libspotify for your OS and CPU + architecture from `Spotify `_. For libspotify 12.1.51 for 64-bit Linux the process is as follows:: @@ -234,7 +264,6 @@ can install Mopidy from PyPI using Pip. tar zxfv libspotify-12.1.51-Linux-x86_64-release.tar.gz cd libspotify-12.1.51-Linux-x86_64-release/ sudo make install prefix=/usr/local - sudo ldconfig Remember to adjust the above example for the latest libspotify version supported by pyspotify, your OS, and your CPU architecture. @@ -245,55 +274,31 @@ can install Mopidy from PyPI using Pip. su -c 'echo "/usr/local/lib" > /etc/ld.so.conf.d/libspotify.conf' sudo ldconfig - #. Then get, build, and install the latest release of pyspotify using Pip:: + #. Then install the latest release of Mopidy-Spotify using pip:: - sudo pip install -U pyspotify - - On Fedora the binary is called ``pip-python``:: - - sudo pip-python install -U pyspotify + sudo pip install -U mopidy-spotify #. Optional: If you want to scrobble your played tracks to Last.fm, you need - pylast:: + to install Mopidy-Scrobbler:: - sudo pip install -U pylast - - On Fedora the binary is called ``pip-python``:: - - sudo pip-python install -U pylast - -#. Optional: If you want to use the HTTP frontend and web clients, you need - cherrypy and ws4py:: - - sudo pip install -U cherrypy ws4py - - On Fedora the binary is called ``pip-python``:: - - sudo pip-python install -U cherrypy ws4py + sudo pip install -U mopidy-scrobbler #. Optional: To use Mopidy-MPRIS, e.g. for controlling Mopidy from the Ubuntu Sound Menu or from an UPnP client via Rygel, you need some additional - dependencies: the Python bindings for libindicate, and the Python bindings - for libdbus, the reference D-Bus library. + dependencies and the Mopidy-MPRIS extension. - On Debian/Ubuntu:: + #. Install the Python bindings for libindicate, and the Python bindings for + libdbus, the reference D-Bus library. - sudo apt-get install python-dbus python-indicate + On Debian/Ubuntu:: -#. Then, to install the latest release of Mopidy:: + sudo apt-get install python-dbus python-indicate - sudo pip install -U mopidy + #. Then install the latest release of Mopidy-MPRIS using pip:: - On Fedora the binary is called ``pip-python``:: + sudo pip install -U mopidy-mpris - sudo pip-python install -U mopidy - - To upgrade Mopidy to future releases, just rerun this command. - - Alternatively, if you want to track Mopidy development closer, you may - install a snapshot of Mopidy's ``develop`` Git branch using Pip:: - - sudo pip install mopidy==dev +#. For more Mopidy extensions, see :ref:`ext`. #. Finally, you need to set a couple of :doc:`config values `, and then you're ready to :doc:`run Mopidy `.