<!-- # # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. # The ASF licenses this file to You under the Apache License, Version 2.0 # (the "License"); you may not use this file except in compliance with # the License. You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # -->

Apache APISIX Dashboard

<p align="center"> <a href="https://apisix.apache.org/">Website</a> • <a href="https://github.com/apache/apisix/tree/master/docs">Docs</a> • <a href="https://twitter.com/apacheapisix">Twitter</a> </p>

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

• The latest released version is 3.0.0 and is compatible with Apache APISIX 3.0.x.

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.

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

Demo

Online Playground

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

.
├── 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
• Rebuild docker image

Development

Pull requests are encouraged and always welcome. Pick an issue and help us out!

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