Skip to content

Commit

Permalink
chore: add README
Browse files Browse the repository at this point in the history
  • Loading branch information
michael1011 committed Dec 24, 2024
1 parent c2db024 commit 16b6089
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Backup

A CLN plugin that uploads the latest SCB to remote locations.
Currently, it supports S3-compatible APIs and WebDAV.
The plugin will upload the SCB on startup and when a channel is opened or closed.

## Installation

Compiling the plugin requires Rust to be installed.

By default, the plugin is compiled with S3 and WebDAV support:

```bash
cargo build --release
```

To compile only with S3 support:

```bash
cargo build --release --no-default-features --features s3
```

Or only with WebDAV support:

```bash
cargo build --release --no-default-features --features webdav
```

0 comments on commit 16b6089

Please sign in to comment.