Copilot commented on code in PR #13222: URL: https://github.com/apache/apisix/pull/13222#discussion_r3077110028
########## docs/en/latest/getting-started/README.md: ########## @@ -1,73 +1,188 @@ --- -title: Get APISIX -description: This tutorial uses a script to quickly install Apache APISIX in your local environment and verify it through the Admin API. +title: Getting Started with Apache APISIX +description: Install and run Apache APISIX in minutes. This guide covers Docker-based setup, verification, basic route configuration, and next steps for production deployment. --- -<head> - <link rel="canonical" href="https://docs.api7.ai/apisix/getting-started/"; /> -</head> +Apache APISIX is an open-source, high-performance API gateway and AI gateway built for cloud-native architectures. It provides dynamic routing, load balancing, authentication, rate limiting, observability, and 100+ plugins for managing API traffic at scale. -> The Getting Started tutorials are contributed by [API7.ai](https://api7.ai/). +This guide walks you through installing APISIX locally, verifying the installation, and configuring your first API route. -Developed and donated by API7.ai, Apache APISIX is an open source, dynamic, scalable, and high-performance cloud native API gateway for all your APIs and microservices. It is a [top-level project](https://projects.apache.org/project.html?apisix) of the Apache Software Foundation. +## Prerequisites -You can use APISIX API Gateway as a traffic entrance to process all business data. It offers features including dynamic routing, dynamic upstream, dynamic certificates, A/B testing, canary release, blue-green deployment, limit rate, defense against malicious attacks, metrics, monitoring alarms, service observability, service governance, and more. +Before you begin, ensure you have the following installed: -This tutorial uses a script to quickly install [Apache APISIX](https://api7.ai/apisix) in your local environment and verifies the installation through the Admin API. +- [Docker](https://docs.docker.com/get-docker/) (version 20.10 or later) — used to run APISIX and etcd containers +- [curl](https://curl.se/) — used to send requests to APISIX for validation -## Prerequisite(s) +APISIX uses [etcd](https://etcd.io/) as its configuration store. The quickstart script handles etcd setup automatically. -The quickstart script relies on several components: +## Install APISIX -* [Docker](https://docs.docker.com/get-docker/) is used to install the containerized **etcd** and **APISIX**. -* [curl](https://curl.se/) is used to send requests to APISIX for validation. - -## Get APISIX - -:::caution - -To provide a better experience in this tutorial, the authorization of Admin API is switched off by default. Please turn on the authorization of Admin API in the production environment. - -::: -APISIX can be easily installed and started with the quickstart script: +APISIX can be installed with a single command using the quickstart script: ```shell 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. +This script starts two Docker containers: + +- **apisix-quickstart** — the APISIX gateway, listening on ports 9080 (HTTP) and 9443 (HTTPS) +- **etcd** — the configuration store + +Both containers use Docker [host network mode](https://docs.docker.com/network/host/), so APISIX is accessible directly from localhost. You will see the following message once APISIX is ready: ```text ✔ APISIX is ready! ``` -## Validate +:::caution -Once APISIX is running, you can use curl to interact with it. Send a simple HTTP request to validate if APISIX is working properly: +The quickstart script disables Admin API authorization by default for ease of use. Always enable Admin API authentication in production environments. See the [Admin API documentation](../admin-api.md) for details. + +::: + +### Alternative Installation Methods + +| Method | Use Case | Documentation | +|--------|----------|---------------| +| Docker Compose | Production-like local setup with custom configuration | [apisix-docker](https://github.com/apache/apisix-docker) | +| Helm Chart | Kubernetes deployment | [apisix-helm-chart](https://github.com/apache/apisix-helm-chart) | +| RPM Package | CentOS/RHEL bare-metal installation | [Installation Guide](../installation-guide.md) | +| Source Build | Development and custom builds | [How to Build](../building-apisix.md) | + +## Verify the Installation + +Send a request to confirm APISIX is running: ```shell curl "http://127.0.0.1:9080"; --head | grep Server ``` -If everything is ok, you will get the following response: +Expected response: ```text -Server: APISIX/Version +Server: APISIX/3.16.0 Review Comment: The "Expected response" example hard-codes `Server: APISIX/3.16.0`, but the quickstart script can install different APISIX versions over time. This will become incorrect/stale; please make the example version-agnostic (e.g., `APISIX/<version>`), or explain that the version number will vary. ```suggestion Server: APISIX/<version> ``` ########## docs/en/latest/getting-started/README.md: ########## @@ -1,73 +1,188 @@ --- -title: Get APISIX -description: This tutorial uses a script to quickly install Apache APISIX in your local environment and verify it through the Admin API. +title: Getting Started with Apache APISIX +description: Install and run Apache APISIX in minutes. This guide covers Docker-based setup, verification, basic route configuration, and next steps for production deployment. --- -<head> - <link rel="canonical" href="https://docs.api7.ai/apisix/getting-started/"; /> -</head> +Apache APISIX is an open-source, high-performance API gateway and AI gateway built for cloud-native architectures. It provides dynamic routing, load balancing, authentication, rate limiting, observability, and 100+ plugins for managing API traffic at scale. -> The Getting Started tutorials are contributed by [API7.ai](https://api7.ai/). +This guide walks you through installing APISIX locally, verifying the installation, and configuring your first API route. Review Comment: The Getting Started landing page no longer includes the `<head>` canonical link that existed before, and it’s now inconsistent with the other getting-started pages (which still define `rel="canonical"`). Since this PR is SEO-focused, consider restoring the canonical tag for this page (e.g., `https://docs.api7.ai/apisix/getting-started/`) to avoid duplicate-indexing/incorrect canonicalization. -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
