SoftwareInstallation

Erland Isaksson edited this page Dec 31, 2015 · 1 revision

Introduction

There are a number of different options to install the SMD prototype as described below.

Installation of SMD for beta testing

The easiest way to install if you just want to beta test the software, is to do as follows. This is not the best way if you want to look at the source code or run the software in the debugger, but it's the preferred way if you are only looking for a way to get it up and running and do some testing.

  1. Make sure Java 6 or later is installed on the computer running Squeezebox Server

  2. Configure one of the following alpha repositories in your Squeezebox Server in Settings/Plugins * Official tested builds: http://socialmusicdiscovery.googlecode.com/svn/repository/alpha.xml * Latest untested builds: http://downloads.socialmusicdiscovery.org/smd-plugin/svn-alpha-repository.xml

  3. In Squeezebox Server inside Settings/Plugin, select to install "Social Music Discovery" which is available in the repository you just setup.

This will give you:

  • The SMD plugin installed into Squeezebox Server
  • The SMD Server installed into Squeezebox Server and automatically launched when Squeezebox Server is started:
    • It will use the MySQL database of Squeezebox Sever and store it's data in a "smd" schema if Squeezebox Server is configured to use its bundled MySQL database.
    • It will use a H2 database stored in the Squeezebox Server cache directory
  • The SMD Frontend can be launched from Squeezebox Server web interface from Extras/Social Music Discovery menu
    • The frontend is the simple Apache Pivot based version, it doesn't contain any management of data.
    • The Apache Pivot fronend is planned to be replaced with the RCP client at some stage.

To start using it, you need to:

  1. Start Squeezebox Server
  2. Either perform a rescan in Squeezebox Server or goto "Squeezebox Server Settings/Advanced/Social Music Discovery" and select on of the "Import" buttons to import your SBS library into the SMD database. The progress of the import will be visible in Squeezebox Server Settings/Information.
  3. After the import is finished you can * Through your normal Squeezebox remote or web interface goto "My Music/Social Music Discovery" * Through the Squeezebox Server web interface, goto Extras/Social Music Discovery and use the SMD frontend to:
    • Search for releases, artists or works
    • Double click on a release to see more details about the release
    • Single click on a release to see related artists and works
    • Single click on an artist to see related releases and works
    • Single click on a work to see related releases or artists

If you get some problem, look in the troubleshooting FAQ and if that doesn't help post details about your problem in the announcement thread.

Trying out the RCP Client

The RCP Client isn't ready for beta testing yet but if you like to install the current version just to see how it looks like, you should do as follows.

  1. Make sure Java 6 or later is installed on the computer where you like to run the RCP Client prototype
  2. Install the main SMD server and plugin as described in the above "Installation of SMD for beta testing" section
  3. Download the RCP Client Prototype zip for your operating system from our download page
  4. Unzip the zip and start the launcher which is found inside the eclipse directory in the zip. * Just hit the "x" to close the welcome screen shown initially * If you are running the SMD server/plugin on a separate server, you will need to goto Window->Preferences->SMD->Server Connection and specify the hostname or IP address of the computer where you are running the SMD server/plugin.

The RCP Client is in a very early stage at the moment, but you can try it out to get a feeling how a rich client will feel in comparison to the traditional web interface which Squeezebox Server is using.

We are currently in the process of moving the RCP client from being a prototype to something we are going to permanently include in the SMD project, eventually it's going to be available under the name Yggdrasil

If you get some problem, look in the troubleshooting FAQ and if that doesn't help post details about your problem in the announcement thread.

Trying out the UPnP server

The UPnP server included in SMD is disabled by default, but if you like to try the current version just to see how it looks like, you should do as follows.

  1. Install the main SMD server and plugin as described in the above "Installation of SMD for beta testing" section
  2. Make sure Java 6 or later is installed on the computer where you are running the web browser
  3. In Squeezebox Server web interface goto Extras/Social Music Discovery
  4. Wait for the smd-frontend to load, this will typically take some time the first time so don't be confused if you are only seeing a blank page initially and noting seems to happen.
  5. Select the Change configuration button when the smd-frontend interface appears
  6. Find the org.socialmusicdiscovery.server.plugins.UpnpPlugin.enabled setting and change its value to true
  7. Restart SBS and when SBS and SMD is running again a new SMD Media Server should appear on your network.

The UPnP MediaServer is in a very early stage at the moment, but you can try it out to get a feeling how the SMD database can/will be exposed to any UPnP client you like to use.

Some things to note:

  • There is currently no support for playing tracks from the UPnP server, you can only browse the library
  • The UPnP server currently have incompatibility issues with some UPnP clients.
    • Look at the page about the UPnP server for some information about which clients we have tried it with and know are working fairly good.
    • We know there are major issues with the [www.plugplayer.com OSX/iOS PlugPlayer app] and are working on trying to solve that.

If you get some problem, look in the troubleshooting FAQ and if that doesn't help post details about your problem in the announcement thread.

Installation for SMD Server development / debugging

This installation is suitable for SMD Server development, if you like to change the SMD Server code or you like to run it in a debugger to see what happens.

Install the prerequisites which is needed to compile the server:

You now need to build both SMD Server and SMD Frontend

  • Check out the source code and build with maven

If you like the server to use a Squeezebox Server library, you also need to install the SMD Plugin in your Squeezebox Server

  1. Configure one of the following development repositories in your Squeezebox Server in Settings/Plugins * Official tested builds: http://socialmusicdiscovery.googlecode.com/svn/repository/development.xml * Latest untested builds: http://downloads.socialmusicdiscovery.org/smd-plugin/svn-development-repository.xml

  2. In Squeezebox Server inside Settings/Plugin, select to install "Social Music Discovery" which is available in the repository you just setup. * The development repository only contains the SMD Plugin without and server/frontend, so this installation differs from the above suggested installation for beta testing.

To start using you need to:

  1. Open a new command prompt/shell and launch the SMD Server: java -jar smd-server-1.0-SNAPSHOT.jar * If you are running Squeezebox Server on a separate machine (somehost), you can instead use: java -Dsqueezeboxserver.host=somehost -jar smd-server-1.0-SNAPSHOT.jar
  2. Open a new command prompt/shell and launch the SMD Frontend: java -jar smd-frontend-1.0-SNAPSHOT.jar

Now, you probably want to run the server inside your development environment so you can step through the code in the debugger, to do this you first need to install a Java development environment. The preferred choices are:

You can generate project files with maven, see the build instructions for more information about this.

To launch the SMD Server in the development environment, you just launch the class:

  • org.socialmusicdiscovery.server.business.logic.SMDAppplication

You can specify the -Dsqueezeboxserver.host JVM parameter when you launch it if Squeezebox Server is running on a separate machine.

As a suitable further reading, it's suggested that you take a look at:

Installation for SMD client development / debugging

This installation is suitable for SMD client development. Since the Apache Pivot based frontend is just a temporary solution, it's not described here, instead this description focus on what's needed for the RCP based frontend called Yggdrasil.

Install the prerequisites which is needed to compile Yggdrasil:

You now need to build SMD Server

If you like the server to use a Squeezebox Server library, you also need to install the SMD Plugin in your Squeezebox Server

  1. Configure one of the following development repositories in your Squeezebox Server in Settings/Plugins * Official tested builds: http://socialmusicdiscovery.googlecode.com/svn/repository/development.xml * Latest untested builds: http://downloads.socialmusicdiscovery.org/smd-plugin/svn-development-repository.xml * The development repository only contains the SMD Plugin without and server/frontend, so this installation differs from the above suggested installation for beta testing.
  2. In Squeezebox Server inside Settings/Plugin, select to install "Social Music Discovery" which is available in the repository you just setup.

To start using you need to:

  1. Open a new command prompt/shell and launch the SMD Server: java -jar smd-server-1.0-SNAPSHOT.jar * If you are running Squeezebox Server on a separate machine (somehost), you can instead use: java -Dsqueezeboxserver.host=somehost -jar smd-server-1.0-SNAPSHOT.jar * If you want an in-memory database filled with some sample data, you can instead use: java -Dorg.socialmusicdiscovery.server.database=h2-memory-test -jar smd-server-1.0-SNAPSHOT.jar

To build the Yggdrasil, follow the instructions described on the separate build instructions

As a suitable further reading, it's suggested that you take a look at:

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.