Documentation

Reverse proxy header authentication

Cloudbeaver supports authorization and authentication with reverse proxy headers. This option authenticates the user in Cloudbeaver via a HTTP header field.

To enable this feature, you need to

  1. add an application parameter enableReverseProxyAuth: true to your server configuration:

    app: {
      ...
      anonymousAccessEnabled: false,
      anonymousUserRole: "user",
      enableReverseProxyAuth: true,
      ...
    }
    
  2. Set up your NGINX configuration to send special header fields to your Cloudbeaver app.

The default values for the HTTP header fields are:

  1. Header User Name: X-User;
  2. Header Role Name: X-Role.

Default roles for user in Cloudbeaver are "user" and "admin". Delimeter for roles is "|".

For example, if you are a user with username "newuser" and your roles are "user" and "admin" and you want to open an app with enabled reverse proxy header auth, you need to set these HTTP headers when you send a request to your CB app:

X-User: newuser
X-Role: user|admin