Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update docs about preinstall in deployment #597

Merged
merged 10 commits into from
Oct 24, 2020
Merged

doc: update docs about preinstall in deployment #597

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
3f845c6
fix: update docs about preinstall in deployment
johzchen Oct 24, 2020
ac96e0f
Update deploy.md
juzhiyuan Oct 24, 2020
b87b327
Update deploy.md
juzhiyuan Oct 24, 2020
f202332
Update deploy.md
juzhiyuan Oct 24, 2020
72dbfef
Update deploy.md
juzhiyuan Oct 24, 2020
837315e
Update deploy.md
juzhiyuan Oct 24, 2020
4a76291
Merge branch 'master' into update-doc
juzhiyuan Oct 24, 2020
e52cc82
Update deploy.zh-CN.md
juzhiyuan Oct 24, 2020
471cee1
fix: use the exists schema.json so we don't need Lua on building
johzchen Oct 24, 2020
a9de5ef
fix typo
johzchen Oct 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions api/run.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,17 +41,17 @@ 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
unzip master.zip
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
Expand Down
5 changes: 4 additions & 1 deletion docs/deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
4 changes: 3 additions & 1 deletion docs/deploy.zh-CN.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. 检查环境变量

Expand Down