diff --git a/README-CN.md b/README-CN.md index ad04500..b3c7b42 100644 --- a/README-CN.md +++ b/README-CN.md @@ -15,7 +15,11 @@ Akasa 是一个 Rust 写的高性能,低延迟,高度可扩展的 MQTT 服 - [ ] 基于 Raft 的服务器集群 (*敬请期待*) ## 如何使用 - +最简单的方法是通过 docker 来使用: +```shell +docker run --init -it --rm -p 1883:1883 -v "$HOME/local/etc":/opt thewawar/akasa:0.1.1 akasa start --config /opt/akasa-config.yaml +``` +或者你可以直接从源码编译: ```shell git clone https://github.com/akasamq/akasa.git && cd akasa # 可能你需要先安装 openssl: https://docs.rs/openssl/latest/openssl/#automatic @@ -85,7 +89,7 @@ Akasa 会有一个企业版本,企业版中的额外功能包括: * 可以跑非常复杂的业务逻辑 (比如 [TensorFlow][tensorflow]) * 相对于脚本语言来说有绝对的性能优势 * 在线更新 -- [ ] 和 Akasa 交互的 HTTP API +- [ ] 和 Akasa 交互的 HTTP API - [ ] 统计指标 - [ ] 流量控制 - [ ] 数据集成 (路由数据到 MySQL/Kafka/InfluxDB...) diff --git a/README.md b/README.md index d942ed9..daac600 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,12 @@ The underlying MQTT protocol message codec ([mqtt-proto][mqtt-proto]) is careful ## How to Use +The easist way is use docker: +```shell +docker run --init -it --rm -p 1883:1883 -v "$HOME/local/etc":/opt thewawar/akasa:0.1.1 akasa start --config /opt/akasa-config.yaml +``` + +Or build from source: ```shell git clone https://github.com/akasamq/akasa.git && cd akasa # You may also need to install openssl: https://docs.rs/openssl/latest/openssl/#automatic diff --git a/docker-files/README.md b/docker-files/README.md index c7b6b11..159ffac 100644 --- a/docker-files/README.md +++ b/docker-files/README.md @@ -7,7 +7,7 @@ rust-musl-builder cargo build --release ### The way to run the container: ```shell -docker run --init -it --rm -p 1883:1883 -p 8883:8883 -v "$HOME/local/etc":/opt akasa:0.1.1 akasa start --config /opt/akasa-config.yaml +docker run --init -it --rm -p 1883:1883 -v "$HOME/local/etc":/opt akasa:0.1.1 akasa start --config /opt/akasa-config.yaml ``` ### The way to build the image: