Difference between revisions of "CherryMusic"

From ArchWiki
Jump to: navigation, search
(Tips & Tricks)
(updated optional dependencies section)
(38 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 +
[[Category:Web Server]]
 
[[Category:Player]]
 
[[Category:Player]]
 +
[[Category:Internet applications]]
 
{{Article summary start}}
 
{{Article summary start}}
{{Article summary text|Installation, configuration and basic troubleshooting of CherryMusic.}}
+
{{Article summary text|Installation, configuration, tips & tricks and basic troubleshooting of CherryMusic - a music streaming server.}}
 
{{Article summary heading|Other sources}}
 
{{Article summary heading|Other sources}}
 
{{Article summary text|[http://www.fomori.org/cherrymusic/ CherryMusic website]}}
 
{{Article summary text|[http://www.fomori.org/cherrymusic/ CherryMusic website]}}
Line 24: Line 26:
  
 
For a more up-to-date version with experimental features the CherryMusic development version, {{AUR|cherrymusic-devel-git}}, can be chosen. In order to build this version, you need {{Pkg|Git}}.
 
For a more up-to-date version with experimental features the CherryMusic development version, {{AUR|cherrymusic-devel-git}}, can be chosen. In order to build this version, you need {{Pkg|Git}}.
 +
 +
{{Note|This AUR package needs pacman > = 4.1!}}
  
 
=== Dependencies ===
 
=== Dependencies ===
Line 29: Line 33:
 
==== Required ====
 
==== Required ====
  
  * {{Pkg|python}}
+
Required dependencies are:
  * {{Pkg|python-cherrypy}}
+
 
 +
{{Pkg|python}}, {{Pkg|python-cherrypy}}
  
 
==== Optional ====
 
==== Optional ====
  
  * {{AUR|python3-stagger-svn}} (For ID3-Tag reading)
+
Optional dependencies are:
  * {{Pkg|lame}} (For live transcoding)
+
 
  * {{Pkg|vorbis-tools}} (For live transcoding)
+
* Live transcoding: {{Pkg|lame}}, {{Pkg|vorbis-tools}}, {{Pkg|flac}}, {{Pkg|faad2}}, {{Pkg|mpg123}} or {{Pkg|ffmpeg}} (which replaces the aforementioned codecs plus adds WMA decoding)
  * {{Pkg|flac}} (For Live transcoding)
+
* Automatic image resizing on displayed cover art: {{Pkg|imagemagick}}
  * {{Pkg|faad2}}
+
* Special character search terms: {{Pkg|python-unidecode}}
  * {{Pkg|mpg123}}
+
* GTK system tray icon: {{Pkg|python-gobject}}
  * {{Pkg|ffmpeg}}
+
  * {{Pkg|imagemagick}} (For autimatic image resizing on displayed cover art)
+
  
 
== Configuration ==
 
== Configuration ==
Line 49: Line 52:
 
To just get it up and running with a basic setup, issue:
 
To just get it up and running with a basic setup, issue:
  
   $ python cherrymusic --setup --port 8080
+
   $ cherrymusic --setup --port 8080
  
 
and open the address "localhost:8080" in your browser (e.g. with [[Firefox]]):
 
and open the address "localhost:8080" in your browser (e.g. with [[Firefox]]):
Line 55: Line 58:
 
   $ firefox localhost:8080
 
   $ firefox localhost:8080
  
This will let you configure the most important options from within the browser.
+
This will let you configure the most important options from within the browser and you can set up the admin account.
 +
 
 +
If you want CherryMusic to run as a system service and to automatically start on boot, see [[#Systemd service file|systemd service file]].
  
 
=== Manual setup ===
 
=== Manual setup ===
Line 63: Line 68:
 
   $ cherrymusic
 
   $ cherrymusic
  
On first startup CherryMusic will create it's data and configuration files in {{ic|~./.local/share/cherrymusic/}} and {{ic|~/.config/cherrymusic/}}, print a note to stout and exit.
+
On first startup CherryMusic will create its data and configuration files in {{ic|~/.local/share/cherrymusic/}} and {{ic|~/.config/cherrymusic/}}, print a note to ''stdout'' and exit.
Now, edit the configuration file in {{ic|~/.config/cherrymusic/cherrymusic.conf}}and change the following line to match your setup:
+
Now, edit the configuration file in {{ic|~/.config/cherrymusic/cherrymusic.conf}}and change the following lines to match your setup:
  
 
{{hc|~/.config/cherrymusic/cherrymusic.conf|
 
{{hc|~/.config/cherrymusic/cherrymusic.conf|
Line 74: Line 79:
 
}}
 
}}
  
Open the address "localhost:8080" in your browser (e.g. with [[Firefox]]) to create an account:
+
Open the address "localhost:8080" in your browser (e.g. with [[Firefox]]) to create an admin account:
  
 
   $ firefox localhost:8080
 
   $ firefox localhost:8080
  
There are much more options to configure, please see [[#Fine tuning|this section]].
+
After logging in, populate the search database by clicking ''Update Music Library'' in the ''Admin'' panel.
 +
 
 +
If you want CherryMusic to run as a system service and to automatically start on boot, see [[#Systemd service file|systemd service file]].
 +
 
 +
There are many more options to configure, please see [[#Fine tuning|this section]].
  
 
=== Fine tuning ===
 
=== Fine tuning ===
Line 101: Line 110:
 
   $ ln -s /path/to/musicdir1 ~/.local/share/cherrymusic/basedir/musicdir1
 
   $ ln -s /path/to/musicdir1 ~/.local/share/cherrymusic/basedir/musicdir1
 
   $ ln -s /path/to/musicdir2 ~/.local/share/cherrymusic/basedir/musicdir2
 
   $ ln -s /path/to/musicdir2 ~/.local/share/cherrymusic/basedir/musicdir2
 +
 +
=== Systemd service file ===
 +
 +
CherryMusic does not come with a daemon yet, but [[#Installation|both CherryMusic AUR packages]] provide a systemd service file.
 +
If you want CherryMusic to run as a system service and to automatically start on boot, simply do:
 +
 +
{{Note|Replace "USER" with the user that should run CherryMusic (do not use root!).}}
 +
 +
  $ sudo systemctl start cherrymusic@USER.service
 +
  $ sudo systemctl enable cherrymusic@USER.service
 +
 +
Note that although the CherryMusic service is now run as the user "USER", the service calls still have to be given as root.
  
 
=== Running in a GNU Screen session ===
 
=== Running in a GNU Screen session ===
Line 108: Line 129:
 
   $ screen -d -m -S cherrymusic cherrymusic
 
   $ screen -d -m -S cherrymusic cherrymusic
  
Since CherryMusic only writes the output to the GNU Screen session, there is nothing to control from within the session. It may be more convenient to use a [[#systemd service file|systemd service file]].
+
Since CherryMusic only writes the output to the GNU Screen session, there is nothing to control from within the session. It may be more convenient to use a [[#Systemd service file|systemd service file]]. However, this may still be useful for debugging.
  
=== Systemd service file ===
+
To run it in a GNU Screen session after boot, the following [[systemd]] service file can also be used:
 
+
CherryMusic does not come with a daemon yet. To run it as a system service, the following [[systemd]] service file can be used:
+
 
+
{{Note|The line "User = cherrymusic" must be changed to the username that should run CherryMusic.}}
+
  
{{hc|/usr/lib/systemd/system/cherrymusic.service|
+
{{hc|/usr/lib/systemd/system/cherrymusic@.service|
 
[Unit]
 
[Unit]
 
Description = CherryMusic server
 
Description = CherryMusic server
 +
Requires = network.target
 
After = network.target
 
After = network.target
  
 
[Service]
 
[Service]
User = cherrymusic
+
User = %I
ExecStart = /usr/bin/cherrymusic
+
Type = simple
PrivateTmp = true
+
ExecStart = /usr/bin/screen -d -m -S cherrymusic /usr/bin/cherrymusic
 +
ExecStop = /usr/bin/screen -X -S cherrymusic quit
 
StandardOutput = null
 
StandardOutput = null
 +
PrivateTmp = true
 
Restart = always
 
Restart = always
  
Line 134: Line 154:
 
This file has to be placed into {{ic|/usr/lib/systemd/system/}}:
 
This file has to be placed into {{ic|/usr/lib/systemd/system/}}:
  
   $ sudo cp cherrymusic.service /usr/lib/systemd/system/cherrymusic.service
+
   $ sudo cp cherrymusic@.service /usr/lib/systemd/system/cherrymusic@.service
  
 
and the permissions should be changed:
 
and the permissions should be changed:
  
   $ sudo chmod 644 /usr/lib/systemd/system/cherrymusic.service
+
   $ sudo chmod 644 /usr/lib/systemd/system/cherrymusic@.service
  
Finally, enable and start the service:
+
To finally enable and start the service, see [[#Systemd service file|systemd service file]].
  
  $ sudo systemctl enable cherrymusic.service
+
== 3rd Party Extensions ==
  $ sudo systemctl start cherrymusic.service
+
  
Note that although the CherryMusic service is now run as the user specified in the systemd service file, the service calls still have to be given as root.
+
* CherryMusic Control - A Playback control plugin for Firefox: <br> https://addons.mozilla.org/en-US/firefox/addon/cherrymusic-control <br> Which is also developed on github: https://github.com/Sets88/cherrymusicctrl
  
 
== Troubleshooting ==
 
== Troubleshooting ==
Line 152: Line 171:
  
 
An active flash blocker can interfere with the web frontend. If you have trouble with things like track selection or playback, try whitelisting the server in your browser's flash blocker/plugin manager.
 
An active flash blocker can interfere with the web frontend. If you have trouble with things like track selection or playback, try whitelisting the server in your browser's flash blocker/plugin manager.
 +
 +
=== CherryMusic does not load on Android Chrome ===
 +
 +
This might be due to AdBlock Plus being installed in the browser. CM does not feature any ads, so the problem is caused by this plug-in.
 +
 +
== See also ==
 +
 +
https://github.com/devsnd/cherrymusic/wiki/Setup-guide
 +
 +
http://fomori.org/blog/?p=687

Revision as of 12:03, 15 March 2014

Template:Article summary start Template:Article summary text Template:Article summary heading Template:Article summary text Template:Article summary text Template:Article summary end

CherryMusic is a music streaming server based on CherryPy and jPlayer. It can be run remotely or on a single computer and is designed to handle huge music libraries (3 TB and more) but also works well with small collections. In contrast to MPD, Icecast and the like, CherryMusic allows multiple users to (individually) login via HTTP/HTTPS using a web browser, browse/search the music database and create/edit playlists and stream music to the browser. From the website:

"CherryMusic is a standalone music server written in python based on CherryPy and jPlayer. It is intended to be an alternative to Last.fm, Spotify, Grooveshark... you name it."

The project is developed on GitHub.

Installation

CherryMusic is available in the AUR. There are two packages, the stable release and the development version. If you do not depend on a completely stable version, the development version is recommended, but needs Git for installation.

Stable version

The latest stable version of cherrymusicAUR is available in the AUR.

Git version

For a more up-to-date version with experimental features the CherryMusic development version, cherrymusic-devel-gitAUR, can be chosen. In order to build this version, you need Git.

Note: This AUR package needs pacman > = 4.1!

Dependencies

Required

Required dependencies are:

python, python-cherrypy

Optional

Optional dependencies are:

Configuration

Quick start

To just get it up and running with a basic setup, issue:

 $ cherrymusic --setup --port 8080

and open the address "localhost:8080" in your browser (e.g. with Firefox):

 $ firefox localhost:8080

This will let you configure the most important options from within the browser and you can set up the admin account.

If you want CherryMusic to run as a system service and to automatically start on boot, see systemd service file.

Manual setup

Start CherryMusic for the initial setup:

 $ cherrymusic

On first startup CherryMusic will create its data and configuration files in ~/.local/share/cherrymusic/ and ~/.config/cherrymusic/, print a note to stdout and exit. Now, edit the configuration file in ~/.config/cherrymusic/cherrymusic.confand change the following lines to match your setup:

~/.config/cherrymusic/cherrymusic.conf
[...]
basedir = /path/to/your/music
[...]
port = 8080
[...]

Open the address "localhost:8080" in your browser (e.g. with Firefox) to create an admin account:

 $ firefox localhost:8080

After logging in, populate the search database by clicking Update Music Library in the Admin panel.

If you want CherryMusic to run as a system service and to automatically start on boot, see systemd service file.

There are many more options to configure, please see this section.

Fine tuning

CherryMusic comes with well-documented manpages. see

 $ man cherrymusic

or

 $ man cherrymusic.conf

Tips & Tricks

Symlinks in "basedir"

Note: This is only useful if your music is in different locations, e.g. on an internal hard drive and an external hard dirve.

Probably, the most modular and flexible way of populating CherryMusic's music directory (called "basedir") is to create a dedicated directory and only symlink all paths to your music collections into that directory, e.g.:

 $ mkdir ~/.local/share/cherrymusic/basedir
 $ ln -s /path/to/musicdir1 ~/.local/share/cherrymusic/basedir/musicdir1
 $ ln -s /path/to/musicdir2 ~/.local/share/cherrymusic/basedir/musicdir2

Systemd service file

CherryMusic does not come with a daemon yet, but both CherryMusic AUR packages provide a systemd service file. If you want CherryMusic to run as a system service and to automatically start on boot, simply do:

Note: Replace "USER" with the user that should run CherryMusic (do not use root!).
 $ sudo systemctl start cherrymusic@USER.service
 $ sudo systemctl enable cherrymusic@USER.service

Note that although the CherryMusic service is now run as the user "USER", the service calls still have to be given as root.

Running in a GNU Screen session

To keep CherryMusic running after logout, it can be run in a GNU Screen session.

 $ screen -d -m -S cherrymusic cherrymusic

Since CherryMusic only writes the output to the GNU Screen session, there is nothing to control from within the session. It may be more convenient to use a systemd service file. However, this may still be useful for debugging.

To run it in a GNU Screen session after boot, the following systemd service file can also be used:

/usr/lib/systemd/system/cherrymusic@.service
[Unit]
Description = CherryMusic server
Requires = network.target
After = network.target

[Service]
User = %I
Type = simple
ExecStart = /usr/bin/screen -d -m -S cherrymusic /usr/bin/cherrymusic
ExecStop = /usr/bin/screen -X -S cherrymusic quit
StandardOutput = null
PrivateTmp = true
Restart = always

[Install]
WantedBy = multi-user.target

This file has to be placed into /usr/lib/systemd/system/:

 $ sudo cp cherrymusic@.service /usr/lib/systemd/system/cherrymusic@.service

and the permissions should be changed:

 $ sudo chmod 644 /usr/lib/systemd/system/cherrymusic@.service

To finally enable and start the service, see systemd service file.

3rd Party Extensions

Troubleshooting

Deactivate flash blocker

An active flash blocker can interfere with the web frontend. If you have trouble with things like track selection or playback, try whitelisting the server in your browser's flash blocker/plugin manager.

CherryMusic does not load on Android Chrome

This might be due to AdBlock Plus being installed in the browser. CM does not feature any ads, so the problem is caused by this plug-in.

See also

https://github.com/devsnd/cherrymusic/wiki/Setup-guide

http://fomori.org/blog/?p=687