Go to file
Jedrzej Stuczynski 11f2f074a1 Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
constants Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
docs Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
healthcheck healthcheck: minor docs fix 2019-09-17 14:22:22 +01:00
metrics metrics: periodically clearing the database so we don't run out of memory (#7) 2019-09-18 13:37:04 +01:00
models Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
pki pki: disabling unused controller method 2019-09-16 10:54:52 +01:00
presence Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
rest Feature/metrics (#6) 2019-09-17 14:05:50 +01:00
.gitignore gitignore: ignoring deploy script 2019-09-16 20:06:28 +01:00
LICENSE Initial commit 2019-09-09 15:02:49 +01:00
README.md readme: a few more updates 2019-09-16 19:09:23 +01:00
go.mod Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
go.sum Using remote ip as host information for presence data 2019-09-18 14:53:13 +01:00
main.go Reverting server changes. 2019-09-16 13:43:03 +01:00

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

Nothing too special here, go run main.go should see you through.

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

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.