Skip to main content

Repository Connection

Entry points

There are three ways to add a GitHub repository to your account:

  1. A keyword search from the Repositories page toolbar (), connecting from a result row.
  2. Connect Repository (), available once you are logged in with GitHub, which browses your own private and public repositories.
  3. The Add to Signaloid button on a repository page on GitHub.

From a search result

The inline search input returns public repositories, and each result row has Connect.

From your own repositories

Connect Repository next to your account button opens the Repositories on GitHub dialog. The dialog lists every repository your GitHub account can see, with an inline filter labeled Search your repositories and Connect on each row.

Validation

For every connection request, the platform opens a Connecting to repository dialog that walks through a short series of checks against the repository on GitHub:

  • Communicating with GitHub.
  • Looking for a Signaloid configuration file (signaloid.yaml).
  • Looking for a ./src directory.
  • Looking for input files in ./inputs.
  • Adding the repository to your Signaloid Cloud account.

If any required step fails, the dialog stays open with an error message and Close. If you are not logged in, the dialog also offers Login with GitHub so you can authorize and retry without losing the request.

Figure 1. Clicking Connect on a repository row and watching the Connecting to repository dialog run each validation check before the repository is added to the account.

After validation succeeds, the dialog closes and the new repository appears as a card on the Repositories page. From there you can pick the Working Branch, Active Core, Build Directory, Command-Line Arguments, and Data Sources, then run the repository on the Compute Engine.

Each connected repository counts against your tier's repository quota. If you hit the limit, Connect shows a tier limit warning before opening the validation dialog. Disconnect a repository you no longer need, to free a slot.