A read-only clone of the dehub project, for until dehub.dev can be brought back online.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
mediocregopher cefe5633e3 Remove reference to Tutorial 4 from README 2 years ago
.dehub Refactor access controls to support multiple branches 3 years ago
accessctl Rework how FilterFilesChanged works 3 years ago
cmd Switch markdown generator in git-http-server 3 years ago
docs update ROADMAP, project is publicized 3 years ago
fs Initial commit, can create master commit and verify previous master commits 3 years ago
sigcred properly check for gpg not returning a matching pgp key 3 years ago
typeobj Fix a bug in typeobj when a type field's name is the same as one of its inner... 3 years ago
yamlutil Completely refactor naming of everything, in light of new SPEC 3 years ago
.gitignore Switch markdown generator in git-http-server 3 years ago
Dockerfile.dehub-remote Support non-fastforward commits 3 years ago
README.md Remove reference to Tutorial 4 from README 2 years ago
commit.go Fix a bug in typeobj when a type field's name is the same as one of its inner... 3 years ago
config.go Completely refactor naming of everything, in light of new SPEC 3 years ago
diff.go refactor how file changes and hashes are handled, and add tests for hashes 3 years ago
fingerprint.go Completely refactor naming of everything, in light of new SPEC 3 years ago
fingerprint_test.go Completely refactor naming of everything, in light of new SPEC 3 years ago
go.mod Give the project a proper root, dehub.dev/src/dehub.git 3 years ago
go.sum Initial commit, can create master commit and verify previous master commits 3 years ago
payload.go add change_description field to credential commits 3 years ago
payload_change.go add change_description field to credential commits 3 years ago
payload_change_test.go Completely refactor naming of everything, in light of new SPEC 3 years ago
payload_comment.go Remove Payload.MessageHead error return and simplify implementations 3 years ago
payload_credential.go add change_description field to credential commits 3 years ago
payload_credential_test.go Completely refactor naming of everything, in light of new SPEC 3 years ago
payload_test.go Fix a bug which prevented force pushing to a previous commit in a branch 3 years ago
project.go change pre-receive hook from flag to sub-command 3 years ago
project_test.go Completely refactor naming of everything, in light of new SPEC 3 years ago

README.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. (Not yet implemented)

Plugins: Extend all aspects of dehub functionality via executables managed in the repo itself (in the same style as git hooks). (Not yet implemented)

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 a YAML encoded payload, 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. (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 -u -v 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. Note that dehub is in the infancy of its development, and so a certain level of profiency with git and PGP is required in order to follow these tutorials.

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.

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 is a simple docker image which can be used to host a remote dehub project over http(s). The endpoint will automatically verify all pushed commits.

git-http-server is a small server which makes a git repo's file tree available via http. It will automatically render markdown files to html as well. git-http-server is used to render dehub's website.