io.quarkiverse.ngrok.runtime.NgrokConfig Maven / Gradle / Ivy

Go to download
package io.quarkiverse.ngrok.runtime;

import java.util.Optional;

import io.quarkus.runtime.annotations.ConfigItem;
import io.quarkus.runtime.annotations.ConfigPhase;
import io.quarkus.runtime.annotations.ConfigRoot;

/**
 * Configuration related to ngrok.
 *
 * These configuration values only apply to dev-mode.
 */
@ConfigRoot(phase = ConfigPhase.RUN_TIME)
public class NgrokConfig {

    /**
     * Whether ngrok should be started when Quarkus dev-mode is launched.
     */
    @ConfigItem(defaultValue = "true")
    public boolean enabled;

    /**
     * The directory into which to save the ngrok binary if it doesn't exist
     */
    @ConfigItem(defaultValue = "${user.home}/.quarkus/ngrok")
    public String directory;

    /**
     * Specify a download URL where the ngrok distribution will be obtained from.
     *
     * If not set, the platform default will be used
     */
    @ConfigItem
    public Optional downloadURL;

    /**
     * The authentication token used to authenticate this client when it connects to the ngrok.com service
     */
    @ConfigItem
    public Optional authToken;

    /**
     * The region where the ngrok agent will connect to host its tunnels
     */
    @ConfigItem
    public Optional region;

    /**
     * The port where ngrok will be serving the local web interface and api
     */
    @ConfigItem
    public Optional port;

    /**
     * The domain or hostname to use instead of the one ngrok generates.
     * See https://ngrok.com/blog-post/free-static-domains-ngrok-users
     */
    @ConfigItem
    public Optional domain;

    /**
     * Name of the tunnel to start from ngrok default config instead of Quarkus configuration. Useful to use extended ngrok
     * configuration.
     */
    @ConfigItem
    public Optional tunnelName;

    /**
     * API key for ngrok if you need to perform any API operations such as delete-certificate-management-policy.
     */
    @ConfigItem
    public Optional apiKey;

    /**
     * Reserved domain unique identifier for revoking certificate upon startup. Example: 'rd_2hrGw0rqFLOm9pcXf4dlbdNfrus'
     * If this value is not null the certificate will be revoked upon dev service startup.
     */
    @ConfigItem
    public Optional deleteCertificateDomainId;

    public enum Region {
        United_States("us"),
        Europe("eu"),
        Asia_Pacific("ap"),
        Australia("au"),
        South_America("sa"),
        Japan("jp"),
        India("in");

        private final String name;

        Region(String name) {
            this.name = name;
        }

        public String getName() {
            return name;
        }
    }
}