Installation

DIDKit can be installed manually or in containerized form.

Manual#

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

We depend on some Rust nightly features. When installing with Rustup, pick the nightly release channel. Or run rustup default nightly to switch to it. (More info)

Spruce's ssi library must be cloned alongside the didkit repository:

# from root directory of DIDKit project
$ git clone https://github.com/spruceid/ssi ../ssi

Build DIDKit using Cargo:

# from root directory of DIDKit project
$ cargo build

That will give you the DIDKit CLI and HTTP server executables located at target/debug/didkit and target/debug/didkit-http, respectively. You can also build and install DIDKit's components separately. Building the FFI libraries will require additional dependencies. See the corresponding readmes linked below 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).

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).