<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://wiki.joshuayun.com/server/cgit/">
<link rel="prev" href="../server/">
<link rel="next" href="../ddns/">
<link rel="icon" href="../../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.1">
<title>Cgit with gitolite - Joshua's Wiki</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.45e1311d.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#cgit-with-gitolite-and-caddy" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="Joshua's Wiki" class="md-header__button md-logo" aria-label="Joshua's Wiki" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Joshua's Wiki
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Cgit with gitolite
</span>
</div>
</div>
</div>
<script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="Joshua's Wiki" class="md-nav__button md-logo" aria-label="Joshua's Wiki" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
</a>
Joshua's Wiki
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Server
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Server
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../server/" class="md-nav__link">
<span class="md-ellipsis">
Server Setup
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Cgit with gitolite
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Cgit with gitolite
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#setup" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gitolite" class="md-nav__link">
<span class="md-ellipsis">
Gitolite
</span>
</a>
<nav class="md-nav" aria-label="Gitolite">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#configuration-with-cgit" class="md-nav__link">
<span class="md-ellipsis">
Configuration with cgit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#repository-ignore" class="md-nav__link">
<span class="md-ellipsis">
Repository ignore
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adding-hooks-to-gitolite" class="md-nav__link">
<span class="md-ellipsis">
Adding Hooks to gitolite
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cgit" class="md-nav__link">
<span class="md-ellipsis">
Cgit
</span>
</a>
<nav class="md-nav" aria-label="Cgit">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#running-cgit-with-caddy" class="md-nav__link">
<span class="md-ellipsis">
Running cgit with caddy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cgit-configuration" class="md-nav__link">
<span class="md-ellipsis">
Cgit configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#references" class="md-nav__link">
<span class="md-ellipsis">
References
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../ddns/" class="md-nav__link">
<span class="md-ellipsis">
DDNS
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../syncthing/" class="md-nav__link">
<span class="md-ellipsis">
Syncthing
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Desktop
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Desktop
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../desktop/desktop/" class="md-nav__link">
<span class="md-ellipsis">
Desktop
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../desktop/thunderbird/" class="md-nav__link">
<span class="md-ellipsis">
Thunderbird
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Food
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Food
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../food/curry/" class="md-nav__link">
<span class="md-ellipsis">
Curry
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../food/tempora/" class="md-nav__link">
<span class="md-ellipsis">
Tempora
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../food/spicy-shrimp/" class="md-nav__link">
<span class="md-ellipsis">
Spicy Shrimp
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../../about/" class="md-nav__link">
<span class="md-ellipsis">
About
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#setup" class="md-nav__link">
<span class="md-ellipsis">
Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#gitolite" class="md-nav__link">
<span class="md-ellipsis">
Gitolite
</span>
</a>
<nav class="md-nav" aria-label="Gitolite">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#configuration-with-cgit" class="md-nav__link">
<span class="md-ellipsis">
Configuration with cgit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#usage" class="md-nav__link">
<span class="md-ellipsis">
Usage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#repository-ignore" class="md-nav__link">
<span class="md-ellipsis">
Repository ignore
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#adding-hooks-to-gitolite" class="md-nav__link">
<span class="md-ellipsis">
Adding Hooks to gitolite
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cgit" class="md-nav__link">
<span class="md-ellipsis">
Cgit
</span>
</a>
<nav class="md-nav" aria-label="Cgit">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#running-cgit-with-caddy" class="md-nav__link">
<span class="md-ellipsis">
Running cgit with caddy
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#cgit-configuration" class="md-nav__link">
<span class="md-ellipsis">
Cgit configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#references" class="md-nav__link">
<span class="md-ellipsis">
References
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="cgit-with-gitolite-and-caddy">Cgit with gitolite and caddy</h1>
<h2 id="setup">Setup</h2>
<p>Install dependencies.</p>
<pre><code># apt install cgit python-is-python3 python3-pygments python3-markdown docutils-common groff perl
</code></pre>
<p>Make a git user.</p>
<pre><code>sudo adduser --system --shell /bin/bash --group --disabled-password --home /home/git git
</code></pre>
<p>Allow ssh passwordless login.</p>
<pre><code>usermod -p '*' username
</code></pre>
<h2 id="gitolite">Gitolite</h2>
<p>Install the <a href="https://gitolite.com/gitolite/install.html">gitolite</a> package from the repository directly.</p>
<h3 id="configuration-with-cgit">Configuration with cgit</h3>
<p>Configuration of gitolite is done by modifying <code>$HOME/.gitolite.rc</code>.</p>
<p>To work correctly with cgit, gitweb and cgit configuration options need to work with gitolite.</p>
<p>Change:</p>
<pre><code>GIT_CONFIG_KEYS => '',
</code></pre>
<p>To:</p>
<pre><code>GIT_CONFIG_KEYS => '.*',
</code></pre>
<p>To have permissions work correctly,</p>
<p>Change:</p>
<pre><code>UMASK => 0077,
</code></pre>
<p>To:</p>
<pre><code>UMASK => 0027,
</code></pre>
<p>In the <code>ENABLE</code> field, add gitweb and cgit to the list.</p>
<h3 id="usage">Usage</h3>
<p>Detailed usage of gitolite can be found <a href="https://gitolite.com/gitolite/basic-admin.html">here</a></p>
<h3 id="repository-ignore">Repository ignore</h3>
<p>After cgit is configured, cgit can be told to ignore a repo with this syntax.</p>
<pre><code>repo gitolite-admin
config cgit.ignore=1
</code></pre>
<h3 id="adding-hooks-to-gitolite">Adding Hooks to gitolite</h3>
<p>This <a href="https://gitolite.com/gitolite/cookbook#adding-other-non-update-hooks">page</a> details how to add hooks to your repositories.</p>
<p>Example hook that updates a website every git push. Make sure this directory is owned by git.</p>
<pre><code>#!/bin/sh
GIT_WORK_TREE=/desired/website/directory git checkout -f
</code></pre>
<h2 id="cgit">Cgit</h2>
<h3 id="running-cgit-with-caddy">Running cgit with caddy</h3>
<p>Install the <a href="https://packages.debian.org/bookworm/fcgiwrap">fcgiwrap</a> package.</p>
<p>Create a systemd service that wraps cgit with FastCGI.</p>
<pre><code># systemctl edit --full --force cgit.service
</code></pre>
<!-- tsk -->
<pre><code>[Unit]
Description=CGI web interface to the Git SCM
After=network.target
[Service]
Type=exec
ExecStart=fcgiwrap -f -p "/usr/lib/cgit/cgit.cgi" -s tcp:127.0.0.1:8999
[Install]
WantedBy=multi-user.target
</code></pre>
<!-- tsk -->
<pre><code># systemctl start cgit
</code></pre>
<p>Add cgit configuration to caddy.</p>
<pre><code>git.joshuayun.com {
handle_path /cgit-css/* {
root * /usr/share/cgit/
file_server
}
handle {
reverse_proxy localhost:8999 {
transport fastcgi {
env DOCUMENT_ROOT /usr/lib/cgit/
env SCRIPT_FILENAME /usr/lib/cgit/cgit.cgi
}
}
}
}
</code></pre>
<h2 id="cgit-configuration">Cgit configuration</h2>
<p>More detailed documentation can be found on the cgitrc(5) <a href="https://linux.die.net/man/5/cgitrc">manual</a>.</p>
<p>enable-git-config is used to allow for gitweb.* configurations in gitolite, e.g. description, owner.</p>
<pre><code>enable-git-config=1
</code></pre>
<p>project-list sets where cgit looks for projects, this list is the one updated by gitolite</p>
<pre><code>project-list=/home/git/projects.list
</code></pre>
<p>scan-path sets where the actual git repositories live</p>
<pre><code>scan-path=/home/git/repositories
</code></pre>
<h2 id="references">References</h2>
<p><a href="https://www.sixfoisneuf.fr/posts/setting-up-cgit-with-caddy2/">SixFoisNeuf</a> Used this blog to run cgit using fcgiwrap rather than a caddy plugin. The entire cgit with caddy section was using his work.</p>
<p><a href="https://matejamaric.com/blog/git-server/">Mateja Maric</a> Used this blog to help configure cgitrc, gitolite.rc</p>
<p><a href="https://luke.hsiao.dev/blog/cgit-caddy-gitolite/">Luke Hsiao</a> Used the git user creation command from this blog.</p>
<p><a href="https://www.omarpolo.com/post/cgit-gitolite.html">Omar Polo (yumh)</a> Used this blog to help configure cgitrc for hidden repos.</p>
<p><a href="https://bryanbrattlof.com/cgit-nginx-gitolite-a-personal-git-server/">Bryan Brattlof</a> Not much used here, kept as reference.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../../assets/javascripts/bundle.d7c377c4.min.js"></script>
</body>
</html>