diff --git a/README-CN.md b/README-CN.md index 009b0787a..f6c5faf1e 100644 --- a/README-CN.md +++ b/README-CN.md @@ -10,7 +10,7 @@ [![最棒的物联网 MQTT 开源团队期待您的加入](https://www.emqx.io/static/img/github_readme_cn_bg.png)](https://careers.emqx.cn/) -[English](./README.md) | 简体中文 | [日本語](./README-JP.md) +[English](./README.md) | 简体中文 | [日本語](./README-JP.md) | [русский](./README-RU.md) *EMQ X* 是一款完全开源,高度可伸缩,高可用的分布式 MQTT 消息服务器,适用于 IoT、M2M 和移动应用程序,可处理千万级别的并发客户端。 diff --git a/README-JP.md b/README-JP.md index 24d53a680..0219eb25e 100644 --- a/README-JP.md +++ b/README-JP.md @@ -9,7 +9,7 @@ [![The best IoT MQTT open source team looks forward to your joining](https://www.emqx.io/static/img/github_readme_en_bg.png)](https://www.emqx.io/careers) -[English](./README.md) | [简体中文](./README-CN.md) | 日本語 +[English](./README.md) | [简体中文](./README-CN.md) | 日本語 | [русский](./README-RU.md) *EMQ X* は、高い拡張性と可用性をもつ、分散型のMQTTブローカーです。数千万のクライアントを同時に処理するIoT、M2M、モバイルアプリケーション向けです。 diff --git a/README-RU.md b/README-RU.md new file mode 100644 index 000000000..d83422f13 --- /dev/null +++ b/README-RU.md @@ -0,0 +1,141 @@ +# Брокер EMQ X + +[![GitHub Release](https://img.shields.io/github/release/emqx/emqx?color=brightgreen)](https://github.com/emqx/emqx/releases) +[![Build Status](https://travis-ci.org/emqx/emqx.svg)](https://travis-ci.org/emqx/emqx) +[![Coverage Status](https://coveralls.io/repos/github/emqx/emqx/badge.svg?branch=master)](https://coveralls.io/github/emqx/emqx?branch=master) +[![Docker Pulls](https://img.shields.io/docker/pulls/emqx/emqx)](https://hub.docker.com/r/emqx/emqx) +[![Slack Invite]()](https://slack-invite.emqx.io) +[![Twitter](https://img.shields.io/badge/Follow-EMQ%20X-1DA1F2?logo=twitter)](https://twitter.com/emqtt) +[![Community](https://img.shields.io/badge/Community-EMQ%20X-yellow?logo=github)](https://github.com/emqx/emqx/discussions) + +[![The best IoT MQTT open source team looks forward to your joining](https://www.emqx.io/static/img/github_readme_en_bg.png)](https://www.emqx.io/careers) + +[English](./README.md) | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | русский + +*EMQ X* — это масштабируемый, высоко доступный, распределённый MQTT брокер с полностью открытым кодом для интернета вещей, межмашинного взаимодействия и мобильных приложений, который поддерживает миллионы одновременных подключений. + +Начиная с релиза 3.0, брокер *EMQ X* полностью поддерживает протокол MQTT версии 5.0, и обратно совместим с версиями 3.1 и 3.1.1, а также протоколами MQTT-SN, CoAP, LwM2M, WebSocket и STOMP. Начиная с релиза 3.0, брокер *EMQ X* может масштабироваться до более чем 10 миллионов одновременных MQTT соединений на один кластер. + +- Полный список возможностей доступен по ссылке: [EMQ X Release Notes](https://github.com/emqx/emqx/releases). +- Более подробная информация доступна на нашем сайте: [EMQ X homepage](https://www.emqx.io). + +## Установка + +Брокер *EMQ X* кросплатформенный, и поддерживает Linux, Unix, macOS и Windows. Он может работать на серверах с архитектурой x86_64 и устройствах на архитектуре ARM, таких как Raspberry Pi. + +Более подробная информация о запуске на Windows по ссылке: [Windows.md](./Windows.md) + +#### Установка EMQ X с помощью Docker-образа + +``` +docker run -d --name emqx -p 1883:1883 -p 8081:8081 -p 8083:8083 -p 8883:8883 -p 8084:8084 -p 18083:18083 emqx/emqx +``` + +#### Установка бинарного пакета + +Сборки для различных операционных систем: [Загрузить EMQ X](https://www.emqx.io/downloads). + +- [Установка на одном сервере](https://docs.emqx.io/en/broker/latest/getting-started/install.html) +- [Установка на кластере](https://docs.emqx.io/en/broker/latest/advanced/cluster.html) + + +## Сборка из исходного кода + +Начиная с релиза 3.0, для сборки требуется Erlang/OTP R21 или выше. + +Инструкция для сборки версии 4.3 и выше: + +```bash +git clone https://github.com/emqx/emqx.git +cd emqx +make +_build/emqx/rel/emqx/bin console +``` + +Более ранние релизы могут быть собраны с помощью другого репозитория: + +```bash +git clone https://github.com/emqx/emqx-rel.git +cd emqx-rel +make +_build/emqx/rel/emqx/bin/emqx console +``` + +## Первый запуск + +Если emqx был собран из исходников: `cd _build/emqx/rel/emqx`. +Или перейдите в директорию, куда emqx был установлен из бинарного пакета. + +```bash +# Запуск: +./bin/emqx start + +# Проверка статуса: +./bin/emqx_ctl status + +# Остановка: +./bin/emqx stop +``` + +Веб-интерфейс брокера будет доступен по ссылке: http://localhost:18083 + +## Тесты + +### Полное тестирование + +``` +make eunit ct +``` + +### Запуск части тестов + +Пример: + +```bash +make apps/emqx_bridge_mqtt-ct +``` + +### Dialyzer +##### Статический анализ всех приложений +``` +make dialyzer +``` + +##### Статический анализ части приложений (список через запятую) +``` +DIALYZER_ANALYSE_APP=emqx_lwm2m,emqx_auth_jwt,emqx_auth_ldap make dialyzer +``` + +## Сообщество + +### FAQ + +Наиболее частые проблемы разобраны в [EMQ X FAQ](https://docs.emqx.io/en/broker/latest/faq/faq.html). + + +### Вопросы + +Задать вопрос или поделиться идеей можно в [GitHub Discussions](https://github.com/emqx/emqx/discussions). + +### Предложения + +Более масштабные предложения можно присылать в виде pull request в репозиторий [EIP](https://github.com/emqx/eip). + +### Разработка плагинов + +Инструкция по разработке собственных плагинов доступна по ссылке: [lib-extra/README.md](./lib-extra/README.md) + + +## Спецификации стандарта MQTT + +Следующие ссылки содержат спецификации стандартов: + +[MQTT Version 3.1.1](https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html) + +[MQTT Version 5.0](https://docs.oasis-open.org/mqtt/mqtt/v5.0/cs02/mqtt-v5.0-cs02.html) + +[MQTT SN](http://mqtt.org/new/wp-content/uploads/2009/06/MQTT-SN_spec_v1.2.pdf) + +## Лицензия + +Apache License 2.0, см. [LICENSE](./LICENSE). diff --git a/README.md b/README.md index ee3cbb845..34366c2ea 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ [![The best IoT MQTT open source team looks forward to your joining](https://www.emqx.io/static/img/github_readme_en_bg.png)](https://www.emqx.io/careers) -English | [简体中文](./README-CN.md) | [日本語](./README-JP.md) +English | [简体中文](./README-CN.md) | [日本語](./README-JP.md) | [русский](./README-RU.md) *EMQ X* broker is a fully open source, highly scalable, highly available distributed MQTT messaging broker for IoT, M2M and Mobile applications that can handle tens of millions of concurrent clients.