fedhub/README.md
2020-04-22 01:57:57 -05:00

1.2 KiB

fedhub

Federated git forge.

The software is currently under active development. Expect massive breaking changes.

Setup

You will need a copy of the Rust compiler to build this software. The project layout is fairly standard and running cargo build --all --release should produce the binaries that you need.

fedhub has multiple components. The absolute minimum you need to get started is to create a config file. By default, fedhub looks for config.toml in your current working directory but you can use -c to specify one when running. The config file uses TOML notation and looks a bit like:

addr = "127.0.0.1:3000"
repo_root = "./repos"
redis_url = "redis://127.0.0.1"

For now, you'll need Redis to run this software. I'll look into making a more portable version that uses an in-memory key-value store.

Project Status

Currently, I'm working on website features as well as liberating myself from libgit2 in parallel. libgit2 bindings contain massive amounts of pointer sharing that this application really doesn't need, since all the information I need lives on disk or in cache (in Redis).

Contact

Author: Michael Zhang

License: MIT/Apache-2.0 Dual License