From e6a2ef85604f4a46c84515038ef00eeab27cdf29 Mon Sep 17 00:00:00 2001 From: Derek Stevens Date: Sat, 4 Feb 2023 09:54:07 -0700 Subject: [PATCH] update readme --- config.yaml | 2 +- readme | 11 +++++++++-- 2 files changed, 10 insertions(+), 3 deletions(-) diff --git a/config.yaml b/config.yaml index 23e72ca..963f263 100644 --- a/config.yaml +++ b/config.yaml @@ -1,5 +1,5 @@ repo: - scanPath: /var/www/git/ + scanPath: /var/www/git readme: - readme - README diff --git a/readme b/readme index 3ca7521..89ad5ec 100644 --- a/readme +++ b/readme @@ -48,6 +48,8 @@ Example config.yaml: meta: title: git good description: i think it's a skill issue + footer: served with legit vVERSION; email patches to MAINTAINER + maintainerEmail: x@icyphox.sh server: name: git.icyphox.sh host: 127.0.0.1 @@ -57,9 +59,14 @@ These options are fairly self-explanatory, but of note are: • repo.scanPath: where all your git repos live (or die). legit doesn't traverse subdirs yet. -• repo.readme: readme files to look for. Markdown isn't rendered. +• repo.readme: readme files to look for. Markdown is rendered via + BlackFriday and relative links to files in the repo are supported • repo.mainBranch: main branch names to look for. • repo.ignore: repos to ignore. +• meta.footer: footer HTML. VERSION is interpolated with the version string + and MAINTAINER is interpolated with a mailto link to meta.maintainerEmail + (can be empty) +• meta.maintainerEmail: probably your own (can be empty) • server.name: used for go-import meta tags and clone URLs. @@ -67,7 +74,7 @@ NOTES • Run legit behind a TLS terminating proxy like relayd(8) or nginx. • Cloning only works in bare repos -- this is a limitation inherent to git. You - can still view bare repos just fine in legit. + can still view normal repos just fine in legit. • The default head.html template uses my CDN to fetch fonts -- you may or may not want this. • Pushing over https, while supported, is disabled because auth is a