Skip to main content

Domain Verification

Overview​

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​

To enable or disable domain verification, follow these steps:

caution

Be aware that this process will cause downtime since it requires a restart of the Appcircle server.

  1. Log in to your Appcircle server via SSH or a remote connection.

  2. Change to the directory containing the Appcircle server configuration.

    cd appcircle-server

  3. Open the global.yaml file in a text editor.

    info

    The spacetech in the example codes below are example project name.

    Please find your own project name and replace spacetech with your project name.

    To see projects, you can check the projects directory.

    ls -l ./projects
    vi ./projects/spacetech/global.yaml

  4. Locate the keycloak entry in the configuration file. Add or update the domainVerification key with the following settings, depending on your preference.

    caution

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

    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.

  5. After saving the configuration changes, restart your Appcircle server to apply the new settings.

    • Shutdown Appcircle server.
    ./ac-self-hosted.sh -n "spacetech" down
    • Apply configuration changes.
    ./ac-self-hosted.sh -n "spacetech" export
    • Boot Appcircle server.
    ./ac-self-hosted.sh -n "spacetech" up
    tip

    You should check the status of the Appcircle server after boot for any possible errors.

    ./ac-self-hosted.sh -n "spacetech" check