Skip to content

Quick Start Guide

Gordin508 edited this page Mar 24, 2020 · 9 revisions

MORR Quick Start Guide

This guide provides a short introduction to get started with MORR. For a full guide on how to use and configure MORR, visit the Usage guide

Setup

Installing MORR

To install MORR, run the MORR-Install.msi after downloading it from the latest release. This will also create a desktop shortcut labeled MORR.exe.

This is what your installation directory will look like:

Installation directory

Dependencies

Before you can use MORR, you need to install the .NET Core 3.1 runtime. You can either use the 64 bit installer (windowsdesktop-runtime-3.1.1-win-x64.exe) supplied with the release in the the Runtimes folder (located in your installation directory) or download it from Microsoft here.

Choosing the modules

By default, all modules are enabled. If this is desired, no further action needs to be taken. If you want to disable some modules, open the config.morr in your MORR directory with a texteditor and remove the entries from the EnabledModules list at the beginning of the config.

Installing the Webextension

After running the MORR installation, the webextension will be located in the MORR-Webextension folder at your installation location. Currently, the webextension may only be installed by loading it as temporary addon. To do so, follow these steps:

Mozilla Firefox

To load the unpacked extension in Firefox, navigate to about:debugging, and, if applicable, click on This Firefox (might not be necessary depending on your version). Then, choose the option Load Temporary Add-on, and then choose any file from the MORR-WebExtension folder (e.g. the manifest.json).

The extension is now loaded. To allow the extension to connect to the MORR main application, the communication port has to be set, see below.

Google Chrome

To load the unpacked extension in Google Chrome, navigate to chrome://extensions and activate Developer mode (top right corner). Next, click on Load unpacked and choose the MORR-WebExtension folder.

The extension is now loaded. To allow the extension to connect to the MORR main application, the communication port has to be set, see below.

After loading the webextension, an icon will be added next to the address bar (DC stands for Disconnected):

Webextension Icon

Setting the communication port

In order for the browser extension to be able to communicate with the MORR main application, a port (and optionally a directory) have to be set in the browser extension's options/preferences. In chrome those can be accessed on chrome://extensions -> Details -> Extension Options, or by right-clicking on the MORR extension icon next to the address bar and choosing Options. In Mozilla Firefox, navigate to about:addons instead and choose Preferences next to the MORR extension. Examples for valid port settings are 60024 and 60024/johndoe. You can click Set default port followed by Save to use the default setting which will work with the default configuration of the main application.

Webextension configuration

You can check if your webextension's configuration is correct by starting a recording (see following section) and checking if the webextension icon turns red.

Using the application

Launching

UI

In most cases, you will want to run the UI application of MORR. To do so, start the UI.exe in the installation directory or use the automatically created desktop shortcut. When MORR has been started successfully, the MORR icon will show in your system tray.

The trayicon:

Tray Icon

Tray icon in extended menu

The traymenu can be opened by rightclicking on the tray icon. It provides following options:

  • Start/Stop recording
  • Open recordings directory
  • Exit

The traymenu:

The tray menu

Recording

Creating a recording is straightforward:

  • Open the traymenu and choose Start Recording.
  • Read the presented information and choose accept. The recording is now running as indicated by the yellow border around your screen as well as the trayicon's color being red.
  • To finish a recording, simply open the traymenu again and choose Stop Recording. In the following dialog, choose Save if you wish to keep the recording or Discard if it shall be deleted instead.

The tray icon while recording:

The tray icon while recoring

When starting a recording on Windows 10 1809, a new window will open after clicking Start recording which lets you choose a videosource1, being either a window or a monitor. In most cases, you will want to record a specific monitor. To do so, click on Share your window, choose Share your display and select the correct view. Afterwards, click OK to start recording.

1: This behavior can also explicitly be enabled in the configuration.

Screenshot of the video source selection:

CLI

MORR also ships with a CLI (Commandline Interface) as an alternative to the UI application. The two most relevant commands are:

CLI validate [-c <filepath>|--config <filepath>] [-v|--verbose]

to validate a configuration file and

CLI record [-c <filepath>|--config <filepath>] [-v|--verbose]

to start a recording using the configuration at the specified path.

Viewing the recordings

To navigate to your recordings, open the traymenu and choose Open recordings directory. Each recording has its own directory, containing a videofile and the Json encoded event data (when using the default configuration).

The contents if your recordings directory may look similar to this (each folder is a unique recording):

Recordings Directory

Known issues with antivirus software

As MORR observes a lot of information flowing through your operating system, some antivirus programs rate it as a threat and block or even delete it. If you are experiencing issues, check your antivirus reports and configure exceptions for MORR if necessary.