nilix/legit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme

Browse source
This commit is contained in:
Iris Lightshard 2023-02-04 09:54:07 -07:00
parent 30683a7cec
commit e6a2ef8560
Signed by: Iris Lightshard
GPG key ID: 3B7FBC22144E6398
2 changed files with 10 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
config.yaml
View file

@ -1,5 +1,5 @@
repo: repo:
scanPath: /var/www/git/ scanPath: /var/www/git
readme: readme:
- readme - readme
- README - README

11
readme
View file

@ -48,6 +48,8 @@ Example config.yaml:
meta: meta:
title: git good title: git good
description: i think it's a skill issue description: i think it's a skill issue
footer: served with legit vVERSION; email patches to MAINTAINER
maintainerEmail: x@icyphox.sh
server: server:
name: git.icyphox.sh name: git.icyphox.sh
host: 127.0.0.1 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 • repo.scanPath: where all your git repos live (or die). legit doesn't
traverse subdirs yet. 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.mainBranch: main branch names to look for.
• repo.ignore: repos to ignore. • 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. • 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. • 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 • 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 • The default head.html template uses my CDN to fetch fonts -- you may
or may not want this. or may not want this.
• Pushing over https, while supported, is disabled because auth is a • Pushing over https, while supported, is disabled because auth is a