Installation

From Release (Recommended)

1. Download the latest .btcpay plugin package from the releases page
2. Go to Server Settings > Plugins in your BTCPay Server
3. Click Upload and select the downloaded .btcpay file
4. Wait for the plugin to install and restart
5. Navigate to your store settings and click CLINK Lightning in the integrations sidebar
6. Configure your CLINK offer string

From Source

Prerequisites

• .NET SDK 10.0+
• Node.js 22+
• Git

Clone and Build

# Clone with submodules (includes BTCPay Server source)
git clone --recurse-submodules https://github.com/WoompaLoompa/btcpay-clink.git
cd btcpay-clink

# If already cloned without submodules
git submodule update --init --recursive

Build the JavaScript Bundle

The Nostr bridge requires a JavaScript bundle built with esbuild:

cd src/BTCPayServer.Plugins.Clink
npm install
npm run build
cd ../..

This bundles nostr/clink-bridge.mjs into nostr/clink-bridge.bundle.mjs, which is embedded into the plugin DLL at compile time.

Build the Plugin

dotnet build

The compiled plugin DLL will be at:

src/BTCPayServer.Plugins.Clink/bin/Debug/net10.0/BTCPayServer.Plugins.Clink.dll

Publish (Production)

dotnet publish -c Release

Output will be in publish/plugin/.

Development Setup

See the Development guide for local debugging, environment setup, and testing.

Verifying Installation

After installing and configuring the plugin:

1. Go to your store's Lightning settings
2. You should see CLINK nOffer as a connection string option
3. Or use the dedicated CLINK Lightning page in the integrations sidebar
4. Create a test invoice and verify the "Lightning (CLINK)" payment method appears at checkout