fork of radicle with Git LFS support, backed by IPFS
Go to file
cloudhead a54180199e
node: Further increase the rate-limit defaults
The rate-limitter gets hit on connect, due to historical gossip messages
being exchanged. This results in a high initial burst that needs to be
accounted for.
2024-05-02 13:43:09 +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: Small changes to build script 2024-05-01 16:09:23 +02:00
debian Add rudimentary Debian packaging for binaries 2023-11-01 12:56:35 +01:00
radicle node: Further increase the rate-limit defaults 2024-05-02 13:43:09 +02:00
radicle-cli node: Further increase the rate-limit defaults 2024-05-02 13:43:09 +02:00
radicle-cli-test Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-cob Tidy up environment variables 2024-04-26 10:38:54 +02:00
radicle-crdt Introduce `cargo-deny` 2023-08-22 14:33:00 +02:00
radicle-crypto Tidy up environment variables 2024-04-26 10:38:54 +02:00
radicle-dag Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-fetch fetch: Improve logging of clone 2024-04-08 17:06:38 +02:00
radicle-httpd node: Further increase the rate-limit defaults 2024-05-02 13:43:09 +02:00
radicle-node node: New relay configuration for nodes 2024-05-02 11:45:29 +02:00
radicle-remote-helper Tidy up environment variables 2024-04-26 10:38:54 +02:00
radicle-ssh Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
radicle-term term: Update `inquire` crate 2024-04-15 17:12:36 +02:00
radicle-tools Update radicle crates to 0.9.0 2024-03-26 11:56:27 +01:00
scripts build: Move/rename build steps 2024-04-29 11:14:09 +02:00
systemd systemd: Update for system install 2024-02-08 12:34:26 +01: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 node: Protect against non-monotonic clocks 2024-04-30 10:56:37 +02: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 docs: Typo fixes 2024-04-29 13:28:31 +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 outdated Dockerfiles 2024-04-29 18:02:07 +02:00
VERSIONING.md build: Add "upload" build step 2024-04-29 10:47:03 +02:00
build.rs Reproducible cross-compiled builds 2024-04-20 11:11:00 +02: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 docs: Update manual pages to 1.0.0 2024-04-22 14:37:19 +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-httpd.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][https://radicle.xyz/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
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.

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.