Commands

Config Input

All commands need to have a valid PostgreSQL connection string defined in the /etc/sicura/sicura-console.yaml config in order to run.

sicura-console

Runs the Console in the foreground and outputs activity and error messages to the terminal.​

It is possible to redirect all messages to the terminal or to specific files with the following config option:​

# Defaults: application -> console, audit -> console, request -> /tmp/jaeger/access.log
main.console.log_output:
 application:
   console: true
   file: false
 audit:
   console: true
   file: false
 request:
   console: false
   file: true
   file_path: /var/log/sicura-console/access.log

sicura-console cleanup

Assists the Sicura Console database in upgrading to the newest release. Able to upgrade a console as far back as 1.4.0. The script will check the database for any potential cleanup fixes. It will create a dump of the PostgreSQL database before starting the upgrade process if any cleanup fixes are found and will always save to /var/db/sicura/dumps/upgrade_backup.dump. The script will automatically run every time the Console is started. The script can be run again at anytime to upgrade whatever database the config file is pointing to.​

Input

None

Flags

None

sicura-console migrate

​Overwrites a PostgreSQL database using the data and schema of a Sicura Console SQLite database. Will prompt the user if they want to create an optional dump of the current PostgreSQL database.​

Input

A SQLite connection string through the command line

Flags

-f / --no-backup (optional): Force the console to not create a dump of the current database

sicura-console restore

Overwrites the current PostgreSQL database using the provided Sicura Console dump file. Will prompt the user if they want to create a dump of the current PostgreSQL database.

Input

A sicura-console database dump through the command line

Flags

-f / --no-backup (optional): Force the console to not create a dump of the current database

sicura-console dump

Create a dump of the current PostgreSQL database.

Input

None

Flags

None

sicura-console drop_schema

Drops all tables of the current PostgreSQL database.

Input

None

Flags

-f / --no-backup (optional): Force the console to not create a dump of the current database

Database Dumps

​All dumps of the PostgreSQL Sicura Console databases are specific to the Sicura Console and are only usable by the sicura-console restore script. They all get saved to /var/db/sicura/dumps.