Install the ClickHouse® client

This page explains how to install the ClickHouse® client to interact with your cluster. You can use the method that best suits your needs.

Quick installation

Docker

DEB-based

RPM-based

You can install the ClickHouse® client together with ClickHouse® on Linux, FreeBSD, or macOS with the following command:

curl https://clickhouse.com/ | sh

This command downloads the official binary for your operating system.

Note

When you connect to a cluster using the ClickHouse® client installed this way, you need to replace clickhouse-client in the native interface connection string with ./clickhouse client.

./clickhouse client --host<rest_of_the_connection_string>

Open your terminal.
(Optional) Start Docker if needed:
```
sudo service docker start
```
Pull the clickhouse-client container image from Docker Hub:
```
docker pull clickhouse/clickhouse-client
```

Open your terminal.

Connect to the ClickHouse® official DEB repository from your Linux system:

sudo apt update && sudo apt install -y apt-transport-https ca-certificates dirmngr && \
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 8919F6BD2B48D754 && \
echo "deb https://packages.clickhouse.com/deb stable main" | sudo tee \
/etc/apt/sources.list.d/clickhouse.list

Refresh the package list and install the clickhouse-client :

sudo apt update && sudo apt install -y clickhouse-client

Open your terminal.

Connect to a ClickHouse® official RPM repository from your Linux system:

sudo yum install -y yum-utils
sudo yum-config-manager --add-repo https://packages.clickhouse.com/rpm/clickhouse.repo

Install the clickhouse-client :
```
sudo yum install -y clickhouse-client
```

Warning

If you run a RedHat 7-based Linux distribution, including Cent OS 7, Oracle Linux 7 and others, you need to download and install trusted certificates and manually add the path to them in the clickhouse-client configuration file as follows:

Install the root certificate:

curl https://letsencrypt.org/certs/isrg-root-x2-cross-signed.pem > \ 
/etc/pki/ca-trust/source/anchors/isrg-root-x2-cross-signed.pem

Install the intermediate certificate:

curl https://letsencrypt.org/certs/lets-encrypt-r3-cross-signed.pem > \
/etc/pki/ca-trust/source/anchors/lets-encrypt-r3-cross-signed.pem

Update the list of trusted certificates:
```
sudo update-ca-trust
```

Locate your clickhouse-client configuration file (by default, you can find it at /etc/clickhouse-client/config.xml) and add the path to the certificates into the <openSSL> section:

<client> <!-- Used for connection to server's secure tcp port -->
    <loadDefaultCAFile>true</loadDefaultCAFile>
    <cacheSessions>true</cacheSessions>
    <disableProtocols>sslv2,sslv3</disableProtocols>
    <preferServerCiphers>true</preferServerCiphers>
    <caConfig>/etc/ssl/certs/ca-bundle.crt</caConfig>
    <!-- Use for self-signed: <verificationMode>none</verificationMode> -->
    <invalidCertificateHandler>
    <!-- Use for self-signed: <name>AcceptCertificateHandler</name> -->
    <name>RejectCertificateHandler</name>
    </invalidCertificateHandler>
</client>

Troubleshoot an overloaded cluster

Connect to a cluster