Home
Administration Guide
Administration, configuration, and management tasks needed for the optimal use of Seeker
Maintenance
To ensure your Seeker system's health, perform periodic maintenance tasks.
Backup and Restore
Seeker provides several options to back up and restore the detection and configuration data that is stored on the Seeker server.
Hot Backup and Restore
Seeker can be configured to perform scheduled hot backup of Seeker detection and configuration data. Additionally, you can perform such backup on demand at any time, and then restore data from it using the CLI.

Administration Guide
Administration, configuration, and management tasks needed for the optimal use of Seeker
- System Administration
  Seeker provides a set of tools that enable administrators to configure, customize, and fine-tune various features and capabilities of the system, as well as integrate external tools.
- User Administration
  Introduces the Seeker role-based access control (RBAC) concept, and outlines the user administration tasks.
- Project Administration
  Management and configuration tasks that Seeker administrators can perform for projects.
- Maintenance
  To ensure your Seeker system's health, perform periodic maintenance tasks.
  - Diagnostics
    To help administrators troubleshoot any issues with their systems, Seeker provides diagnostic tools.
  - Backup and Restore
    Seeker provides several options to back up and restore the detection and configuration data that is stored on the Seeker server.
    - Hot Backup and Restore
      Seeker can be configured to perform scheduled hot backup of Seeker detection and configuration data. Additionally, you can perform such backup on demand at any time, and then restore data from it using the CLI.
    - Cold Backup and Restore
      When updating to a new version, or migrating an existing installation of Seeker to another machine, you might want to perform a cold back up of the Seeker data, and then restore it in an appropriate location.
- Using APIs
  Seeker provides a set of Web (REST) APIs that expose its basic functionality. You can use these APIs to automate various administration tasks, such as managing projects, exporting vulnerabilities or creating a diagnostic dump.
- Appendix A. Seeker Environment Variables
  Seeker uses a number of operating system (OS) environment variables and Java Virtual Machine (JVM) properties that administrators can configure to customize and fine-tune the behavior of Seeker server and Agents.

Hot Backup and Restore

Seeker can be configured to perform scheduled hot backup of Seeker detection and configuration data. Additionally, you can perform such backup on demand at any time, and then restore data from it using the CLI.

Hot backup and restore are performed while the system is up and running.

Attention:

The source and target machines must have the same operating system and bitness.

Back Up the Data

You can perform hot backup using the UI. For instructions, see Configure Automatic Hot Backup.

Another option is to run the following command in the CLI:

COMMAND backup DATABASE_NAME DATABASE_USERNAME BACKUP_DIR_PATH BACKUP_NAME BACKUP_FORMAT DRY_RUN

COMMAND: SeekerService for Windows, sk_ctl for Linux/MacOS.
DATABASE_NAME: default is inline.
DATABASE_USERNAME: default is seeker.
BACKUP_DIR_PATH: full path to the backup file location.
BACKUP_NAME: backup file name without extension.
BACKUP_FORMAT: zip for Windows, tar.gz for Linux/MacOS.
DRY_RUN: false to include both the database schema and data (default), true to include the database schema only.

For example:

Windows: SeekerService backup inline seeker C:\Synopsys\Seeker\data\backups backup_2019-09-10 zip false
Linux/MacOS: sk_ctl backup inline seeker /Users/myuser/seeker/data/backups backup_2019-09-10 tar.gz false

Restore the Data

Run the following command in the CLI:

COMMAND restore DATABASE_NAME DB_USERNAME BACKUP_FILE_PATH, where BACKUP_FILE_PATH is the full path of the backup file to restore from.

Important:

Before restoring the data, this command will automatically stop the Seeker server, and restart it afterwards.

For example:

Windows: SeekerService restore inline seeker C:\Synopsys\Seeker\data\backups\backup_2019-09-10.zip
Linux/MacOS: sk_ctl restore inline seeker /Users/myuser/seeker/data/backups/backup_2019-09-10.tar.gz