kmxgit 0.3

kmxgit is a web interface and a Git server written in C and Elixir / Phoenix.

kmxgit started as a frontend for git-auth.

Now public repositories are also supported.

This branch is work in progress, for the stable branch see v0.2.

For releases see the tags, latest is v0.2.0.

Installation

git-auth installation

git-auth handles all permissions for a single git user accessible through SSH with just one config file (/etc/git/auth.conf).

Please see git-auth README.md.

Phoenix installation

• Clone repo with git clone https://git.kmx.io/kmx.io/kmxgit.git
• Change directory with cd kmxgit
• Install dependencies with mix deps.get
• Create and migrate your database with mix ecto.setup
• Install bin/* into /usr/local/bin
• Start Phoenix endpoint with mix phx.server or inside IEx with iex -S mix phx.server

Now you can visit localhost:4000 from your browser.

Public access

To setup public access repositories on HTTP or HTTPS you need to setup your web server to serve certain requests with git-http-backend.

Nginx setup

First you need to setup fcgiwrap to serve on 127.0.0.1:9001.

Then in your nginx server config :

location ~ ^(.*/info/refs|.*/git-upload-pack)$ {
    fastcgi_pass  127.0.0.1:9001;
    include       fastcgi_params;
    fastcgi_param SCRIPT_FILENAME  /usr/local/libexec/git/git-http-backend;
    fastcgi_param GIT_PROJECT_ROOT ~git;
    fastcgi_param PATH_INFO        $1;        
}

Features

Added in kmxgit 0.2

• auth
  • auth users using phx.gen.auth
  • change password in separate form
  • session timeout (60 days)
  • auth with login
  • 2FA TOTP (Google Authenticator)
• public repositories
  • option “public access ?”
  • routes
  • permissions
  • git-http-backend
• front
  • source code coloration
  • line numbers
• admin
  • create organisation without members
• Git features
  • diff
    • sub-route, controller, view
    • links
    • line numbers
  • log
  • tags
• notification e-mails
  • change login
  • change e-mail
  • change password
  • change 2FA

TODO

kmxgit 0.3

• DONE Disk usage
  • DONE Per repo
  • DONE Per user
  • DONE Per organisation
  • DONE Server-wise
• DONE Footer
  • DONE environment variable
• Bug : fix empty diff
• Users
  • Profile picture
  • Link user in git log and commits
• Front page
  • DONE Stats
    • DONE count users, organisations, repositories
    • DONE disk usage
  • git cli help
    • install git
    • git clone
    • git remote add kmx git@git.kmx.io:user/repo.git
    • git push -u kmx branch
    • git pull
• Releases
  • infos
  • static files
• Pull requests
  • Comments in diff
• Issues / tickets ?
• Static site generator
• OAuth2
  • Google
  • Github
  • Gitlab ?

Copyright

kmxgit - git server administration

Copyright 2021,2022 Thomas de Grivel thoxdg@gmail.com

Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.