Connect a GitHub account
Open Account → GitHub and click Connect GitHub. Approve the Ornn app on GitHub and select the repositories it can read. The connection belongs to you in the current organization. Other members can use files you pull and sync the existing folder. Use Add account for another installation, Manage on GitHub to change repository access, or Disconnect to remove the connection. Disconnection keeps the copied files and pauses future syncs until you reconnect.Pull a repository into a volume
- Open a volume in Storage and choose Upload → Import from GitHub. From a mounted volume in Nodes, use Pull from GitHub.
- Pick a repository, branch, and empty destination folder. The default folder name is the repository name.
- Click Pull repository. When it finishes, the branch files are in the selected folder.
Create a volume from a repository
- In Storage, click Create Ornn bucket (or Create a bucket when you have no buckets yet).
- Select From a GitHub repository.
- Select Repository, Branch, and Folder name within the selected option. Branch and folder controls become available after you choose a repository. The bucket name defaults to the repository name.
- Click Create and pull.
When files reach the nodes
Availability depends on the volume:Keep a repository up to date
Click Sync beside a repository to update the folder. Sync replaces changed files, restores missing repository files, and removes files deleted on GitHub. Local files at other paths remain in place. Save local edits and pause workloads that read the folder before syncing. Changes made on the volume stay there. Sync uses the GitHub connection of the person who pulled the repository. If they leave or disconnect it, pull again into a new folder with your own connection.Sync a repository through the API
Pull the repository in the console first. A read-write API key can sync that folder. Poll Get a volume until the folder’ssync.state is ready or failed. On failure, read sync.error. A volume runs one pull or sync at a time.
Limits
- Files only. No Git history is pulled, and there is no
.gitfolder on the node. - 1 GiB per pull. Git LFS files count at their full size. A larger branch is refused. Contact support for a higher limit.
- Git LFS. LFS files are pulled as real files, not pointer files. The download counts against the repository owner’s Git LFS bandwidth on GitHub. An LFS file that GitHub no longer has is written as its pointer file and reported as skipped.
- Symbolic links are kept as links. On a node that mounts the volume, a link works as it does in the repository:
Makefileopensbuild/root/Makefile, and the target is stored only once. In the file browser, a link shows Link to and its target; click it to open the target’s folder. A link that points outside the repository, such as../../etc/passwd, is skipped. - Skipped files. Files whose names contain a control character, such as a tab, or a backslash are skipped. The repository row shows N skipped; click it to see each skipped file and why (link points outside the repository, name not allowed, or LFS file not available). The list shows up to 100 files and stays until a later sync replaces it.
- Rate limits. When GitHub rate limits Ornn, the sync waits and retries on its own. After one hour it stops, and the repository shows an error; click Sync to try again.