Skip to main content

Configuration update

When updating your node from V5 to V6, you can choose to disable/enable certain parts depending on your needs. The common paragraph describes the required configuration changes.

Common

Before you update, make a backup and check the diagnostics of your node. To have the migrations run smoothly, make sure vdr.conflicted_did_documents.owned_count equals 0. If not, please refer to the documentation on how to fix.

As stated in the release notes, you MUST do the following configuration changes:

  • add storage.sql.connection config value according to the storage documentation
  • add url config value according to the manual. The auth.publicURL has been removed and also uses that same config value.
  • when using docker, make sure user ID 18081 has access to the mounted volumes.
  • change port settings in the configuration and in your reverse-proxy. The new default is that public endpoints are bound to :8080 and internal endpoints to 127.0.0.1:8081.
  • change reverse-proxy configuration to allow/disallow the correct endpoints. (See also later paragraphs)
  • remove legacy internal API tokens and migrate to new API tokens if applicable.

Without additional features

You can disable the did:web method and only use the did:nuts method (like in v5) by adding the didmethods config param:

didmethods: [nuts]

Keep using the VDR v1 API for did document updates and the auth v1 API for access token requests. The V6 Nuts node exposes more paths to the public interfaces. These are only used by new features. If your reverse-proxy is configured correctly you block any unwanted paths already. The following paths resolve to APIs in V6:

  • /iam
  • /oauth2
  • /.well-known
  • /statuslist
  • /discovery

Note: although some features may be disabled, your did:nuts documents are still migrated to an SQL database and their controller is set to blank (self-controlled).

With additional features

todo

Back to top