fork of radicle with Git LFS support, backed by IPFS
Go to file
Fintan Halpenny cd9b46fe51
radicle: fault tolerant thresholds
There are two areas where we can be more tolerant of delegate namespaces
being missing or not validating:
1. Calculating the canonical HEAD
2. Fetching from a remote

In 1. the protocol is tolerant in that if the local node does not have
the default branch for a delegate, it will still attempt to use any of
the delegates it does have to reach the threshold.

This is made safe by ensuring that if the threshold is being updated
then the node performing the update must have a threshold of delegates
locally in their storage. It also made safe by 2.

In 2. the protocol is tolerant by allowing delegates to be missing
from the serving side, as long as they can still meet a threshold of
delegates. This is further tolerant, when validating the received
data, a threshold of delegates are valid to consider the fetch
successful -- otherwise it will fail.

Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com>
X-Clacks-Overhead: GNU Terry Pratchett
2024-04-03 14:30:05 +02:00
.config nix: switch to use nix flakes 2023-12-13 12:25:12 +01:00
.github/workflows ci: Fix release workflow 2024-03-27 13:51:38 +01:00
.radicle build: add config for Radicle native CI engine 2024-01-19 11:29:23 +01:00
debian Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
radicle radicle: fault tolerant thresholds 2024-04-03 14:30:05 +02:00
radicle-cli radicle: fault tolerant thresholds 2024-04-03 14:30:05 +02:00
radicle-cli-test Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-cob Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-crdt Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
radicle-crypto Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-dag Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-fetch radicle: fault tolerant thresholds 2024-04-03 14:30:05 +02:00
radicle-httpd radicle: Switch error type for repository methods 2024-04-03 14:25:02 +02:00
radicle-node radicle: fault tolerant thresholds 2024-04-03 14:30:05 +02:00
radicle-remote-helper radicle: fault tolerant thresholds 2024-04-03 14:30:05 +02:00
radicle-ssh Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-term term: Fix spinner output on certain platforms 2024-03-26 13:13:54 +01:00
radicle-tools Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
scripts scripts: Add 'tag' script for releases 2024-03-26 09:50:32 +01:00
systemd systemd: Update for system install 2024-02-08 12:34:26 +01: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
.envrc nix: simplify devShell and envrc 2023-12-14 10:52:04 +01: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 Update CONTRIBUTING.md 2024-03-25 13:39:56 +01:00
Cargo.lock Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
Cargo.toml nix: switch to use nix flakes 2023-12-13 12:25:12 +01: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 docs: Use POSIX-compliant install command 2024-03-15 10:36:22 +01:00
VERSIONING.md Implement new versioning system 2024-03-25 11:54:08 +01:00
build.rs ci: Fix release workflow 2024-03-27 13:51:38 +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
flake.lock nix: Update rust-overlay input to rust 1.77 2024-03-30 22:58:21 +01:00
flake.nix man: Add `rad-id.1` man page 2024-03-17 21:14:58 +01:00
git-remote-rad.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
rad-id.1.adoc man: Add `rad-id.1` man page 2024-03-17 21:14:58 +01:00
rad-patch.1.adoc man: Update `rad-patch` with new sync options 2024-03-22 16:35:06 +01:00
rad.1.adoc Use "repository" consistently over "project" 2024-01-22 21:18:54 +01:00
radicle-httpd.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
radicle-node.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01: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 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:

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

📦 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.