1. Introduction
2. Installation
3. RPM Installation
4. Container Installation
5. Upgrades
6. Running Sicura Console
7. Configuration - Accounts
8. Configuration - Database
9. Configuration - Collector
10. Configuration - Security
11. Configuration - Plugins
12. Configuration - Experimental
13. Sidebar - Administration
14. Sidebar - Infrastructure
15. Sidebar - Profiles
16. Sidebar - Reports
17. Sidebar - Scheduling
18. Commands
19. Known Issues
20. How To - Enforce compliance
21. How To - Enforce custom profiles
22. How To - Use the API

Container Installation

Images

All Sicura Console container images are located at https://customers.sicura.us/products/sicura-console/container_registry

The latest stable release will have a latest tag, and can be downloaded from the following URL:

registry.customers.sicura.us/products/sicura-console:latest

A specific release (e.g 1.8.0-1) can be downloaded using the release version as the tag, such as:

registry.customers.sicura.us/products/sicura-console:1.8.0-1

Requirements

PostgreSQL Server

A PostgreSQL server is required in order to run the Console.

A production implementation of PostgreSQL is recommended.

Alternatively, if you prefer, a PostgreSQL Server can be run in Docker as well. The following run command can be used to spin up a new container:

docker run --name postgres -p 5432:5432 -e POSTGRES_PASSWORD=mysecretpassword --rm -d postgres:14

Console Environment Variables

Environment variables are used to customize the Console.

Required

License Key

A valid License Key needs to be set with one of the following variables:

• SICURA_LICENSE_KEY: A valid Sicura License Key as a String.
• SICURA_LICENSE_KEY_FILE: A path to a valid Sicura License Key. File must be mounted during run.

Config

A valid Config needs to be set with one of the following variables:

• SICURA_CONFIG: A YAML parseable Hash containing other Console config settings
• SICURA_CONFIG_FILE: A path for a Console config file. File must be mounted during run.

Database

The Postgresql Server database information from above is required to be set using the following variables:

• DB_USER: Postgres Database User
• DB_PASSWORD: Postgres Database Password
• DB_HOST: Postgres Database Host
• DB_PORT: Postgres Database Port
• DB_DATABASE: Postgres Database Name

Optional

Directory Services

Directory Services can be set with one of the following variables:

• SICURA_DIRECTORY_SERVICES: A YAML parseable Hash containing Directory Services settings.
• SICURA_DIRECTORY_SERVICES_FILE: A file path containing Directory Services settings. File must be mounted during run.

SSL

An SSL Key and Cert can be set using the following variables:

• SICURA_SSL_KEY: SSL Key used for enabling HTTPS access to the Console. main.ssl.enabled: true should be set in the config.
• SICURA_SSL_CERT: SSL Cert used for enabling HTTPS access to the Console. main.ssl.enabled: true should be set in the config.

Starting the Console Container

After pulling a version of the Console container and setting the appropriate variables for your environment, it can be started by running:

docker run --name <container name> --rm -d sicura-console:latest