a FUSE-based (at least for the time being) FS.
gitmod can be used to virtually display the contents of revisions/tags/branches on a read-only mount-point. No need to have the files of the project on the FS. Just having a bare repo (somewhere on the computer) should suffice to make the files show up at a desired mount point.
At the moment it does the very basics:
- Lists files in the tree on the mount point
- Gets contents of files
- Permissions of executables are kept
- Tracks if the published treeish moves and updates accordingly
Run:
make clean && make
That will generate a binary called gitmod inside bin directory.
It supports the standard options provided by FUSE. It also provides a few more options
- --treeish: use to specify which treeish to track (branch/tag/revision). Default: HEAD
- --repo: use to specify which repo to expose contents from. There is no default. If a default is not provided, gitmod will not work.
Check more options and details with
./bin/gitmod -h
Mount the contents of a web project from branch main of a repo in /home/user/project on apache (standard debian layout).
sudo ./bin/gitmod --repo=/home/user/project --treeish=main -o allow_other -o uid=$( id -u www-data ) /var/www/html
The --kim (keep in memory). This option will force gitmod to keep objects that are loaded from the git repo in memory. This option allows for a 10x throughput improvement in my computer.
You can run make like this to compile with debug output information
DEBUG=1 make
This will make gitmod send information to stdout when running. Important: might require running gitmod with FUSE option -f so that the process does not go into the background.
Building packages is done through docker containers based on the distros (based on rpm or deb) that are "tagged" locally for gitmod specifically.
The following script can be called to generate a debian package:
./scripts/deb.sh package debian bookworm HEAD
The following script can be called to generate an RPM package:
./scripts/rpm.sh package fedora 41 HEAD
NOTE: It will be possible to package (other) specific versions of gitmod later.
Copyright 2020-2024 Edmundo Carmona Antoranz. Released under the terms of GPLv2.
This is very alpha software at the moment so:
- DO NOT USE IT IN PRODUCTION
- USE AT YOUR OWN RISK