From 519341c740890c134b705f8204b270b9cfa59308 Mon Sep 17 00:00:00 2001
From: Runxi Yu <me@runxiyu.org>
Date: Wed, 05 Mar 2025 08:20:05 +0800
Subject: [PATCH] config: Add explanatory comments

---
 forge.scfg | 32 +++++++++++++++++++++++++++++---

diff --git a/forge.scfg b/forge.scfg
index 5b3f2d7613363b86238fc6c9df0b102788c3a7d7..3b8aafb882af150611aec0082f795573db5e7d41 100644
--- a/forge.scfg
+++ b/forge.scfg
@@ -1,15 +1,34 @@
 http {
+	# What network transport should we listen on?
+	# Examples: tcp tcp4 tcp6 unix
 	net tcp
-	addr :8080
+
+	# What address to listen on?
+	# Examples for net tcp*: 127.0.0.1:8080 :80
+	# Example for unix: /var/run/lindenii/forge/http.sock
+	addr /var/run/lindenii/forge/http.sock
+
+	# How many seconds should cookies be remembered before they are purged?
 	cookie_expiry 604800
+
+	# What is the canonical URL of the web root?
 	root https://forge.example.org
 }
 
 ssh {
+	# What network transport should we listen on?
+	# This should be "tcp" in almost all cases.
 	net tcp
-	addr :2222
+
+	# What address to listen on?
+	addr :22
+
+	# What is the path to the SSH host key? Generate it with ssh-keygen.
+	# The key must have an empty password.
 	key /etc/lindenii/ssh_host_ed25519_key
-	root ssh://forge.example.org:2222
+
+	# What is the canonical SSH URL?
+	root ssh://forge.example.org
 }
 
 general {
@@ -17,11 +36,18 @@ 	title "Test Forge"
 }
 
 db {
+	# What type of database are we connecting to?
+	# Currently only "postgres" is supported.
 	type postgres
+
+	# What is the connection string?
 	conn postgresql:///lindenii-forge?host=/var/run/postgresql
 }
 
 hooks {
+	# On which UNIX domain socket should we listen for hook callbacks on?
 	socket /var/run/lindenii/forge/hooks.sock
+
+	# Where should hook executables be put?
 	execs /usr/libexec/lindenii/forge/hooks
 }

-- 
2.48.1