summaryrefslogtreecommitdiffstats
path: root/README.org
blob: 97badd46d07f3224d58bff0e490513ebc2488f72 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#+title: Caddy VFS module for (local) Git repositories
#+author: tecosaur

/With special thanks to [[https://github.com/sagikazarmark/caddy-fs-s3][caddy-fs-s3]] for serving as a template./

* Installation

Build Caddy using [[https://github.com/caddyserver/xcaddy][xcaddy]]

#+begin_src sh
xcaddy build --with github.com/tecosaur/caddy-fs-git
#+end_src

* Usage

#+begin_src caddyfile
file_server {
	fs git <path/to/repo.git> [<revision=HEAD>]
}
#+end_src

#+begin_src caddyfile
file_server {
	fs git {
		repository <path/to/repo.git>
		revision HEAD # the default revision
	}
}
#+end_src