Skip to content

decentralized-identity/did-dht

Folders and files

NameName
Last commit message
Last commit date
Nov 1, 2024
Oct 28, 2024
Jan 16, 2024
Jul 25, 2024
Mar 22, 2024
Jul 17, 2024
Oct 2, 2023
Oct 3, 2024
Oct 2, 2023
Oct 2, 2023
Oct 3, 2024
Feb 12, 2024

Repository files navigation

godoc did-dht go version 1.23.2 license Apache 2 issues GitHub Actions Workflow Status FOSSA Status

did-dht

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

πŸŽ‰ Hacktoberfest 2024 πŸŽ‰

did-dht is a participating project in Hacktoberfest 2024! We’re so excited for your contributions, and have created a wide variety of issues so that anyone can contribute. Whether you're a seasoned developer or a first-time open source contributor, there's something for everyone.

To get started:

  1. Read the contributing guide.
  2. Read the code of conduct.
  3. Choose a task from this project's Hacktoberfest issues in our Project Hub and follow the instructions. Each issue has the 🏷️ hacktoberfest label.

Have questions? Connecting with us in our Discord community in the #hacktoberfest project channel.


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, 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 web5-rs

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

License

FOSSA Status