User guide
Rgit is Git with etiquette.
Rgit is Git with etiquette. Run a git forge on a machine you own: SSH remotes, users, merge requests, a small CI runner, and Conventional Commits / SemVer 2.0 by default (turn that off). rgit serve has no HTTP git UI. Browse locally with rgit view, or add Rgit Web as a companion.
If you know git clone, git commit, and git push, follow the pages in order. Examples use git.example.com, user ada, repo ada/website.
Contents
- What is Rabun Git? — how this compares to GitHub and a plain git remote
- Install — install the
rabun-gitcommand - Start the forge — pack-and-push or manual
init/serve, then first admin and key - Set up a remote repository — create
owner/name, addorigin, first push or clone - Users and roles — add people, register keys, grant and revoke
read/write/admin - Everyday git — clone, branches, protected
main/master, localrgit view - Merge requests — propose, review, fast-forward merge
- CI workflows —
.rabun/workflowson push, tag, and request - Versioning — SemVer, Conventional Commits, changelog,
rgit version - Command reference — CLI and SSH cheat sheet
- Compared to GitHub — feature and
ghcommand gap analysis
Layout, ACL, systemd: architecture. Ubuntu pack/push: deploy Ubuntu. Extra disk for repos/: storage volume.
Start here
| Job | Page |
|---|---|
| Put a project on the forge | Remote repository |
| Let teammates in | Users and roles |
Clone URL shape used throughout:
ssh://git@git.example.com:2222/ada/website.git
Forge commands from this machine (rgit login attaches a key after website sign-in; key copy is host SSH for the first admin):
rgit remote add origin git@git.example.com
rgit login --web https://git.example.com
rgit origin repo list
-
What is Rabun Git?
Rgit is Git with etiquette.
-
Install
Install rabun-git on the server that will host repositories.
-
Start the forge
Start serve, then add the first admin and that user’s SSH key.
-
Set up a remote repository
Create a repository on the forge that other machines can clone and push to.
-
Users and roles
An admin creates a user, attaches that person’s SSH public key, and grants a role on each repository they should see.
-
Everyday git
Daily work is ordinary git once the remote exists and you have a role.
-
Merge requests
A merge request asks to fast-forward master or main to a branch.
-
CI workflows
Run shell commands on push, tag, or merge request.
-
Versioning
Conventional Commits 1.0.0 and Semantic Versioning 2.0.0 are the default.
-
Command reference
CLI and SSH cheat sheet.
-
Compared to GitHub
rgit hosts git: remotes, users and keys, path ACL, fast-forward merge requests, shell CI, and SemVer 2.0 / Conventional Commits by default.
-
Architecture
Layout, ACL, and systemd for operators.
-
Ubuntu deploy
Install rabun-git as a systemd unit on x86_64 (or aarch64) Ubuntu.
-
Storage volume
Mount a block volume at /var/lib/rabun-git so systemd, RABUN_GIT_ROOT, and ReadWritePaths stay unchanged.
-
Contributing content
Page schema for adding docs to this site.