Knowledge Base Administration Guide

Install Simscope

These instructions walk through download and install of Simscope.

Note: you can install and run Simscope as either a normal Linux user or as root user.

a. Download Simscope

Note: this requires installing RabbitMQ and the Tunnel first.

# NOTE: this URL is provided from VerOps
> wget SIMSCOPE-DOWNLOAD-URL
> tar zxf SIMSCOPE-DIR.tar.gz

# Symlink this, so Simscope can be updated later
> ln -s SIMSCOPE-DIR simscope-latest

b. Install license key

Save the license key from your VerOps email attachment into the $SIMSCOPE_CONFIG directory:

> cp COMPANY_LICENSE_KEY.lic $SIMSCOPE_CONFIG/

c. Create Simscope config

Create the file $SIMSCOPE_CONFIG/simscope.config, using the following template:

NOTE: please make sure to edit the following sections of the config:

  1. Simscope URL: change httpaddr to the desired port # of the server.
  2. Simscope hostname: change serverurl to the desired IP address or hostname.
  3. License key: change licensepath to your license key file.
  4. Projects: change these to your desired project name.
  5. Categories: change these to your desired job categories
  6. RabbitMQ: change to your RabbitMQ URL/username/password

Later on, you can configure SMTP email, LDAP authentication, commit info, metadata fields, etc.

d. Edit simscope.sh

Edit the file simscope.sh and replace:

SIMSCOPE=/work/simscope/simscope-latest
SIMSCOPE_CONFIG=/work/simscope/config
SIMSCOPE_DB=/work/simscope/db

e. Start the Simscope server

> bin/simscope.sh

NOTE: On the first run of Simscope, you should see a message similar to this on the terminal. This is the randomly generated administrator password. Please save this password temporarily to a file, so you can log in.

────────────────────────────────────────────────────────────
admin account issued new password: ilG/LDrE

        → Go to the [Change Password] page in your browser to change this password.
────────────────────────────────────────────────────────────

f. Log in to the Simscope web server

Open your web browser to http://SERVERURL:PORT and log in using:

  • admin
  • ADMIN-PASSWORD (see Step e above)

If this works, congratulations!

→ Simscope is ready for testing.

g. Change the admin password

You can change the admin password from the web browser, via:

  • http://SERVERURL:PORT/change-password