Step-by-Step Setup Guide

This guide walks you through the initial account setup, token generation, and connecting your first project to Seal Security.

Account Creation & Token Generation

Follow these steps to access the platform and prepare your environment. If you already have a token, you can skip to the next section.

1. Access the Invite: Click on the Sign in > button in the Seal Security invite email you received.

2. Log In: Log in to the platform using your password or social login credentials.

3. Start Onboarding: We're starting the onboarding flow. Click Next > to begin.

4. Generate Token: First, you must generate a token to Seal's artifact server. This allows you to download our sealed versions.

   1. Generate: Click on Generate token.

   2. Copy: Copy the newly generated token using the copy icon at the right of the text box.

      Important: You will need this token later. While it should eventually be saved in a secure location (like a password manager or secret store), copy it now for immediate use in the next steps.

   3. Continue: Click Next >.

5. Click Next > and then click on GitHub.

6. Grant Access and Install Bot: You need to give the Seal Security Bot access to the relevant repositories:

   1. Connect to your GitHub account.

   2. Install the Seal Security Bot. In this screen, you will be asked to select the relevant GitHub organization, and then decide whether to give the Seal app access to all its repositories or to select specific ones.

   3. After you've selected which repositories you're giving access to, you'll return to the onboarding flow.

      

      Grant Access and Install Bot
7. Choose your import method: Automatic (Bulk) or Manual (One-by-one).

   Path A1: Manual Import

   

   Manual Import

   1. Paste the path to your repository. You can add up to 3 repositories at once.

   2. Give each repository a name.

   3. Click Import.

   Path A2: Automatic (Bulk) Import

   

   Automatic Import

   1. Review the list of dependency files detected in your repository.

   2. Select the specific dependency files you wish to scan.

   3. Click Import.

8. View Protection page: You will land on the Protection screen.

   • Status: Since no projects are connected yet, we are not showing any results.

   • Next Step: We are now going to populate this data using the CLI.

Integrate the Seal CLI

To start fixing vulnerabilities (and populate the Protection page), you must integrate the CLI into your build pipeline.

The Golden Rule: In all cases, the CLI step must be added immediately after dependencies are pulled/installed (from standard registries or your artifact server) but before the final build/compilation.

Important Configuration: For all integration methods, you must ensure the following environment variables are set:

• SEAL_TOKEN: The token you generated earlier.

• SEAL_PROJECT: The ID of your project on the Seal platform (e.g., "my-first-project").

Identify the location of your build pipeline. Typically, this is a .gitlab-ci.yml or Jenkinsfile in your repository.

In the pipeline, identify the step where dependencies are installed (e.g., pnpm install).

Identify the location of the pnpm-lock.yaml file.

Add the seal fix command:

pnpm install
curl -fsSL https://github.com/seal-community/cli/releases/download/latest/seal-linux-amd64-latest -o seal
chmod +x seal
export SEAL_TOKEN=${YOUR_TOKEN}
export SEAL_PROJECT="my-first-project"
export SEAL_USE_SEALED_NAMES=1
# Ox integration
export SEAL_OX_URL="https://api.cloud.ox.security/api/apollo-gateway"
export SEAL_OX_TOKEN=${OX_TOKEN}
export SEAL_OX_APPLICATION=${OX_APPLICATION}
export SEAL_OX_EXCLUDE_WHEN_HIGH_CRITICAL_FIXED="true"
./seal fix --mode remote pnpm-lock.yaml
pnpm build

Sealing a package

Once you have integrated the CLI into your pipeline, follow these steps to see the results.

1. Trigger the Pipeline: Run your build pipeline (Jenkins job, GitHub Action workflow, or Docker build). This execution will trigger the seal fix command, which scans your dependencies and reports back to the Seal Platform.

2. View the Protection page: Navigate to the Protection page.

   • If the page is already open and empty, refresh it. You should now see a list of detected vulnerable packages.

3. Remediate Vulnerabilities: Now that we have visibility, let's look at how we apply fixes. In remote fix mode you have full control over the sealing process via the UI:

   • Available Fixes: Packages with a ready-to-use sealed version will display a blue Seal button.

   • Action: Click the Seal button, then confirm by clicking Seal package in the dialog box. This creates a sealing rule on the server to replace the vulnerable package with a sealed version of it.

   • Apply: Run your pipeline again. The CLI will now pick up the new rule, replace the package, and the status in the UI will change to a green Sealed label.

   • Pending: Packages without an existing sealed version will show a Generate Fix button.