interserver_http_* server settings

These settings configure the ClickHouse server and are autogenerated from ClickHouse source.

interserver_http_credentials

A username and a password used to connect to other servers during replication. Additionally, the server authenticates other replicas using these credentials. interserver_http_credentials must therefore be the same for all replicas in a cluster.

By default, if interserver_http_credentials section is omitted, authentication is not used during replication.
interserver_http_credentials settings do not relate to a ClickHouse client credentials configuration.
These credentials are common for replication via HTTP and HTTPS.

The following settings can be configured by sub-tags:

user — Username.
password — Password.
allow_empty — If true, then other replicas are allowed to connect without authentication even if credentials are set. If false, then connections without authentication are refused. Default: false.
old — Contains old user and password used during credential rotation. Several old sections can be specified.

Credentials Rotation ClickHouse supports dynamic interserver credentials rotation without stopping all replicas at the same time to update their configuration. Credentials can be changed in several steps. To enable authentication, set interserver_http_credentials.allow_empty to true and add credentials. This allows connections with authentication and without it.

<interserver_http_credentials>
    <user>admin</user>
    <password>111</password>
    <allow_empty>true</allow_empty>
</interserver_http_credentials>

After configuring all replicas set allow_empty to false or remove this setting. It makes authentication with new credentials mandatory. To change existing credentials, move the username and the password to interserver_http_credentials.old section and update user and password with new values. At this point the server uses new credentials to connect to other replicas and accepts connections with either new or old credentials.

<interserver_http_credentials>
    <user>admin</user>
    <password>222</password>
    <old>
        <user>admin</user>
        <password>111</password>
    </old>
    <old>
        <user>temp</user>
        <password>000</password>
    </old>
</interserver_http_credentials>

When new credentials are applied to all replicas, old credentials may be removed.

interserver_http_host

The hostname that can be used by other servers to access this server. If omitted, it is defined in the same way as the <hostname -f> command. Useful for breaking away from a specific network interface. Example

<interserver_http_host>example.clickhouse.com</interserver_http_host>

interserver_http_port

Port for exchanging data between ClickHouse servers. Example

<interserver_http_port>9009</interserver_http_port>

SQL Reference

Data Types

Engines

Functions

Formats

Settings

System Tables

Data Lakes

interserver_http_credentials

interserver_http_host

interserver_http_port

​interserver_http_credentials

​interserver_http_host

​interserver_http_port

interserver_http_credentials

interserver_http_host

interserver_http_port