Creating own confing.yml file

Customers with self-hosted LiveAgent installations have to create their own config.yml file if they use any feature that requires configuration data like Salesforce or Pipedrive integrations. It is recommended to place the config.yml file outside of the LiveAgent installation directory.

Keep in mind that the file is indentation-sensitive.

Example config.yml file:

################################################################################
## Plugins configuration
################################################################################
# This section is for LiveAgent plugins that require configuration, such as OAuth2 credentials.
# Any text inside curly braces {} is a placeholder and should be replaced with your own values.
plugin:
  pipedrive:
    client_id: {your client_id}
    client_secret: {your client_secret}
    # To obtain the "client_id" and "client_secret" you need a Pipedrive developer account and create a new private app.
    redirect_url: https://{your LiveAgent domain}/public/plugins/pipedrive/oauth/callback
    # The "redirect_url" must be also configured in your Pipedrive private app settings as Callback URL.

  salesforce:
    consumer_key: {your consumer_key}
    consumer_secret: {your consumer_secret}
    # To obtain the "consumer_key" and "consumer_secret" you need a Salesforce developer account and create a new app.
    redirect_url: https://{your LiveAgent domain}/public/plugins/salesforce/oauth/callback
    # The "redirect_url" must be also configured in your Salesforce app settings as Callback URL.

Additionally, it is also required to add the following line to your Apache configuration file:

Do not forget to adjust the path to the config.yml file.

SetEnv LIVEAGENT_CONFIG_FILE "/var/www/config.yml"

Example Apache configuration:

If you have VirtualHost configured for port 80 and also for 443 the SetEnv record has to be added to both blocks.

<VirtualHost *:80>
    DocumentRoot "/var/www/LiveAgent"
    ServerName MyLiveAgent.com

    # Other settings

    SetEnv LIVEAGENT_CONFIG_FILE "/var/www/config.yml"
</VirtualHost>