From 3782ba7d6b87ad461a44b3065e9005aea18ef53f Mon Sep 17 00:00:00 2001 From: Ivan Blinkov Date: Tue, 4 Dec 2018 20:09:57 +0300 Subject: [PATCH] Rewrite en/getting_started/index.md (#3747) * CLICKHOUSE-4063: less manual html @ index.md * CLICKHOUSE-4063: recommend markdown="1" in README.md * CLICKHOUSE-4003: manually purge custom.css for now * CLICKHOUSE-4064: expand
before any print (including to pdf) * CLICKHOUSE-3927: rearrange interfaces/formats.md a bit * CLICKHOUSE-3306: add few http headers * Remove copy-paste introduced in #3392 * Hopefully better chinese fonts #3392 * get rid of tabs @ custom.css * Apply comments and patch from #3384 * Add jdbc.md to ToC and some translation, though it still looks badly incomplete * minor punctuation * Add some backlinks to official website from mirrors that just blindly take markdown sources * Do not make fonts extra light * find . -name '*.md' -type f | xargs -I{} perl -pi -e 's//g' {} * find . -name '*.md' -type f | xargs -I{} perl -pi -e 's/ sql/g' {} * Remove outdated stuff from roadmap.md * Not so light font on front page too * Refactor Chinese formats.md to match recent changes in other languages * Update some links on front page * Remove some outdated comment * Add twitter link to front page * More front page links tuning * Add Amsterdam meetup link * Smaller font to avoid second line * Add Amsterdam link to README.md * Proper docs nav translation * Back to 300 font-weight except Chinese * fix docs build * Update Amsterdam link * remove symlinks * more zh punctuation * apply lost comment by @zhang2014 * Apply comments by @zhang2014 from #3417 * Remove Beijing link * rm incorrect symlink * restore content of docs/zh/operations/table_engines/index.md * CLICKHOUSE-3751: stem terms while searching docs * CLICKHOUSE-3751: use English stemmer in non-English docs too * CLICKHOUSE-4135 fix * Remove past meetup link * Add blog link to top nav * Add ContentSquare article link * Add form link to front page + refactor some texts * couple markup fixes * minor * Introduce basic ODBC driver page in docs * More verbose 3rd party libs disclaimer * Put third-party stuff into a separate folder * Separate third-party stuff in ToC too * Update links * Move stuff that is not really (only) a client library into a separate page * Add clickhouse-hdfs-loader link * Some introduction for "interfaces" section * Rewrite tcp.md * http_interface.md -> http.md * fix link * Remove unconvenient error for now * try to guess anchor instead of failing * remove symlink * Remove outdated info from introduction * remove ru roadmap.md * replace ru roadmap.md with symlink * Update roadmap.md * lost file * Title case in toc_en.yml * Sync "Functions" ToC section with en * Remove reference to pretty old ClickHouse release from docs * couple lost symlinks in fa * Close quote in proper place * Rewrite en/getting_started/index.md * Sync en<>ru getting_started/index.md * minor changes --- docs/en/getting_started/index.md | 109 ++++++++++++++----------------- docs/fa/getting_started/index.md | 6 +- docs/ru/getting_started/index.md | 104 +++++++++++++---------------- docs/zh/getting_started/index.md | 8 +-- 4 files changed, 100 insertions(+), 127 deletions(-) diff --git a/docs/en/getting_started/index.md b/docs/en/getting_started/index.md index 53a8fa495fc..f78cb5dc03a 100644 --- a/docs/en/getting_started/index.md +++ b/docs/en/getting_started/index.md @@ -2,35 +2,29 @@ ## System Requirements -Installation from the official repository requires Linux with x86_64 architecture and support for the SSE 4.2 instruction set. +ClickHouse can run on any Linux, FreeBSD or Mac OS X with x86\_64 CPU architecture. -To check for SSE 4.2: +Though pre-built binaries are typically compiled to leverage SSE 4.2 instruction set, so unless otherwise stated usage of CPU that supports it becomes an additional system requirement. Here's the command to check if current CPU has support for SSE 4.2: -```bash -grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not supported" +``` bash +$ grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not supported" ``` -We recommend using Ubuntu or Debian. The terminal must use UTF-8 encoding. - -For rpm-based systems, you can use 3rd-party packages: https://packagecloud.io/altinity/clickhouse or install debian packages. - -ClickHouse also works on FreeBSD and Mac OS X. It can be compiled for x86_64 processors without SSE 4.2 support, and for AArch64 CPUs. - ## Installation -For testing and development, the system can be installed on a single server or on a desktop computer. +### From DEB Packages -### Installing from Packages for Debian/Ubuntu +Yandex ClickHouse team recommends using official pre-compiled `deb` packages for Debian or Ubuntu. -In `/etc/apt/sources.list` (or in a separate `/etc/apt/sources.list.d/clickhouse.list` file), add the repository: +To install official packages add the Yandex repository in `/etc/apt/sources.list` or in a separate `/etc/apt/sources.list.d/clickhouse.list` file: ``` deb http://repo.yandex.ru/clickhouse/deb/stable/ main/ ``` -If you want to use the most recent test version, replace 'stable' with 'testing'. +If you want to use the most recent version, replace `stable` with `testing` (this is not recommended for production environments). -Then run: +Then run these commands to actually install packages: ```bash sudo apt-key adv --keyserver keyserver.ubuntu.com --recv E0C56BD4 # optional @@ -40,82 +34,77 @@ sudo apt-get install clickhouse-client clickhouse-server You can also download and install packages manually from here: . -ClickHouse contains access restriction settings. They are located in the 'users.xml' file (next to 'config.xml'). -By default, access is allowed from anywhere for the 'default' user, without a password. See 'user/default/networks'. -For more information, see the section "Configuration files". +### From RPM Packages -### Installing from Sources +Yandex does not run ClickHouse on `rpm` based Linux distributions and `rpm` packages are not as thoroughly tested. So use them at your own risk, but there are many other companies that do successfully run them in production without any major issues. -To compile, follow the instructions: build.md +For CentOS, RHEL or Fedora there are the following options: +* Packages from are generated from official `deb` packages by Yandex and have byte-identical binaries. +* Packages from are built by independent company Altinity, but are used widely without any complaints. +* Or you can use Docker (see below). -You can compile packages and install them. -You can also use programs without installing packages. +### From Docker Image + +To run ClickHouse inside Docker follow the guide on [Docker Hub](https://hub.docker.com/r/yandex/clickhouse-server/). Those images use official `deb` packages inside. + +### From Sources + +To manually compile ClickHouse, follow the instructions for [Linux](../development/build.md) or [Mac OS X](../development/build_osx.md). + +You can compile packages and install them or use programs without installing packages. Also by building manually you can disable SSE 4.2 requirement or build for AArch64 CPUs. ``` Client: dbms/programs/clickhouse-client Server: dbms/programs/clickhouse-server ``` -For the server, create a catalog with data, such as: - +You'll need to create a data and metadata folders and `chown` them for the desired user. Their paths can be changed in server config (src/dbms/programs/server/config.xml), by default they are: ``` /opt/clickhouse/data/default/ /opt/clickhouse/metadata/default/ ``` -(Configurable in the server config.) -Run 'chown' for the desired user. - -Note the path to logs in the server config (src/dbms/programs/server/config.xml). - -### Other Installation Methods - -Docker image: - -RPM packages for CentOS or RHEL: - -Gentoo: `emerge clickhouse` +On Gentoo you can just use `emerge clickhouse` to install ClickHouse from sources. ## Launch -To start the server (as a daemon), run: +To start the server as a daemon, run: -```bash -sudo service clickhouse-server start +``` bash +$ sudo service clickhouse-server start ``` -See the logs in the `/var/log/clickhouse-server/ directory.` +See the logs in the `/var/log/clickhouse-server/` directory. -If the server doesn't start, check the configurations in the file `/etc/clickhouse-server/config.xml.` +If the server doesn't start, check the configurations in the file `/etc/clickhouse-server/config.xml`. -You can also launch the server from the console: +You can also manually launch the server from the console: -```bash -clickhouse-server --config-file=/etc/clickhouse-server/config.xml +``` bash +$ clickhouse-server --config-file=/etc/clickhouse-server/config.xml ``` In this case, the log will be printed to the console, which is convenient during development. -If the configuration file is in the current directory, you don't need to specify the '--config-file' parameter. By default, it uses './config.xml'. +If the configuration file is in the current directory, you don't need to specify the `--config-file` parameter. By default, it uses `./config.xml`. -You can use the command-line client to connect to the server: +ClickHouse supports access restriction settings. They are located in the `users.xml` file (next to `config.xml`). +By default, access is allowed from anywhere for the `default` user, without a password. See `user/default/networks`. +For more information, see the section ["Configuration Files"](../operations/configuration_files.md). -```bash -clickhouse-client +After launching server, you can use the command-line client to connect to it: + +``` bash +$ clickhouse-client ``` -The default parameters indicate connecting with localhost:9000 on behalf of the user 'default' without a password. -The client can be used for connecting to a remote server. Example: +By default it connects to `localhost:9000` on behalf of the user `default` without a password. It can also be used to connect to a remote server using `--host` argument. -```bash -clickhouse-client --host=example.com -``` +The terminal must use UTF-8 encoding. +For more information, see the section ["Command-line client"](../interfaces/cli.md). -For more information, see the section "Command-line client". - -Checking the system: - -```bash -milovidov@hostname:~/work/metrica/src/dbms/src/Client$ ./clickhouse-client +Example: +``` bash +$ ./clickhouse-client ClickHouse client version 0.0.18749. Connecting to localhost:9000. Connected to ClickHouse server version 0.0.18749. @@ -135,7 +124,7 @@ SELECT 1 **Congratulations, the system works!** -To continue experimenting, you can try to download from the test data sets. +To continue experimenting, you can download one of test data sets or go through [tutorial](https://clickhouse.yandex/tutorial.html). [Original article](https://clickhouse.yandex/docs/en/getting_started/) diff --git a/docs/fa/getting_started/index.md b/docs/fa/getting_started/index.md index dba3d4d080f..3fbe345b888 100644 --- a/docs/fa/getting_started/index.md +++ b/docs/fa/getting_started/index.md @@ -4,7 +4,7 @@ ## نیازمندی های سیستم -این یک سیستم چند سکویی (Cross-Platform) نمی باشد. این ابزار نیاز به Linux Ubuntu Precise (12.04) یا جدیدتر، با معماری x86_64 و پشتیبانی از SSE 4.2 می باشد. برای چک کردن SSE 4.2 خروجی دستور زیر را بررسی کنید: +این یک سیستم چند سکویی (Cross-Platform) نمی باشد. این ابزار نیاز به Linux Ubuntu Precise (12.04) یا جدیدتر، با معماری x86\_64 و پشتیبانی از SSE 4.2 می باشد. برای چک کردن SSE 4.2 خروجی دستور زیر را بررسی کنید: @@ -18,8 +18,6 @@ grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not su ## نصب -برای تست و توسعه، ClickHouse می تواند در یک سرور یا در یک کامپیوتر desktop نصب شود. - ### نصب از طریق پکیج های Debian/Ubuntu در فایل `/etc/apt/sources.list` (یا در یک فایل جدا `/etc/apt/sources.list.d/clickhouse.list`)، Repo زیر را اضافه کنید: @@ -100,7 +98,7 @@ sudo service clickhouse-server start
-لاگ های دایرکتوری `/var/log/clickhouse-server/ directory.` را مشاهده کنید. +لاگ های دایرکتوری `/var/log/clickhouse-server/` directory. را مشاهده کنید. اگر سرور استارت نشد، فایل تنظیمات را بررسی کنید `/etc/clickhouse-server/config.xml.` diff --git a/docs/ru/getting_started/index.md b/docs/ru/getting_started/index.md index 037dfb7379b..5ed654e1634 100644 --- a/docs/ru/getting_started/index.md +++ b/docs/ru/getting_started/index.md @@ -2,35 +2,29 @@ ## Системные требования -Для установки из официального репозитория требуется ОС Linux; архитектура x86_64 с поддержкой набора инструкций SSE 4.2. +ClickHouse может работать на любом Linux, FreeBSD или Mac OS X с архитектурой процессора x86\_64. -Для проверки наличия SSE 4.2, выполните: +Хотя предсобранные релизы обычно компилируются с использованием набора инструкций SSE 4.2, что добавляет использование поддерживающего его процессора в список системных требований. Команда для п проверки наличия поддержки инструкций SSE 4.2 на текущем процессоре: ```bash -grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not supported" +$ grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not supported" ``` -Рекомендуется использовать Ubuntu или Debian. Терминал должен работать в кодировке UTF-8. - -Для rpm-based систем вы можете использовать 3rd-party пакеты: https://packagecloud.io/altinity/clickhouse либо установить debian пакеты. - -ClickHouse также работает на FreeBSD и Mac OS X; может быть собран для процессоров x86_64 без поддержки SSE 4.2, и для процессоров AArch64. - ## Установка -В целях тестирования и разработки, система может быть установлена на один сервер или на рабочий компьютер. +### Из DEB пакетов -### Установка из пакетов для Debian/Ubuntu +Яндекс рекомендует использовать официальные скомпилированные `deb` пакеты для Debian или Ubuntu. -Пропишите в `/etc/apt/sources.list` (или в отдельный файл `/etc/apt/sources.list.d/clickhouse.list`) репозитории: +Чтобы установить официальные пакеты, пропишите репозиторий Яндекса в `/etc/apt/sources.list` или в отдельный файл `/etc/apt/sources.list.d/clickhouse.list`: ``` deb http://repo.yandex.ru/clickhouse/deb/stable/ main/ ``` -Если вы хотите использовать наиболее свежую тестовую версию, замените stable на testing. +Если вы хотите использовать наиболее свежую тестовую, замените `stable` на `testing` (не рекомендуется для production окружений). -Затем выполните: +Затем для самой установки пакетов выполните: ```bash sudo apt-key adv --keyserver keyserver.ubuntu.com --recv E0C56BD4 # optional @@ -38,84 +32,78 @@ sudo apt-get update sudo apt-get install clickhouse-client clickhouse-server ``` -Также можно скачать и установить пакеты вручную, отсюда: . +Также эти пакеты можно скачать и установить вручную отсюда: . -ClickHouse содержит настройки ограничения доступа. Они расположены в файле users.xml (рядом с config.xml). -По умолчанию, разрешён доступ отовсюду для пользователя default без пароля. См. секцию users/default/networks. -Подробнее смотрите в разделе "конфигурационные файлы". +### Из RPM пакетов -### Установка из исходников +Яндекс не использует ClickHouse на поддерживающих `rpm` дистрибутивах Linux, а также `rpm` пакеты менее тщательно тестируются. Таким образом, использовать их стоит на свой страх и риск, но, тем не менее, многие другие компании успешно работают на них в production без каких-либо серьезных проблем. -Для сборки воспользуйтесь инструкцией: build.md +Для CentOS, RHEL и Fedora возможны следующие варианты: +* Пакеты из генерируются на основе официальных `deb` пакетов от Яндекса и содержат в точности тот же исполняемый файл. +* Пакеты из собираются независимой компанией Altinity, но широко используются без каких-либо нареканий. +* Либо можно использовать Docker (см. ниже). -Вы можете собрать пакеты и установить их. -Также вы можете использовать программы без установки пакетов. +### Из Docker образа + +Для запуска ClickHouse в Docker нужно следовать инструкции на [Docker Hub](https://hub.docker.com/r/yandex/clickhouse-server/). Внутри образов используются официальные `deb` пакеты. + +### Из исходникого кода + +Для компиляции ClickHouse вручную, испольщуйте инструкцию для [Linux](../development/build.md) или [Mac OS X](../development/build_osx.md). + +Можно скомпилировать пакеты и установить их, либо использовать программы без установки пакетов. Также при ручой сборке можно отключить необходимость поддержки набора инструкций SSE 4.2 или собрать под процессоры архитектуры AArch64. ``` Client: dbms/programs/clickhouse-client Server: dbms/programs/clickhouse-server ``` -Для сервера создаёте директории с данными, например: +Для работы собранного вручную сервера необходимо создать директории для данных и метаданных, а также сделать их `chown` для желаемого пользователя. Пути к этим директориям могут быть изменены в конфигурационном файле сервера (src/dbms/programs/server/config.xml), по умолчанию используются следующие: ``` /opt/clickhouse/data/default/ /opt/clickhouse/metadata/default/ ``` -(Настраивается в конфиге сервера.) -Сделайте chown под нужного пользователя. - -Обратите внимание на путь к логам в конфиге сервера (src/dbms/programs/server/config.xml). - -### Другие методы установки - -Docker образ: - -RPM пакеты для CentOS, RHEL: - -Gentoo: `emerge clickhouse` +На Gentoo для установки ClickHouse из исходного кода можно использовать просто `emerge clickhouse`. ## Запуск -Для запуска сервера (в качестве демона), выполните: +Для запуска сервера в качестве демона, выполните: -```bash -sudo service clickhouse-server start +``` bash +% sudo service clickhouse-server start ``` -Смотрите логи в директории `/var/log/clickhouse-server/` +Смотрите логи в директории `/var/log/clickhouse-server/`. -Если сервер не стартует - проверьте правильность конфигурации в файле `/etc/clickhouse-server/config.xml` +Если сервер не стартует, проверьте корректность конфигурации в файле `/etc/clickhouse-server/config.xml` -Также можно запустить сервер из консоли: +Также можно запустить сервер вручную из консоли: -```bash -clickhouse-server --config-file=/etc/clickhouse-server/config.xml +``` bash +$ clickhouse-server --config-file=/etc/clickhouse-server/config.xml ``` -При этом, лог будет выводиться в консоль - удобно для разработки. -Если конфигурационный файл лежит в текущей директории, то указывать параметр --config-file не требуется - по умолчанию будет использован файл ./config.xml +При этом, лог будет выводиться в консоль, что удобно для разработки. +Если конфигурационный файл лежит в текущей директории, то указывать параметр `--config-file` не требуется, по умолчанию будет использован файл `./config.xml`. -Соединиться с сервером можно с помощью клиента командной строки: +После запуска сервера, соединиться с ним можно с помощью клиента командной строки: -```bash -clickhouse-client +``` bash +$ clickhouse-client ``` -Параметры по умолчанию обозначают - соединяться с localhost:9000, от имени пользователя default без пароля. -Клиент может быть использован для соединения с удалённым сервером. Пример: +По умолчанию он соединяется с localhost:9000, от имени пользователя `default` без пароля. Также клиент может быть использован для соединения с удалённым сервером с помощью аргемента `--host`. -```bash -clickhouse-client --host=example.com -``` +Терминал должен использлвать кодировку UTF-8. -Подробнее смотри раздел "Клиент командной строки". +Более подробная информация о клиенте располагается в разделе [«Клиент командной строки»](../interfaces/cli.md). -Проверим работоспособность системы: +Пример проверки работоспособности системы: -```bash -milovidov@hostname:~/work/metrica/src/dbms/src/Client$ ./clickhouse-client +``` bash +$ ./clickhouse-client ClickHouse client version 0.0.18749. Connecting to localhost:9000. Connected to ClickHouse server version 0.0.18749. @@ -135,6 +123,6 @@ SELECT 1 **Поздравляем, система работает!** -Для дальнейших экспериментов можно попробовать загрузить из тестовых наборов данных. +Для дальнейших экспериментов можно попробовать загрузить один из тестовых наборов данных или пройти [пошаговое руководство для начинающих](https://clickhouse.yandex/tutorial.html). [Оригинальная статья](https://clickhouse.yandex/docs/ru/getting_started/) diff --git a/docs/zh/getting_started/index.md b/docs/zh/getting_started/index.md index 2820719990a..ca108db655a 100644 --- a/docs/zh/getting_started/index.md +++ b/docs/zh/getting_started/index.md @@ -2,7 +2,7 @@ ## 系统要求 -如果从官方仓库安装，需要确保您使用的是x86_64处理器构架的Linux并且支持SSE 4.2指令集 +如果从官方仓库安装，需要确保您使用的是x86\_64处理器构架的Linux并且支持SSE 4.2指令集 检查是否支持SSE 4.2： @@ -14,12 +14,10 @@ grep -q sse4_2 /proc/cpuinfo && echo "SSE 4.2 supported" || echo "SSE 4.2 not su 基于rpm的系统,你可以使用第三方的安装包：https://packagecloud.io/altinity/clickhouse 或者直接安装debian安装包。 -ClickHouse还可以在FreeBSD与Mac OS X上工作。同时它可以在不支持SSE 4.2的x86_64构架和AArch64 CPUs上编译。 +ClickHouse还可以在FreeBSD与Mac OS X上工作。同时它可以在不支持SSE 4.2的x86\_64构架和AArch64 CPUs上编译。 ## 安装 -为了测试和开发，系统可以安装在单个服务器或普通PC机上。 - ### 为Debian/Ubuntu安装 在`/etc/apt/sources.list` (或创建`/etc/apt/sources.list.d/clickhouse.list`文件)中添加仓库： @@ -54,7 +52,7 @@ ClickHouse包含访问控制配置，它们位于`users.xml`文件中(与'config ```text Client: dbms/programs/clickhouse-client Server: dbms/programs/clickhouse-server -``` + ``` 在服务器中为数据创建如下目录：