readme: more info

Changes

1 changed files (+58/-1)

• readme
  • @@ -6,8 +6,65 @@
    Pronounced however you like; I prefer channeling my beret-wearing Frenchman, and say "Oui, il est le git!" - But yeah it's pretty legit, on god no cap fr fr. + But yeah it's pretty legit, no cap on god fr fr. + + + FEATURES + + • Fully customizable templates and stylesheets. + • Cloning over http(s). + • Less archaic HTML. + • Not CGI. + INSTALLING Clone it, 'go build' it. + + + CONFIG + + Uses yaml for configuration. Looks for a 'config.yaml' in the current + directory by default; pass the '--config' flag to point it elsewhere. + + Example config.yaml: + + repo: + scanPath: /var/www/git + readme: + - readme + - README + - readme.md + - README.md + mainBranch: + - master + - main + dirs: + templates: ./templates + static: ./static + meta: + title: git good + description: i think it's a skill issue + server: + name: git.icyphox.sh + host: 127.0.0.1 + port: 5555 + + 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.mainBranch: main branch names to look for. + • server.name: used for go-import meta tags and clone URLs. + + + NOTES + + • Run legit behind a TLS terminating proxy like relayd(8) or nginx. + • The default head.html template uses my CDN to fetch fonts -- you may + or may not want this. + • Support or cgit-like filters (for readmes etc.) is planned. + • Pushing over https, while supported, is disabled because auth is a + pain. Use ssh. + • "Private" repos only available over Tailscale is planned.