Skip to content

Commit 544875f

Browse files
committed
Apply markdownfmt.sh from https://github.com/docker-library/docs
1 parent 291bb14 commit 544875f

File tree

1 file changed

+18
-21
lines changed

1 file changed

+18
-21
lines changed

docker/server/README.md

Lines changed: 18 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,34 @@
44

55
ClickHouse is an open-source column-oriented DBMS (columnar database management system) for online analytical processing (OLAP) that allows users to generate analytical reports using SQL queries in real-time.
66

7-
ClickHouse works 100-1000x faster than traditional database management systems, and processes hundreds of millions to over a billion rows and tens of gigabytes of data per server per second. With a widespread user base around the globe, the technology has received praise for its reliability, ease of use, and fault tolerance.
7+
ClickHouse works 100-1000x faster than traditional database management systems, and processes hundreds of millions to over a billion rows and tens of gigabytes of data per server per second. With a widespread user base around the globe, the technology has received praise for its reliability, ease of use, and fault tolerance.
88

99
For more information and documentation see https://clickhouse.com/.
1010

1111
## Versions
1212

13-
- The `latest` tag points to the latest release of the latest stable branch.
14-
- Branch tags like `22.2` point to the latest release of the corresponding branch.
15-
- Full version tags like `22.2.3.5` point to the corresponding release.
16-
- The tag `head` is built from the latest commit to the default branch.
17-
- Each tag has optional `-alpine` suffix to reflect that it's built on top of `alpine`.
13+
- The `latest` tag points to the latest release of the latest stable branch.
14+
- Branch tags like `22.2` point to the latest release of the corresponding branch.
15+
- Full version tags like `22.2.3.5` point to the corresponding release.
16+
- The tag `head` is built from the latest commit to the default branch.
17+
- Each tag has optional `-alpine` suffix to reflect that it's built on top of `alpine`.
1818

1919
### Compatibility
2020

21-
- The amd64 image requires support for [SSE3 instructions](https://en.wikipedia.org/wiki/SSE3). Virtually all x86 CPUs after 2005 support SSE3.
22-
- 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).
21+
- The amd64 image requires support for [SSE3 instructions](https://en.wikipedia.org/wiki/SSE3). Virtually all x86 CPUs after 2005 support SSE3.
22+
- 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).
2323

2424
## How to use this image
2525

2626
### start server instance
27+
2728
```bash
2829
docker run -d --name some-clickhouse-server --ulimit nofile=262144:262144 clickhouse/clickhouse-server
2930
```
3031

3132
By default, ClickHouse will be accessible only via the Docker network. See the [networking section below](#networking).
3233

33-
By default, starting above server instance will be run as the `default` user without password.
34+
By default, starting above server instance will be run as the `default` user without password.
3435

3536
### connect to it from a native client
3637

@@ -66,9 +67,7 @@ docker run -d -p 18123:8123 -p19000:9000 --name some-clickhouse-server --ulimit
6667
echo 'SELECT version()' | curl 'http://localhost:18123/' --data-binary @-
6768
```
6869

69-
```
70-
22.6.3.35
71-
```
70+
`22.6.3.35`
7271

7372
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):
7473

@@ -77,16 +76,14 @@ docker run -d --network=host --name some-clickhouse-server --ulimit nofile=26214
7776
echo 'SELECT version()' | curl 'http://localhost:8123/' --data-binary @-
7877
```
7978

80-
```
81-
22.6.3.35
82-
```
79+
`22.6.3.35`
8380

8481
### Volumes
8582

8683
Typically you may want to mount the following folders inside your container to achieve persistency:
8784

88-
* `/var/lib/clickhouse/` - main folder where ClickHouse stores the data
89-
* `/var/log/clickhouse-server/` - logs
85+
- `/var/lib/clickhouse/` - main folder where ClickHouse stores the data
86+
- `/var/log/clickhouse-server/` - logs
9087

9188
```bash
9289
docker run -d \
@@ -97,9 +94,9 @@ docker run -d \
9794

9895
You may also want to mount:
9996

100-
* `/etc/clickhouse-server/config.d/*.xml` - files with server configuration adjustments
101-
* `/etc/clickhouse-server/users.d/*.xml` - files with user settings adjustments
102-
* `/docker-entrypoint-initdb.d/` - folder with database initialization scripts (see below).
97+
- `/etc/clickhouse-server/config.d/*.xml` - files with server configuration adjustments
98+
- `/etc/clickhouse-server/users.d/*.xml` - files with user settings adjustments
99+
- `/docker-entrypoint-initdb.d/` - folder with database initialization scripts (see below).
103100

104101
### Linux capabilities
105102

@@ -150,7 +147,7 @@ docker run --rm -e CLICKHOUSE_DB=my_database -e CLICKHOUSE_USER=username -e CLIC
150147

151148
## How to extend this image
152149

153-
To perform additional initialization in an image derived from this one, add one or more `*.sql`, `*.sql.gz`, or `*.sh` scripts under `/docker-entrypoint-initdb.d`. After the entrypoint calls `initdb`, it will run any `*.sql` files, run any executable `*.sh` scripts, and source any non-executable `*.sh` scripts found in that directory to do further initialization before starting the service.
150+
To perform additional initialization in an image derived from this one, add one or more `*.sql`, `*.sql.gz`, or `*.sh` scripts under `/docker-entrypoint-initdb.d`. After the entrypoint calls `initdb`, it will run any `*.sql` files, run any executable `*.sh` scripts, and source any non-executable `*.sh` scripts found in that directory to do further initialization before starting the service.
154151
Also, you can provide environment variables `CLICKHOUSE_USER` & `CLICKHOUSE_PASSWORD` that will be used for clickhouse-client during initialization.
155152

156153
For example, to add an additional user and database, add the following to `/docker-entrypoint-initdb.d/init-db.sh`:

0 commit comments

Comments
 (0)