Home
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.
Configuring Integration with External Tools
Seeker brings additional functionality by seamless integration with external Black Duck and third-party tools.
Install and Configure Seeker Jenkins Plugin
The Seeker Jenkins plugin facilitates the integration of security testing in CI/CD processes by enabling an additional build step. This build step will cause a build failure upon detection of any critical or high vulnerability and generate a Seeker security report.

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.
  - Configure Server URL
    The URL of the Enterprise Server is set after installation, but you can change it at any time as required.
  - Customize Seeker Connection Settings
    By default, Seeker uses fixed port numbers for external communications. If needed, you can customize some of these port numbers.
  - Configure HTTPS Certificates
    If you want to use a secure protocol for Seeker communications, configure HTTPS certificates.
  - Configure Automatic Project Creation
    Enable the global feature of automatic creation of regular projects within composite projects. This can greatly simplify the onboarding of new applications that are composed of multiple microservices.
  - Set up License
    To use Seeker, you need to set up a valid license for the product.
  - Configure Project Templates
    Save time and effort by creating project templates that enable you to share configuration settings between multiple projects.
  - Configure Compliance Policies
    Configure compliance policies to apply to your Seeker projects.
  - Configure Custom Reports
    Customize the Seeker reports by configuring additional filters. These custom reports can be generated on demand from the Export menu, or included in periodic email digests.
  - Configure Custom Tags
    Seeker supports defining custom tags and applying them to vulnerabilities. This helps you filter and manage vulnerabilities more effectively.
  - Configuring Integration with External Tools
    Seeker brings additional functionality by seamless integration with external Black Duck and third-party tools.
    - Install and Configure Black Duck® Binary Analysis
      Integration with Black Duck® Binary Analysis, a Software Composition Analysis (SCA) tool, enables Seeker to detect known security vulnerabilities in third-party components included in applications, as well as secret information leakages.
    - Configure Black Duck
      Integration with Black Duck enables Seeker to verify the Black Duck Binary Analysis vulnerability detections by identifying methods associated with known vulnerabilities (CVEs) that are actually used by applications.
    - Configure eLearning
      eLearning provides a wealth of online courses that educate and guide developers how to handle and remediate vulnerabilities detected in their code. Integration with eLearning enables Seeker users to access the relevant courses directly from the Vulnerability Details page.
    - Configure Secure Code Warrior
      Secure Code Warrior is a popular application security training product that helps developers to handle and remediate vulnerabilities detected in their code. Integration with Secure Code Warrior enables Seeker users to access the relevant training materials directly from the Vulnerability Details page.
    - Configure SMTP Account
      To enable Seeker to send email notifications and digests, configure an SMTP account.
    - Install and Configure Seeker Jenkins Plugin
      The Seeker Jenkins plugin facilitates the integration of security testing in CI/CD processes by enabling an additional build step. This build step will cause a build failure upon detection of any critical or high vulnerability and generate a Seeker security report.
  - Configure Notification Rules
    Configure Seeker to take automatic actions upon vulnerability detection: create a ticket in a bug tracking system or send notifications to the relevant recipients.
  - Configure Vulnerability Lifecycle Management
    Define how to manage vulnerabilities when they move through their lifecycle stages in Seeker.
  - Configure Automatic Hot Backup
    Configure a recurrent automatic hot backup of the Seeker detection and configuration data. This data can be restored from backup at any point.
  - Configure Server JVM Options
    Fine-tune the performance of Seeker server by configuring its Java Virtual Machine (JVM) options.
  - Create Linux Service to Start/Stop Seeker
    To start and stop Seeker on a Linux machine, create a custom systemd service.
  - Logging
  - Customize the Sign-In Page
    Customize your Seeker sign-in page to display your brand logo and custom sign-on messages.
  - Configure Proxies for External Systems
    If Seeker cannot connect directly to an external system, configure and use a proxy for connection.
- 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.
- 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.

Install and Configure Seeker Jenkins Plugin

The Seeker Jenkins plugin facilitates the integration of security testing in CI/CD processes by enabling an additional build step. This build step will cause a build failure upon detection of any critical or high vulnerability and generate a Seeker security report.

To install the plugin, perform the following steps:

Download the Jenkins plugin file by navigating to <Seeker host>:<port>/rest/ui/installers/integrations/jenkins.
Log on to your Jenkins instance as an administrator.
Go to Manage Jenkins > Manage Plugins > Advanced.
Upload the downloaded plugin file SeekerJenkinsPlugin.hpi to Jenkins.

To configure the plugin, you need an access token for Seeker APIs. For instructions, see Configure Access Tokens.

Go to Manage Jenkins > Configure System, and scroll to Seeker Configuration.
Enter Seeker Base URL and Access Token that you have generated.
In the Jenkins dashboard, click your <Jenkins job> > Configure.
Click Add build step > Seeker Build Status.

Enter the following properties:

Property	Description
Project Keys	A comma-separated list of project keys, for example:default,projectA,projectB.
Fail on Detection	Select a detection type on which the build should fail. For example, A verified vulnerability (Critical/High) is detected.
Report Format	Select a format for generating a vulnerability report.

Add and configure any number of additional build steps, as required for different projects and/or vulnerability detections.
Click Save.