Documentation

Media Stream Planner (MSP) — Installation Guide

Installation type: installation scripts
Supported OS:
– Linux: Debian 12, Debian 13, Ubuntu 22.04 LTS, Ubuntu 24.03 LTS;
– Windows with WSL2: Ubuntu 22.04 / 24.04;

Create Users

First off, we need to prepare a server for the application installation, and create the necessary users.

The permission model of the application is:
– two users will be reserved for the application maintenance: msp and msprt
– msp user is the “operator”: regular login user with sudo permissions
– msprt is a no-priv non-login “safe” user which will be created automatically during the setup and will own the service

As sudo

  1. First step, create the msp user. As a sudo user or root:
    sudo adduser msp
sudo usermod -aG sudo

    After those commands, the msp user will be created with /home/msp home directory.

    Unpack package

    As msp

    Login as msp user.
    We need to do some preparations and run commands as msp user.

    2. As msp user:
    – upload the package to your home directory (to have something like /home/msp/msp-1.1.8-beta.1.tgz)
    – unpack the package: 

    tar -xvzf /home/msp/msp-*.tgz

    make installation scripts executable (optional):

    chmod u+x /home/msp/msp-*/*.sh

    then navigate to the application’s directory:

    cd /home/msp/msp-*/

    You can check its content and permissions correctness by listing the directory content:

    ls -la

    Install the application

    As msp

    3. Now we can install and setup the application. Next steps are automated, you just need to run the installation scripts and answer questions / choose options in the prompt. Please note that the setup will ask for sudo password and could take a while —  especially installing dependencies step. It will install a lot of components and additionally will compile a lot of components in place.

    Step A. Install dependencies (might take a while):

    ./install_dep.sh

    Step B. Setup application and settings. In this step, you will specify the parameters needed to run the application: provide IP / domain, port, setup SSL/non-SSL, generate SSL keychain, and set credentials for the database:

    ./setup_app.sh

    ⚠️ If you are using domain and SSL, make sure port 80 is open before running the script

    Run the application

    4. Once application is installed and configured, you have two options on how to run it.

    For short-term run and debugging, you can run the app in foreground:

    ./start_msp.sh

    For long-run, headless / non-interactive production mode, please run the application as a service in background:

    ./create_service.sh

    Then the msp service can be controlled by the following commands:

    sudo service msp (start|stop|restart|status|force-reload)
# For example:
# sudo service msp start
# sudo service msp stop
# sudo service msp status

    Access the application

    5. After the installation has finished and the application is running, it can be accessed by a browser via a URL, depending on the provided parameters. For example:

    http://localhost:8080
    http://localhost
    https://localhost:8443
    https://localhost
    http://12.34.56.78:8080
    https://12.34.56.78:8443
    http://msp-domain.com:8080
    https://domain-for-msp.com:8443

    ⚠️ Note that with IP address-based URLs, the browser may warn about the self-signed certificate.

    6. Use default credentials to access the freshly installed application:

    Username: admin, password: admin
    Username: user, password: user

    ⚠️ It is recommended to change the password to a stronger one for admin and user after the first login!

    Upload media files to the server

    As msp

    7. Create a directory to upload your media files, for example:

    mkdir -p /home/msp/media/lib

    now the /home/msp/media/lib path can be used to point your File Source in the application to the uploaded file and build the Media Library to organize the stream

    Normalize media file

    If it is needed, you can use a helper utility shipped with the application package, to transcode your media files to a better stream-ready format (H.264/AAC). To do this, run this command and follow the questions at the prompt:

    ./convv.sh
    Scroll to Top