web frontend for git repositories, written in Go
git.pocka.jp/legit.git
Add documentation comment for sample config.yaml
This is handy. I'm not sure I'll create a reference doc for
configurations.
Shota FUJI
(Mar 22, 2025, 5:30 PM +0900)
6fbc5cd1
7f5f8dbe
+41
-2
+41
-2
config.yaml
+41
-2
config.yaml
···
1
1
repo:
2
+
# Directory containing git repositories to serve.
3
+
# Relative path is resolved from *current working directory* not from
4
+
# path to the config file.
2
5
scanPath: /var/www/git
6
+
7
+
# Which filename will be treated as README file?
8
+
# If a repository contains a file with exact matching filename to one from
9
+
# this list, legit displays that file contents in repository top page.
10
+
# When multiple files match (e.g. a repository having both `readme` and
11
+
# `README.md`), the earlier one in the list will be shown.
3
12
readme:
4
13
- readme
14
+
# Filenames are case-sensitive.
5
15
- README
16
+
# You have to provide file extensions.
6
17
- readme.md
7
18
- README.md
19
+
20
+
# What branch will be considered default branch?
21
+
# legit use default branch as a default ref for navigations.
8
22
mainBranch:
9
23
- master
10
24
- main
25
+
26
+
# Runtime directories.
11
27
dirs:
28
+
# Path to a directory containing HTML templates.
29
+
# Templates are written in Go's html/template syntax.
30
+
# <https://pkg.go.dev/html/template>
31
+
# Relative path is resolved from *current working directory* not from
32
+
# path to the config file.
12
33
templates: ./templates
34
+
35
+
# Path to a directory containing static assets.
36
+
# User can access files in this directory by accessing "/static/*".
37
+
# Relative path is resolved from *current working directory* not from
38
+
# path to the config file.
13
39
static: ./static
40
+
14
41
meta:
15
-
title: icy does git
16
-
description: come get your free software
42
+
# Website's name.
43
+
title: legit
44
+
45
+
# Website's description.
46
+
description: "web frontend for git repositories, written in Go"
47
+
17
48
server:
49
+
# legit uses this strings for clone URL.
50
+
# `https://<name>/<directory>`
51
+
# In addition to hostname, you can include paths as well.
52
+
# This will NOT affect how web server behaves.
18
53
name: github.com/pocka
54
+
55
+
# A host/hostname to bind web server to.
19
56
host: 0.0.0.0
57
+
58
+
# TCP port legit's web server listens to.
20
59
port: 5555