0.1.41 • Public • Published

Name Service

A service to handle name resolution requests in a fully distributed way.

Since version 0.1.38 all Identity Box services are ESM-only. No building is required.


On your identity-box, first create a folder where you want your service to be installed (we recommend that you use the name of the service as the name of the folder). Then install the service as follows:

$ npx github:/identity-box/cli install-service nameservice


Make sure the IPFS daemon is running:

$ ipfs daemon --enable-namesys-pubsub --enable-pubsub-experiment --enable-gc --migrate

Required environment variables

Name Service assume some environment variables to be set.


IPFS_ADDR contains the address of the IPFS host. This needs to conform to the multiaddr format. When this environment variable is not set, the address will default to /ip4/


To directly run the service, use:

$ yarn nameservice start

All currently published identities are listed in the Identities.json file. This allows the Name Service to automatically restart publishing after the service has been restarted.

With PM2

You can take of advantage of pm2 to start an identity-box service. Make sure you have pm2 installed globally:

$ npm install pm2 -g

Start service

$ pm2 start ecosystem.config.cjs

List all services

$ pm2 list

Settings on a service

$ pm2 show nameservice


To show both stdout and stderr logs run:

$ pm2 logs nameservice

This shows all the logs of nameservice and outputs the last 15 lines (the default).

To see only standard output logs, and print more lines from the output use:

$ pm2 logs nameservice --out --lines 150

Restart process after editing ecosystem

$ pm2 delete ecosystem.config.cjs
$ pm2 start ecosystem.config.cjs

Package Sidebar


npm i @identity-box/nameservice

Weekly Downloads






Unpacked Size

14.7 kB

Total Files


Last publish


  • everydayproductive