From 70fd3a348123f50dc9cdfd2921db7d7a28a9040b Mon Sep 17 00:00:00 2001 From: marvzhang Date: Mon, 13 Jan 2020 09:57:41 +0800 Subject: [PATCH] updated README --- README-zh.md | 11 +++++++---- README.md | 10 +++++++--- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/README-zh.md b/README-zh.md index cc3b3494..b6319a07 100644 --- a/README-zh.md +++ b/README-zh.md @@ -41,8 +41,9 @@ ### 要求(Docker) - Docker 18.03+ -- Redis +- Redis 5.x+ - MongoDB 3.6+ +- Docker Compose 1.24+ (可选,但推荐) ### 要求(直接部署) - Go 1.12+ @@ -52,12 +53,16 @@ ## 快速开始 +请打开命令行并执行下列命令。请保证您已经提前安装了 `docker-compose`。 + ```bash git clone https://github.com/crawlab-team/crawlab cd crawlab docker-compose up -d ``` +接下来,您可以看看 `docker-compose.yml` (包含详细配置参数),以及参考 [文档](http://docs.crawlab.cn) 来查看更多信息。 + ## 运行 ### Docker @@ -71,13 +76,11 @@ services: image: tikazyq/crawlab:latest container_name: master environment: - CRAWLAB_API_ADDRESS: "http://localhost:8000" CRAWLAB_SERVER_MASTER: "Y" CRAWLAB_MONGO_HOST: "mongo" CRAWLAB_REDIS_ADDRESS: "redis" ports: - - "8080:8080" # frontend - - "8000:8000" # backend + - "8080:8080" depends_on: - mongo - redis diff --git a/README.md b/README.md index 02b2c5f0..20bc9e4b 100644 --- a/README.md +++ b/README.md @@ -41,8 +41,9 @@ Two methods: ### Pre-requisite (Docker) - Docker 18.03+ -- Redis +- Redis 5.x+ - MongoDB 3.6+ +- Docker Compose 1.24+ (optional but recommended) ### Pre-requisite (Direct Deploy) - Go 1.12+ @@ -52,12 +53,16 @@ Two methods: ## Quick Start +Please open the command line prompt and execute the command beloe. Make sure you have installed `docker-compose` in advance. + ```bash git clone https://github.com/crawlab-team/crawlab cd crawlab docker-compose up -d ``` +Next, you can look into the `docker-compose.yml` (with detailed config params) and the [Documentation (Chinese)](http://docs.crawlab.cn) for further information. + ## Run ### Docker @@ -76,8 +81,7 @@ services: CRAWLAB_MONGO_HOST: "mongo" CRAWLAB_REDIS_ADDRESS: "redis" ports: - - "8080:8080" # frontend - - "8000:8000" # backend + - "8080:8080" depends_on: - mongo - redis