- Build instructions
- Short instructions
- Full instructions
- Cross-compilation
The latest release of Universal Media Server can be downloaded from: https://www.universalmediaserver.com
This document describes how to build Universal Media Server from the source files. The following software packages are required:
- The Java JDK (the JRE is not enough)
- Git
- Maven
- External libraries
Read the Full instructions section for a complete explanation of how to install all required software and how to build UMS for each operating system.
If all required software packages are installed, the following commands will download the latest sources and build UMS:
git clone git://github.com/UniversalMediaServer/UniversalMediaServer.git
cd UniversalMediaServer
mvn package
The result will be built in the "target" directory:
- Windows:
UMS-setup-full.exe,UMS-setup-full-x64.exeandUMS-setup-without-jre.exe - Linux:
ums-linux-generic-x.xx.x.tar.gz - macOS:
ums-setup-macosx-x.xx.x.tar.gz
First all required software has to be installed:
Note: the JRE is not enough, and versions higher than Java 8 are not recommended.
See http://www.oracle.com/technetwork/java/javase/downloads/index.html
Be sure to remember the install location.
sudo apt-get install openjdk-7-jdk
See https://developer.apple.com/downloads/index.action?name=for%20Xcode%20-
Look for the Java Developer Package.
See http://code.google.com/p/msysgit/downloads/list
For the "Adjusting your PATH environment" section, select "Run Git from the Windows Command Prompt".
For the "Configuring the line ending conversions" section, select "Checkout Windows-style, commit Unix-style line endings".
sudo apt-get install git-core git-gui git-doc
If you are using brew (http://mxcl.github.com/homebrew/) you just have to do:
brew install git
See http://maven.apache.org/download.html
sudo apt-get install maven3
Nothing to do, automatically installed with Java for XCode in step 1.
Be sure to remember the extract location.
Create new variables or append the value if the variable already exists:
- Level: System, variable:
JAVA_HOME, value: JDK install location - Level: User, variable
M2_HOME, value: Maven extract location - Level: User, variable
M2, value:%M2_HOME%\bin - Level: User, variable
PATH, value%M2%
Nothing to do.
Nothing to do.
git clone git://github.com/UniversalMediaServer/UniversalMediaServer.git
cd UniversalMediaServer
These are needed by the build process:
mvn external:install
At this point all required software packages are present. UMS is now ready to be built.
git pull
mvn package
The resulting binaries will be built in the "target" directory:
- Windows:
UMS-setup-full.exe,UMS-setup-full-x64.exeandUMS-setup-without-jre.exe - Linux:
ums-linux-generic-x.xx.x.tar.gz - macOS:
ums-setup-macosx-x.xx.x.tar.gz
These last two commands can easily be automated using a script e.g.:
rem build-ums.bat
start /D UniversalMediaServer /wait /b git pull
start /D UniversalMediaServer /wait /b mvn package
#!/bin/sh
# build-ums.sh
cd UniversalMediaServer
git pull
mvn package
By default, mvn package builds an installer or distibution file for the
platform it is being compiled on e.g. UMS-setup-full.exe on Windows and a tarball on Linux.
As an optional step, releases for other platforms can be built.
The Windows installers (UMS-setup-full.exe, UMS-setup-full-x64.exe and UMS-setup-without-jre.exe) and Windows executable
(UMS.exe) can be built on non-Windows platforms.
First of all, you'll need to have the makensis binary installed. On Debian/Ubuntu,
this can be done with:
sudo apt-get install nsis
Then the NSISDIR environment needs to be set to the absolute path to the
nsis directory. This can either be set per-command:
NSISDIR=$PWD/src/main/external-resources/third-party/nsis mvn ...
- temporarily in the current shell:
export NSISDIR=$PWD/src/main/external-resources/third-party/nsis
mvn ...
- or permanently:
# these two commands only need to be run once
echo "export NSISDIR=$PWD/src/main/external-resources/third-party/nsis" >> ~/.bashrc
source ~/.bashrc
mvn...
For the sake of brevity, the following examples assume it has already been set.
The Windows installer can now be built with one of the following commands:
mvn package -P system-makensis,windows
mvn package -P system-makensis,windows,-osx-java7,-osx-java8
mvn package -P linux,-windows
mvn package -P linux,-osx-java7,-osx-java8
The macOS installer tarball can be built on any platform by specifying the "osx" profile explicity:
mvn package -P osx-java7
or
mvn package -P osx-java8
- Build UMS
- Install http://s.sudre.free.fr/Software/Packages/about.html
- Set a variable storing the directory path of the build distribution file, e.g.
export UMS_DIST_FOLDER="/Users/dev/ums/target/ums-7.3.1-SNAPSHOT-distribution/Universal Media Server.app"
export UMS_LOGO_FILE="/Users/dev/ums/src/main/external-resources/third-party/nsis/Contrib/Graphics/Wizard/win.png"
- Replace desired path inside the .pkgproj file
sed -i '' "s#UMS_DIST_FOLDER#$UMS_DIST_FOLDER#g" src/main/assembly/osx-installer.pkgproj
sed -i '' "s#UMS_LOGO_FILE#$UMS_LOGO_FILE#g" src/main/assembly/osx-installer.pkgproj
- Build .pkg installer. This will output to
/target/Universal Media Server.pkg
/usr/local/bin/packagesbuild src/main/assembly/osx-installer.pkgproj