mygit

[UNMAINTAINED] A cgit/webgit alternative, written in Rust
Log | Files | Refs | README | LICENSE

commit cff2cc7b0f0204d8e7c8b899604cdadf376d2610
parent cc3ac2b31293b275b97ed84afc7b464440be6c70
Author: alex wennerberg <alex@alexwennerberg.com>
Date:   Sun, 18 Jul 2021 11:06:39 -0700

Update README

Diffstat:
MREADME.md | 28+++++++++++++++-------------
1 file changed, 15 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md @@ -1,9 +1,9 @@ # mygit -Small self-hosted git, written in Rust +Simple self-hosted git, written in Rust -More lightweight than something like [gitea](https://gitea.io/en-us/), more modern than something like [cgit](https://git.zx2c4.com/cgit/) or [gitweb](https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb) +Lighter weight than [gitea](https://gitea.io/en-us/), more modern than [cgit](https://git.zx2c4.com/cgit/) or [gitweb](https://git-scm.com/book/en/v2/Git-on-the-Server-GitWeb). For people who want to run a git server themselves, rather than depending on someone else, but don't want to put too much work into it. -Live demo at https://git.alexwennerberg.com +Live demo at [https://git.alexwennerberg.com](https://git.alexwennerberg.com) ## Deploying Build your binary with `cargo build --release`. Then probably move it somewhere sensible so it's in your $PATH or use `cargo install --release`. Packages and prebuilt binaries are TBD. @@ -11,10 +11,9 @@ Build your binary with `cargo build --release`. Then probably move it somewhere Probably you want to use your linux distro's init system to keep this server running. ## Setting up your repos +Acquire a Linux server that you have ssh access to, and decide on the best place to place your repos. You can also do this locally to experiment with it. -Acquire a Linux server that you have ssh access to, and decide on the best place to place your repos. - -To initialize a repo, you'll need to run a few commands. I'm using a self-hosted instance of the mygit repo as an example. Find a directory where you want to host your repositories. This is using the default settings found in mygit.toml +To initialize a repo, you'll need to run a few commands. I'm using a self-hosted instance of the mygit repo as an example. Find a directory where you want to host your repositories. This is using the default settings found in `mygit.toml` ``` git init --bare mygit cd mygit @@ -27,22 +26,25 @@ Update the `description` file with a description of the repository Make sure the HEAD in your remote repo points to your default branch (e.g. master vs main) Pushing your changes is not handled via mygit -- this will be done over ssh. For example: - ``` git remote add origin ssh://git@git.alexwennerberg.com:/www/git/mygit git push -u origin main ``` -You'll want to modify these commands to push to your mygit server and somewhere else (e.g. a GitHub mirror). This is left as an exercise to the reader. +Set up a reverse proxy on an http server which forwards port 8081 (or whatever port you configure) to your mygit server. -## Background -Many people want to self-host Git in order to get rid of their reliance on GitHub or other institutions. However, the options for doing this are problematic in a number of ways. There are ancient CGI programs written in C or Perl like gitolite, cgit and webgit, and there are modern programs like gitea or gitlab that are essentially GitHub clones, with a lot of unnecessary complexity for many people's use cases. +## Why self-host? +Self-hosting provides self-reliance and independence from large platforms that using a git hosting platform does not. There are inconvenciences and disadvantages to self-hosting, but I think there are also advantages as well of a decentralized, self-hosted network of collaboration. Mygit is designed primraily for hobbyists or open source hosts, so it's easy to setup and maintain with little effort, rather than an unnecessarily piece of software like GitLab. The tradeoff is that you lose out on a lot of features. Self-hosting git isn't for everyone! -The simplest way to accept patches when self-hosting Git is through [git-send-email](https://git-scm.com/docs/git-send-email). You can accept patches either to your personal email or use a mailing list. +## Accepting patches +The simplest way to accept patches when self-hosting Git is through [git-send-email](https://git-scm.com/docs/git-send-email) ([guide](https://git-send-email.io/)). You can accept patches either to your personal email or use a mailing list. Basically only obsessive ideologues like myself still use git-send-email these days, so you will probably lose contributers, and not being on GitHub means you lose a lot of discoverability, so make sure that you're willing to accept that when self-hosting git. You can mitigate these issues by mirroring to GitHub, but that kind of defeats the purpose of self-hosting. -I am working on a sibling project to this that handles mailing list archives for exactly this purpose: -https://github.com/alexwennerberg/crabmail +I am working on a sibling project to this that handles mailing list archives for exactly this purpose, but it is not ready for the public yet. + +## Why self-host git? ## Contributing * [ticket tracker](https://todo.sr.ht/~aw/mygit) * [patches](https://lists.sr.ht/~aw/patches) + +This exists on GitHub solely for visibility sake, and probably won't forever, but while it's here feel free to use GitHub issues, etc. This is alpha software, please report any bugs, etc!