https://github.com/apache/apisix-dashboard
Dashboard for Apache APISIX
https://github.com/apache/apisix-dashboard
api api-management apisix dashboard devops
Last synced: 23 days ago
JSON representation
Dashboard for Apache APISIX
- Host: GitHub
- URL: https://github.com/apache/apisix-dashboard
- Owner: apache
- License: apache-2.0
- Created: 2019-07-01T09:50:11.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T09:42:05.000Z (8 months ago)
- Last Synced: 2025-04-11T01:51:24.684Z (23 days ago)
- Topics: api, api-management, apisix, dashboard, devops
- Language: Go
- Homepage: https://apisix.apache.org/
- Size: 15.1 MB
- Stars: 1,058
- Watchers: 48
- Forks: 552
- Open Issues: 345
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Apache APISIX Dashboard
[](https://github.com/apache/apisix-dashboard/blob/master/LICENSE)
[](https://goreportcard.com/report/github.com/apache/apisix-dashboard)
[](https://hub.docker.com/r/apache/apisix-dashboard)
[](https://www.cypress.io/)
[](https://apisix.apache.org/slack)
- The master version should be used with Apache APISIX master version.
- The latest released version is [3.0.0](https://apisix.apache.org/downloads/) and is compatible with [Apache APISIX 3.0.x](https://apisix.apache.org/downloads/).
## What's Apache APISIX Dashboard
The Apache APISIX Dashboard is designed to make it as easy as possible for users to operate [Apache APISIX](https://github.com/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.
Note: Currently the Dashboard does not have complete coverage of Apache APISIX features, [visit here](https://github.com/apache/apisix-dashboard/milestones) to view the milestones.
## Demo
[Online Playground](https://apisix-dashboard.apiseven.com/)
```text
Username: admin
Password: admin
```
## Works with APISIX Ingress Controller
Currently, APISIX Ingress Controller automatically manipulates some APISIX resources, which is not very compatible with APISIX Dashboard. In addition, users should not modify resources labeled `managed-by: apisix-ingress-controllers` via APISIX Dashboard.
## Project structure
```text
.
├── 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.
- [Docker, RPM, Source Codes](./docs/en/latest/install.md)
- [Rebuild docker image](./docs/en/latest/deploy-with-docker.md)
## Development
Pull requests are encouraged and always welcome. [Pick an issue](https://github.com/apache/apisix-dashboard/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) and help us out!
Please refer to the [Development Guide](./docs/en/latest/develop.md).
## User Guide
Please refer to the [User Guide](./docs/en/latest/USER_GUIDE.md).
## Contributing
Please refer to the [Contribution Guide](./CONTRIBUTING.md) for a more detailed information.
## FAQ
Please refer to the [FAQ](./docs/en/latest/FAQ.md) for more known issues.
## License
[Apache License 2.0](./LICENSE)