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.
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.

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.
      - Prerequisites
        To back up and restore the Seeker data, make sure that your system meets the following requirements.
      - Stop Seeker: Windows
        To proceed with the backup, stop Seeker and the PostgreSQL database managed by Seeker.
      - Stop Seeker: Linux/Mac OS
        To proceed with the backup, stop Seeker and the PostgreSQL database managed by Seeker.
      - Back Up the Data
        To back up the Seeker data from a source machine, copy the data to a network drive or a shared location.
      - Verify Before Restore
        Tasks to perform before restoring the Seeker data.
      - Restore the Data
        To restore the Seeker data on a target machine, copy the data from a backup location.
      - Start Seeker
        After restoring the data from backup, restart Seeker.
- 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.

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.

Seeker Data Locations

The Seeker data is stored in the following locations:

Home Directory
The Seeker home directory contains all the dynamic data and configuration files that are used by Seeker. It also contains the PostgreSQL database data directory that is managed by Seeker.
The home directory path is stored in the SEEKER_HOME_DIR environment variable. The default values of this variable are:
- Linux/Mac OS: ${HOME}/seeker/data/. For example, /Users/myuser/seeker/data/.
- Windows: %SEEKER_HOME_DIR%. For example, C:\ProgramData\Seeker Security\inline\.
Install Directory
The Seeker Install directory, or Bin directory, contains the binary files that are required to run Seeker.
The Install directory path is stored in the SEEKER_INSTALL_DIR environment variable. The default values of this variable are:
- Linux/Mac OS: ${HOME}/seeker/install/. For example, /Users/myuser/seeker/install/.
- Windows: %SEEKER_INSTALL_DIR%. For example, C:\Synopsys\Seeker\.

Workflow

Cold backup and restore are performed when the system is not running.

Check the Prerequisites.
Depending on the OS of your source machine:
- Stop Seeker: Linux/Mac OS
- Stop Seeker: Windows
Back Up the Data
Verify Before Restore
Restore the Data
Start Seeker