If you’re using git for source code management, you may run into a problem if you try to include large files using GitHub or other repos.

By large I mean in the tens of megabytes range, and certainly larger files like ISO images, etc.

I ran into this for a project I’ve been tinkering with (full post coming soon) which generates large 6000×9000 .PNG images which come in at 30+ MB each.  The code is Python but I wanted to include some examples and when I tried to push to GitHub, git spun and spun and spun.  An hour later I killed it.

Turns out that git really doesn’t like large files.  Even worse, if you have large files that frequently change, your repo is going to be massive because all previous versions are changed.  So if part of your process is “rebuild the ISO and then update the repo” you are in for a world of pain down the road.

In my case, I just wanted a few .PNGs which are probably never going to change.  Best practice would be to store them separately outside the repo, but since I’m using GitHub it just makes sense to store everything in.

The solution to overcome GitHub’s limitation: git lfs.  From their GitHub:

Git LFS is a command line extension and specification for managing large files with Git.

The client is written in Go, with pre-compiled binaries available for Mac, Windows, Linux, and FreeBSD.

How to Use It

Installation is as simple as using your package manager.  On my mac I use Homebrew:

brew install git-lfs

Then set it up:

git lfs install

Now in your repo, you need to tell Git LFS what it should handle.  In my case, I said “all PNG files:

git lfs track "*.png"

Then you need to add the .gitattributes file where Git LFS stores its info:

git add .gitattributes

And then the rest is familiar:

git add example.png
git commit -m "added example.png"
git push -u origin main

After that, my giant .PNGs worked perfectly

• Author
• Recent Posts

raindog308

Dread Lord of LowEnd Content at LowEndBox

I'm raindog308, techno polymath and long-time LowEndTalk community Administrator. My technical interests include all things Unix, perl, python, golang, shell scripting, vintage operating systems such as MVS, and relational database systems such as Oracle, PostgreSQL, and MySQL.

I also enjoy using LEBs! I have an empire of little guys for VPNs, larger guys for apps, and big guys for databases and storage. When I'm not in front a screen I'm into German Shepherd dogs, quality knives, target shooting, theology, tabletop roleplaying games, and forest hiking.

I enjoy writing technical articles here on LowEndBox to help people get more out of their systems. You can find me on LowEndTalk @raindog308

Latest posts by raindog308 (see all)

• cPanel VPS Licenses for Only $4.00/Month!Dedicated for Only $4.50/Month!But There’s One Important Detail… - April 18, 2024
• Gloo.top – a Cool LowEndTalk Member Link Shortener You Should Check Out! - April 18, 2024
• Setup a Highly Available WordPress Site From Scratch, 2024 Edition!Part 7: Round-Robin DNS, Let’s Encrypt, & Conclusion - April 17, 2024