{"id":14988062,"url":"https://github.com/apache/apisix-docker","last_synced_at":"2025-05-14T15:09:54.756Z","repository":{"id":37095598,"uuid":"190105197","full_name":"apache/apisix-docker","owner":"apache","description":"the docker for Apache APISIX","archived":false,"fork":false,"pushed_at":"2025-04-01T16:25:56.000Z","size":457,"stargazers_count":760,"open_issues_count":8,"forks_count":468,"subscribers_count":33,"default_branch":"master","last_synced_at":"2025-04-10T11:58:28.922Z","etag":null,"topics":["api","api-gateway","api-management","apisix","cloud-native","devops","docker","kubernetes","loadbalancing","microservices","reverse-proxy","serverless"],"latest_commit_sha":null,"homepage":"https://apisix.apache.org/","language":"Dockerfile","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-06-04T01:07:54.000Z","updated_at":"2025-04-10T02:26:57.000Z","dependencies_parsed_at":"2023-11-07T09:28:14.470Z","dependency_job_id":"547281f7-0058-421b-a36e-b0b0fcf7e4ce","html_url":"https://github.com/apache/apisix-docker","commit_stats":{"total_commits":276,"total_committers":82,"mean_commits":"3.3658536585365852","dds":0.8840579710144928,"last_synced_commit":"b9d1be0e56630051360e9b6f65f989e5a79d9be3"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fapisix-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fapisix-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fapisix-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fapisix-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/apisix-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248666929,"owners_count":21142345,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","api-gateway","api-management","apisix","cloud-native","devops","docker","kubernetes","loadbalancing","microservices","reverse-proxy","serverless"],"created_at":"2024-09-24T14:16:01.667Z","updated_at":"2025-05-14T15:09:54.748Z","avatar_url":"https://github.com/apache.png","language":"Dockerfile","readme":"## Roadmap\n\nRefer to [⚡️ Apache APISIX Projects Roadmap](https://github.com/apache/apisix/issues/12159)\n\n## What is Apache APISIX API Gateway\n\nApache APISIX is a dynamic, real-time, high-performance API Gateway.\n\nAPISIX API Gateway provides rich traffic management features such as load balancing, dynamic upstream, canary release, circuit breaking, authentication, observability, and more.\n\nYou can use APISIX API Gateway to handle traditional north-south traffic, as well as east-west traffic between services.\nAt present, APISIX has been used in various industries, including NASA, Tencent Cloud, EU Digital Factory, Airbus, Airwallex, iQIYI, etc.\n\n## How to run Apache APISIX\n\nApache APISIX supports stand-alone mode and also supports the use of etcd database as the configuration center.\n\n### How to run APISIX in stand-alone mode\n\nIn stand-alone mode, APISIX uses `apisix.yaml` as the configuration center to store routing, upstream, consumer and other information. After APISIX is started, it will load the `apisix.yaml` file regularly to update the corresponding configuration information.\n\nYou can start an APISIX container with stand-alone mode by the following command:\n\n```shell\ndocker run -d --name apache-apisix \\\n  -p 9080:9080 \\\n  -e APISIX_STAND_ALONE=true \\\n  apache/apisix\n```\n\nAdd Route and Plugin configuration to the running APISIX container:\n\n```shell\ndocker exec -i apache-apisix sh -c 'cat \u003e /usr/local/apisix/conf/apisix.yaml \u003c\u003c_EOC_\nroutes:\n  -\n    id: httpbin\n    uri: /*\n    upstream:\n      nodes:\n        \"httpbin.org\": 1\n      type: roundrobin\n    plugin_config_id: 1\n\nplugin_configs:\n  -\n    id: 1\n    plugins:\n      response-rewrite:\n        body: \"Hello APISIX\\n\"\n    desc: \"response-rewrite\"\n#END\n_EOC_'\n```\n\nTest example:\n\n```shell\ncurl http://127.0.0.1:9080/\n```\n\n```shell\nHello APISIX\n```\nIf you want to know more configuration examples, you can refer to [stand-alone](https://apisix.apache.org/docs/apisix/deployment-modes/#standalone).\n\n### How to run APISIX using etcd as configuration center\n\n#### Solution 1\n\nThe operation of APISIX also supports the use of etcd as the configuration center. Before starting the APISIX container, we need to start the etcd container with the following command, and specify the network used by the container as the host network. Make sure that all the required ports (default: `9080`, `9443` and `2379`) are available and not used by other system processes.\n\n1. Start etcd.\n\n```shell\ndocker run -d \\\n  --name etcd \\\n  --net host \\\n  -e ALLOW_NONE_AUTHENTICATION=yes \\\n  -e ETCD_ADVERTISE_CLIENT_URLS=http://127.0.0.1:2379 \\\n  bitnami/etcd:latest\n```\n\n2. Start APISIX.\n\n```shell\ndocker run -d \\\n  --name apache-apisix \\\n  --net host \\\n  apache/apisix\n```\n\n#### Solution 2\n\nBefore starting the APISIX container, we need to create a Docker virtual network and start the etcd container.\n\n1. Create a network and view the subnet address, then start etcd\n\n```shell\ndocker network create apisix-network --driver bridge \u0026\u0026 \\\ndocker network inspect -v apisix-network \u0026\u0026 \\\ndocker run -d --name etcd \\\n  --network apisix-network \\\n  -p 2379:2379 \\\n  -p 2380:2380 \\\n  -e ALLOW_NONE_AUTHENTICATION=yes \\\n  -e ETCD_ADVERTISE_CLIENT_URLS=http://127.0.0.1:2379 \\\n  bitnami/etcd:latest\n```\n\n2. View the return result of the previous step, we can see the `subnet` address. Create a APISIX configuration file in the current directory. You need to set `allow_admin` to the `subnet` address obtained in step1.\n\n```shell\ncat \u003c\u003c EOF \u003e $(pwd)/config.yaml\ndeployment:\n  role: traditional\n  role_traditional:\n    config_provider: etcd\n  admin:\n    allow_admin:\n      - 0.0.0.0/0  # Please set it to the subnet address you obtained.\n                  # If not set, by default all IP access is allowed.\n  etcd:\n    host:\n      - \"http://etcd:2379\"\n    prefix: \"/apisix\"\n    timeout: 30\nEOF\n```\n\n3. Start APISIX and reference the file created in the previous step.\n\n```shell\n docker run -d --name apache-apisix \\\n  --network apisix-network \\\n  -p 9080:9080 \\\n  -p 9180:9180 \\\n  -v $(pwd)/config.yaml:/usr/local/apisix/conf/config.yaml \\\n  apache/apisix\n```\n\n#### Test example\n\nCheck that APISIX is running properly by running the following command on the host.\n\n```\ncurl \"http://127.0.0.1:9180/apisix/admin/services/\" \\\n-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1'\n```\n\nThe response indicates that apisix is running successfully:\n\n```json\n{\n  \"total\": 0,\n  \"list\": []\n}\n```\n\nIf you want to modify the default configuration of APISIX, you can use the following command to enter the APISIX container and modify the configuration file `./conf/config.yaml`, which will take effect after reloading APISIX. For details, please refer to `./conf/config-default.yaml`.\n\n```shell\ndocker exec -it apache-apisix bash\n```\n\nFor more information, you can refer to the [APISIX Website](https://apisix.apache.org/) and [APISIX Documentation](https://apisix.apache.org/docs/apisix/getting-started). If you encounter problems during use, you can ask for help through [slack and the mailing list](https://apisix.apache.org/docs/general/join/).\n\n## Reload APISIX in a running container\n\nIf you change your custom configuration, you can reload APISIX (without downtime) by issuing.\n\n```shell\ndocker exec -it apache-apisix apisix reload\n```\nThis will run the `apisix reload` command in your container.\n\n## Kubernetes Ingress\n\nDuring the deployment process, in addition to the above operations, APISIX also derived the [`apisix-ingress-controller`](https://github.com/apache/apisix-ingress-controller), which can be deployed and used in the K8s environment more conveniently.\n\n## License\n\nLicensed under the Apache License, Version 2.0: [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)\n","funding_links":[],"categories":["Dockerfile"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fapisix-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fapisix-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fapisix-docker/lists"}