fork of radicle with Git LFS support, backed by IPFS
Go to file
cloudhead 1d167581f2
cob: Introduce `xyz.radicle.id` COB
Introduces a new COB type to store repository identity documents.

The reason for this change is to:

1. Simplify the code, as the identity document logic resembled a COB,
   yet it had custom logic. This allows existing COB code to be used for
   identities.
2. Make identity document update logic more flexible, since COB actions
   can be added in the future.
3. Re-purpose existing tools around COBs to work on identities, eg. `rad
   cob`.
4. Unify the concept of an identity change proposal, with regular identity
   changes. This means we can remove the `id.proposal` COB in favor of
   using the `id` COB itself.

Notes
-----

* Each repository has one Identity COB.
* The `Proposal` COB has been repurposed into the `Identity` COB.
* Identity documents are stored as *embeds* inside the Identity COB
  actions.
* The action that contains new document versions is called `revision`,
  just like the Patches COB.
* The namespaced `rad/id` ref is a symbolic reference to that Identity
  COB.
* The canonical `rad/id` ref is a direct reference to the commit in the
  Identity COB that contains the latest *accepted* revision of the
  document.
* All commands for managing identities have been folded into `rad id`.
  Hence `rad delegate` and `rad edit` are removed.
* The concept of "rebasing" an identity document is gone.
* The `rad id` output has been updated to match the style of other
  commands.
* When a revision has enough signatures, it is automatically adopted as
  the current identity, there is no longer the need for a "commit"
  action.
* When an identity revision is proposed, and the current identity has a
  threshold of `1`, that identity is automatically accepted due to the
  above point.
* The idea of "verifying a peer's identity branch" no longer applies, as
  COBs cannot be verified one history at a time.
* Since the root commit of the Identity COB does not have a "Resource"
  to point to (it would have to point to itself, which is impossible),
  we've made the resource id optional for COBs.
2023-10-12 17:32:33 +02:00
.github/workflows build: Fix man page building 2023-08-17 11:43:17 +02:00
.nix nix: add rust-analyzer 2023-08-25 16:54:41 +02:00
radicle cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
radicle-cli cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
radicle-cli-test cli-test: Update framework with new features 2023-08-04 12:23:49 +02:00
radicle-cob cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
radicle-crdt Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
radicle-crypto cli: Give passphrase error on prompt 2023-09-06 20:03:58 +02:00
radicle-dag dag: Add "dot" format output 2023-10-11 14:53:59 +02:00
radicle-httpd cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
radicle-node cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
radicle-remote-helper cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
radicle-ssh Prepare crates for publishing to `crates.io` 2023-08-07 11:31:11 +02:00
radicle-term cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
radicle-tools cob: Wrap patch ID types with new types 2023-09-05 11:17:59 +02:00
scripts scripts: Small fix for POSIX-compliance 2023-09-26 13:11:12 +02:00
systemd Move unit files to `systemd` directory 2023-06-22 12:13:30 +02:00
.dockerignore Dockerize services 2022-12-14 17:15:40 +01:00
.env.seed seed: Update default tracking policy for seed 2023-04-17 21:16:56 +02:00
.gitignore Cleanup .gitignore 2023-08-04 12:50:08 +02:00
.gitsigners Add yorgos to .gitsigners 2023-08-18 16:36:02 +02:00
ARCHITECTURE.md Flesh out `HACKING.md` 2023-03-16 13:06:38 +01:00
CONTRIBUTING.md docs: Replace deprecated `--all` flag with `--workspace` 2023-07-26 13:23:15 +02:00
Cargo.lock cob: Introduce `xyz.radicle.id` COB 2023-10-12 17:32:33 +02:00
Cargo.toml Remove `radicle-tui` crate 2023-08-08 16:31:25 +02:00
DCO Add licenses and contributor information 2022-11-16 12:26:12 +01:00
HACKING.md node: Rename control socket 2023-03-31 17:29:58 +02:00
LICENSE-APACHE Add licenses and contributor information 2022-11-16 12:26:12 +01:00
LICENSE-MIT Add licenses and contributor information 2022-11-16 12:26:12 +01:00
README.md Move unit files to `systemd` directory 2023-06-22 12:13:30 +02:00
build.rs Rust 1.67 2023-02-04 19:30:29 +01:00
deny.toml Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
docker-compose.yml docker: Add `$USER` env var to docker-compose 2023-07-26 12:35:55 +02:00
rad-patch.1.adoc cli: Move commenting to patch/issue commands 2023-09-19 14:33:40 +02:00
rad.1.adoc cli: Add `--config` option to `rad self` 2023-08-16 14:58:21 +02:00
rust-toolchain Update toolchain to Rust 1.71 2023-08-09 18:49:13 +02:00

README.md

❤️🪵

Radicle Heartwood Protocol & Stack

Heartwood is the third iteration of the Radicle Protocol, a powerful peer-to-peer code collaboration and publishing stack. The repository contains a full implemention of Heartwood, complete with a user-friendly command-line interface (rad) and network daemon (radicle-node).

Radicle was designed to be a secure, decentralized and powerful alternative to code forges such as GitHub and GitLab that preserves user sovereignty and freedom.

Installation

Requirements

  • Linux or Unix based operating system.
  • Git 2.34 or later
  • OpenSSH 9.1 or later with ssh-agent

📀 From binaries

Requires curl and tar.

Run the following command to install the latest binary release:

sh <(curl -sSf https://radicle.xyz/install)

📦 From source

Requires the Rust toolchain.

You can install the Radicle stack from source, by running the following commands from inside this repository:

cargo install --path radicle-cli --force --locked
cargo install --path radicle-node --force --locked
cargo install --path radicle-remote-helper --force --locked

Or directly from our seed node:

cargo install --force --locked --git https://seed.radicle.xyz/z3gqcJUoA1n9HaHKufZs5FCSGazv5.git \
    radicle-cli radicle-node radicle-remote-helper

Running

Systemd unit files are provided for the node and HTTP daemon under the /systemd folder. They can be used as a starting point for further customization.

Additionally, a Dockerfile is included under both crates.

For running in debug mode, see HACKING.md.

Contributing

See CONTRIBUTING.md and HACKING.md for an introduction to contributing to Radicle.

License

Radicle is distributed under the terms of both the MIT license and the Apache License (Version 2.0).

See LICENSE-APACHE and LICENSE-MIT for details.