◆ docs

Git LFS

Store large files — binaries, datasets, media — outside your normal git history using Git Large File Storage, with the standard git-lfs client.

Install git-lfs

Install the client once per machine and enable it for your user:

# macOS:        brew install git-lfs
# Debian/Ubuntu: sudo apt-get install git-lfs
git lfs install

Track file types

Tell LFS which paths to manage. This writes rules to .gitattributes, which you commit so everyone on the project uses the same tracking:

git lfs track "*.psd"
git lfs track "assets/**/*.bin"
git add .gitattributes

Commit and push

Add and commit tracked files as usual — git-lfs stores the large content and keeps a small pointer in your history:

git add design.psd
git commit -m "Add design source"
git push origin main

Push against your rickub remote over HTTPS. When git prompts for credentials, use your rickub handle and a personal access token as the password — the token authorizes both the git push and the LFS object upload:

git remote add origin https://git.rickub.com/your-handle/your-repo.git
git push -u origin main

Clone and pull

Cloning a repository that uses LFS fetches the large files automatically when git-lfs is installed. To fetch or update them explicitly:

git clone https://git.rickub.com/your-handle/your-repo.git
git lfs pull

Authentication

LFS works over both transports, using the same credentials as normal git access to rickub:

  • HTTPS — your handle as the username and a personal access token as the password. The one token authorizes both the git operation and the LFS object transfer.
  • SSH — works transparently with a registered SSH key: git-lfs runs git-lfs-authenticate over your SSH connection and rickub automatically mints a short-lived token for the LFS object transfer. No extra setup needed.
Note

rickub doesn't support the LFS file-locking API. If git-lfs warns about locksverify on push, silence it with git config lfs.https://git.rickub.com/your-handle/your-repo.git/info/lfs.locksverify false.

Browse LFS files in the UI

Opening an LFS-tracked file in the web UI never shows the raw pointer. Instead you see a panel reading “Stored with Git LFS · <size>” with a Download button, and images render inline as a preview. The size shown is the file’s real size, not the pointer’s.