Create the vhost.conf.json Configuration File - Fluid Topics - 3.6

Install Fluid Topics on a Single Server

Product
Fluid Topics
FT_Version
3.6
Platform
Debian
Category
Technical Notes

The vhost.conf.json file indicates the domain name used to reach the portal. It is used within the server, especially for emails containing access URLs to Fluid Topics (user account activation email, and so on) and for customer users database integration. When the Fluid Topics tenant is accessible through multiple domains, the main domain must be set in the vhost.conf.json file.

In the case of an on-premises installation, the following file is preset and is automatically provided by means of the antidot-svc-ft-$project_name-singlebox installation package given by Antidot.

Fluid Topics needs to know the tenant URL.

To set the tenant URL:

  1. Create the following file:

    As antidot user

    /usr/local/afs7/Fluid-Topics/conf/$TENANT_ID/vhost.conf.json

  2. Add the following lines:

    {
    "vhost": "https://$DOMAIN_NAME",
    "certFile": "$CERTIFICATE.CERT",
    "boPortal": "$BACK_OFFICE_URL"
    }

Where:

  • $DOMAIN_NAME is the URL where the tenant portal can be accessed. It can be a server hostname (the server hosting the front environment), a server IP or a dedicated URL.
  • $CERTIFICATE.CERT is the absolute path to the complete "certificate.cert" (CA_BUNDLE) file to be used. The "certFile" parameter is optional.

If the certificate is self-signed, or signed by an authority not recognized by the operating system or the browser, the "certFile" parameter is mandatory. If the certificate is not recognized and certFile is not present, an error may occur when indexing data.

  • $BACK_OFFICE_URL is the dedicated URL where the Back Office can be accessed. For example: http://fluidtopics-bo.com. The URL entered here is mandatory and will be used for various queries between the Back Office and Fluid Topics user interface. Its default value is: http://localhost/bo-portal

If the "boPortal" parameter is not set, some Administration features will not work.

The tenant domain name is the responsibility of the customer.

If the tenant site is not going to use the HTTPS protocol, enter the following lines:

{
"vhost":"http://$DOMAIN_NAME"
}

In our example, the vhost.conf.json file is as follows:

{
"vhost": "http://oleandor:8080/OleanDor",
"boPortal": "http://oleandor/bo-portal/"
}

The documentation for all the parameters of doc.antidot.net configuration file can be consulted at doc.antidot.net/configuration-doc

You can consult the same documentation specifically generated for your own tenant by adding "/configuration-doc" to the tenant homepage URL.