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.

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

docs: Added default listening port intent #11530

Open
wants to merge 2 commits into
base: release/3.10
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions docs/en/latest/getting-started/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ curl -sL https://run.api7.ai/apisix/quickstart | sh

The script should start two Docker containers, _apisix-quickstart_ and _etcd_. APISIX uses etcd to save and synchronize configurations. Both the etcd and the APISIX use [**host**](https://docs.docker.com/network/host/) Docker network mode. That is, the APISIX can be accessed from local.

You can see that a number of ports are listened to by default, and the purpose of these default ports can be referenced:
[Port Reference](https://docs.api7.ai/apisix/networking/port-reference)
Copy link
Member

@kayx23 kayx23 Aug 29, 2024

Choose a reason for hiding this comment

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

This doc is only accurate if you install APISIX directly on host. The container started by the script only maps a few ports (details mentioned in the comment above). The mapping to host isn't exactly the same as the original (e.g. -p9090:9092) though I can't remember why.



You will see the following message once APISIX is ready:

```text
Expand Down
Loading