You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: clickhouse/content.md
+19-24Lines changed: 19 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,35 +10,28 @@ ClickHouse works 100-1000x faster than traditional database management systems,
10
10
11
11
For more information and documentation see https://clickhouse.com/.
12
12
13
-
## Versions
14
-
15
-
- The `latest` tag points to the latest release of the latest stable branch.
16
-
- Branch tags like `22.2` point to the latest release of the corresponding branch.
17
-
- Full version tags like `22.2.3.5` point to the corresponding release.
18
-
- The tag `head` is built from the latest commit to the default branch.
19
-
- Each tag has optional `-alpine` suffix to reflect that it's built on top of `alpine`.
20
-
21
13
### Compatibility
22
14
23
15
- The amd64 image requires support for [SSE3 instructions](https://en.wikipedia.org/wiki/SSE3). Virtually all x86 CPUs after 2005 support SSE3.
24
16
- The arm64 image requires support for the [ARMv8.2-A architecture](https://en.wikipedia.org/wiki/AArch64#ARMv8.2-A) and additionally the Load-Acquire RCpc register. The register is optional in version ARMv8.2-A and mandatory in [ARMv8.3-A](https://en.wikipedia.org/wiki/AArch64#ARMv8.3-A). Supported in Graviton >=2, Azure and GCP instances. Examples for unsupported devices are Raspberry Pi 4 (ARMv8.0-A) and Jetson AGX Xavier/Orin (ARMv8.2-A).
17
+
- Since the Clickhouse 24.11 Ubuntu images started using `ubuntu:22.04` as its base image. It requires docker version >= `20.10.10` containing [patch](https://github.com/moby/moby/commit/977283509f75303bc6612665a04abf76ff1d2468). As a workaround you could use `docker run [--privileged | --security-opt seccomp=unconfined]` instead, however that has security implications.
25
18
26
19
## How to use this image
27
20
28
21
### start server instance
29
22
30
23
```bash
31
-
docker run -d --name some-clickhouse-server --ulimit nofile=262144:262144 clickhouse/clickhouse-server
24
+
docker run -d --name some-clickhouse-server --ulimit nofile=262144:262144 %%IMAGE%%
32
25
```
33
26
34
-
By default, ClickHouse will be accessible only via the Docker network. See the [networking section below](#networking).
27
+
By default, ClickHouse will be accessible only via the Docker network. See the **networking** section below.
35
28
36
29
By default, starting above server instance will be run as the `default` user without password.
You can expose your ClickHouse running in docker by [mapping a particular port](https://docs.docker.com/config/containers/container-networking/) from inside the container using host ports:
or by allowing the container to use [host ports directly](https://docs.docker.com/network/host/) using `--network=host` (also allows achieving better network performance):
67
+
Or by allowing the container to use [host ports directly](https://docs.docker.com/network/host/) using `--network=host` (also allows achieving better network performance):
75
68
76
69
```bash
77
-
docker run -d --network=host --name some-clickhouse-server --ulimit nofile=262144:262144 clickhouse/clickhouse-server
70
+
docker run -d --network=host --name some-clickhouse-server --ulimit nofile=262144:262144 %%IMAGE%%
Read more in [knowledge base](https://clickhouse.com/docs/knowledgebase/configure_cap_ipc_lock_and_cap_sys_nice_in_docker).
109
+
115
110
## Configuration
116
111
117
112
The container exposes port 8123 for the [HTTP interface](https://clickhouse.com/docs/en/interfaces/http_interface/) and port 9000 for the [native client](https://clickhouse.com/docs/en/interfaces/tcp/).
@@ -121,30 +116,30 @@ ClickHouse configuration is represented with a file "config.xml" ([documentation
121
116
### Start server instance with custom configuration
122
117
123
118
```bash
124
-
docker run -d --name some-clickhouse-server --ulimit nofile=262144:262144 -v /path/to/your/config.xml:/etc/clickhouse-server/config.xml clickhouse/clickhouse-server
119
+
docker run -d --name some-clickhouse-server --ulimit nofile=262144:262144 -v /path/to/your/config.xml:/etc/clickhouse-server/config.xml %%IMAGE%%
125
120
```
126
121
127
122
### Start server as custom user
128
123
129
124
```bash
130
-
# $(pwd)/data/clickhouse should exist and be owned by current user
When you use the image with local directories mounted, you probably want to specify the user to maintain the proper file ownership. Use the `--user` argument and mount `/var/lib/clickhouse` and `/var/log/clickhouse-server` inside the container. Otherwise, the image will complain and not start.
135
130
136
131
### Start server from root (useful in case of enabled user namespace)
### How to create default database and user on starting
143
138
144
139
Sometimes you may want to create a user (user named `default` is used by default) and database on a container start. You can do it using environment variables `CLICKHOUSE_DB`, `CLICKHOUSE_USER`, `CLICKHOUSE_DEFAULT_ACCESS_MANAGEMENT` and `CLICKHOUSE_PASSWORD`:
0 commit comments