Update the Vera user guide URL

The URL of the Tricentis Vera user guide is preconfigured to Tricentis Vera documentation. However, you can change it for a particular system.

To update the Tricentis Vera user guide URL, follow these steps:

  1. Sign in to the Tricentis Vera web portal as an administrative user.

    Once signed in, you can view the Tricentis Vera user guide URL in the profile menu in the upper right corner of the Tricentis Vera application.

  2. Update the URLby following one of these methods:

Add an environment variable to the docker-compose.yml file

To add an environment variable to the docker-compose.yml file, follow these steps:

  1. Open the docket-compose.yml file on the server.

    sudo nano docker-compose.yml

  2. Navigate to the vera.web.portal section and add the following line below the environment header:

    - VERA_USER_GUIDE_URL=<custom_url>

    Replace <custom_url> with your custom URL.

  3. Restart the Vera web portal.

Update the config.yaml file

To update the config.yaml file, follow these steps:

  1. Navigate to the Configs directory and open the config.yaml file.

  2. Add the following line to the file:

    userGuideUrl: <custom_url>

    Replace <custom_url> with your custom URL.

Add an environment variable

You can only add environment variables for non-Docker installation:

  1. Open the Environment Variables window.

  2. Add a new system variable and replace <custom_url> with your custom URL.

  3. Restart the Vera web portal and the parent application, such as PowerShell, Command Prompt, or Visual Studio.