Customer-Hosted Runner

Why customer-hosted

Option A: GitHub Actions composite action

Use the docsci/runner-action composite action. It runs the DocsCI Docker image as a step in your GitHub Actions workflow on your self-hosted runner. Zero external network calls — all execution happens in your runner environment.

# .github/workflows/docsci.yml (customer-hosted runner)
name: DocsCI
on: [pull_request]

jobs:
  docs-ci:
    runs-on: self-hosted          # your runner — no outbound internet needed
    steps:
      - uses: actions/checkout@v4

      - name: Run DocsCI (customer-hosted)
        uses: docsci/runner-action@v1
        with:
          # Required
          docs_path: "docs/"
          token: ${{ secrets.DOCSCI_LICENSE_KEY }}

          # Optional: OpenAPI drift detection
          openapi_url: "http://internal-staging.corp/api/openapi.json"

          # Optional: post findings back to GitHub PR
          github_token: ${{ secrets.GITHUB_TOKEN }}
          post_pr_comments: true

          # Optional: disable telemetry to DocsCI dashboard entirely
          telemetry: false

Option B: Docker image (curl-deployable)

For non-GitHub CI systems (GitLab, Jenkins, Buildkite, CircleCI) or one-off audits. Pull the image, mount your docs directory, and run. Output is a JSON report file.

# Pull the runner image (from your internal registry or Docker Hub)
docker pull docsci/runner:latest

# Run against a local docs directory
docker run --rm \
  -v "$(pwd)/docs:/workspace/docs:ro" \
  -v "$(pwd)/reports:/workspace/reports" \
  -e DOCSCI_LICENSE_KEY=$DOCSCI_LICENSE_KEY \
  -e OPENAPI_URL="http://staging:8080/openapi.json" \
  docsci/runner:latest \
  --docs /workspace/docs \
  --report /workspace/reports/docsci-report.json \
  --exit-on-critical

# Output: reports/docsci-report.json
# Exit code: 0 (pass), 1 (critical findings), 2 (error)

# For GitLab CI (.gitlab-ci.yml):
docs:verify:
  stage: docs
  image: docsci/runner:latest
  script:
    - docsci-runner --docs docs/ --report docsci-report.json --exit-on-critical
  artifacts:
    paths: [docsci-report.json]
    expire_in: 1 week

Security model

Timeline