/apisix-dashboard

Dashboard for Apache APISIX

Primary LanguageGoApache License 2.0Apache-2.0

Apache APISIX Dashboard (Experimental)

License Go Report Card

WebsiteDocsTwitter

  • The master version should be used with Apache APISIX master version.

  • The latest released version is 2.2 and should be used with Apache APISIX 2.1. It is not recommended to use with other Apache APISIX versions.

What's Apache APISIX Dashboard

The Apache APISIX Dashboard is designed to make it as easy as possible for users to operate Apache APISIX through a frontend interface.

The Dashboard is the control plane and performs all parameter checks; Apache APISIX mixes data and control planes and will evolve to a pure data plane.

This project includes Manager API, which will gradually replace Admin API in Apache APISIX.

Note: Currently the Dashboard does not have complete coverage of Apache APISIX features, visit here to view the milestones.

architecture

Project structure

.
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── Makefile
├── NOTICE
├── README.md
├── api
├── docs
├── licenses
└── web
  1. The api directory is used to store the Manager API source codes, which is used to manage etcd and provide APIs to the frontend interface.
  2. The web directory is used to store the frontend source codes.

Build then launch

Support the following ways currently.

Development

Please refer to the Development Guide.

User Guide

Please refer to the User Guide.

Contributing

Please refer to the Contribution Guide for a more detailed information.

FAQ

Please refer to the FAQ for more known issues.

License

Apache License 2.0