Skip to main content
Signing in is a single GitHub OAuth click that establishes who you are, and it grants Orbi no repository access by itself. Orbi Cloud has no password of its own. Your GitHub account is your identity, and the repository access is a separate, explicit step, installing the GitHub App, that you control from GitHub.

Sign in

Open orbi.build/api/ and click Sign in with GitHub. GitHub shows you its standard authorization screen. Approving it returns you to Orbi Cloud: to the page you were on your way to, or, if the App is not installed yet, to a page with an Install the Orbi GitHub App button. The sign-in requests one OAuth scope, user:email: your identity and your email address, nothing more. It does not grant access to any repository’s code or Issues. That comes from the GitHub App installation, which is authorized separately and lists its own permissions.
If you install the App directly from its page on GitHub instead, GitHub signs you in to Orbi Cloud when it returns. The result is the same: you are signed in, and the App is installed on the repositories you picked.

The account menu

Click your GitHub avatar in the top right of any Cloud page. The menu offers website language, subscription actions when applicable, Settings, support, online docs and Sign out. Settings opens one page for the currently selected account: If you can manage several installations, the menu shows which installation you are acting on and offers a switch to the others. Settings and usage belong to that account, so check the account name before editing.

Choosing your language

Orbi Cloud is available in English and Chinese. The page follows your browser’s preferred language on the first visit, so it may open in Chinese. Switch from the account menu, or with the same 🇨🇳 ZH | 🇺🇸 EN switch in the top right of the sign-in page. Your choice is stored in a cookie and remembered for a year, on that browser. It changes the website only. To change Orbi’s GitHub comments and Telegram messages, use Settings → Orbi message language; see notifications and message language.

Personal and organization accounts

If you install the Orbi GitHub App on an organization rather than on your personal account, the organization gets its own Orbi tenant: its repositories, its subscription and its usage are tracked separately from your personal one. You sign in the same way either way. When you have access to more than one installation, use the Switch to the … installation buttons in the account menu to choose which tenant you are working on.

Signing out

Open the account menu and click Sign out. Signing out clears the session on that device only. It does not uninstall the GitHub App, cancel a subscription, or stop a task that is already running.

When your session expires

A session lasts 7 days and is not extended by activity, so you sign in again about once a week. If the GitHub authorization behind your session has lapsed, the status page shows GitHub sign-in has expired with a Sign in again button; pages that need an identity say so rather than failing silently. Signing in again restores everything. Your connected repositories, your model configuration and your task history are stored against your tenant, not against the browser session.