Common tasks
Rather than a tour, this is the list of things people do, with the route to each.
#What you can do
Task | Where | Notes |
|---|---|---|
Connect your GitHub account | On a Confluence page: insert the "Github fil | A GitHub consent window opens (consent is always re-prompted, even if you have connected before). The app asks for repo, user:email, read:org and read:user. After you authorise, the app wait |
Add a file from a repository to a page | Macro configuration → Browse GitHub modal | Search repositories (private ones sort to the top) or paste a github.com blob / raw.githubusercontent.com URL into the search box, browse into the repository, click the file to preview it, t |
Add a file without opening the picker | The Confluence editor | Paste a GitHub blob or raw file URL and it converts into the macro automatically, with repository, path and branch taken from the URL. Use the short /blob/<branch>/<path> form. The /blob/ref |
Show a file from a specific branch, tag or commit | The Confluence editor, by pasting a URL | There is no branch picker. The picker always uses the repository's default branch. To pin to a different ref, paste a GitHub URL that names it. |
Connect a second GitHub account (for example work and personal) | Browse GitHub modal → account dropdown → "Ad | Repositories from all connected accounts are merged and de-duplicated, and when a file cannot be read with one account the macro automatically retries the others. Adding an account from the |
Disconnect a GitHub account or revoke access | Atlassian account settings → Connected Apps | The in-app Disconnect buttons only tell you to do this. They do not disconnect anything. When you unlink there, the app's declared revocation call deletes the token at GitHub. |
Find pages that reference GitHub files | Capable → Github catalogue, or the Capable S | Filters: Minimum Files, Repository (type owner/repo), Organization, File Type. Columns: Files, Repositories, Organizations, File Types. Sorts: Git Last Updated, Git File Count. For File Type |
See which GitHub files are on the page you are reading | The "Github" page byline (shows "N files"), | Both link out to github.com/{owner}/{repo}/blob/{branch}/{path}. The byline needs you to be logged in with view permission, and does not appear for logged-out or unlicensed readers. |
Browse the Capable → Github page | Capable → Github | Four groups: Getting started (dismissable), All files, Browse by file type (8 sub-sections including image), and About (roadmap and changelog). Everything here queries the Confluence index, |
Migrate GitHub macros from Mibex or Appfire | Capable migration wizard | Mibex "Include GitHub for Confluence" and Appfire's GitHub File and GitHub Markdown macros convert to the Capable macro, all marked partial support. Appfire File macros that use line-range f |
Share GitHub content with readers who have no GitHub account | Repository settings on GitHub | Public files render for everyone, including logged-out readers, because the server tries an unauthenticated fetch before touching any credential. Private files require every individual reade |
Turn GitHub off for a space or the whole site | Space settings → General tab (the Capable co | Both controls only hide the "Github" byline. Existing GitHub macros on pages keep rendering either way. There is no GitHub-specific settings tab anywhere. |
#A few things worth knowing
Some tasks need an administrator. The Where column says so.
Anything relying on search needs the page to have been indexed first.
Macro names differ slightly between the standalone app and the suite.
#Related
What people actually do.
