legitrx

command module
v0.3.0-alpha1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 16, 2024 License: MIT Imports: 6 Imported by: 0

README

Legitrx

This is Runxi Yu's fork of icyphox's legit project. It aims to replace the use of cgit Runxi's servers.

At its current state, you should not use this fork. Use upstream instead.

Features

  • Customizable templates and stylesheets. The default one is adapted from cgit.
  • Cloning over HTTPS.
  • Not CGI.

Building

git clone https://git.sr.ht/~runxiyu/legitrx
go build

Configuration

If no filename is specified via the --config option, it looks for legitrx.yaml in the current working directory.

repo:
  scanPath: /var/www/git
  readme:
    - README
    - README.md
  mainBranch:
    - master
    - main
  ignore:
    - foo
    - bar
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) or nginx.
  • Cloning only works in bare repos.
  • Pushing over https, while supported, is disabled because auth is a pain. Use ssh or Gitolite.
  • Paths are unveil(2)'d on OpenBSD.

Ideas

  • Code highlighting support.

License

Legitrx is licensed under the MIT license.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL