You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/02/24 12:28:57 UTC
[GitHub] [apisix] Chever-John opened a new pull request #6442: Docs: refactor document
Chever-John opened a new pull request #6442:
URL: https://github.com/apache/apisix/pull/6442
### What this PR does / why we need it:
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes an open issue, please link to the issue here. -->
I had some problems installing and configuring APISIX on my M1 macOS, and I happened to fix them. Documentation can be improved!
### Pre-submission checklist:
<!--
Please follow the PR manners:
1. Use Draft if the PR is not ready to be reviewed
2. Test is required for the feat/fix PR, unless you have a good reason
3. Doc is required for the feat PR
4. Use a new commit to resolve review instead of `push -f`
5. If you need to resolve merge conflicts after the PR is reviewed, please merge master but do not rebase
6. Use "request review" to notify the reviewer once you have resolved the review
7. Only reviewer can click "Resolve conversation" to mark the reviewer's review resolved
-->
* [ ] Did you explain what problem does this PR solve? Or what new features have been added?
* [ ] Have you added corresponding test cases?
* [ ] Have you modified the corresponding document?
* [ ] Is this PR backward compatible? **If it is not backward compatible, please discuss on the [mailing list](https://github.com/apache/apisix/tree/master#community) first**
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tokers commented on a change in pull request #6442: Docs: refactor document
Posted by GitBox <gi...@apache.org>.
tokers commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814408822
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,11 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
Review comment:
```suggestion
Solution: luarocks supports adding custom package filepaths to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
```
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,11 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
Review comment:
Since you mention the `brew`, let's also give an example to use `brew` to install openldap.
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,11 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
+ 2. Locate the 'openldap' local installation directory. Note that the default address for 'brew' in macOS for ARM architecture is '/opt/homebrew/cellar/', and macOS for x86 architecture defaults to '/usr/local/opt/';
Review comment:
Can we give a command to locate the directory? Or we may have to update this statement after the new macos release.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r815553076
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,18 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到 `openldap` 的本地安装目录。如果是 macOS 系统，并使用 `brew` 安装 `openldap` 的话，可以通过 `brew --prefix openldap` 命令找到本地安装目录。
Review comment:
OK, I will try.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r816775845
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,22 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
-
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ **注意**：如果使用 `make deps` 安装 `lualdap` 失败, 错误信息如： `Could not find header file for LDAP`，那么可以肯定这是一类关于安装依赖失败的问题。同理，遇到 `PCRE`、`openssl` 等依赖包安装失败问题，皆可以使用本方法解决问题。
+
+ 解决思路：根据 luarocks 支持添加自定义包到项目中的思想，使用第三方工具安装缺失的包，并将其地址添加到项目的配置文件中以识别。
Review comment:
I think that's a good idea.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
moonming commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r820572154
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports custom compile-time dependency directories(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the `luarocks`'s variables table. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
Got it. Please describe it more clearly, for example:
This is a common practice, we can do this under Mac, and other operating systems are similar
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: Docs: refactor document
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814414618
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,11 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
+ 2. Locate the 'openldap' local installation directory. Note that the default address for 'brew' in macOS for ARM architecture is '/opt/homebrew/cellar/', and macOS for x86 architecture defaults to '/usr/local/opt/';
Review comment:
Google searched, and there is indeed a command which you can use to find the installation package.
Thanks! modify the documentation now!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814441246
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,11 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
Review comment:
yeah, I think my document now is better.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
hf400159 commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r813849611
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
+ 3. 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`。
+
Review comment:
del
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tzssangglass commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r816710615
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,22 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
-
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ **注意**：如果使用 `make deps` 安装 `lualdap` 失败, 错误信息如： `Could not find header file for LDAP`，那么可以肯定这是一类关于安装依赖失败的问题。同理，遇到 `PCRE`、`openssl` 等依赖包安装失败问题，皆可以使用本方法解决问题。
+
+ 解决思路：根据 luarocks 支持添加自定义包到项目中的思想，使用第三方工具安装缺失的包，并将其地址添加到项目的配置文件中以识别。
Review comment:
```suggestion
解决思路：luarocks 支持自定义编译时依赖目录，使用第三方工具安装缺失的依赖，并将其文件路径添加到 luarocks 的变量表中。
```
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,22 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
-
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ **注意**：如果使用 `make deps` 安装 `lualdap` 失败, 错误信息如： `Could not find header file for LDAP`，那么可以肯定这是一类关于安装依赖失败的问题。同理，遇到 `PCRE`、`openssl` 等依赖包安装失败问题，皆可以使用本方法解决问题。
+
+ 解决思路：根据 luarocks 支持添加自定义包到项目中的思想，使用第三方工具安装缺失的包，并将其地址添加到项目的配置文件中以识别。
Review comment:
what about add link? https://github.com/luarocks/luarocks/wiki/Config-file-format#variables
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r817702540
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports adding custom packages to projects(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the project's configuration file. The method is applied to macOS, ubuntu, Centos and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
It may be not a good idea.
The advantages of sympol ``` cannot be fully reflected here.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] yzeng25 commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
yzeng25 commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r817366669
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,25 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
+ **注意**：使用 `make deps` 安装 `lualdap`、`PCRE`、`openssl` 等依赖包失败, 错误信息如： `Could not find header file for LDAP/PCRE/openssl`，可使用本方法解决。
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决思路：`luarocks` 支持添加自定义包到项目中（参考自[链接](https://github.com/luarocks/luarocks/wiki/Config-file-format))。使用第三方工具安装缺失的包，并将其安装目录添加到项目的配置文件中。方法适用于 macOS、ubuntu、Centos 等主流操作系统，此处暂给出 macOS 的具体解决步骤仅供参考。
+
+ macOS 具体解决步骤：
+
+ 1. 使用 `brew install openldap` 命令将 `openldap` 安装到本地;
Review comment:
```suggestion
1. 使用 `brew install openldap` 命令将 `openldap` 安装到本地；
```
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,25 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
+ **注意**：使用 `make deps` 安装 `lualdap`、`PCRE`、`openssl` 等依赖包失败, 错误信息如： `Could not find header file for LDAP/PCRE/openssl`，可使用本方法解决。
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决思路：`luarocks` 支持添加自定义包到项目中（参考自[链接](https://github.com/luarocks/luarocks/wiki/Config-file-format))。使用第三方工具安装缺失的包，并将其安装目录添加到项目的配置文件中。方法适用于 macOS、ubuntu、Centos 等主流操作系统，此处暂给出 macOS 的具体解决步骤仅供参考。
Review comment:
```suggestion
解决思路：`luarocks` 支持添加自定义包到项目中（参考自[luarocks Config file format](https://github.com/luarocks/luarocks/wiki/Config-file-format))。使用第三方工具安装缺失的包，并将其安装目录添加到项目的配置文件中。方法适用于 macOS、Ubuntu、CentOS 等主流操作系统，此处暂给出 macOS 的具体解决步骤仅供参考。
```
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,25 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
+ **注意**：使用 `make deps` 安装 `lualdap`、`PCRE`、`openssl` 等依赖包失败, 错误信息如： `Could not find header file for LDAP/PCRE/openssl`，可使用本方法解决。
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决思路：`luarocks` 支持添加自定义包到项目中（参考自[链接](https://github.com/luarocks/luarocks/wiki/Config-file-format))。使用第三方工具安装缺失的包，并将其安装目录添加到项目的配置文件中。方法适用于 macOS、ubuntu、Centos 等主流操作系统，此处暂给出 macOS 的具体解决步骤仅供参考。
+
+ macOS 具体解决步骤：
+
+ 1. 使用 `brew install openldap` 命令将 `openldap` 安装到本地;
+ 2. 使用 `brew --prefix openldap` 命令找到本地安装目录；
+ 3. 将路径添加到项目配置文件中（选择两种方法中的一种即可）：
+ 1. 方法一：通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`；
+ 2. 方法二：当然你也可以选择直接更改 luarocks 的默认配置文件，执行 `cat ~/.luarocks/config-5.1.lua` 命令，然后在文件中添加 `openldap` 的安装目录；
+ 3. 参考配置文件示例如下：
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
You might want to add ` ``` ` to represent them as a code block
```suggestion
```
variables = {
LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
}
```
```
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports adding custom packages to projects(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the project's configuration file. The method is applied to macOS, ubuntu, Centos and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
+
+ `/opt/homebrew/cellar/openldap/` is default path to install openldap on macOS(Apple Silicon) using brew.
+ `/usr/local/opt/openldap/` is default path to install openldap on macOS(Intel)using brew.
Review comment:
```suggestion
`/usr/local/opt/openldap/` is default path to install openldap on macOS(Intel) using brew.
```
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,25 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
+ **注意**：使用 `make deps` 安装 `lualdap`、`PCRE`、`openssl` 等依赖包失败, 错误信息如： `Could not find header file for LDAP/PCRE/openssl`，可使用本方法解决。
Review comment:
```suggestion
**注意**：使用 `make deps` 安装 `lualdap`、`PCRE`、`openssl` 等依赖包失败，错误信息如： `Could not find header file for LDAP/PCRE/openssl`，可使用本方法解决。
```
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports adding custom packages to projects(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the project's configuration file. The method is applied to macOS, ubuntu, Centos and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
You might want to add ` ``` ` to represent them as a code block
```suggestion
```
variables = {
LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
}
```
```
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports adding custom packages to projects(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the project's configuration file. The method is applied to macOS, ubuntu, Centos and other operating systems, and the specific solution for macOS are given here for reference only.
Review comment:
```suggestion
The general solution: `luarocks` supports adding custom packages to projects(from this [luarocks Config file format](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the project's configuration file. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
hf400159 commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814501361
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
+ 3. 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`。
+
Review comment:
You already deleted it.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
moonming commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r819193938
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports custom compile-time dependency directories(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the `luarocks`'s variables table. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
Is this a problem only for mac?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r816636240
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,20 +117,20 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
-
- Solution: luarocks supports adding custom package filepaths to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
- 1. Install `openldap` locally using tools including but not limited to 'brew';
- 2. Locate the 'openldap' local installation directory. If you are macOS and use `brew` to install `openldap`, you can find the local installation directory with the `brew --prefix openldap` command.
- 3. Manually set the `LDAP_DIR` variable via `luarocks config`, e.g. `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
- 4. Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file. Example as follows:
- ```lua
- variables = {
- LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
- LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
- }
- ```
- If you have similar problems installing other dependencies, you can refer to this solution as well.
+ **Note**: It will definitely be a problem set of dependency failed installation, If you fail to install with `make deps` and get an error message like `Could not find header file for LDAP`. Similarly, you can use this method to solve installation problems such as `Could not find header file for PCRE` or others.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`;
Review comment:
I think first method is a part of solution.
macOS needs it. Ubuntu also needs it.
If I separate it from solution, two problems will arise, solution for macOS will lose its integrity, and the luarocks approach will lose support(path of package) leading to a lose of persuasion.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tzssangglass commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r818262080
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -113,9 +113,22 @@ sudo yum install ./apisix/*.rpm
make install
```
-- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
-
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ **注意**：如果使用 `make deps` 安装 `lualdap` 失败, 错误信息如： `Could not find header file for LDAP`，那么可以肯定这是一类关于安装依赖失败的问题。同理，遇到 `PCRE`、`openssl` 等依赖包安装失败问题，皆可以使用本方法解决问题。
+
+ 解决思路：根据 luarocks 支持添加自定义包到项目中的思想，使用第三方工具安装缺失的包，并将其地址添加到项目的配置文件中以识别。
Review comment:
hi @Chever-John , PLAT suggested changes above
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
spacewander merged pull request #6442:
URL: https://github.com/apache/apisix/pull/6442
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: Docs: refactor document
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814398227
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
+ 3. 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`。
+
Review comment:
del what (´・ω・`)?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814503801
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
+ 3. 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`。
+
Review comment:
Yeah, thanks for your comment!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: Docs: refactor document
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814398711
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,10 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
+ 2. Find the location of your local installation of `openldap`. Note here that the default address of `brew` in the macOS of the M1 chip is `/opt/homebrew/cellar/`, and the previous macOS default is `/usr/local/opt/`;
Review comment:
OK
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] shuaijinchao commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
shuaijinchao commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r815552017
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,18 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到 `openldap` 的本地安装目录。如果是 macOS 系统，并使用 `brew` 安装 `openldap` 的话，可以通过 `brew --prefix openldap` 命令找到本地安装目录。
Review comment:
can you add and supplement the installation and search methods of `Ubuntu` and `CentOS` systems?
changes in the `how-to-build` documentation need cover as many mainstream operating systems as possible.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] shuaijinchao commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
shuaijinchao commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r816535374
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,20 +117,20 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
-
- Solution: luarocks supports adding custom package filepaths to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
- 1. Install `openldap` locally using tools including but not limited to 'brew';
- 2. Locate the 'openldap' local installation directory. If you are macOS and use `brew` to install `openldap`, you can find the local installation directory with the `brew --prefix openldap` command.
- 3. Manually set the `LDAP_DIR` variable via `luarocks config`, e.g. `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
- 4. Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file. Example as follows:
- ```lua
- variables = {
- LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
- LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
- }
- ```
- If you have similar problems installing other dependencies, you can refer to this solution as well.
+ **Note**: It will definitely be a problem set of dependency failed installation, If you fail to install with `make deps` and get an error message like `Could not find header file for LDAP`. Similarly, you can use this method to solve installation problems such as `Could not find header file for PCRE` or others.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`;
Review comment:
The first method is the original general solution. Is it suitable to integrate it into the macos system general solution?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] SkyeYoung commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
SkyeYoung commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814514751
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,11 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
Review comment:
@Chever-John I think, the conversation should be marked as resolved by the reviewer, but not you
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
moonming commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r815549086
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,18 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package filepaths to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
Review comment:
Why do other Lua dependencies not have this issue?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a change in pull request #6442: Docs: refactor document
Posted by GitBox <gi...@apache.org>.
hf400159 commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r813849611
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
+ 3. 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`。
+
Review comment:
del
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
+ 3. 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`。
Review comment:
```suggestion
3. 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量，比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`。
```
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
Review comment:
```suggestion
2. 找到 `openldap` 本地安装目录。需要注意，ARM 架构的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，x86 架构的 macOS 默认是 `/usr/local/opt/`;
```
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,10 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package addresses to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
+ 2. Find the location of your local installation of `openldap`. Note here that the default address of `brew` in the macOS of the M1 chip is `/opt/homebrew/cellar/`, and the previous macOS default is `/usr/local/opt/`;
Review comment:
Please refer to Chinese for modification.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r815552350
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,18 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package filepaths to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
Review comment:
This is not just a dependency issue.
I have the same problem with PCRE & openssl.
This is a general solution.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r815552350
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,18 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package filepaths to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
Review comment:
This is not just this dependency's issue.
I have had the same problem with PCRE & openssl.
This is a general solution.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
moonming commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r819432267
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports custom compile-time dependency directories(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the `luarocks`'s variables table. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
but the title is `Solution for macOS`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: Docs: refactor document
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r814398438
##########
File path: docs/zh/latest/how-to-build.md
##########
@@ -115,7 +115,11 @@ sudo yum install ./apisix/*.rpm
- 4.1 `make deps` 安装 `lualdap` 失败, 错误信息如: `Could not find header file for LDAP`
- 解决方案: 通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`
+ 解决方案: luarocks 支持添加自定义的包地址到项目中。通过 `luarocks config` 手动设置 `LDAP_DIR` 变量, 比如 `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`，你应该按照下面流程设置：
+ 1. 使用包括但不仅限于 `brew` 等工具将 `openldap` 安装到本地;
+ 2. 找到你本地安装 `openldap` 的位置。此处注意 M1 芯片的 macOS 中 `brew` 的默认地址是 `/opt/homebrew/cellar/`，之前的 macOS 默认是 `/usr/local/opt/`;
Review comment:
Thank you very much!
It helps me a lot!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r819200853
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports custom compile-time dependency directories(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the `luarocks`'s variables table. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
Review comment:
@moonming I think I made it clear over here.
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports custom compile-time dependency directories(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the `luarocks`'s variables table. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
There is also a sentence above the title: "for reference only".
Please check the complete changes before review
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports custom compile-time dependency directories(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the `luarocks`'s variables table. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
Review comment:
There is also a sentence above the title: for reference only.
@moonming
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] moonming commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
moonming commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r819193105
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -119,7 +119,18 @@ Follow the steps below to install Apache APISIX via the source release package.
**Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ Solution: luarocks supports adding custom package filepaths to the project. You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`. You should config as follows:
+ 1. Install `openldap` locally using tools including but not limited to 'brew';
Review comment:
So I think you should write a generic method
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] Chever-John commented on a change in pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
Chever-John commented on a change in pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#discussion_r819198786
##########
File path: docs/en/latest/how-to-build.md
##########
@@ -117,9 +117,25 @@ Follow the steps below to install Apache APISIX via the source release package.
make install
```
- **Note**: If `make deps` fails with "install `lualdap` failed" with an error like `Could not find header file for LDAP` try the solution below.
+ **Note**: If you fail to install dependency packages using `make deps` and get an error message like `Could not find header file for LDAP/PCRE/openssl`, you can use this general method to solve problems.
- Solution: Set `LDAP_DIR` with `luarocks config` manually. For example `luarocks config variables.LDAP_DIR /usr/local/opt/openldap/`.
+ The general solution: `luarocks` supports custom compile-time dependency directories(from this [link](https://github.com/luarocks/luarocks/wiki/Config-file-format)). Use a third-party tool to install the missing package and add its installation directory to the `luarocks`'s variables table. The method is applied to macOS, Ubuntu, CentOS and other operating systems, and the specific solution for macOS are given here for reference only.
+
+ Solution for macOS:
+
+ 1. Install `openldap` with `brew install openldap`;
+ 2. Locate installation directory with `brew --prefix openldap`;
+ 3. Add the path to the project configuration file(choose one of the following two methods):
+ 1. Solution A: You can set `LDAP_DIR` with `luarocks config` manually, for example `luarocks config variables.LDAP_DIR /opt/homebrew/cellar/openldap/2.6.1`;
+ 2. Solution B: Of course, you can also choose to change the default configuration file of luarocks directly, execute the 'cat ~/.luarocks/config-5.1.lua' command, and then add the installation directory of 'openldap' to the file;
+ 3. Example as follows:
+ variables = {
+ LDAP_DIR = "/opt/homebrew/cellar/openldap/2.6.1",
+ LDAP_INCDIR = "/opt/homebrew/cellar/openldap/2.6.1/include",
+ }
Review comment:
No, this is a general solution to the same kind of problem that we have in centos.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] leslie-tsang commented on pull request #6442: docs: refactor how-to-build.md
Posted by GitBox <gi...@apache.org>.
leslie-tsang commented on pull request #6442:
URL: https://github.com/apache/apisix/pull/6442#issuecomment-1061308715
Hello there, @Chever-John Plz don't force push during the <ins>review</ins>.
Commit history allows reviewers to see what has changed since the last review, which is <ins>useful</ins> for them.
A force-push could <ins>**ruin**</ins> the review experience.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org