readme: more info

This commit is contained in:
Anirudh Oppiliappan 2022-12-19 10:52:16 +05:30
parent fc65017b75
commit 9a8041a274
No known key found for this signature in database
GPG Key ID: 8A93F96F78C5D4C4
1 changed files with 58 additions and 1 deletions

59
readme
View File

@ -6,8 +6,65 @@ A git web frontend written in Go.
Pronounced however you like; I prefer channeling my beret-wearing Pronounced however you like; I prefer channeling my beret-wearing
Frenchman, and say "Oui, il est le git!" 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 INSTALLING
Clone it, 'go build' it. 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.