DIDKit can be installed manually or in containerized form.
We do not depend on any Rust nightly features, so our installation instructions assume
stable versions; be sure to switch the installation defaults to
nightly if the calling application depends on them.
Spruce's ssi library must be cloned alongside the
didkit repository in a parallel directory between downloading didkit and building it.
Build DIDKit using Cargo, from root directory of DIDKit project:
This will give you the DIDKit CLI and HTTP server executables located at
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.
Both the CLI and HTTP server are containerised and available under
The image is private for now, so a Personal Access Token is required. Once created you can login like so:
You can use the images like CLIs:
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_JWKor
docker run didkit-http --jwk $MY_JWK.
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:
And to use them, replace
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.