Where connecting is possible
You can connect your GitHub account in two places: from a GitHub file macro on a page, or from the Browse GitHub window in the macro's configuration. There is nowhere else to do it.
#Where you do it
Task | Where |
|---|---|
Connect your GitHub account | On a Confluence page: insert the "Github file (Capable)" macro, then press Connect GitHub in the macro; or open the macro's configuration and press Connect in the Browse GitHub modal. |
Add a file from a repository to a page | Macro configuration → Browse GitHub modal |
Add a file without opening the picker | Paste the file's GitHub link into the Confluence editor |
#Settings that affect this
Setting | Where | What it does |
|---|---|---|
There is no GitHub settings screen | Nowhere | GitHub adds nothing to Capable global settings or space settings. There is also no admin screen for connecting the whole site to GitHub, because each person connects their own account. |
Hide GitHub across the whole site | App property `capable-global-hidden-capabilities`, object name `hiddenCapabilities`, value | Hides GitHub site-wide. Important: this only hides the GitHub byline. Existing GitHub macros keep showing on pages. |
Turn GitHub on or off per space | Space property `<APP_HASH>_capable`, object name `capabilities.alwaysOff` / `capabilities. | alwaysOff hides the byline in that space. alwaysOn shows it even on pages with no GitHub macro. Again, byline only: macros still show. |
#Limits that apply here
Limit | Value | What happens |
|---|---|---|
No handling of GitHub rate limits | - | Capable does not retry or wait when GitHub limits requests. A GitHub 403 caused by rate limiting is shown to the reader as an access problem, as though they do not have permission. |
#Related
Better with company.
