Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tnull merged 1 commit into from
Apr 16, 2026
Merged

Add initial guides & documentation #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down
77 changes: 24 additions & 53 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
- Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
- Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
- Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
- Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.
12 changes: 6 additions & 6 deletions ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.
22 changes: 22 additions & 0 deletions contrib/ldk-server.service
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Apr 16, 2026
 Merged


Add initial guides & documentation
#186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down

77 changes: 24 additions & 53 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
 - Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
 - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
 - Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
 - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.

12 changes: 6 additions & 6 deletions
ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"]  # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.

22 changes: 22 additions & 0 deletions
contrib/ldk-server.service

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Apr 16, 2026
 Merged


Add initial guides & documentation
#186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down

77 changes: 24 additions & 53 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
 - Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
 - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
 - Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
 - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.

12 changes: 6 additions & 6 deletions
ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"]  # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.

22 changes: 22 additions & 0 deletions
contrib/ldk-server.service

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Apr 16, 2026
 Merged


Add initial guides & documentation
#186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down

77 changes: 24 additions & 53 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
 - Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
 - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
 - Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
 - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.

12 changes: 6 additions & 6 deletions
ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"]  # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.

22 changes: 22 additions & 0 deletions
contrib/ldk-server.service

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Apr 16, 2026
 Merged


Add initial guides & documentation
#186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down

77 changes: 24 additions & 53 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
 - Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
 - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
 - Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
 - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.

12 changes: 6 additions & 6 deletions
ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"]  # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.

22 changes: 22 additions & 0 deletions
contrib/ldk-server.service

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Apr 16, 2026
 Merged


Add initial guides & documentation
#186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down

77 changes: 24 additions & 53 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
 - Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
 - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
 - Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
 - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.

12 changes: 6 additions & 6 deletions
ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"]  # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.

22 changes: 22 additions & 0 deletions
contrib/ldk-server.service

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Apr 16, 2026
 Merged


Add initial guides & documentation
#186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down

77 changes: 24 additions & 53 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
 - Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
 - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
 - Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
 - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.

12 changes: 6 additions & 6 deletions
ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"]  # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.

22 changes: 22 additions & 0 deletions
contrib/ldk-server.service

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add initial guides & documentation#186

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

tnull
merged 1 commit into

from

Apr 16, 2026
 Merged


Add initial guides & documentation
#186
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


1 commit


Select commit


File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 2 additions & 2 deletions
CONTRIBUTING.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -13,7 +13,7 @@ cargo build --release # Production build (LTO enabled)
## Running

```bash
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cargo run --bin ldk-server ./contrib/ldk-server-config.toml
```

## Testing
Expand DownExpand Up@@ -54,7 +54,7 @@ cargo fmt --all

## Configuration

- Config template with all options: `ldk-server/ldk-server-config.toml`
- Config template with all options: `contrib/ldk-server-config.toml`
- When updating config options, also update the tests in `ldk-server/src/util/config.rs`

## Before Submitting
Expand Down

77 changes: 24 additions & 53 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,7 +15,7 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu
 - Deploy a Lightning Network node with minimal configuration, no coding required.

- **API-First Design**:
 - Exposes a well-defined API using Protobuf, allowing seamless integration with HTTP-clients or applications.
 - Exposes a well-defined gRPC API using Protobuf, allowing seamless integration with any language.

- **Powered by LDK**:
 - Built on top of LDK-Node, leveraging the modular, reliable, and high-performance architecture of LDK.
Expand All@@ -26,67 +26,38 @@ a Lightning node while exposing a robust, language-agnostic API via [Protocol Bu

### Project Status

🚧 **Work in Progress**:
- **APIs Under Development**: Expect breaking changes as the project evolves.
- **Potential Bugs and Inconsistencies**: While progress is being made toward stability, unexpected behavior may occur.
- **Improved Logging and Error Handling Coming Soon**: Current error handling is rudimentary (specially for CLI), and usability improvements are actively being worked on.
- **Pending Testing**: Not tested, hence don't use it for production!
**Work in Progress**:
- APIs are under development. Expect breaking changes as the project evolves.
- Not tested for production use.
- We welcome your feedback and contributions to help shape the future of LDK Server!

We welcome your feedback and contributions to help shape the future of LDK Server!
### Quick Start


### Configuration
Refer `./ldk-server/ldk-server-config.toml` to see available configuration options.

You can configure the node via a TOML file, environment variables, or CLI arguments. All options are optional — values provided via CLI override environment variables, which override the values in the TOML file.

### Building
```
```bash
git clone https://github.com/lightningdevkit/ldk-server.git
cargo build
```

### Running
- Using a config file:
```
cargo run --bin ldk-server ./ldk-server/ldk-server-config.toml
cd ldk-server
cargo build --release
cp contrib/ldk-server-config.toml my-config.toml # edit with your settings
./target/release/ldk-server my-config.toml
```

- Using environment variables (all optional):
```
export LDK_SERVER_NODE_NETWORK=regtest
export LDK_SERVER_NODE_LISTENING_ADDRESS=localhost:3001
export LDK_SERVER_NODE_REST_SERVICE_ADDRESS=127.0.0.1:3002
export LDK_SERVER_NODE_ALIAS=LDK-Server
export LDK_SERVER_BITCOIND_RPC_ADDRESS=127.0.0.1:18443
export LDK_SERVER_BITCOIND_RPC_USER=your-rpc-user
export LDK_SERVER_BITCOIND_RPC_PASSWORD=your-rpc-password
export LDK_SERVER_STORAGE_DIR_PATH=/path/to/storage
cargo run --bin ldk-server
```

Interact with the node using CLI:
```
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem onchain-receive # To generate onchain-receive address.
ldk-server-cli -b localhost:3002 --api-key your-secret-api-key --tls-cert /path/to/tls_cert.pem help # To print help/available commands.
```

### Shell Completions
See [Getting Started](docs/getting-started.md) for a full walkthrough.

The CLI supports generating shell completions for Bash, Zsh, Fish, Elvish, and PowerShell.
### Documentation

Add completions to your shell config:
```bash
# Bash (add to ~/.bashrc)
eval "$(ldk-server-cli completions bash)"
| Document | Description |
|----------|-------------|
| [Getting Started](docs/getting-started.md) | Install, configure, and run your first node |
| [Configuration](docs/configuration.md) | All config options, environment variables, and Bitcoin backend tradeoffs |
| [API Guide](docs/api-guide.md) | gRPC transport, authentication, and endpoint reference |
| [Tor](docs/tor.md) | Connecting to and receiving connections over Tor |
| [Operations](docs/operations.md) | Production deployment, backups, and monitoring |

# Zsh (add to ~/.zshrc)
eval "$(ldk-server-cli completions zsh)"
### API

# Fish (add to ~/.config/fish/config.fish)
ldk-server-cli completions fish | source
```
The canonical API definitions are in [`ldk-server-grpc/src/proto/`](ldk-server-grpc/src/proto/). A ready-made
Rust client library is provided in [`ldk-server-client/`](ldk-server-client/).

## Contributing
### Contributing

Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on building, testing, code style, and development workflow.

12 changes: 6 additions & 6 deletions
ldk-server/ldk-server-config.toml → contrib/ldk-server-config.toml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
# Lightning node settings
[node]
network = "regtest" # Bitcoin network to use
listening_addresses = ["localhost:3001"] # Lightning node listening addresses
announcement_addresses = ["54.3.7.81:3001"]  # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
listening_addresses = ["localhost:9735"] # Lightning node listening addresses
#announcement_addresses = ["54.3.7.81:9735"] # Lightning node announcement addresses
#grpc_service_address = "127.0.0.1:3536" # LDK Server gRPC address (optional, defaults to 127.0.0.1:3536)
alias = "ldk_server" # Lightning node alias
#pathfinding_scores_source_url = "" # External Pathfinding Scores Source
#rgs_server_url = "https://rapidsync.lightningdevkit.org/snapshot/v2/" # Optional: RGS URL for rapid gossip sync
Expand All@@ -14,12 +14,12 @@ dir_path = "/tmp/ldk-server/" # Path for LDK and BDK data persis

[log]
level = "Debug" # Log level (Error, Warn, Info, Debug, Trace)
file = "/tmp/ldk-server/ldk-server.log" # Log file path
#file = "/tmp/ldk-server/ldk-server.log" # Log file path

[tls]
#cert_path = "/path/to/tls.crt" # Path to TLS certificate, by default uses dir_path/tls.crt
#key_path = "/path/to/tls.key" # Path to TLS private key, by default uses dir_path/tls.key
hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"
#hosts = ["example.com"] # Allowed hosts for TLS, will always include "localhost" and "127.0.0.1"

# Must set one of bitcoind, electrum, or esplora

Expand DownExpand Up@@ -100,4 +100,4 @@ poll_metrics_interval = 60 # The polling interval for metrics in seconds.
# Tor Config
[tor]
# Only connections to OnionV3 peers will be made via this proxy; other connections (IPv4 peers, Electrum server) will not be routed over Tor.
#proxy_address = "" # Tor daemon SOCKS proxy address.
#proxy_address = "127.0.0.1:9050" # Tor daemon SOCKS proxy address.

22 changes: 22 additions & 0 deletions
contrib/ldk-server.service

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
[Unit]
Description=LDK Server Lightning Node
After=network-online.target bitcoind.service
Wants=network-online.target

[Service]
Type=notify
ExecStart=/usr/local/bin/ldk-server /etc/ldk-server/config.toml
Restart=always
RestartSec=10

# Security hardening
User=ldk-server
ProtectSystem=strict
NoNewPrivileges=true
PrivateTmp=true
PrivateDevices=true
MemoryDenyWriteExecute=true
ReadWritePaths=/var/lib/ldk-server

[Install]
WantedBy=multi-user.target
Loading