docs: update installation guide #11160
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: nitishfy <justnitish06@gmail.com>
bzp2010
reviewed
Apr 16, 2024
kayx23
reviewed
Apr 17, 2024
Signed-off-by: nitishfy <justnitish06@gmail.com>
yzeng25
added
the
wait for update
Signed-off-by: nitishfy <justnitish06@gmail.com>
|
The linter issues have been fixed now |
kayx23
reviewed
Apr 24, 2024
Co-authored-by: Traky Deng <trakydeng@gmail.com>
kayx23
reviewed
Apr 28, 2024
| 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 master https://github.com/apache/apisix.git |
There was a problem hiding this comment.
kayx23
removed
the
wait for update
| @@ -271,9 +271,13 @@ You can configure your APISIX deployment in two ways: | |||
| apisix start -c <path to config file> | |||
| ``` | |||
|
|
|||
| APISIX will use the configurations added in this configuration file and will fall back to the default configuration if anything is not configured. | |||
| APISIX will use the configurations added in this configuration file and will fall back to the default configuration if anything is not configured. Generally, APISIX gets installed at `/usr/local/apisix/` directory, so your configuration file will be present at `/usr/local/apisix/conf/` path. | |||
There was a problem hiding this comment.
Suggested change
| APISIX will use the configurations added in this configuration file and will fall back to the default configuration if anything is not configured. Generally, APISIX gets installed at `/usr/local/apisix/` directory, so your configuration file will be present at `/usr/local/apisix/conf/` path. | |
| APISIX will use the configurations added in this configuration file and will fall back to the default configuration if anything is not configured. Generally, APISIX gets installed at `/usr/local/apisix/` directory, so the configuration file will be present at `/usr/local/apisix/conf/`. |
| APISIX will use the configurations added in this configuration file and will fall back to the default configuration if anything is not configured. | ||
| APISIX will use the configurations added in this configuration file and will fall back to the default configuration if anything is not configured. Generally, APISIX gets installed at `/usr/local/apisix/` directory, so your configuration file will be present at `/usr/local/apisix/conf/` path. | ||
|
|
||
| If you are unable to start APISIX and observe `Bind address already in use` in logs, it means the ports APISIX wants to use are already occupied by other running processes. Upon reviewing the use of these processes, you may decide to kill these processes or configure APISIX to use other non-conflicting ports. |
There was a problem hiding this comment.
I think this is pretty basic stuff, we can remove this.
|
|
||
| If you are unable to start APISIX and observe `Bind address already in use` in logs, it means the ports APISIX wants to use are already occupied by other running processes. Upon reviewing the use of these processes, you may decide to kill these processes or configure APISIX to use other non-conflicting ports. | ||
|
|
||
| Other way is to configure the default listening port to other available port on your local machine. |
|
Do we need this PR still? The most beneficial change here as it seems is to re-arrange etcd and APISIX installation order. Let's re-align what needs to be done here and move this effort forward. Thanks. |
|
🏓 |
yzeng25
added
stale
and removed
wait for update
|
The only change beneficial here is to adjust the order of APISIX and etcd installation. This can be addressed in a separate PR. Closing this PR as it is stagnant. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Generally, when you're trying to install the apisix from the installation guide, sometimes you come across the
Address Bind already in useerror logs when trying to start the apisix server. This is likely caused due to the unavailability of the port. Mostly, it happens if you've installed the apisix using docker due to which the ports get equipped. Hence, when you try installing the apisix locally, you get the error logs.This PR mentions this minor information with solution to this problem. There is a little refactoring of the docs as well. Since, it is required to install the
etcdfirst, the installation part of etcd is moved first, followed by installation ofapisixserver installation.Fixes # (issue)
Checklist