Installation Guide

1 Get Your RSOLV API Key

1. Visit rsolv.dev/signup and create an account
2. Complete email verification
3. Navigate to your dashboard at rsolv.dev/portal
4. Copy your API key from the API Keys section

2 Add API Key to GitHub Secrets

Store your RSOLV API key securely as a GitHub Secret:

1. Go to your repository on GitHub
2. Click Settings → Secrets and variables → Actions
3. Click New repository secret
4. Set the name to: RSOLV_API_KEY
5. Paste your API key in the value field
6. Click Add secret

3 Create GitHub Actions Workflow

Create a new file in your repository at:

.github/workflows/rsolv-security.yml

Option A: Simple Scan (Recommended to Start)

This workflow runs on every push to main and detects vulnerabilities without applying fixes:

name: RSOLV Security Scan

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  scan:
    runs-on: ubuntu-latest
    permissions:
      contents: write
      issues: write

    steps:
      - uses: actions/checkout@v4

      - name: RSOLV Security Scan
        uses: RSOLV-dev/rsolv-action@v4
        with:
          rsolvApiKey: ${{ secrets.RSOLV_API_KEY }}
          mode: 'scan'

Option B: Full Pipeline (Scan + Matrix Process)

This workflow scans for vulnerabilities, then processes each issue independently using a matrix strategy to validate and create fix pull requests:

name: RSOLV Security Pipeline

on:
  push:
    branches: [main]
  workflow_dispatch:

jobs:
  scan:
    runs-on: ubuntu-latest
    outputs:
      pipeline_run_id: ${{ steps.rsolv.outputs.pipeline_run_id }}
      issue_numbers: ${{ steps.rsolv.outputs.issue_numbers }}
    permissions:
      contents: write
      issues: write
    steps:
      - uses: actions/checkout@v4
      - name: Scan for vulnerabilities
        id: rsolv
        uses: RSOLV-dev/RSOLV-action@v4
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          rsolvApiKey: ${{ secrets.RSOLV_API_KEY }}
          mode: 'scan'
          max_issues: '3'

  process:
    needs: scan
    if: needs.scan.outputs.issue_numbers != '[]'
    strategy:
      matrix:
        issue_number: ${{ fromJSON(needs.scan.outputs.issue_numbers) }}
      fail-fast: false
      max-parallel: 1
    runs-on: ubuntu-latest
    permissions:
      contents: write
      issues: write
      pull-requests: write
    steps:
      - uses: actions/checkout@v4
      - name: Validate and fix issue
        uses: RSOLV-dev/RSOLV-action@v4
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          rsolvApiKey: ${{ secrets.RSOLV_API_KEY }}
          mode: 'process'
          pipeline_run_id: ${{ needs.scan.outputs.pipeline_run_id }}
          issue_number: ${{ matrix.issue_number }}

4 Commit and Verify Installation

Commit the workflow file

git add .github/workflows/rsolv-security.yml
git commit -m "Add RSOLV security workflow"
git push origin main

Verify the workflow runs

1. Go to your repository's Actions tab
2. You should see "RSOLV Security Scan" or "RSOLV Security Pipeline" workflow running
3. Click on the workflow run to view progress
4. Wait for completion (typically 2-5 minutes)

Check for detected vulnerabilities

• Navigate to your repository's Issues tab
• Look for issues labeled security and rsolv
• Each issue describes a detected vulnerability with file location and details

Common Installation Issues