d5f172875e
--- type: change message: |- Refactor all documentation * INTRODUCTION.md has been changed into README.md, and been essentially rewritten. * ROADMAP has been updated significantly. * SPEC has been slightly updated, mostly to add a header section indicating that it is an incomplete document. change_hash: ALqHmxfJSBVUIHrI4B9bGjeQpKvBUwL6GPmkDfjhu9uf credentials: - type: pgp_signature pub_key_id: 95C46FA6A41148AC body: iQIzBAABAgAdFiEEJ6tQKp6olvZKJ0lwlcRvpqQRSKwFAl6BIBQACgkQlcRvpqQRSKxguw//YGGDA/UJTVMPAkW8FeX+Pw8GzyW/nnF+f8HOo2/z56GA+llXVDwAyTXPJO3MIUBwPfnN1mLxANDClpofgKuy5I/uXD0ZEN8P4C8zyhv/OQIrgbkEa3iCnHgKFXmdn8URoeb8Bpcb5za/6VN/EwhkQlXGdwqppWcBMCuBx555AJRCIuC0LmOaVVSulbWTr4dAPU0OGodKqXxB5Je+mVzMJ43JQPw7nT5AxnN/CuEG6KsmtfRJISg6BwIVaVipoBGCNPA8Qsf6MC7RK2bCaQgxlQk3kVC46hNaGHlCbfOJgSMHwz4ivhk6tSCmfqzDQOfSQN4FQ0y9LghvFiuBI2PszytEVnYQZlX2vvXBCVa3k0BMNktCs1BKMUAxfZKJIg6YsfWlGt7hlbEgd/YvypC0JCLe3AEh7pILf2UQnxD9VWQhcpHiivXapSKgsoN1qgLgfRqQvFBAz9Wy1PMe3ySnUsBQ3hEdwqWXtQILtHRrhe9TzvMF+zQYQb0bQPM09tR0MicQD7bjzo3F0OOvudRBAAA+5W9uOEpThUVi6hJa2pTcH38ZAHcISENwqOahran4TPZ2eGyl6afmkzjjrMe3THo6rZg+U+P1MQe/2K8JItSPH98fD/eeO74QUAgq/SLIa24MqaCSFIiJ3I1xgnB5o1b8/xhAcodOUFKdgwGtdXE= account: mediocregopher |
||
|---|---|---|
| .dehub | ||
| accessctl | ||
| cmd | ||
| fs | ||
| sigcred | ||
| typeobj | ||
| yamlutil | ||
| .gitignore | ||
| commit_change_test.go | ||
| commit_change.go | ||
| commit_comment.go | ||
| commit_credential_test.go | ||
| commit_credential.go | ||
| commit_test.go | ||
| commit.go | ||
| config.go | ||
| diff.go | ||
| Dockerfile.dehub-remote | ||
| go.mod | ||
| go.sum | ||
| hash.go | ||
| README.md | ||
| repo_test.go | ||
| repo.go | ||
| ROADMAP.md | ||
| SPEC.md | ||
dehub
dehub aims to provide all the features of a git hosting platform, but without the hosting part. These features include:
User management - Authentication that commits come from the user they say they do, and fine-grained control over which users can do what.
Pull requests and issues - Facilitation of discussion via comment commits, and fine-grained (down to the file level) sign-off requirements.
Tags and releases* - Mark releases in the repo itself, and provide immutable and verifiable git tags so there's never any funny business.
Plugins*: Extend all aspects of dehub functionality via executables managed in the repo itself (in the same style as git hooks).
Key Concepts
To implement these features, dehub combines two key concepts:
First, repo configuration is defined in the repo itself. A file called
.dehub/config.yml contains all information related to user accounts, their pgp
keys, branch and file level access controls, and more. Every commit must adhere
to the configuration of its parent in order to be considered verifiable. The
configuration file is committed to the repo like any other file would be, and so
is even able to define the access controls on itself.
Second, the commit message of every dehub commit contains YAML encoded metadata,
which allows dehub to extend git and provide multiple commit types, each with
its own capabilities and restrictions. Some example dehub commit types are
change commits, comment commits, and credential commits.
Infrastructure (or lack thereof)
Because a dehub project is entirely housed within a traditional git project, which is merely a collection of files, any existing git or network filesystem infrastructure can be used to host any dehub project:
-
The most barebones git daemon server (with a simple pre-receive hook set up).
-
A remote SSH endpoint.
-
A mailing list (aka the old school way).
-
Network file syncing utilities such as dropbox, syncthing, or NFS.
-
Existing git project hosts like GitHub, Bitbucket, or Keybase.
-
Decentralized filesystems such as IPFS*.
* Planned feature, but not yet implemented.
Getting Started
The dehub project itself can be found by cloning
https://dehub.dev/src/dehub.git.
Installation of the dehub tool is currently done via the go get command:
go get dehub.dev/src/dehub.git/cmd/dehub
This will install the binary to your $GOBIN path, which you'll want to put in
your $PATH. Run go env if you're not sure where your $GOBIN is.
Once installed, running dehub -h should show you the help output of the
command. You can continue on to the tutorials if you're not sure where to go
from here.
Tutorials
The following tutorials will guide you through the basic usage of dehub. As dehub is still very much in development a high level of git and PGP profiency is still required in order to use dehub effectively.
TODO
Documentation
The SPEC is the best place to see every possible nitty-gritty detail of how dehub works. It attempts to be both human-readable and exhaustive in its coverage.
Other links
ROADMAP documents upcoming features and other work required on the project. If you're looking to contribute, this is a great place to start.
dehub-remote TODO
git-http-server TODO