This is an automated email from the ASF dual-hosted git repository. wenming pushed a commit to branch v0.9 in repository https://gitbox.apache.org/repos/asf/incubator-apisix.git
The following commit(s) were added to refs/heads/v0.9 by this push: new a73fb33 doc: add doc for install from source RC. (#859) a73fb33 is described below commit a73fb338e3e7dfc9b1bb9118572bbb045cd4f7dc Author: WenMing <moonbingb...@gmail.com> AuthorDate: Fri Nov 15 22:54:27 2019 +0800 doc: add doc for install from source RC. (#859) --- README.md | 7 ++----- README_CN.md | 7 ++----- doc/how-to-build-cn.md | 10 ++++++---- doc/how-to-build.md | 14 ++++++++------ doc/install-dependencies.md | 15 ++++++++------- 5 files changed, 26 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 0333d8c..1a470a9 100644 --- a/README.md +++ b/README.md @@ -89,18 +89,17 @@ We provide an online dashboard [demo version](http://apisix.iresty.com), make ## Installation APISIX Installed and tested in the following systems(OpenResty MUST >= 1.15.8.1, or Tengine >= 2.3.2): + CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04 Steps to install APISIX: 1. Installation runtime dependencies: OpenResty and etcd, refer to [documentation](doc/install-dependencies.md); 2. There are several ways to install Apache APISIX: - - [Source code](doc/how-to-build.md#installation-via-source-code) + - [Source Release Candidate](doc/how-to-build.md#installation-via-source-release-candidate) - [RPM package](doc/how-to-build.md#installation-via-rpm-package-centos-7) for CentOS 7 - [Luarocks](doc/how-to-build.md#installation-via-luarocks-macos-not-supported) - [Docker](https://github.com/apache/incubator-apisix-docker) -Then you can try APISIX with the [**Quickstart**](#quickstart) now. - ## Quickstart 1. start server: @@ -109,8 +108,6 @@ Then you can try APISIX with the [**Quickstart**](#quickstart) now. sudo apisix start ``` -*note*: If you are in a development environment, start server by command `make run`. - 2. try limit count plugin Limit count plugin is a good start to try APISIX, diff --git a/README_CN.md b/README_CN.md index e4fab3d..7a28973 100644 --- a/README_CN.md +++ b/README_CN.md @@ -87,18 +87,17 @@ APISIX 通过插件机制,提供动态负载平衡、身份验证、限流限 ## 安装 APISIX 在以下操作系统中可顺利安装并做过运行测试,需要注意的是:OpenResty 的版本必须 >= 1.15.8.1: + CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubuntu 18.04 安装 APISIX 的步骤: 1. 安装运行时依赖:OpenResty 和 etcd,参考[依赖安装文档](doc/install-dependencies.md). 2. 有以下几种方式来安装 Apache APISIX: - - 通过[源码安装](doc/how-to-build-cn.md#通过源码安装); + - 通过[源码候选版本](doc/how-to-build-cn.md#通过源码候选版本安装); - 如果你在使用 CentOS 7,可以使用 [RPM 包安装](doc/how-to-build-cn.md#通过-rpm-包安装centos-7); - 其它 Linux 操作系统,可以使用 [Luarocks 安装方式](doc/how-to-build-cn.md#通过-luarocks-安装-不支持-macos); - 你也可以使用 [Docker 镜像](https://github.com/apache/incubator-apisix-docker) 来安装。 -如果安装成功,就可以参考 [**快速上手**](#快速上手) 来进行体验。如果失败,欢迎反馈给我们。 - ## 快速上手 1. 启动 APISIX @@ -107,8 +106,6 @@ CentOS 7, Ubuntu 16.04, Ubuntu 18.04, Debian 9, Debian 10, macOS, **ARM64** Ubun sudo apisix start ``` -*注意*:如果你当前在开发环境下,应使用 `make run` 命令启动服务。 - 2. 测试限流插件 你可以测试限流插件,来上手体验 APISIX,按照[限流插件文档](doc/plugins/limit-count-cn.md)的步骤即可。 diff --git a/doc/how-to-build-cn.md b/doc/how-to-build-cn.md index 8798f23..56b06a0 100644 --- a/doc/how-to-build-cn.md +++ b/doc/how-to-build-cn.md @@ -20,23 +20,25 @@ ## 1. 安装依赖 Apache APISIX 的运行环境需要 Nginx 和 etcd, + 所以在安装前,请根据不同的操作系统来[安装依赖](install-dependencies.md)。 ## 2. 安装 Apache APISIX 你可以通过源码包、Docker、Luarocks 等多种方式来安装 Apache APISIX。 -### 通过源码安装 +### 通过源码候选版本安装 -你可以下载 Apache release 包(Apache APISIX 还没有发布 Apache release),或者从 GitHub 下载源码: +你需要先下载源码候选版本: ```shell -git clone g...@github.com:iresty/apisix.git -cd apisix +wget https://dist.apache.org/repos/dist/dev/incubator/apisix/0.9-RC1/apache-apisix-0.9-rc1-incubating-src.tar.gz +tar zxvf apache-apisix-0.9-rc1-incubating-src.tar.gz ``` 安装运行时依赖的 Lua 库: ``` +cd apache-apisix-0.9-rc1-incubating-src make deps ``` diff --git a/doc/how-to-build.md b/doc/how-to-build.md index 307c4ab..4aec39c 100644 --- a/doc/how-to-build.md +++ b/doc/how-to-build.md @@ -21,23 +21,25 @@ ## 1. Install dependencies The runtime environment for Apache APISIX requires Nginx and etcd. + So before installation, please follow the different operating systems [install Dependencies](install-dependencies.md). ## 2. Install Apache APISIX You can install Apache APISIX in a variety of ways, including source code packages, Docker, and Luarocks. -### Installation via source code +### Installation via source release candidate -You can download the Apache release package (Apache APISIX has not released the Apache release yet), or download the source code from GitHub: +You need to download the source release candidate first: ```shell -git clone g...@github.com:iresty/apisix.git -cd apisix +wget https://dist.apache.org/repos/dist/dev/incubator/apisix/0.9-RC1/apache-apisix-0.9-rc1-incubating-src.tar.gz +tar zxvf apache-apisix-0.9-rc1-incubating-src.tar.gz ``` -Install the Lua library that the runtime depends on: -``` +Install the Lua libraries that the runtime depends on: +```shell +cd apache-apisix-0.9-rc1-incubating-src make deps ``` diff --git a/doc/install-dependencies.md b/doc/install-dependencies.md index abf7703..1b351bc 100644 --- a/doc/install-dependencies.md +++ b/doc/install-dependencies.md @@ -18,19 +18,13 @@ --> # Install Dependencies -**NOTE** -- Apache APISIX currently only supports the v2 protocol storage to etcd, but the latest version of etcd (starting with 3.4) has turned off the v2 protocol by default. -You need to add `--enable-v2=true` to the startup parameter to enable the v2 protocol. The development of the v3 protocol supporting etcd has begun and will soon be available. - -- If you want use Tengine instead of OpenResty, please take a look at this installation step script [Install Tengine at Ubuntu](.travis/linux_tengine_runner.sh). - -- [Install Dependencies](#install-dependencies) - [CentOS 6](#centos-6) - [CentOS 7](#centos-7) - [Ubuntu 16.04 & 18.04](#ubuntu-1604--1804) - [Debian 9 & 10](#debian-9--10) - [Mac OSX](#mac-osx) - [How to compile the OpenResty](#how-to-compile-the-openresty) +- [Note](#note) CentOS 6 ======== @@ -135,3 +129,10 @@ Compiling OpenResty from source is very complicated, it's not easy to make it cl http://openresty.org/en/linux-packages.html +Note +==== +- Apache APISIX currently only supports the v2 protocol storage to etcd, but the latest version of etcd (starting with 3.4) has turned off the v2 protocol by default. + +You need to add `--enable-v2=true` to the startup parameter to enable the v2 protocol. The development of the v3 protocol supporting etcd has begun and will soon be available. + +- If you want use Tengine instead of OpenResty, please take a look at this installation step script [Install Tengine at Ubuntu](../.travis/linux_tengine_runner.sh).