Skip to content

FormFree/did-dht-method

 
 

Repository files navigation

godoc did-dht-method go version 1.22.2 license Apache 2 issues GitHub Actions Workflow Status

did-dht-method

The did:dht method. Home to the DID DHT Method Specification, and a reference implementation of a gateway server in Go.

Build & Run

Quickstart

To build and run in a single command ./scripts/quickstart.sh.

Usage: ./scripts/quickstart.sh [options]

Builds and runs the did-dht server

Options
  -h, --help          show this help message and exit
  -c, --commit=<hash> commit hash for `docker build` (default: HEAD)
  -t, --tag=<tag>     tag name for `docker build` (default: did-dht:latest)
  -d, --detach        run the container in the background (default: false)
  -k, --keep          keep the container after it exits (default: false)
  -n, --name=<name>   name to give the container (default: did-dht-server)
  -p, --port=<port>   ports to publish the host/container (default: 8305:8305)
  --skip-run          skip running the container (default: false)

docker

To build and run the gateway server, from the impl directory run:

docker build \
  --build-arg GIT_COMMIT_HASH=$(git rev-parse head) \
  --tag did-dht \
  --file build/Dockerfile .

and then

docker run \
    --publish 8305:8305 \
    --publish 6881:6881/udp \
    did-dht

Implementations

Language Client Server Link
Go Yes Yes did-dht-method, web5-go
Typescript Yes No web5-js
Kotlin Yes No web5-kt
Swift Yes No web5-swift
Dart Yes No web5-dart
Rust Yes No Coming soon!

Project Resources

Resource Description
Specification The DID Method specification
CODEOWNERS Outlines the project lead(s)
CODE_OF_CONDUCT.md Expected behavior for project contributors, promoting a welcoming environment
CONTRIBUTING.md Developer guide to build, test, run, access CI, chat, discuss, file issues
GOVERNANCE.md Project governance
LICENSE Apache License, Version 2.0

Releases

No releases published

Packages

No packages published

Languages

  • Go 97.1%
  • Shell 2.6%
  • Dockerfile 0.3%