fork of radicle with Git LFS support, backed by IPFS
Go to file
Fintan Halpenny b26842d4d8
radicle: add cob::cache module
Add the cob::cache module which describes an SQLite store and schema
for caching COBs. It also provides in-memory and no-cache types for
testing purposes.

The intention is for the store to be used alongside the existing COB
types so that a write-thru cache can be implemented and used for
efficient reads.

Signed-off-by: Fintan Halpenny <fintan.halpenny@gmail.com>
X-Clacks-Overhead: GNU Terry Pratchett
2024-02-23 13:56:19 +01:00
.config nix: switch to use nix flakes 2023-12-13 12:25:12 +01:00
.github/workflows Move `rad-web` binary to `radicle-httpd` package 2023-11-22 11:27:11 +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: add cob::cache module 2024-02-23 13:56:19 +01:00
radicle-cli cob: Properly authorize root actions 2024-02-23 12:31:13 +01:00
radicle-cli-test cli-test: Expand env vars in commands 2024-01-05 11:03:24 +01:00
radicle-cob cob: move unwrap_used pragma 2024-02-23 13:56:19 +01:00
radicle-crdt Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
radicle-crypto Various small improvements across crates 2024-02-06 10:37:44 +01:00
radicle-dag cob: Expose operation concurrency 2024-01-22 21:20:01 +01:00
radicle-fetch Fix code around default policies 2024-01-25 21:11:08 +01:00
radicle-httpd radicle: rename resolved to is_resolved 2024-02-23 13:56:19 +01:00
radicle-node cli: Fix `id` COB notifications in `rad inbox` 2024-02-23 11:35:54 +01:00
radicle-remote-helper cli: Add new `rad inbox` command 2024-02-06 11:40:58 +01:00
radicle-ssh Prepare crates for publishing to `crates.io` 2023-08-07 11:31:11 +02:00
radicle-term cli: Fix output of `rad seed` when empty 2024-02-07 15:45:50 +01:00
radicle-tools cli: Tell the user when canonical head is updated 2024-01-05 12:09:30 +01:00
scripts Move `rad-web` binary to `radicle-httpd` package 2023-11-22 11:27:11 +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 docs: Replace deprecated `--all` flag with `--workspace` 2023-07-26 13:23:15 +02:00
Cargo.lock cli: Update and remove some dependencies 2024-02-02 09:57:45 +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 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
flake.lock nix: switch to use nix flakes 2023-12-13 12:25:12 +01:00
flake.nix nix: add sqlite in devShell 2024-01-02 15:23:08 +01:00
git-remote-rad.1.adoc Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
rad-patch.1.adoc cli: amend `rad patch comment` docs 2024-01-12 16:09:22 +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 Rust toolchain to 1.74 2023-11-17 16:58:24 +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:

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.