Installation

Installing DIDKit

DIDKit can be installed as a package via cargo, manually from source, or in containerized form.

Prerequisites

• Any major GNU/Linux distribution, including MacOS or Microsoft's WSL2

• Stable Rust

DIDKit is written in Rust. To get Rust, you can use Rustup.

We do not depend on any Rust nightly features, so our installation instructions assume the most recent stable version; be sure to switch the installation defaults to nightly if the calling application or forked source code does depend on them.

Cargo install

1. To install the DIDKit command line program on GNU/Linux, MacOS, or Windows+WSL, first install cargo.

2. Install libssl-dev, as well as pkg-config,build-essential, or equivalent core toolsets if they aren't already installed.

3. Then simply run cargo install for the given target package: didkit-cli

For example, for DIDKit CLI, run:

cargo install didkit-cli

This will add the binary DIDKit to your Cargo installation (typically ~/.cargo/bin), which can be added to your system's PATH for ease of use.

Manual

git clone https://github.com/spruceid/didkit
cd didkit

Build DIDKit using Cargo, from root directory of DIDKit project:

cargo build

This will give you the DIDKit CLI executable located at target/debug/didkit

DIDKit also offers a didkit-powered HTTP server for internal or external use, depending on your context in a separate crate. For comprehensive documentation of the HTTP commands and configuration options, see GitHub, and for a more skimmable overview, see the HTTP server.

git clone https://github.com/spruceid/didkit-http
cd didkit-http/
cargo run
Listening on 127.0.0.1:3000

You can configure your didkit-http server by editing the defaults.toml file.

You can also build and install DIDKit's components separately. Building the FFI libraries will require additional dependencies. See the corresponding documentation for each package for more info.

Container

Both the CLI and HTTP server are containerised and available under ghcr.io/spruceid/didkit-(cli|http).

The image is private for now, so a Personal Access Token is required. Once created you can login like so:

docker login ghcr.io -u USERNAME --password-stdin

You can use the images like CLIs:

docker run ghcr.io/spruceid/didkit-cli:latest --help
docker run --init -p 8080 ghcr.io/spruceid/didkit-http:latest --port 8080

Note: You can pass JWKs either by sharing a volume with docker run --volume, or by passing the JWK directly with docker run -e JWK=$MY_JWK or docker run didkit-http --jwk $MY_JWK.

Build Images

The Dockerfiles rely on having ssi in the root of didkit (a symbolic link will not work, unfortunately).

After you have made sure ssi is present in the root of didkit, then the images can be built with:

docker build -f Dockerfile-cli . -t didkit-cli
docker build -f Dockerfile-http . -t didkit-http

And to use them, replace ghcr.io/spruceid/didkit-(cli|http):latest with didkit-(cli|http).

Building Interfaces

While many of the DIDKit interfaces can be installed as libraries via each language's dedicated package manager, they can also be built manually. For instructions, see the "Installation" section of each interface's dedicated page in the section to the left.