diff options
Diffstat (limited to 'blog')
| -rw-r--r-- | blog/git_server.html | 156 | ||||
| -rw-r--r-- | blog/git_server.md | 219 |
2 files changed, 219 insertions, 156 deletions
diff --git a/blog/git_server.html b/blog/git_server.html deleted file mode 100644 index 5a9423c..0000000 --- a/blog/git_server.html +++ /dev/null @@ -1,156 +0,0 @@ -<!DOCTYPE html> - -<html> - <head> - <title>cacharle</title> - <link rel="stylesheet" type="text/css" href="../style.css"/> - <meta charset="utf-8"/> - <link rel="icon" type="image/png" href="../favicon.png" /> - </head> - - <body> - <div id="page-wrapper"> - <!--BLOG--> -<h1 id="how-to-make-your-own-git-serverwebsite">How to make your own git server/website</h1> -<h2 id="basic-ssh-server">Basic ssh server</h2> -<p>Every repository on the server will be owned by a git user.</p> -<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">useradd</span> -m git</span></code></pre></div> -<p>Create a new directory to store the repositories owned by the git user.</p> -<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> /srv/git</span> -<span id="cb2-2"><a href="#cb2-2" aria-hidden="true" tabindex="-1"></a><span class="fu">chown</span> git:git /srv/git</span></code></pre></div> -<p>Login as the git user so the new repositories will be owned by him.</p> -<div class="sourceCode" id="cb3"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="fu">su</span> git</span> -<span id="cb3-2"><a href="#cb3-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> /srv/git</span></code></pre></div> -<h3 id="creating-a-repository">Creating a repository</h3> -<p>They will be stored as bare, meaning we will only store the <code>.git</code> folder not the actual files (called the <em>workspace</em>) to save space.<br /> -It’s a convention to to suffix a bare repository with the <code>.git</code> extension.</p> -<div class="sourceCode" id="cb4"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> repo.git</span> -<span id="cb4-2"><a href="#cb4-2" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> repo.git</span> -<span id="cb4-3"><a href="#cb4-3" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> init --bare</span></code></pre></div> -<p>Or clone a distant one:</p> -<div class="sourceCode" id="cb5"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone --bare <span class="op"><</span>location<span class="op">></span></span></code></pre></div> -<blockquote> -<p>Look at the content of a bare repository and the <code>.git</code> directory in a regular one to convince yourself that they’re the same.</p> -</blockquote> -<h3 id="ssh-authentication">SSH Authentication</h3> -<p>You could add a password for the git user but it’s ultimately safer to user a key pair.</p> -<p>If you don’t know what that is you generate it with <code>ssh-keygen</code>.<br /> -Follow the steps and it will create <code>id_rsa</code> (private key) and <code>id_rsa.pub</code> (public key) in <code>~/.ssh</code>.<br /> -On your server you append your <strong>public</strong> key to <code>/home/git/.ssh/authorized_keys</code></p> -<p>At this point you should be able to login as the git user via ssh</p> -<div class="sourceCode" id="cb6"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="fu">ssh</span> git@<span class="op"><</span>host<span class="op">></span></span></code></pre></div> -<p>You can clone from your server.</p> -<div class="sourceCode" id="cb7"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> clone git@<span class="op"><</span>hostname<span class="op">></span>:/srv/git/<span class="op"><</span>reponame<span class="op">></span>.git</span></code></pre></div> -<h2 id="better-server-interaction-with-git-shell">Better server interaction with git-shell</h2> -<p>Permitting the git user to have a regular shell can be too permissive, we would like to restrict him to a few repository actions, like creation/deletion, importing (clone), listing.</p> -<div class="sourceCode" id="cb8"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="bu">echo</span> <span class="va">$(</span><span class="fu">which</span> git-shell<span class="va">)</span> <span class="op">>></span> /etc/shells<span class="kw">`</span> # <span class="ex">Register</span> the git-shell as a valid shell</span> -<span id="cb8-2"><a href="#cb8-2" aria-hidden="true" tabindex="-1"></a><span class="fu">chsh</span> -s <span class="va">$(</span><span class="fu">which</span> git-shell<span class="va">)</span> git # Change the shell of the git user</span></code></pre></div> -<p>If you try to ssh as the git user, you will be greeted with something along the line of:</p> -<pre><code>fatal: Interactive git shell is not enabled. -hint: ~/git-shell-commands should exist and have read and execute access. -Connection to <host> closed.</code></pre> -<p>As suggested by the hint we have to create the directory <code>/home/git/git-shell-commands</code> and put the commands (executable) available to the git user.</p> -<div class="sourceCode" id="cb10"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="co">#!/bin/sh</span></span> -<span id="cb10-2"><a href="#cb10-2" aria-hidden="true" tabindex="-1"></a><span class="bu">[</span> <span class="va">$#</span> <span class="ot">-ne</span> 1<span class="bu"> ]</span> <span class="kw">&&</span></span> -<span id="cb10-3"><a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> <span class="bu">echo</span> <span class="st">"Usage: </span><span class="va">$0</span><span class="st"> repository"</span> <span class="kw">&&</span> <span class="bu">exit</span> 1</span> -<span id="cb10-4"><a href="#cb10-4" aria-hidden="true" tabindex="-1"></a><span class="va">repo_path=</span><span class="st">"/srv/git/</span><span class="va">$1</span><span class="st">.git"</span></span> -<span id="cb10-5"><a href="#cb10-5" aria-hidden="true" tabindex="-1"></a><span class="bu">[</span> <span class="ot">-d</span> <span class="st">"</span><span class="va">$repo_path</span><span class="st">"</span><span class="bu"> ]</span> <span class="kw">&&</span></span> -<span id="cb10-6"><a href="#cb10-6" aria-hidden="true" tabindex="-1"></a> <span class="bu">echo</span> <span class="st">"</span><span class="va">$0</span><span class="st">: Error: </span><span class="va">$repo_path</span><span class="st"> already exist"</span> <span class="kw">&&</span> <span class="bu">exit</span> 2</span> -<span id="cb10-7"><a href="#cb10-7" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> <span class="st">"</span><span class="va">$repo_path</span><span class="st">"</span></span> -<span id="cb10-8"><a href="#cb10-8" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> -C <span class="st">"</span><span class="va">$repo_path</span><span class="st">"</span> init --bare</span></code></pre></div> -<p>This script create a new repository in <code>/srv/git</code>.<br /> -Put it under <code>git-shell-commands/create</code> and make it executable then try to ssh as the git user once again.<br /> -You will be prompted with <code>git></code>, you can only execute the <code>create <repository></code> and <code>exit</code> command.</p> -<blockquote> -<p>You can probably create the <code>delete</code>, <code>import</code> and <code>list</code> scripts yourself.<br /> -If you add a <code>help</code> script, it will be ran at the beginning of the connection. It can be used to add a greeting message.</p> -</blockquote> -<h2 id="allow-anyone-to-clone-with-git-daemon">Allow anyone to clone with git-daemon</h2> -<p>Cloning with ssh is fine but only the people with ssh access can do it, we would like anyone to clone.<br /> -git-daemon does precisely that, after running it you will be able to run <code>git clone git://<host>/<repository></code></p> -<div class="sourceCode" id="cb11"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="fu">git</span> daemon --reuseaddr --base-path=/srv/git/ /srv/git/</span></code></pre></div> -<p>Follow the instruction of <a href="https://git-scm.com/book/en/v2/Git-on-the-Server-Git-Daemon">this</a> tutorial if you want to know how to make it a service</p> -<h3 id="publicprivate-repository">Public/private repository</h3> -<p>You may want to introduce a public/private distinction for your repositories.<br /> -A simple way to do this is by creating a <code>public</code> directory in <code>/srv/git</code> which will contain symbolic link to the repository in <code>/srv/git</code>.</p> -<pre><code>/srv/git/ - |- foo.git/ - |- bar.git/ - |- qux.git/ - |- public/ - |- foo.git -> /srv/git/foo.git - |- bar.git -> /srv/git/bar.git</code></pre> -<blockquote> -<p>Change the git daemon to only serve the public repositories <code>git daemon --reuseaddr --base-path=/srv/git/public /srv/git/public</code>.</p> -</blockquote> -<blockquote> -<p>Add a <code>publish</code> and <code>unpublish</code> script in <code>git-shell-commands/</code>.</p> -</blockquote> -<h2 id="generate-a-static-website">Generate a static website</h2> -<p>Here we will create a site that look’s like <a href="https://git.suckless.org">this</a> with <a href="https://nginx.org">nginx</a>, <a href="https://git.codemadness.org/stagit/">stagit</a> and a few scripts.<br /> -If you don’t like the minimalist appearance of the site, <a href="https://git.wiki.kernel.org/index.php/Interfaces,_frontends,_and_tools#Web_Interfaces">here</a> is a list of alternatives.</p> -<h3 id="nginx">nginx</h3> -<pre><code>server { - root /var/www/git; # where our website's files will be located - index index.html; - # It's a convention to put it in a git. subdomain. - server_name git.<hostname> www.git.<hostname>; - location / { - try_files $uri $uri/ =404; - } -}</code></pre> -<p>Put this configuration file in <code>/etc/nginx/sites-available</code>.<br /> -Enable the site <code>ln -s /etc/nginx/sites-available /etc/nginx/sites-enable</code></p> -<h3 id="stagit">stagit</h3> -<p>Stagit is pretty small tool so it won’t take long to install it from sources.</p> -<pre><code>git clone git://git.codemadness.org/stagit -cd stagit -make -make install</code></pre> -<ul> -<li><code>stagit /path/to/repository</code>. - generate a static pages for a repository in the current directory.</li> -<li><code>stagit-index repo1 repo2 repo3 > index.html</code> - generate an index for multiple repositories.</li> -</ul> -<blockquote> -<p>Read the man page of both of these commands for more information</p> -</blockquote> -<h4 id="git-hooks">git hooks</h4> -<p>Git hooks are scripts located in <code><repository>/.git/hooks</code> that will be run on a certain action.<br /> -The hook we’re interested in is <code>post-receive</code>, it will be ran after someone pushes to the repository.<br /> -We can use it to regenerate the repository’s pages and the website’s index.</p> -<div class="sourceCode" id="cb15"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb15-1"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a><span class="co">#!/bin/sh</span></span> -<span id="cb15-2"><a href="#cb15-2" aria-hidden="true" tabindex="-1"></a></span> -<span id="cb15-3"><a href="#cb15-3" aria-hidden="true" tabindex="-1"></a><span class="co"># Insert repo_name variable here</span></span> -<span id="cb15-4"><a href="#cb15-4" aria-hidden="true" tabindex="-1"></a><span class="co"># <REPO_NAME> -- replace with repo_name=name</span></span> -<span id="cb15-5"><a href="#cb15-5" aria-hidden="true" tabindex="-1"></a></span> -<span id="cb15-6"><a href="#cb15-6" aria-hidden="true" tabindex="-1"></a><span class="bu">[</span> <span class="ot">-z</span> <span class="st">"</span><span class="va">$repo_name</span><span class="st">"</span><span class="bu"> ]</span> <span class="kw">&&</span> <span class="bu">exit</span> 1</span> -<span id="cb15-7"><a href="#cb15-7" aria-hidden="true" tabindex="-1"></a><span class="bu">[</span> <span class="ot">!</span> <span class="ot">-d</span> <span class="st">"/srv/git/public/</span><span class="va">$repo_name</span><span class="st">.git"</span><span class="bu"> ]</span> <span class="kw">&&</span> <span class="bu">exit</span></span> -<span id="cb15-8"><a href="#cb15-8" aria-hidden="true" tabindex="-1"></a></span> -<span id="cb15-9"><a href="#cb15-9" aria-hidden="true" tabindex="-1"></a><span class="va">repo_web_path=</span><span class="st">"/var/www/git/</span><span class="va">$repo_name</span><span class="st">"</span></span> -<span id="cb15-10"><a href="#cb15-10" aria-hidden="true" tabindex="-1"></a><span class="fu">mkdir</span> -p <span class="st">"</span><span class="va">$repo_web_path</span><span class="st">"</span></span> -<span id="cb15-11"><a href="#cb15-11" aria-hidden="true" tabindex="-1"></a><span class="bu">cd</span> <span class="st">"</span><span class="va">$repo_web_path</span><span class="st">"</span> <span class="kw">||</span> <span class="bu">exit</span> 1</span> -<span id="cb15-12"><a href="#cb15-12" aria-hidden="true" tabindex="-1"></a><span class="ex">stagit</span> <span class="st">"/srv/git/</span><span class="va">$repo_name</span><span class="st">.git"</span></span> -<span id="cb15-13"><a href="#cb15-13" aria-hidden="true" tabindex="-1"></a><span class="ex">stagit-index</span> /srv/git/public/* <span class="op">></span> /var/www/git/index.html</span></code></pre></div> -<p>This is a template for the <code>post-receive</code> hook. Every time you publish a repository you can change his <code>post-receive</code> hook.</p> -<div class="sourceCode" id="cb16"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb16-1"><a href="#cb16-1" aria-hidden="true" tabindex="-1"></a><span class="va">post_receive_path=</span><span class="st">"<repository>/hooks/post-receive"</span></span> -<span id="cb16-2"><a href="#cb16-2" aria-hidden="true" tabindex="-1"></a><span class="fu">sed</span> <span class="st">'/REPO_NAME/ c repo_name='"</span><span class="va">$repo</span><span class="st">"</span> <span class="op"><</span> post-receive.template <span class="op">></span> <span class="st">"</span><span class="va">$post_receive_path</span><span class="st">"</span></span> -<span id="cb16-3"><a href="#cb16-3" aria-hidden="true" tabindex="-1"></a><span class="fu">chmod</span> +x <span class="st">"</span><span class="va">$post_receive_path</span><span class="st">"</span></span> -<span id="cb16-4"><a href="#cb16-4" aria-hidden="true" tabindex="-1"></a><span class="st">"</span><span class="va">$post_receive_path</span><span class="st">"</span></span></code></pre></div> -<blockquote> -<p>Add this code to your <code>publish</code> script</p> -</blockquote> -<h2 id="sources">Sources</h2> -<ul> -<li><a href="https://www.youtube.com/watch?v=ju9loeXNVW0">Setting up *Your Own* Git Server</a></li> -<li><a href="https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server">Git book - setting up the server</a></li> -<li><a href="https://git-scm.com/book/en/v2/Git-on-the-Server-Git-Daemon">Git book - git daemon</a></li> -<li><a href="https://git.codemadness.org/stagit/file/README.html">stagit README</a></li> -<li><a href="https://git-scm.com/docs/git-shell.html">git-shell man</a></li> -</ul> - </div> - - <footer> - <!--TODO--> - <footer> - </body> -</html> diff --git a/blog/git_server.md b/blog/git_server.md new file mode 100644 index 0000000..67191c6 --- /dev/null +++ b/blog/git_server.md @@ -0,0 +1,219 @@ +# How to make your own git server/website + +## Basic ssh server + +Every repository on the server will be owned by a git user. + +```sh +useradd -m git +``` + +Create a new directory to store the repositories owned by the git user. + +```sh +mkdir /srv/git +chown git:git /srv/git +``` + +Login as the git user so the new repositories will be owned by him. + +```sh +su git +cd /srv/git +``` + +### Creating a repository + +They will be stored as bare, meaning we will only store the `.git` +folder not the actual files (called the *workspace*) to save space. +It's a convention to to suffix a bare repository with the `.git` extension. + +```sh +mkdir repo.git +cd repo.git +git init --bare +``` + +Or clone a distant one: + +```sh +git clone --bare <location> +``` + +> Look at the content of a bare repository and the `.git` directory in a regular one +> to convince yourself that they're the same. + +### SSH Authentication + +You could add a password for the git user but it's ultimately safer to user a key pair. + +If you don't know what that is you generate it with `ssh-keygen`. +Follow the steps and it will create `id_rsa` (private key) and `id_rsa.pub` (public key) in `~/.ssh`. +On your server you append your **public** key to `/home/git/.ssh/authorized_keys` + +At this point you should be able to login as the git user via ssh + +```sh +ssh git@<host> +``` + +You can clone from your server. + +```sh +git clone git@<hostname>:/srv/git/<reponame>.git +``` + +## Better server interaction with git-shell + +Permitting the git user to have a regular shell can be too permissive, +we would like to restrict him to a few repository actions, like creation/deletion, importing (clone), listing. + +``` sh +echo $(which git-shell) >> /etc/shells` # Register the git-shell as a valid shell +chsh -s $(which git-shell) git # Change the shell of the git user +``` + +If you try to ssh as the git user, you will be greeted with something along the line of: + +``` +fatal: Interactive git shell is not enabled. +hint: ~/git-shell-commands should exist and have read and execute access. +Connection to <host> closed. +``` + +As suggested by the hint we have to create the directory `/home/git/git-shell-commands` +and put the commands (executable) available to the git user. + +```sh +#!/bin/sh +[ $# -ne 1 ] && + echo "Usage: $0 repository" && exit 1 +repo_path="/srv/git/$1.git" +[ -d "$repo_path" ] && + echo "$0: Error: $repo_path already exist" && exit 2 +mkdir "$repo_path" +git -C "$repo_path" init --bare +``` + +This script create a new repository in `/srv/git`. +Put it under `git-shell-commands/create` and make it executable then try to ssh as the git user once again. +You will be prompted with `git> `, you can only execute the `create <repository>` and `exit` command. + +> You can probably create the `delete`, `import` and `list` scripts yourself. +> If you add a `help` script, it will be ran at the beginning of the connection. +> It can be used to add a greeting message. + +## Allow anyone to clone with git-daemon + +Cloning with ssh is fine but only the people with ssh access can do it, we would like anyone to clone. +git-daemon does precisely that, after running it you will be able to run `git clone git://<host>/<repository>` + +```sh +git daemon --reuseaddr --base-path=/srv/git/ /srv/git/ +``` + +Follow the instruction of [this](https://git-scm.com/book/en/v2/Git-on-the-Server-Git-Daemon) tutorial if you want to know how to make it a service + +### Public/private repository + +You may want to introduce a public/private distinction for your repositories. +A simple way to do this is by creating a `public` directory in `/srv/git` +which will contain symbolic link to the repository in `/srv/git`. + +``` +/srv/git/ + |- foo.git/ + |- bar.git/ + |- qux.git/ + |- public/ + |- foo.git -> /srv/git/foo.git + |- bar.git -> /srv/git/bar.git +``` + +> Change the git daemon to only serve the public repositories +> `git daemon --reuseaddr --base-path=/srv/git/public /srv/git/public`. + +> Add a `publish` and `unpublish` script in `git-shell-commands/`. + +## Generate a static website + +Here we will create a site that look's like [this](https://git.suckless.org) +with [nginx](https://nginx.org), [stagit](https://git.codemadness.org/stagit/) and a few scripts. +If you don't like the minimalist appearance of the site, +[here](https://git.wiki.kernel.org/index.php/Interfaces,_frontends,_and_tools#Web_Interfaces) +is a list of alternatives. + +### nginx + +``` +server { + root /var/www/git; # where our website's files will be located + index index.html; + # It's a convention to put it in a git. subdomain. + server_name git.<hostname> www.git.<hostname>; + location / { + try_files $uri $uri/ =404; + } +} +``` + +Put this configuration file in `/etc/nginx/sites-available`. +Enable the site `ln -s /etc/nginx/sites-available /etc/nginx/sites-enable` + +### stagit + +Stagit is pretty small tool so it won't take long to install it from sources. + +``` +git clone git://git.codemadness.org/stagit +cd stagit +make +make install +``` + +* `stagit /path/to/repository`. - generate a static pages for a repository in the current directory. +* `stagit-index repo1 repo2 repo3 > index.html` - generate an index for multiple repositories. + +> Read the man page of both of these commands for more information + +#### git hooks + +Git hooks are scripts located in `<repository>/.git/hooks` that will be run on a certain action. +The hook we're interested in is `post-receive`, it will be ran after someone pushes to the repository. +We can use it to regenerate the repository's pages and the website's index. + +```sh +#!/bin/sh + +# Insert repo_name variable here +# <REPO_NAME> -- replace with repo_name=name + +[ -z "$repo_name" ] && exit 1 +[ ! -d "/srv/git/public/$repo_name.git" ] && exit + +repo_web_path="/var/www/git/$repo_name" +mkdir -p "$repo_web_path" +cd "$repo_web_path" || exit 1 +stagit "/srv/git/$repo_name.git" +stagit-index /srv/git/public/* > /var/www/git/index.html +``` + +This is a template for the `post-receive` hook. +Every time you publish a repository you can change his `post-receive` hook. + +```sh +post_receive_path="<repository>/hooks/post-receive" +sed '/REPO_NAME/ c repo_name='"$repo" < post-receive.template > "$post_receive_path" +chmod +x "$post_receive_path" +"$post_receive_path" +``` + +> Add this code to your `publish` script + +## Sources + +* [Setting up \*Your Own\* Git Server](https://www.youtube.com/watch?v=ju9loeXNVW0) +* [Git book - setting up the server](https://git-scm.com/book/en/v2/Git-on-the-Server-Setting-Up-the-Server) +* [Git book - git daemon](https://git-scm.com/book/en/v2/Git-on-the-Server-Git-Daemon) +* [stagit README](https://git.codemadness.org/stagit/file/README.html) +* [git-shell man](https://git-scm.com/docs/git-shell.html) |