dmx-systems / dmx-build-deb Goto Github PK

DMX deb packages (e.g. for Debian and Ubuntu) are build from DMX binary files.
They are freely available from our public repository at https://download.dmx.systems/repos/ubuntu/.

# Packages
 * `dmx` - the stable standard (default desktop) package for DMX
 * `dmx-headless` - the stable headless (mutliuser web-hosting) package for DMX
 * `dmx-latest` - the latest unstable standard (default desktop) package for DMX build from SNAPSHOT - not for production
 * `dmx-headless-latest` - the latest unstable headless (mutliuser web-hosting) package for DMX build from SNAPSHOT - not for production

# Compatibility
 * Ubuntu 20.04
 * Ubuntu 18.04
 * Ubuntu 16.04
 * Debian 10 => Not out of the box, since DMX requires openjdk-8-jre, which can be only be installed manually.
 * Debian 9
 * Debian 8

# Installation

## automatic:

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

## manual:

 1. Add file /etc/apt/sources.list.d/dmx-repo.list
   ~$ sudo bash -c 'echo "deb https://download.dmx.systems/repos/ubuntu/ xenial/" >/etc/apt/sources.list.d/dmx-repo.list'

 2. Add key:
   ~$ curl -fsSL https://download.dmx.systems/repos/gpg | sudo apt-key add -

 3. Update packet sources and install DMX
   ~$ sudo apt update && sudo apt install dmx

 4. Adjust the configuration
   ~$ sudo nano /etc/dmx/config.properties 

 5. Start DMX
   ~$ sudo systemctl start dmx

 6. Browse to the local instance
    http://localhost:8080/systems.dmx.webclient/

# Upgrading from DMX 5.1 or earlier to DMX 5.2 on headless hosts systems (e.g. a public webserver)
   When upgrading to DMX 5.2 on a non-desktop system, you should manually remove the existing DMX package with `sudo apt remove dmx`.
   Then install the package for headless systems with `sudo apt install dmx-headless`. Your data and config files will be preserved.

# Plugins
  The /usr/share/dmx/bundle-available directory contains a set of selected DMX plugins. To activate a plugin copy or link it to the
  /usr/share/dmx/bundle-deploy folder. Alternatively you may use the 'dmxenplug' or 'dmxdisplug' scripts. You may can find more
  information on DMX plugins at "https://git.dmx.systems/dmx-plugins".

# Known Issues
 * DMX is still in an early beta stage and clearly needs further improvement.
 * There are lacks in a) security, b) robustness, and c) usability.

# Documentation, Help and Feedback
 * Check https://docs.dmx.systems to learn more about DMX.
 * Join https://forum.dmx.systems to help us improve.

# Copyright + Licensing 
 * Copyright 2021 DMX Systems <https://dmx.systems>
 * dmx-build-deb is available freely under the GNU General Public License, GPL version 3 or later.
 * DMX is available freely under the GNU Affero General Public License, AGPL version 3 or later.

# Disclaimer
 * DMX Systems assumes no liability for lost or compromised data.

# Source code
 * https://git.dmx.systems/dmx-platform/dmx-build-deb
 * https://github.com/dmx-systems/dmx-build-deb