Skip to main content

Domain Verification

This document explains how to configure your Appcircle server's domain verification option when adding domains as trusted for Appcircle organizations. By skipping the domain verification process, domains will be automatically marked as verified without the need for TXT records.

Please note, this page does not cover the domain verification feature itself. For more detailed information on domain verification, please refer to the Domain Verification documentation.

By default, domain verification is disabled on the Appcircle server, meaning domains are automatically considered verified without the need to add a TXT record to your DNS configuration. However, if you change this option, Appcircle will require the addition of a TXT record to validate the domain.

Configuring the Appcircle Server Chart

To enable or disable domain verification, follow these steps:

  1. Open the values.yaml file in a text editor.

    vi values.yaml
  2. Locate the auth entry in the configuration file. Add or update the domainVerification key with the following settings, depending on your preference.

    caution

    If the auth-keycloak entry already exists in your values.yaml file, ensure you update the existing key instead of creating a new one.

    auth:
    auth-keycloak:
    domainVerification:
    enabled: true
    note
    • enabled: If this variable is set to true, it requires the addition of a TXT record for domain verification. If you want to skip TXT record verification and make the domain automatically considered as verified, then this variable should be set to false.
  3. Upgrade the Appcircle server release with new values.yaml settings.

    To apply configuration changes to the Appcircle server installation, update the Helm release with the new configuration using the following command:

    info

    The namespace, release name, and Helm repository name in the example command below are written for the example installation document. If you have changed these values while installing the Appcircle server, adjust the values if required.

    helm upgrade appcircle-server appcircle/appcircle \
    -n appcircle \
    -f values.yaml
  4. Restart the Keycloak stateful set to apply new changes.

kubectl rollout restart statefulset appcircle-server-auth-keycloak -n appcircle
caution

Restarting the Keycloak stateful set affects active sessions and causes a redirection to the login page for the end-users to log in again. After re-login, the users can go on with their operations as usual from where they left off.