Skip to main content

Upgrading the Nuts node

WhenThe updatingsteps yourfor upgrading a Nuts node from V5v5 to V6,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 statedare in the Nuts node documentation: releaseMigrating notesfrom v5 to v6,. youIt MUST do the following configuration changes:covers:

  • addSQL storage.sql.connection config value according to the storage documentation
  • add url config value according to the manual.container The auth.publicURL has been removeduser and alsoDocker usesimage that same config value.tags
  • whenHTTP usinginterfaces docker,and makeTLS sure user ID 18081 has access to the mounted volumes.termination
  • 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.changes
  • changerolling reverse-proxy configuration to allow/disallow the correct endpoints. (See also later paragraphs)back
  • 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 usingmixing the VDR v1 API for did document updates and thev2 authAPIs v1

enabling APIdid:web for access

For token requests. The V6 Nuts node exposes more pathschanges to the publicdesign interfaces.of Thesea areuse onlycase, usedsee byUse newcase 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)migration.