[OCaml] Mobile-friendly clone of cgit.
refactor consolidate config into single root config.toml
Rename config.toml.sample to config.toml as the single source of truth. deploy/config.toml is now a symlink to ../config.toml. Updated steering rule and file header accordingly.
.kiro/steering/ocaml.md
@@ -40,8 +40,7 @@
40
40
41
41
## Configuration
42
42
43
Removed:
- The project SHALL include a sample `config.toml` file (at the project root or a documented location) that serves as reference documentation.
44
Removed:
- The sample configuration file SHALL be fully commented out (all key = value lines prefixed with `#`).
45
Removed:
- Every configurable variable SHALL appear in the sample file with its default value.
43
Added:
- The project SHALL include a `config.toml` file at the project root that serves as reference documentation.
44
Added:
- Every configurable variable SHALL appear in the file with its default value, uncommented.
46
45
- Each variable SHALL be preceded by a comment explaining the variable's purpose and other permissible values (e.g. types, allowed ranges, examples).
47
Removed:
- When a configuration variable is added or changed, the sample file SHALL be updated in the same commit.
46
Added:
- When a configuration variable is added or changed, `config.toml` SHALL be updated in the same commit.
config.toml
@@ -0,0 +1,46 @@
1
Added:
# ogit configuration file
2
Added:
# Copy to $XDG_CONFIG_HOME/ogit/config.toml or /etc/ogit/config.toml,
3
Added:
# or set OGIT_CONFIG to point to a custom location.
4
Added:
5
Added:
# Username displayed in the page footer and navigation title.
6
Added:
# When empty, the navigation shows "Repositories" and the footer
7
Added:
# omits the name.
8
Added:
# Type: string
9
Added:
user_name = ""
10
Added:
11
Added:
# Default branch to resolve when HEAD is detached or missing.
12
Added:
# Type: string
13
Added:
default_branch = "main"
14
Added:
15
Added:
# Filesystem path containing bare or non-bare git repositories.
16
Added:
# Type: string (absolute path)
17
Added:
git_project_root = "/srv/git"
18
Added:
19
Added:
# Maximum number of commits shown on the summary page.
20
Added:
# Type: integer (must be positive)
21
Added:
commits_max_displayed = 10
22
Added:
23
Added:
# Site title shown in the navigation bar. When empty, defaults to
24
Added:
# "Repositories" (or "Repositories for <user_name>" if user_name is set).
25
Added:
# Type: string
26
Added:
title = ""
27
Added:
28
Added:
# Network interface to bind the HTTP server to.
29
Added:
# Type: string (IP address)
30
Added:
host = "127.0.0.1"
31
Added:
32
Added:
# TCP port for the HTTP server.
33
Added:
# Type: integer (1-65535)
34
Added:
port = 8081
35
Added:
36
Added:
# Repositories or directories to highlight in a "Favorites" section
37
Added:
# at the top of the root page. Use the repo directory name for repos
38
Added:
# (e.g. "myproject.git") or a directory name with trailing slash for
39
Added:
# groups (e.g. "important/").
40
Added:
# Type: array of strings
41
Added:
favorite_repositories = []
42
Added:
43
Added:
# Repositories or directories to collect in an "Archived" section
44
Added:
# at the bottom of the root page. Same naming convention as above.
45
Added:
# Type: array of strings
46
Added:
archived_repositories = []
config.toml.sample
@@ -1,47 +0,0 @@
1
Removed:
# ogit sample configuration file
2
Removed:
# Copy to $XDG_CONFIG_HOME/ogit/config.toml or /etc/ogit/config.toml,
3
Removed:
# or set OGIT_CONFIG to point to a custom location.
4
Removed:
# Uncomment and modify values as needed.
5
Removed:
6
Removed:
# Username displayed in the page footer and navigation title.
7
Removed:
# When empty, the navigation shows "Repositories" and the footer
8
Removed:
# omits the name.
9
Removed:
# Type: string
10
Removed:
# user_name = ""
11
Removed:
12
Removed:
# Default branch to resolve when HEAD is detached or missing.
13
Removed:
# Type: string
14
Removed:
# default_branch = "main"
15
Removed:
16
Removed:
# Filesystem path containing bare or non-bare git repositories.
17
Removed:
# Type: string (absolute path)
18
Removed:
# git_project_root = "/home/git/git"
19
Removed:
20
Removed:
# Maximum number of commits shown on the summary page.
21
Removed:
# Type: integer (must be positive)
22
Removed:
# commits_max_displayed = 10
23
Removed:
24
Removed:
# Site title shown in the navigation bar. When empty, defaults to
25
Removed:
# "Repositories for <user>".
26
Removed:
# Type: string
27
Removed:
# title = ""
28
Removed:
29
Removed:
# Network interface to bind the HTTP server to.
30
Removed:
# Type: string (IP address)
31
Removed:
# host = "127.0.0.1"
32
Removed:
33
Removed:
# TCP port for the HTTP server.
34
Removed:
# Type: integer (1–65535)
35
Removed:
# port = 8081
36
Removed:
37
Removed:
# Repositories or directories to highlight in a "Favorites" section
38
Removed:
# at the top of the root page. Use the repo directory name for repos
39
Removed:
# (e.g. "myproject.git") or a directory name with trailing slash for
40
Removed:
# groups (e.g. "important/").
41
Removed:
# Type: array of strings
42
Removed:
# favorite_repositories = []
43
Removed:
44
Removed:
# Repositories or directories to collect in an "Archived" section
45
Removed:
# at the bottom of the root page. Same naming convention as above.
46
Removed:
# Type: array of strings
47
Removed:
# archived_repositories = []
deploy/config.toml
@@ -1,9 +1,1 @@
1
Removed:
# ogit configuration
2
Removed:
# Place at /etc/ogit/config.toml (or set OGIT_CONFIG to override)
3
Removed:
4
Removed:
user = "git"
5
Removed:
default_branch = "master"
6
Removed:
git_project_root = "/srv/git"
7
Removed:
commits_max_displayed = 10
8
Removed:
host = "127.0.0.1"
9
Removed:
port = 8081
1
Added:
../config.toml