Skip to content

docs: update variable in building apisix from source #11640

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

Merged
merged 7 commits into from
Apr 15, 2025
Merged

docs: update variable in building apisix from source #11640

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6c101d0
correction
kayx23 Oct 12, 2024
50d76a0
install open resty
kayx23 Oct 12, 2024
3b1b0c5
update zh doc
kayx23 Oct 19, 2024
dc79a4c
update zh doc
kayx23 Oct 19, 2024
f7206ed
Merge branch 'master' into docs-apisix-build-patch
kayx23 Apr 8, 2025
d84278c
Update .ignore_words
kayx23 Apr 8, 2025
28ff026
Update .ignore_words
kayx23 Apr 8, 2025
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
2 changes: 2 additions & 0 deletions .ignore_words
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@ nd
hel
nulll
smove
aks
nin
Copy link
Member Author

@kayx23 kayx23 Apr 9, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed CI error on main here

11 changes: 7 additions & 4 deletions docs/en/latest/building-apisix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,24 +45,27 @@ To build and package APISIX for a specific platform, see [apisix-build-tools](ht

## Building APISIX from source

First of all, we need to specify the version `APISIX_VERSION` to be installed:
First of all, we need to specify the branch to be built:

```shell
APISIX_VERSION='3.12.0'
APISIX_BRANCH='release/3.11.0'
Copy link
Member Author

@kayx23 kayx23 Oct 12, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was a bit outdated

image image

APISIX_VERSION='release/3.12.0'
```

Then, you can run the following command to clone the APISIX source code from Github:

```shell
git clone --depth 1 --branch ${APISIX_VERSION} https://github.com/apache/apisix.git apisix-${APISIX_VERSION}
git clone --depth 1 --branch ${APISIX_BRANCH} https://github.com/apache/apisix.git apisix-${APISIX_BRANCH}
```

Alternatively, you can also download the source package from the [Downloads](https://apisix.apache.org/downloads/) page. Note that source packages here are not distributed with test cases.

Before installation, install [OpenResty](https://openresty.org/en/installation.html).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Otherwise:

image


Next, navigate to the directory, install dependencies, and build APISIX.

```shell
cd apisix-${APISIX_VERSION}
cd apisix-${APISIX_BRANCH}
make deps
make install
```
Expand Down
8 changes: 5 additions & 3 deletions docs/zh/latest/building-apisix.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,23 +47,25 @@ import TabItem from '@theme/TabItem';
首先，我们需要指定需要安装的版本`APISIX_VERSION`:

```shell
APISIX_VERSION='3.12.0'
APISIX_BRANCH='release/3.12.0'
```

然后，你可以运行以下命令，从 Github 克隆 APISIX 源码：

```shell
git clone --depth 1 --branch ${APISIX_VERSION} https://github.com/apache/apisix.git apisix-${APISIX_VERSION}
git clone --depth 1 --branch ${APISIX_BRANCH} https://github.com/apache/apisix.git apisix-${APISIX_BRANCH}
```

你可以从[下载页面](https://apisix.apache.org/downloads/)下载源码包。但是官网的源码包缺少测试用例，可能会对你后续操作产生困扰。

另外，你也可以在该页面找到 APISIX Dashboard 和 APISIX Ingress Controller 的源码包。

安装之前，请安装[OpenResty](https://openresty.org/en/installation.html)。

然后切换到 APISIX 源码的目录，创建依赖项并安装 APISIX，命令如下所示：

```shell
cd apisix-${APISIX_VERSION}
cd apisix-${APISIX_BRANCH}
make deps
make install
```
Expand Down
Loading