Skip to content

SLIM Channel Manager: Installation Guide

The Channel Manager is available as a pre-built Docker image or can be built from source.

Docker

docker pull ghcr.io/agntcy/slim/channel-manager:2.0.0
docker run --rm -v ./config.yaml:/config.yaml ghcr.io/agntcy/slim/channel-manager:2.0.0 --config-file /config.yaml

Build from Source

Prerequisites

  • Rust toolchain (the workspace pins a specific version via rust-toolchain.toml)
  • The SLIM repository cloned locally

Build from Source

Clone the repository if you have not already:

git clone https://github.com/agntcy/slim.git
cd slim

Build the Channel Manager binary in release mode:

cargo build --release -p agntcy-slim-channel-manager

This produces two binaries in target/release/:

Binary Description
channel-manager The Channel Manager server
cmctl Standalone gRPC client for the Channel Manager API

To build both in one command:

cargo build --release -p agntcy-slim-channel-manager --bins

Running the Channel Manager

Create a configuration file (see Configuration Reference) and start the server:

./target/release/channel-manager --config-file config.yaml

On a successful start you will see log output confirming the SLIM connection and gRPC server address:

INFO channel_manager: Connected to SLIM node at http://127.0.0.1:46357
INFO channel_manager: gRPC API listening on 127.0.0.1:10356

Verifying the Installation

Use slimctl channel-manager (or the standalone cmctl binary) to confirm the Channel Manager is responding:

slimctl channel-manager list-channels

Or using cmctl directly:

./target/release/cmctl list-channels

Both connect to 127.0.0.1:10356 by default. Use --server to point at a different address.

Installing slimctl

slimctl is required to manage the Channel Manager from the command line. See the SLIM CLI Installation guide.

Next Steps