Scenarioo Viewer Docker Image

Scenarioo provides a Docker Image to run the Scenarioo Viewer web application on your local machine, on a server or somewhere in the cloud.

The following page describes, how to install and run this docker image (it is more or less a one liner! :smile: ).

Prerequisites

To run the Scenarioo docker image it is necessary to install Docker. Visit the docker installation page for installation guides.

Run Scenarioo Docker Image

How to set up and run the Scenarioo Viewer Web App as a docker image:

  1. Simply run the following one liner command to install and run the docker image:
     sudo docker run -it --rm --name scenarioo -p 8080:8080 -v /home/user/your-scenarioo-docu-folder:/docu scenarioo/webapp:3.0.0
    
    with following parameters:
    • --name - defines a name for the container (= running image)
    • -p - maps a port of your host OS to the container's internal port.
    • -v - maps the directory where your Scenarioo documentation data and config will be stored, simply replace /home/user/your-scenarioo-docu-folder by the absolute path to the folder where you want scenarioo to read from and store in the documentation and config data. Make sure that the docker image wil have read and write access to this directory for storing its data (on linux use simply sudo chmod ug+rws <scenarioo-docu-directory> or see Viewer Web App Setup for more information in case of problems).
    • Remark for Backwards-Compatibility when migrating an existing docker setup (version 2.x or before) to the newest docker image version: the new docker image will as well store its config file inside the configured data directory, this was not the case for earlier docker image versions out of the box. Therefore you might have to migrate your settings from config files inside your old docker containers to the new container, if you had any special settings configured before. In future this wont be an issue anymore, since the config file is now as well stored in your configured scenarioo data directory.
  1. Access http://localhost:8080/scenarioo/ in your web browser to verify the Viewer application is running.

  2. At this point, the Scenarioo Configuration is only in memory. Go to Manage -> General Settings (see upper right navigation in the Viewer) and at least add your application name and save the configuration. The configuration file config.xml will be saved to the directory you have configured as docu directory.

  3. Start adding your documentation data to the mapped directory and let the Viewer application import it. More information on how to publish documentation data can be found in How to Publish Documentation Data

  4. You can configure advanced settings of the Scenarioo Viewer as explained in Viewer Configuration by changing the stored config.xml inside the mapped directory.

More Information

results matching ""

    No results matching ""