blob: fdcd0677feb28e686d751cfd49fa1ace1840d9f4 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
# Legitrx
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.
At its current state, you should not use this fork. Use upstream instead.
## Features
- Customizable templates and stylesheets.
- Cloning over HTTPS.
- Not CGI.
## Building
```sh
git clone https://git.sr.ht/~runxiyu/legitrx
go build
```
## Configuration
If no filename is specified via the `--config` option, it looks for `config.yaml` in the current working directory.
```yaml
repo:
scanPath: /srv/git
readme:
- README
- README.md
mainBranch:
- master
- main
ignore:
- repo-to-hide
dirs:
templates: ./templates
static: ./static
meta:
title: Legitrx
description: Testing
server:
name: git.runxiyu.org
host: 127.0.0.1
port: 5555
```
`server.name` is used for `go import` meta tags and clone URLs.
## Notes
- 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
- Code highlighting support.
## License
Legitrx is licensed under the MIT license.
|
