Difference between revisions of "Subsonic"

From ArchWiki
Jump to: navigation, search
(Systemd Setup)
(Configure permissions: Split one of the sample commands into two commands. This provides a 1:1 ratio of sentences to commands, which is logically consistent. Also tweak wording in instructions.)
(26 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
[[Category:Audio/Video]]
 
[[Category:Audio/Video]]
[[Category:Daemons and system services]]
 
 
'''Subsonic''' is a music server that lets you store your music on one machine and play it from other machines, cell phones, via a web interface, or various other applications. It can be installed using the {{AUR|subsonic}} package on [[AUR]].
 
'''Subsonic''' is a music server that lets you store your music on one machine and play it from other machines, cell phones, via a web interface, or various other applications. It can be installed using the {{AUR|subsonic}} package on [[AUR]].
  
==Additional config==
+
==Configuration==
===Run subsonic daemon NOT as root===
+
  
Stop subsonic daemon is running
+
After performing any configuration, remember to restart the daemon.
  
  # rc.d stop subsonic
+
  # systemctl restart subsonic
  
Add a system user "subsonic" without home folder and add it to "audio" group if you want to use the "jukebox" feature
+
For details on using systemctl, see [[Systemd#Using_units]].
  
# useradd --system --groups audio subsonic
+
===Configure permissions===
  
Change folder owners as follow. Path may changes; these are the default ones:
+
By default, Subsonic runs as root. The following instructions make Subsonic run as user "subsonic".
  
# chown -R subsonic:subsonic /tmp/subsonic
+
Stop the daemon if it's running. Add a system user named "subsonic". Optionally, add this user to the "audio" group to enable the [http://www.subsonic.org/pages/features.jsp jukebox] feature.
# chown -R subsonic:subsonic /var/subsonic
+
# chown -R root:root /var/subsonic/transcode
+
# chown -R root:root /var/subsonic/jetty/*/webapp
+
  
Change this line in {{ic|/var/subsonic/subsonic.sh}}
+
# systemctl stop subsonic
 +
# useradd --system subsonic
 +
# gpasswd --add subsonic audio
 +
 
 +
Create several folders and customize their permissions.
 +
 
 +
# cd /var/subsonic
 +
# chown -R subsonic:subsonic .
 +
# test -d transcode || mkdir transcode
 +
# chown -R root:root transcode
 +
 
 +
Change this line in {{ic|/var/subsonic/subsonic.sh}}:
  
 
  ${JAVA} -Xmx${SUBSONIC_MAX_MEMORY}m \
 
  ${JAVA} -Xmx${SUBSONIC_MAX_MEMORY}m \
  
with this one
+
to this:
  
 
  sudo -u subsonic ${JAVA} -Xmx${SUBSONIC_MAX_MEMORY}m \
 
  sudo -u subsonic ${JAVA} -Xmx${SUBSONIC_MAX_MEMORY}m \
  
Restart subsonic daemon
+
===Install transcoders===
  
# rc.d start subsonic
+
By default, Subsonic uses FFmpeg to transcode videos and songs to an appropriate format and bitrate on-the-fly. After installation, you can change these defaults so that, for example, Subsonic will transcode FLAC files using FLAC and LAME instead of FFmpeg. You should therefore [[pacman|Install]] the {{Pkg|ffmpeg}}, and you may also want to install {{Pkg|flac}} and {{Pkg|lame}}.
  
===Install LAME and FFmpeg for Transcoding ===
+
For security reasons, Subsonic will not search the system for any transcoders. Instead, the user must create symlinks to the transcoders in the {{ic|/var/subsonic/transcode}} folder. Create the {{ic|transcode}} folder if it does not already exist, then make the necessary symlinks.
Subsonic requires LAME to be installed to transcode songs in mp3 format to lower bit rates. Also requieres FFmpeg to transcode from other formats (as ogg, flac, wav or wma) to mp3 format or to stream video files.
+
If not already installed, [[pacman|Install]] the {{Pkg|lame}} and {{Pkg|ffmpeg}} package, available in the [[Official Repositories|official repositories]].
+
  
Put a symlink to LAME in the transcode directory for subsonic.
+
# mkdir /var/subsonic/transcode
 +
$ cd /var/subsonic/transcode
 +
# ln -s `which ffmpeg`
 +
# ln -s `which flac`
 +
# ln -s `which lame`
  
# ln -s /usr/bin/lame /var/subsonic/transcode/lame
+
=== HTTPS Setup ===
  
Put a symlink to FFmpeg in the transcode directory for subsonic.
+
To enable HTTPS browsing and streaming, edit {{ic|/var/subsonic/subsonic.sh}} and change this line:
# ln -s /usr/bin/ffmpeg /var/subsonic/transcode/ffmpeg
+
  
Restart subsonic daemon
+
  SUBSONIC_HTTPS_PORT=0
  # rc.d start subsonic
+
  
=== Systemd Setup ===
+
To this:
  
Create a service file in /usr/lib/systemd/system called subsonicd.service with this
+
  SUBSONIC_HTTPS_PORT=8443
   
+
{{hc|
+
[Unit]
+
Description=Subsonic
+
After=network.target
+
  
[Service]
+
{{Note|port 8443 seems hard-coded somewhere. When attempting to change it to port 8080 it will automatically redirect the browser to port 8443 after manually accepting the invalid HTTPS certificate. You will still be able to re-navigate to port 8080 after the warning page and have it work on that port.}}
Type=forking
+
ExecStart=/var/subsonic/subsonic.sh
+
ExecStop=/bin/kill -15 $MAINPID
+
  
[Install]
+
==Troubleshooting==
WantedBy=multi-user.target
+
===UTF-8 file names not added to the database===
}}
+
You must have at least one UTF-8 [[locale]] installed.
  
Then, run:
+
If you start subsonic using {{ic|/etc/rc.d/subsonic}}, and your /etc/[[rc.conf]] has {{ic|<nowiki>DAEMON_LOCALE="no"</nowiki>}}, then the subsonic daemon will be started with the C locale, and Java will skip any folders with "international characters" (e.g. ßðþøæå etc.). Either set {{ic|DAEMON_LOCALE}} to {{ic|"yes"}} (but this will affect '''all''' rc.daemons), or add a line to the beginning of {{ic|/var/subsonic/subsonic.sh}} which sets {{ic|LANG}} to an installed UTF-8 locale, e.g. {{ic|<nowiki>LANG=nn_NO.utf8</nowiki>}}.
{{ic|
+
  
$ sudo systemctl --system daemon-reload}}
+
===FLAC playback===
  
And finally enable it:
+
The FFmpeg transcoder doesn't handle FLAC files well, and clients will often fail to play the resultant streams. (at least, on [[User:Ichimonji10|my]] machine) Using FLAC and LAME instead of FFmpeg solves this issue. This workaround requires that the FLAC and LAME transcoders have been installed, as explained in [[#Install Transcoders]].
  
{{ic|
+
Start Subsonic and go to {{ic|settings > transcoding}}. Ensure that the default FFmpeg transcoder does not get used on files with a "flac" extension, then add a new entry. You'll end up with something like this:
  
$ sudo systemctl enable minecraftd.service}}
+
{| class="wikitable" border="1" cellpadding="5" cellspacing="0"
 +
! Name !! Convert from !! Convert to !! Step 1 !! Step 2
 +
|-
 +
| mp3 default || ... NOT flac ... || mp3 || ffmpeg ... || &nbsp;
 +
|-
 +
| mp3 flac || flac || mp3 || flac --silent --decode --stdout %s || lame --silent -h -b %b -
 +
|}
  
==Troubleshooting==
+
==Madsonic==
===UTF-8 file names not added to the database===
+
Madsonic is a fork of Subsonic with extra features, does not require a registration fee (read completely free) and is available in AUR.
You must have at least one UTF-8 [[locale]] installed.
+
  
If you start subsonic using {{ic|/etc/rc.d/subsonic}}, and your /etc/[[rc.conf]] has {{ic|<nowiki>DAEMON_LOCALE="no"</nowiki>}}, then the subsonic daemon will be started with the C locale, and Java will skip any folders with "international characters" (e.g. ßðþøæå etc.). Either set {{ic|DAEMON_LOCALE}} to {{ic|"yes"}} (but this will affect '''all''' rc.daemons), or add a line to the beginning of {{ic|/var/subsonic/subsonic.sh}} which sets {{ic|LANG}} to an installed UTF-8 locale, e.g. {{ic|<nowiki>LANG=nn_NO.utf8</nowiki>}}.
+
Once you start the server, pay close attention to the Transcoding options, as you will probably have to change the command from "Audioffmpeg" to "ffmpeg".
  
 
==External links==
 
==External links==
 
* [http://www.subsonic.org Official web site]
 
* [http://www.subsonic.org Official web site]

Revision as of 20:58, 8 February 2014

Subsonic is a music server that lets you store your music on one machine and play it from other machines, cell phones, via a web interface, or various other applications. It can be installed using the subsonicAUR package on AUR.

Configuration

After performing any configuration, remember to restart the daemon.

# systemctl restart subsonic

For details on using systemctl, see Systemd#Using_units.

Configure permissions

By default, Subsonic runs as root. The following instructions make Subsonic run as user "subsonic".

Stop the daemon if it's running. Add a system user named "subsonic". Optionally, add this user to the "audio" group to enable the jukebox feature.

# systemctl stop subsonic
# useradd --system subsonic
# gpasswd --add subsonic audio

Create several folders and customize their permissions.

# cd /var/subsonic
# chown -R subsonic:subsonic .
# test -d transcode || mkdir transcode
# chown -R root:root transcode

Change this line in /var/subsonic/subsonic.sh:

${JAVA} -Xmx${SUBSONIC_MAX_MEMORY}m \

to this:

sudo -u subsonic ${JAVA} -Xmx${SUBSONIC_MAX_MEMORY}m \

Install transcoders

By default, Subsonic uses FFmpeg to transcode videos and songs to an appropriate format and bitrate on-the-fly. After installation, you can change these defaults so that, for example, Subsonic will transcode FLAC files using FLAC and LAME instead of FFmpeg. You should therefore Install the ffmpeg, and you may also want to install flac and lame.

For security reasons, Subsonic will not search the system for any transcoders. Instead, the user must create symlinks to the transcoders in the /var/subsonic/transcode folder. Create the transcode folder if it does not already exist, then make the necessary symlinks.

# mkdir /var/subsonic/transcode
$ cd /var/subsonic/transcode
# ln -s `which ffmpeg`
# ln -s `which flac`
# ln -s `which lame`

HTTPS Setup

To enable HTTPS browsing and streaming, edit /var/subsonic/subsonic.sh and change this line:

SUBSONIC_HTTPS_PORT=0

To this:

SUBSONIC_HTTPS_PORT=8443
Note: port 8443 seems hard-coded somewhere. When attempting to change it to port 8080 it will automatically redirect the browser to port 8443 after manually accepting the invalid HTTPS certificate. You will still be able to re-navigate to port 8080 after the warning page and have it work on that port.

Troubleshooting

UTF-8 file names not added to the database

You must have at least one UTF-8 locale installed.

If you start subsonic using /etc/rc.d/subsonic, and your /etc/rc.conf has DAEMON_LOCALE="no", then the subsonic daemon will be started with the C locale, and Java will skip any folders with "international characters" (e.g. ßðþøæå etc.). Either set DAEMON_LOCALE to "yes" (but this will affect all rc.daemons), or add a line to the beginning of /var/subsonic/subsonic.sh which sets LANG to an installed UTF-8 locale, e.g. LANG=nn_NO.utf8.

FLAC playback

The FFmpeg transcoder doesn't handle FLAC files well, and clients will often fail to play the resultant streams. (at least, on my machine) Using FLAC and LAME instead of FFmpeg solves this issue. This workaround requires that the FLAC and LAME transcoders have been installed, as explained in #Install Transcoders.

Start Subsonic and go to settings > transcoding. Ensure that the default FFmpeg transcoder does not get used on files with a "flac" extension, then add a new entry. You'll end up with something like this:

Name Convert from Convert to Step 1 Step 2
mp3 default ... NOT flac ... mp3 ffmpeg ...  
mp3 flac flac mp3 flac --silent --decode --stdout %s lame --silent -h -b %b -

Madsonic

Madsonic is a fork of Subsonic with extra features, does not require a registration fee (read completely free) and is available in AUR.

Once you start the server, pay close attention to the Transcoding options, as you will probably have to change the command from "Audioffmpeg" to "ffmpeg".

External links