Skip to content
A temporarily centralised PKI and presence server allowing us to get the other Nym node types running
Go HTML
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
constants
docs Noting most recent version bump Dec 14, 2019
healthcheck healthcheck: noting automated monitoring here Sep 18, 2019
metrics
models
presence presence: removing cowboy hat - got a little too cavalier with untest… Jan 16, 2020
server
.gitignore gitignore: removing ye olde binary from ignore Sep 30, 2019
.golangci.yml
.travis.yml ci: adding config files Sep 25, 2019
LICENSE Initial commit Sep 9, 2019
README.md
go.mod server: small cleanup at start Oct 1, 2019
go.sum
main.go docs: incrementing version number Dec 9, 2019
nym_directory_suite_test.go server: set up empty test bootstrap as a sanity check Sep 30, 2019

README.md

Nym Directory Server

A temporarily centralised PKI, presence and metrics server allowing us to get the other Nym node types running. Nym nodes and clients use it to find each other, and bootstrap the network into existence. Metrics allow us to easily build visualizations of the network for demonstration, education, and debugging purposes during development.

Eventually some aspects of it (presence, PKI) will be decentralized. Other aspects of it (e.g. metrics) will likely stay centralized.

Dependencies

  • Go 1.12 or later

Building

go test ./... will run the test suite.

go run main.go builds the binary (as expected).

swag init rebuilds the Swagger docs if you've changed anything there. Otherwise it should not be needed.

If you update any of the HTML assets, go-assets-builder server/html/index.html -o server/html/index.go will put it in the correct place to be built into the binary.

Usage

The server exposes an HTTP interface which can be queried. To see documentation of the server's capabilities, go to http://localhost:8080/swagger/index.html in your browser once you've run the server. You'll be presented with an overview of functionality. All methods are runnable through the Swagger docs interface, so you can poke at the server to see what it does.

You can’t perform that action at this time.