1. Create a separate database for the ClickHouse peer called peerdb. This is where tables will be auto-created and synced by PeerDB.
  1. Make sure you have a database user who has permissions for DDL, DML and SELECT operations on ClickHouse.
  2. ClickHouse has several ports exposed, and PeerDB requires to use a port that exposes the ClickHouse native protocol which by default is 9440 for the secure TLS-enabled port and 9000 for the non-TLS port. If the default ports have been changed, please adjust them accordingly.

We do not recommend using the non-TLS enabled port for ClickHouse. If this is needed, please also check the Disable TLS? option.

  1. If you are using PeerDB OSS, we use MinIO as the internal transient stage. You might need to adjust your firewall rules to allow connections from ClickHouse to MinIO. In PeerDB Cloud, we abstract all of this from you. If you run into issues, please reach out to support@peerdb.io or join our Slack channel.
  2. Create the ClickHouse Peer through UI

    Choose PostgreSQL Peer

    Enter all the details Name, Host, Port (as determined above), User, Password and Database along with S3 credentials to setup the peer.