Enabling authentication

Configuring Vyne to require authentication through OpenID Connect

Vyne supports authentication through an OpenID Connect authentication service.

This is disabled by default, and can be configured through a series of parameters passed to Vyne through the command line on startup.

Quick tip

We provide a full tutorial on securing Vyne with Keycloak - a popular open source identity platform, which supports OpenID Connect.

Take a look here

To enable, pass the following config options to Vyne on the command line:

ParameterSample valuesDescription
vyne.security.openIdp.enabledtrue / false (default)Set to true to enable auth
vyne.security.openIdp.clientIdvyneThe client id to present to OpenID server
vyne.security.openIdp.jwk-set-urlhttp://auth-service/certsA url to load the set of JWK's used to verify signatures of presented tokens

A typical docker config might look as follows:

    image: vyneco/vyne:${VYNE_VERSION}
      - ./vyne-config:/opt/service/config
      OPTIONS: >-

When a user attempts to access Vyne, they will be redirected to the login page as configured with the OpenId connect provider.

See also