hurricane/subsonic repository overview

• Introduction⁠
  • Contributing⁠
  • Issues⁠
• Getting started⁠
  • Prerequisites⁠
  • Installation⁠
    • Docker Hub⁠
    • GitHub⁠
    • Initial Configuration⁠
• Maintenance⁠
  • Upgrading⁠
  • Automatic Upgrades⁠
  • Removal⁠
  • Shell Access⁠
• unRAID⁠
  • Installation⁠
  • Automatic Upgrades⁠
• Technical Information⁠
  • Environment Variables⁠
  • Volumes⁠
• Manual Run and Installation⁠
• License⁠
• Donation⁠

⁠Introduction

Subsonic is an open source, web-based media server.

Because Subsonic was written in Java, it may be run on any operating system with Java support. Subsonic supports streaming to multiple clients simultaneously, and supports any streamable media (including MP3, AAC, and Ogg). Subsonic also supports on-the-fly media conversion (through the use of plugins) of most popular media formats, including WMA, FLAC, and more.

This subfolder contains all necessary files to build a Docker⁠ image for Subsonic⁠.

⁠Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature
5. Submit a pull request :D

⁠Issues

Before reporting your issue please try updating Docker to the latest version and check if it resolves the issue. Refer to the Docker installation guide⁠ for instructions.

SELinux users should try disabling SELinux using the command setenforce 0 to see if it resolves the issue.

If the above recommendations do not help then report your issue⁠ along with the following information:

• Output of the docker version and docker info commands
• The docker run command or docker-compose.yml used to start the image. Mask out the sensitive bits.
• Please state if you are using Boot2Docker⁠, VirtualBox⁠, etc.

⁠Getting started

⁠Prerequisites

• ensure the user running the installation command can run docker

⁠Installation:

⁠Docker Hub⁠:

It is recommended you install directly from the Docker Hub⁠. Before starting the install procedure please verify that any and all prerequisites are fulfilled:

The following command copies over a wrapper scrip that will create a container named subsonic when executed. The wrapper script will ensure that the container gets setup with the appropriate environment variables and volumes each time it is executed. It does so by prompting and saving certain setting to answer file that it will look up each time it is called.

Start the installation by issuing the following command from within a terminal:

docker run -it --rm -v /usr/local/bin:/target \
    hurricane/subsonic instl

Optionally, you can also install a systemd service file. Before installing the systemd service file, you might want specify which user you wish the daemon to run as, specifically if it differs from the user running the installation. You can do this by reinstalling subsonic with the following command:

docker run -it --rm -v /usr/local/bin:/target -e "APP_USER=username" \
    hurricane/subsonic instl

If the user you specified does not have a valid home directory you will probably want to specify an alternate location to store the subsonic configuration and database like so:

docker run -it --rm -v /usr/local/bin:/target \
    -e "APP_USER=username" \
    -e "APP_CONFIG=/var/lib/subsonic" \
    hurricane/subsonic instl

Above, change the username to the name of the user you wish to run the daemon as, and adjust /var/lib/subsonic to wherever it is you wish to store your subsonic database and information. Please verify that $APP_USER is the owner of $APP_CONFIG.

Afterward, proceed with the service file installation:

docker run -it --rm -v /etc/systemd/system:/target \
   hurricane/subsonic instl service

If you installed the systemd service file, you can enable Subsonic to automatically start when the system boots by executing the following command:

sudo systemctl enable subsonic.service

⁠GitHub⁠:

Installation from GitHub is recommended only for the purposes of troubleshooting and development. To install Subsonic from GitHub execute the following:

git clone https://github.com/hurricane/docker-containers
cd docker-containers/subsonic
make instl

Additionally, you can install the systemd service file after executing the above by issuing the following:

make service

⁠Initial Configuration:

Once Subsonic has been installed you can simply execute the binary from a terminal:

subsonic

The first time you run the Subsonic container it will prompt you for the locations of MUSIC, PODCASTS, and PLAYLISTS. Enter one response per query. This will ensure that the container gets access to the host's file system from within the containerized environment.

⁠Maintenance

⁠Upgrading:

If you have installed our systemd service file, you can update by executing the following command:

sudo systemctl restart subsonic.service

Additionally you can update by:

docker exec subsonic update

Or by executing:

docker pull hurricane/subsonic
docker stop subsonic
subsonic

⁠Automatic Upgrades:

In order to have the container periodically check and upgrade the subsonic binary one needs to add a crontab⁠ entry. Like so:

echo "0 2 * * * docker exec subsonic update" | sudo tee -a /var/spool/cron/crontabs/root

⁠Removal:

docker run -it --rm \
  --volume /usr/local/bin:/target \
  hurricane/subsonic uninstl

⁠Shell Access

For debugging and maintenance purposes you may want access the containers shell. If you are using Docker version 1.3.0 or higher you can access a running containers shell by starting bash using docker exec:

docker exec -it subsonic bash

⁠unRAID:

You can find the template for this container on GitHub. Located here⁠.

⁠unRAID Installation:

Please navigate to the Docker settings page on unRAID's Web-UI and under repositories add:

https://github.com/hurricanehrndz/container-templates/tree/master/hurricane

For more information on adding templates to unRAID please visit the unRAID forums⁠.

⁠unRAID Automatic Upgrades:

On unRAID, execute the following to have the container periodically update itself. Additionally, add the same line of code to your go file to make the change persistent.

echo "0 2 * * * docker exec Subsonic update" | sudo tee -a /var/spool/cron/crontabs/root

⁠Technical information:

By default the image has been created to run with UID and GID 1000. If using the automatic install method from Docker, the container is set to run with the UID and GID of of the user executing the subsonic wrapper script. Additionally, the wrapper script by default saves subsonic's database and settings in a hidden sub folder in the executing user's home directory. Most default settings can be adjusted by passing the appropriate environment variable. Here is a list of any and all applicable environment variables that can be override by the end user.

⁠Environment Variables:

You can adjust some of the default settings set for container/application by passing any or all of the following environment variable:

[1]: Variable is applicable only during install.
[2]: Variable is applicable during install, when invoking installed wrapper script or systemd service.
[3]: Variable is applicable only when invoking docker run directly.
[4]: Variable is applicable in all scenarios.

If you set HTTPS_PORT to something else other than 0 all HTTP request will be redirected to HTTPS.

Please read Docker documentation on environment variables⁠ for more information.

⁠Volumes:

• /subsonic - Folder to store Subsonic's log, configuration and database.
• /music - Default music folder.
• /podcasts - Default podcast folder.
• /playlists - Default playlists folder.

⁠Manual Run and Installation:

Of course you can always run docker image manually. Please be aware that if you wish your data to remain persistent you need to provide a location for the /config volume. For example,

docker run -d --net=host -v /*your_subsonichome_location*:/subsonic \
                         -v /*your_music_folder_location*:/music \
                         -v /*your_podcast_folder_location*:/podcasts \
                         -e TZ=America/Edmonton
                         --name=subsonic hurricane/subsonic

All the information mention previously regarding user UID and GID still applies when executing a docker run command.

⁠License

Code released under the MIT license⁠.

⁠Donation

@hurricanehrndz⁠: