Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.blacksmith.sh/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Scale Apps are additional GitHub Apps (blacksmith-sh-scale-1, blacksmith-sh-scale-2, blacksmith-sh-scale-3) that you can install alongside the primary Blacksmith GitHub App. Each one gives Blacksmith additional GitHub API rate-limit budget, so that runner provisioning keeps up during high-volume CI activity without tripping GitHub’s secondary rate limit.

​
What they are used for

Scale Apps have a deliberately narrow scope. Blacksmith uses Scale App tokens only to provision and deprovision GitHub Actions runners on your organization. Every other GitHub API call Blacksmith makes (webhooks, repository metadata, PR comments from features like Test Analytics, and so on) goes through the primary Blacksmith GitHub App. Scale Apps are never used to read your code, write to your repositories, or act on pull requests or issues.

​
Permissions

Each Scale App requests a single organization permission: self-hosted runners: read & write. It does not request any other permissions, so it cannot read your source code, see your secrets, or interact with pull requests, issues, or workflows. You can confirm the exact permission set on the GitHub App listing before installing.

​
Installing Scale Apps

When your org hits GitHub’s secondary rate limit, the Blacksmith dashboard shows org admins a notification suggesting they install the next available Scale App. To install one, open its GitHub App page and pick the organization to install it on: Install them one at a time as your rate-limit pressure grows. No workflow changes are required, and uninstalling a Scale App at any time is safe; it just gives back the extra headroom.
If you have questions about Scale Apps or want help deciding how many to install, reach out through the support console.