diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 70 |
1 files changed, 26 insertions, 44 deletions
@@ -1,37 +1,31 @@ -# legitrx +# Legitrx -This is [Runxi Yu](https://runxiyu.org)'s fork of -[icyphox](https://icyphox.sh/)'s -[legit](https://git.icyphox.sh/legit/) project +This is [Runxi Yu](https://runxiyu.org)'s fork of [icyphox](https://icyphox.sh/)'s [legit](https://git.icyphox.sh/legit/) project. It aims to replace the use of [cgit](https://git.zx2c4.com/cgit/about/) Runxi's servers. -The README hasn't really been updated yet and not much has happened in -the fork yet. Just use upstream for now. +At its current state, you should not use this fork. Use upstream instead. -A git web frontend written in Go. +## Features -## FEATURES - -- Fully customizable templates and stylesheets. -- Cloning over http(s). -- Less archaic HTML. +- Customizable templates and stylesheets. The default one is adapted from cgit. +- Cloning over HTTPS. - Not CGI. -## INSTALLING +## Building -Clone it, `go build` it. +```sh +git clone https://git.sr.ht/~runxiyu/legitrx +go build +``` -## CONFIG +## Configuration -Looks for a `legitrx.yaml` in the current directory by default; pass the -`--config` flag to point it elsewhere. +If no filename is specified via the `--config` option, it looks for `legitrx.yaml` in the current working directory. ```yaml repo: scanPath: /var/www/git readme: - - readme - README - - readme.md - README.md mainBranch: - master @@ -43,39 +37,27 @@ dirs: templates: ./templates static: ./static meta: - title: git good - description: i think it's a skill issue + title: Legitrx + description: Testing server: - name: git.icyphox.sh + name: git.runxiyu.org 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. legitrx doesn't - traverse subdirs yet. -- dirs: use this to override the default templates and static assets. -- repo.readme: readme files to look for. -- repo.mainBranch: main branch names to look for. -- repo.ignore: repos to ignore, relative to scanPath. -- server.name: used for go-import meta tags and clone URLs. +`server.name` is used for `go import` meta tags and clone URLs. -## NOTES +## Notes -- Run legitrx 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 legitrx. -- 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 - pain. Use ssh. -- Paths are unveil(2)'d on OpenBSD. +- Run legitrx behind a TLS terminating proxy like [relayd(8)](https://man.openbsd.org/relayd.8) or nginx. +- Cloning only works in bare repos. +- Pushing over https, while supported, is disabled because auth is a pain. Use ssh or [Gitolite](https://gitolite.com/gitolite/). +- Paths are [unveil(2)](https://man.openbsd.org/unveil.2)'d on OpenBSD. -## IDEAS +## Ideas -- Support for filters for markdown rendering and code highlighting. +- Code highlighting support. -## LICENSE +## License -legitrx is licensed under MIT. +Legitrx is licensed under the MIT license. |