Skip to documentation
MMirageDocs

Documentation

Manage runners

Accounts and teams

Connect personal and organization accounts, share machines, and manage team access.

Switch accounts

You can connect your personal GitHub account and organizations to Mirage. Use the account menu in the dashboard to switch between them. Runs, repository settings, available runners, and billing estimates reflect the selected account.

A GitHub App installation gives Mirage access to an account’s selected repositories. You may see the word “installation” in settings or CLI output; choose the one for the repository you are configuring. Switching the dashboard account does not change which accounts a machine serves.

Share a machine

Open a machine you control in Machines. Under Available to, choose which connected GitHub accounts may schedule jobs on it. A shared machine must also have an active capacity grant for that account; organization administrators can review grants in Machines.

Machines shows your hosts and capacity the selected account can use, including machines shared by other people. Offering capacity does not transfer ownership of your machine.

A machine shares one resource budget across accounts. Giving two organizations access does not duplicate its CPU, memory or disk capacity. macOS jobs and agent VMs also share the host's macOS guest allowance, which cannot exceed two. Each account must have GitHub App access to the private repository.

Team permissions

Mirage uses your GitHub organization's people. Everyone in the organization can use Mirage with the role they have on GitHub, and People in Settings lists them. To add someone, remove them, or change their role, do it on GitHub; Mirage picks up the change on its own. A personal account has only its owner.

GitHub roleWhat they can do in Mirage
OwnerManage the account, repositories, runs, billing, providers, and capacity.
MemberView the account and its available runners, and offer machine capacity.

Someone who leaves the organization loses Mirage access, and the machines they offered stop running its jobs. Mirage reads organization members through the GitHub App's Members permission.

Stop sharing capacity

Remove an account from a machine’s Available to list, or manage its grant in Machines. To stop a Mac from accepting all new jobs temporarily, pause it. Before removing an account’s last machine permanently, make sure its workflows have hosted fallback or restore GitHub-hosted labels.