Hosted: Overview

Hosted

Hosted overview

What the hosted HookCI hub at ci.webuno.io does for you, how accounts work, and what you still run yourself.

The hosted hub at https://ci.webuno.io is the control plane for HookCI. You run the agent that executes your checks. We run everything between your agent, GitHub, and Slack.

What the hub does

  • Receives GitHub events. The HookCI GitHub App sends push and pull request webhooks to the hub.
  • Routes work to your agent. Each repository is bound to an agent. The hub sends the run to that agent over its outbound WebSocket and tracks it until it finishes.
  • Reports to GitHub. It writes an aggregate hookci check run and one hookci/<job> check run per job, with annotations. See GitHub Checks.
  • Reports to Slack. It posts one run message per run, edits it as jobs finish, sends failure alerts, and serves the App Home and /hookci commands. See Slack.
  • Stores logs and results. Job logs go to object storage when logs: hub is set, and View log links are signed and last 15 minutes. Source code is not stored. See Security and data.
  • Manages agents. It issues single-use pair tokens, stores a hash of each agent credential, and revokes agents on request. See Pair an agent.

The hub does not run your code, and it needs no access to your servers. For the data flow, see How it works.

Accounts

There is no separate sign-up form. An account is a GitHub App installation on your GitHub user or organization, plus the Slack workspace you connect to it.

Concept What it is
Installation The HookCI GitHub App installed on one GitHub account. Everything the hub stores is scoped to it.
Repositories The repositories you gave the App access to when you installed it, which you can change in GitHub.
Agents The servers paired to the installation. Each runs the checks of the repositories bound to it.
Slack workspace One workspace per installation, added with Add to Slack.
Your Slack user Linked to your GitHub account with /hookci me. Commands check your GitHub permissions.

Only an admin of the GitHub account can pair an agent or add HookCI to Slack. Everyone else uses the product through GitHub checks and Slack messages.

What you need to be

To do this You need
Read run status in Slack Read access to the repository, and a linked GitHub account
Watch or unwatch a repository, retry a run, approve a fork run Write access
Bind a repository to an agent Admin access
Pair or revoke an agent, add to Slack Admin of the GitHub account

Getting set up

  1. Install the GitHub App at ci.webuno.io/start.
  2. Pair at least one agent: Pair an agent.
  3. Add HookCI to Slack and watch a repository: Slack.

The Quickstart walks through all three with screenshots.

Limits and plans

How many agents, runs, and days of log retention you get depends on your plan. The numbers are on the pricing page. When a limit applies, the hub tells you where it counts:

  • A daily run limit puts the aggregate check in “action required” and resets at 00:00 UTC.
  • Pairing one more agent than your plan allows is refused with an agent_limit error. Revoke an agent you no longer use, or change plan.
  • Pair tokens and slash commands are rate limited. Slash commands answer with “try again in a minute”.

Leaving

  • Revoke an agent in Slack App Home to stop it at once.
  • Uninstall the Slack app or the GitHub App to remove that workspace’s or installation’s data from the hub within 30 days.
  • /hookci export gives you a JSON download of your data, and /hookci delete-my-data removes your GitHub link and author mappings in that workspace.