From a050e8464165c973663fc14fa5a7ecfd7255f1ae Mon Sep 17 00:00:00 2001 From: nic-chen <33000667+nic-chen@users.noreply.github.com> Date: Sun, 25 Oct 2020 07:25:58 +0800 Subject: [PATCH] doc: update docs about preinstall in deployment (#597) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * fix: update docs about preinstall in deployment * fix: use the exists schema.json so we don't need Lua on building Co-authored-by: 琚致远 --- api/run.sh | 8 ++++---- docs/deploy.md | 5 ++++- docs/deploy.zh-CN.md | 4 +++- 3 files changed, 11 insertions(+), 6 deletions(-) diff --git a/api/run.sh b/api/run.sh index 737cd2488e..a45061dc61 100755 --- a/api/run.sh +++ b/api/run.sh @@ -41,8 +41,8 @@ if [[ ! -f "dag-to-lua-1.1/lib/dag-to-lua.lua" ]]; then fi -# generate json schema -if [[ ! -f "${pwd}/schema.json" ]]; then +# generate json schema if need a new one +if [[ ! -f "${pwd}/api/conf/schema.json" ]]; then rm master.zip rm -rf ./api/build-tools/apisix/ wget https://github.com/apache/apisix/archive/master.zip @@ -50,8 +50,8 @@ if [[ ! -f "${pwd}/schema.json" ]]; then mkdir -p ./api/build-tools/apisix/ mv ./apisix-master/apisix/* ./api/build-tools/apisix/ rm -rf ./apisix-master - cd ./api/build-tools/ && lua schema-sync.lua > ${pwd}/schema.json - cd ../../ + cd ./api/build-tools/ && lua schema-sync.lua > ${pwd}/api/conf/schema.json + cd ../../ fi # build diff --git a/docs/deploy.md b/docs/deploy.md index 53ebad1ff9..a91dc3dbad 100644 --- a/docs/deploy.md +++ b/docs/deploy.md @@ -31,7 +31,9 @@ $ cd apisix-dashboard The `manager-api` is used to provide APIs for Dashboard, just like a bridge between the Apache APISIX and the Dashboard. Here are the steps to build it manually: -1. We need `Go` 1.13+ and `Lua` 5.1+ to be preinstalled. +1. We need `Go` 1.13+ to be preinstalled. + +NOTE: You also need to install `Lua` 5.1+ if you want to use the Plugin Orchestration, we will improve this part and omit Lua's dependency in the future. 2. Check environment variables @@ -84,4 +86,5 @@ $ yarn build ``` 5. The bundled files are under `/dist` folder if the step 4 is successful. + 6. Move files under `dist` folder to manager-api's `dist` folder, then visit `http://127.0.0.1:8080` in your browser, `8080` is the default listen port of manager-api. diff --git a/docs/deploy.zh-CN.md b/docs/deploy.zh-CN.md index 01c2159c27..f8a899b6f5 100644 --- a/docs/deploy.zh-CN.md +++ b/docs/deploy.zh-CN.md @@ -31,7 +31,9 @@ $ cd apisix-dashboard `manager-api` 用于为控制台提供接口,就像 Apache APISIX 和控制台之间的桥梁。下面是手动构建步骤: -1. 需要预先安装 `Go` 1.13+ 、`Lua` 5.1+ +1. 需要预先安装 `Go` 1.13+ + +注意:如果使用插件编排,需要同时预先安装 `Lua` 5.1+ ,后续版本会对此进行优化,取消对 `Lua` 的依赖。 2. 检查环境变量