fork of radicle with Git LFS support, backed by IPFS
Go to file
Fintan Halpenny 84aaf9efd0
remote-helper: relax the quorum checks
The rules for checking the quorum of the remote helper, when pushing to the
canonical branch, can prevent the operator from even attempting to try converge
to a state of agreeance.

Instead, the checking of the quorum rules are relaxed. It is still the case that
if the peer is pushing a diverging commit while in a working state they are
warned and the push does not go through. However, there are two cases where it
is fine to force push a change:

1. When pushing a new tip, as a delegate, there is still a canonical tip and the
   new tip still converges with the history, i.e. it is equal to, behind, or
   ahead of another delegate tip.
2. If there is no quorum in the current state, for example there were multiple
   concurrent pushes, then the peer is free to continue to push to their default
   branch in attempt to converge with the other peers.

The example tests ensure that these cases are covered, while also preserving the
old behaviour.

Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com>
X-Clacks-Overhead: GNU Terry Pratchett
2024-07-03 15:14:58 +01:00
.cargo fetch: upgrade gix crates 2024-05-17 13:27:18 +02:00
.config nix: switch to use nix flakes 2023-12-13 12:25:12 +01:00
.radicle build: add config for Radicle native CI engine 2024-01-19 11:29:23 +01:00
build build: Update env vars for build process 2024-06-20 10:47:50 +02:00
debian Remove `radicle-httpd` crate 2024-06-06 11:14:00 +02:00
radicle radicle: port quorum code to Canonical 2024-07-03 15:10:43 +01:00
radicle-cli remote-helper: relax the quorum checks 2024-07-03 15:14:58 +01:00
radicle-cli-test Bump crate versions 2024-06-05 16:51:55 +02:00
radicle-cob Bump crate versions 2024-06-05 16:51:55 +02:00
radicle-crdt Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
radicle-crypto Bump crate versions 2024-06-05 16:51:55 +02:00
radicle-dag Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-fetch node: Simplify configuration 2024-06-04 14:08:15 +02:00
radicle-node node: Constrain worker channel size 2024-07-03 14:15:45 +02:00
radicle-remote-helper remote-helper: relax the quorum checks 2024-07-03 15:14:58 +01:00
radicle-signals Bump crate versions 2024-06-05 16:51:55 +02:00
radicle-ssh Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-term term: Don't print empty tables 2024-06-12 15:36:34 +02:00
radicle-tools term: Implement content-aware pager 2024-05-03 14:31:05 +02:00
scripts docker: Remove outdated docker-compose files 2024-05-24 12:07:02 +02:00
systemd Remove `radicle-httpd` crate 2024-06-06 11:14:00 +02:00
.dockerignore build: Add "upload" build step 2024-04-29 10:47:03 +02:00
.env.seed seed: Update default tracking policy for seed 2023-04-17 21:16:56 +02:00
.envrc nix: simplify devShell and envrc 2023-12-14 10:52:04 +01:00
.gitignore Reproducible cross-compiled builds 2024-04-20 11:11:00 +02:00
.gitsigners Add yorgos to .gitsigners 2023-08-18 16:36:02 +02:00
ARCHITECTURE.md docs: link to protocol guide 2024-04-03 15:32:26 +02:00
CONTRIBUTING.md docs: Typo fixes 2024-04-29 13:28:31 +02:00
Cargo.lock Bump `radicle` crate to 0.11.1 2024-06-26 14:49:10 +02:00
Cargo.toml Remove `radicle-httpd` crate 2024-06-06 11:14:00 +02:00
DCO Add licenses and contributor information 2022-11-16 12:26:12 +01:00
HACKING.md Remove `radicle-httpd` crate 2024-06-06 11:14:00 +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 Remove `radicle-httpd` crate 2024-06-06 11:14:00 +02:00
VERSIONING.md build: Add "upload" build step 2024-04-29 10:47:03 +02:00
build.rs build: Update env vars for build process 2024-06-20 10:47:50 +02:00
deny.toml Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
flake.lock nix: Polish `flake.nix` 2024-05-17 12:19:30 +02:00
flake.nix Remove `radicle-httpd` crate 2024-06-06 11:14:00 +02:00
git-remote-rad.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
rad-id.1.adoc cli: Have way to delete payload field in `rad id` 2024-05-13 16:12:41 +02:00
rad-patch.1.adoc docs: Update manual pages to 1.0.0 2024-04-22 14:37:19 +02:00
rad.1.adoc docs: Update manual pages to 1.0.0 2024-04-22 14:37:19 +02:00
radicle-node.1.adoc docs: Update manual pages to 1.0.0 2024-04-22 14:37:19 +02:00
rust-toolchain Update toolchain to Rust 1.77 2024-03-26 10:03:11 +01: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 implementation 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.

See the Protocol Guide for an in-depth description of how Radicle works.

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:

curl -sSf https://radicle.xyz/install | sh

Or visit our download page.

📦 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 --root ~/.radicle
cargo install --path radicle-node --force --locked --root ~/.radicle
cargo install --path radicle-remote-helper --force --locked --root ~/.radicle

Or directly from our seed node:

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

Running

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

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.