Installation

DMX runs on several different operating systems. Below you can find how to get started on Windows, Mac OS and Linux.

Running DMX on Windows

Install a Java Runtime Environment version 8

Go to Oracle’s website and download the recommended Java version. Currently, this is Java 8. Any version from Java 6 to 8 will work out of the box with DMX. Execute the JavaSetup*.exe with a double-click and click through the installer.

Download DMX

Currently we recommend you to download the beta-5 release. To try out the latest state of development you can download the latest snapshot instead. All previous snapshots are available for download on https://download.dmx.systems/ci/.

Save the according file to a location of your choice. Extract the zip archive.

_images/windows-extract-zip.png _images/windows-choose-destination.png

A new folder is created. It has the name of the zip file.

Start DMX

Enter the folder that was created when you unpacked the zip archive. Double-click the file dmx-windows.bat. If your Explorer does not display file extensions, you only see dmx-windows as a file name. That is the same file.

A black terminal window opens to display what is happening. Just leave it there. The Windows Defender Firewall might ask you to allow Java access. Choose “Private networks, such as my home or work network”.

Your default browser opens the DMX webclient at http://localhost:8080/systems.dmx.webclient/. You are ready to go.

Hint

Log in as “admin” without a password.

Stop DMX

To stop DMX, bring the black terminal windows to the foreground. Press CTRL + C. In the window you will now see the question “Terminate batch job (Y/N)?” Answer with a “Y” for yes. DMX is now stopped.

Remove DMX

You can get rid of DMX by deleting the whole folder that got created when you unpacked the zip file, e.g. dmx-5.0-beta-5. The Java Runtime Environment has to be uninstalled separately.

Running DMX on Mac OS

Download DMX

Currently we recommend you to download the beta-5 release. To try out the latest state of development you can download the latest snapshot instead. All previous snapshots are available for download on https://download.dmx.systems/ci/.

Save the according file to a location of your choice. Extract the zip archive. A new folder is created. It has the name of the zip file.

Start DMX

Enter the folder that was created when you unpacked the zip archive. Double-click the file dmx-macosx.command. A terminal window opens to display what is happening. Just leave it there.

Your default browser opens the DMX webclient at http://localhost:8080/systems.dmx.webclient/. You are ready to go.

Hint

Log in as “admin” without a password.

Stop DMX

To stop DMX, press CTRL + C in the terminal window.

Remove DMX

You can get rid of DMX by deleting the whole folder that got created when you unpacked the zip file, e.g. dmx-5.0-beta-5. The Java Runtime Environment has to be uninstalled separately.

Running DMX on Linux

On a Linux machine, you have two options to run DMX: You can start it from an unpacked zip file or you can install it from our APT repository.

Install a Java Runtime Environment

Use your package manager to install the Java 8 for your Linux distribution.

For example, on Debian / Ubuntu, you would run the command

sudo apt install openjdk-8-jre

to install OpenJDK/JRE. Make sure that Java 8 (not 11) is used by running

sudo update-alternatives --config java

and selecting the right version interactively.

Run DMX from a zip archive

Download DMX

Currently we recommend you to download the beta-5 release. To try out the latest state of development you can download the latest snapshot instead. All previous snapshots are available for download on https://download.dmx.systems/ci/.

Save the according file to a location of your choice, e.g. your “Downloads” folder. Open a terminal and go to that location. Extract the zip archive.

~ $ cd Downloads
# to get the beta-5 release:
~/Downloads $ wget https://download.dmx.systems/dmx-5.0-beta-5.zip
~/Downloads $ unzip dmx-5.0-beta-5.zip
# to get the latest nightly build:
~/Downloads $ wget https://download.dmx.systems/ci/dmx-latest.zip
~/Downloads $ unzip dmx-latest.zip

Start DMX

Go into the newly created folder (in this example “dmx-5.0-beta-5”) and run the start script ./dmx-linux.sh.

~/Downloads $ cd dmx-5.0-beta-5
~/Downloads/cd dmx-5.0-beta-5 $ ./dmx-linux.sh

Hint

Log in as “admin” without a password.

Stop DMX

To stop DMX, press CTRL + C in the terminal you started it in.

Remove DMX

You can get rid of DMX by deleting the whole folder that got created when you unpacked the zip file, e.g. dmx-5.0-beta-5. The Java Runtime Environment has to be uninstalled separately.

Install DMX from our APT repository

For apt-based Linux distributions (like Debian / Ubuntu) we provide a repository. It is intended for installations on servers but can obviously be used on Debian/Ubuntu laptops as well. The package has a built-in dependency to default-jre.

Warning

If your Java Runtime Environment is newer than Java 8, you cannot use the repository for the moment. Check your version by running the command java -version.

Here is how to download and execute our install script. It adds the repository, installs DMX from it, prompts the user for the DMX admin passphrase and starts DMX as a daemon.

$ curl -sS https://download.dmx.systems/repos/dmx-install.sh | sudo bash

Configure DMX

For server installations and advanced configuration we will soon provide more instructions in the Admin Documentation. By default, DMX listens on port 8080. The main configuration file is located in /etc/dmx/config.properties.

Start DMX

Invoke this command to start the daemon:

systemctl start dmx

Stop DMX

Stop the daemon by running

systemctl stop dmx