Automation Suite on Linux installation guide

Last updated Mar 10, 2025

Configuring the cluster

Updating the SQL Server connection

To update the connection string or credentials to the SQL Server, directly edit the cluster_config.json file on the primary the server node. You can directly edit the SQL fields (sql.username, sql.password, and sql.server_url) in the file based on what you need to update.

After updating the file, rerun the interactive installation wizard on the same machine with the updated config as the parameter. You only need to rerun the installation on the primary server.

Updating Kerberos auth

To update the global Kerberos auth configuration and/or the service specific auth configuration, see Configuring Kerberos authentication via cluster_config.json.

Adding system administrators

One system administrator is created in Automation Suite by default with the username admin on the host organization.

If access to the host organization is lost - for example, if the password for the system administrator is lost or the only users with system administrator accounts leave the company - there is a tool to add or restore a system administrator.

This script does not work if the SQL connection string parameter "Integrated Security=true" exists for platform services.

./bin/uipathctl config add-host-admin --username [new-admin-username] --email [new-admin-email] --password [new-admin-password]./bin/uipathctl config add-host-admin --username [new-admin-username] --email [new-admin-email] --password [new-admin-password]

--username is a required field.
--password is required only if the new administrator uses basic authentication to login.
--email is optional unless your external identity provider requires it (for example, Google matches by email, not username).

There are a few important notes about how the administrator is created or restored:

New administrators cannot have the same username or email as an existing administrator. If you use the same username or email as an existing administrator, the existing administrator is updated. This is useful if you want to change the password.
If an administrator was deleted and you use the same username or email for a new user, the deleted administrator will be restored instead of creating a new one. The password field is not overwritten in this case. An exceptional case is if multiple administrators were deleted with the same username or email, which results in a new administrator being created.
If any of the external identity providers configured on the host are forced, that imposes restrictions on the parameters. For instance, if Windows AD is forced, the username must be in the form user@domain. If Google is forced, then email is required.
When logging in to a new administrator account for the first time, the password must be changed.

Re-enabling basic authentication

Organization and system administrators may be unable to log in due to an issue with their configured Azure Active Directory or other external identity provider. Organization administrators may be locked out because the Disable basic authentication flag is checked in the Authentication Settings. Organization and system administrators may be locked out because an external identity provider was configured as force/exclusive. This tool will try to re-enable basic authentication for an organization.

This script does not work if the SQL connection string parameter Integrated Security=true exists for platform services.

./bin/uipathctl config enable-basic-auth --orgname [org-name]./bin/uipathctl config enable-basic-auth --orgname [org-name]

Note: --orgname is a required field. If basic authentication is restricted at the host level, set the orgname to host.

Updating the TLS protocol

The Istio ingress gateway configured in Automation Suite for routing, communicating between the services, and more uses TLS to secure the exchanges. To prevent any security threats, deprecated TLS protocol version are disabled by default.

Only TLS version 1.2 and higher are currently supported, and if you use a previous version, it is recommended that you upgrade. However, it is still possible to connect using a previous TLS version, but you must first enable it on the Automation Suite server.

Important: TLS 1.0 and 1.1 are deprecated, and enabling these versions can pose a security risk. You are strongly recommended to upgrade to TLS 1.2 or higher instead of enabling lower versions on the server.

To enable an unsupported TLS version, take one of the following steps:

To enable support for TLS 1.0 and higher, run the following command:

kubectl -n istio-system patch gateway main-gateway --type=json \
    -p='[{ "op": "replace", "path": "/spec/servers/0/tls/minProtocolVersion", "value": "TLSV1_0"}]'kubectl -n istio-system patch gateway main-gateway --type=json \
    -p='[{ "op": "replace", "path": "/spec/servers/0/tls/minProtocolVersion", "value": "TLSV1_0"}]'

To enable support for TLS 1.1 and higher, run the following command:

kubectl -n istio-system patch gateway main-gateway --type=json \
    -p='[{ "op": "replace", "path": "/spec/servers/0/tls/minProtocolVersion", "value": "TLSV1_1"}]'kubectl -n istio-system patch gateway main-gateway --type=json \
    -p='[{ "op": "replace", "path": "/spec/servers/0/tls/minProtocolVersion", "value": "TLSV1_1"}]'

Forwarding logs to external tools

You can forward logs to external tools, such as Splunk, using the OpenTelemetry Collector. For details on how to install and use the OpenTelemetry Collector, refer to the official documentation of the tool provider (such as Splunk official documentation).

Note:

This method refers to forwading logs from infrastructure and application pods. For saving robot logs, please refer to Saving robot logs to Elasticsearch.

On this page

Updating the SQL Server connection
Updating Kerberos auth
Adding system administrators
Re-enabling basic authentication
Updating the TLS protocol
Forwarding logs to external tools

Was this page helpful?

PREVIOUSMigrating to an external OCI-compliant registry

NEXTConfiguring the FQDN post-installation

Support and Services

Get The Help You Need

UiPath Academy

Learning RPA - Automation Courses

UiPath Forum

UiPath Community Forum

Trust and Security

Cookies Policy