All Downloads are FREE. Search and download functionalities are using the official Maven repository.

org.keycloak.config.HostnameV2Options Maven / Gradle / Ivy

There is a newer version: 25.0.6
Show newest version
package org.keycloak.config;

public class HostnameV2Options {

    public static final Option HOSTNAME = new OptionBuilder<>("hostname", String.class)
            .category(OptionCategory.HOSTNAME_V2)
            .description("Address at which is the server exposed. Can be a full URL, or just a hostname. When only hostname is provided, scheme, port and context path are resolved from the request.")
            .build();

    public static final Option HOSTNAME_ADMIN = new OptionBuilder<>("hostname-admin", String.class)
            .category(OptionCategory.HOSTNAME_V2)
            .description("Address for accessing the administration console. Use this option if you are exposing the administration console using a reverse proxy on a different address than specified in the 'hostname' option.")
            .build();

    public static final Option HOSTNAME_BACKCHANNEL_DYNAMIC = new OptionBuilder<>("hostname-backchannel-dynamic", Boolean.class)
            .category(OptionCategory.HOSTNAME_V2)
            .description("Enables dynamic resolving of backchannel URLs, including hostname, scheme, port and context path. Set to true if your application accesses Keycloak via a private network. If set to true, 'hostname' option needs to be specified as a full URL.")
            .defaultValue(Boolean.FALSE)
            .build();

    public static final Option HOSTNAME_STRICT = new OptionBuilder<>("hostname-strict", Boolean.class)
            .category(OptionCategory.HOSTNAME_V2)
            .description("Disables dynamically resolving the hostname from request headers. Should always be set to true in production, unless your reverse proxy overwrites the Host header. If enabled, the 'hostname' option needs to be specified.")
            .defaultValue(Boolean.TRUE)
            .build();

    public static final Option HOSTNAME_DEBUG = new OptionBuilder<>("hostname-debug", Boolean.class)
            .category(OptionCategory.HOSTNAME_V2)
            .description("Toggles the hostname debug page that is accessible at /realms/master/hostname-debug.")
            .defaultValue(Boolean.FALSE)
            .build();

}




© 2015 - 2024 Weber Informatics LLC | Privacy Policy