apisix dashboard 本地启动

### 安装和配置 Apisix Dashboard 对于希望在 Windows 系统上安装和配置 Apisix Dashboard 的用户来说，由于官方文档主要针对 Linux 和 macOS 提供详细的指导说明[^1]，因此需要采取一些额外措施来适应 Windows 平台。 #### 使用 WSL 或 Docker 方案 考虑到原生支持有限，在 Windows 上推荐采用两种主流方案之一： - **WSL (Windows Subsystem for Linux)**：利用此功能可以在 Windows 中运行完整的 Linux 环境而无需修改主机操作系统。这使得能够按照标准流程执行基于 Unix/Linux 的命令集来进行 Apisix 及其仪表板的部署。 - **Docker**：另一种方法是借助容器化技术 Docker 来简化跨平台开发环境的一致性问题。通过拉取预构建镜像文件快速搭建起所需的全部依赖关系和服务实例。 #### 准备工作 无论选择哪种途径，都需要先完成如下准备工作： - 对于 WSL 用户而言，需确保已启用该特性并通过 Microsoft Store 获取合适的发行版； - 如果倾向于使用 Docker，则应前往官方网站下载适用于 Windows 版本的应用程序并依照指示完成设置过程； #### 配置 Etcd Etcd 是一个分布式键值存储系统，用于保存集群数据状态信息。为了使 Apisix 正常运作，必须事先准备好至少一个可用节点作为后端数据库连接目标。可以通过以下任一方式进行初始化操作： ```bash # 基于 Homebrew（仅限 Mac OS） brew install etcd # 利用 apt-get （Debian/Ubuntu 类 Linux 发行版本） sudo apt update && sudo apt install -y etcd # 从源码编译或直接获取二进制分发包... ``` 请注意上述指令并不完全兼容 Windows，默认情况下建议考虑将 Etcd 运行在一个独立虚拟机内或是同样依靠 Docker 实现隔离化的管理维护模式。 #### 启动 Apisix-Dashboard 一旦前置条件满足之后，就可以着手准备启动 Apisix-Dashboard 应用了。假设已经成功设置了 WSL/Docker，并且有可访问的 Etcd 资源存在的话，那么接下来的操作步骤大致相同： ##### 方法 A: 通过 Git Clone & 手动构建 如果决定走传统路线即手动克隆仓库再自行打包发布的方式，请参照下面给出的具体做法： ```bash git clone https://github.com/apache/apisix-dashboard.git $HOME/apisix-dashboard cd $HOME/apisix-dashboard make build docker-compose up -d --build ``` 以上命令序列会依次完成项目检出、本地资源整理以及最终的服务上线动作。当然实际执行过程中可能还需要根据提示调整部分参数选项以适配特定场景下的需求差异。 ##### 方法 B: 单纯运用 Docker Compose 文件 更简便的办法莫过于直接调用预先编写好的 `docker-compose.yml` 描述模板一键搞定整个架构体系的建立： ```yaml version: '3' services: apisix: image: apache/apisix:latest-alpine ports: - "9080:9080" - "9443:9443" environment: APISIX_ADMIN_KEY: edd1c9f034335f136f87ad84b625c8f1 ETCD_HOSTS: http://${ETCD_IP}:2379 dashboard: image: apachecn/apisix-dashboard:latest depends_on: - apisix ports: - "9000:9000" ``` 只需简单替换 `${ETCD_IP}` 处的内容指向真实的 Etcd 地址即可实现无缝衔接的效果。随后只要正常启动关联容器就能立即体验到图形界面带来的便捷之处了。

### 编译 Apisix-Dashboard 的准备工作 对于 Ubuntu 操作系统的开发者来说，在准备编译 Apisix-Dashboard 源代码之前，确保操作环境已经正确设置是非常重要的。这通常涉及到更新现有的包列表以及安装必要的构建工具和依赖项。 #### 更新现有包列表 为了使系统能够获取最新的软件包信息，建议先执行如下命令刷新本地的 APT 数据库[^3]: ```bash sudo apt-get update ``` #### 安装基础开发工具链 接下来，安装一系列用于支持 C++ 开发的基础工具链，这些工具同样适用于 Lua 和其他语言项目，如 Apisix-Dashboard 所需的一些通用组件可以通过以下命令一次性完成安装: ```bash sudo apt-get install build-essential curl git make unzip -y ``` ### 获取并编译 Apisix-Dashboard 源码 #### 克隆官方 Git 仓库 通过 GitHub 上托管的官方存储库克隆最新版本的 Apisix-Dashboard 到本地计算机: ```bash git clone https://github.com/apache/apisix-dashboard.git cd apisix-dashboard ``` #### 设置 Go 环境 (如果适用) Apisix-Dashboard 使用 Go 进行部分功能实现，因此可能需要预先准备好 Go SDK 并将其路径加入到 PATH 中。可以按照官方文档指引下载适合当前平台架构的稳定版 Go 发布包，并解压至 `/usr/local` 或者个人偏好位置之后，编辑 `~/.profile`, `~/.bashrc` 文件添加相应环境变量定义: ```bash export GOROOT=/usr/local/go export GOPATH=$HOME/go export PATH=$PATH:$GOROOT/bin:$GOPATH/bin source ~/.profile # or source ~/.bashrc depending on your shell configuration ``` #### 安装 Node.js 及其相关模块 由于前端界面由 React 构建而成，所以还需要安装 Node.js 来处理 JavaScript 相关的任务。推荐采用 nvm(Node Version Manager) 方式来进行多版本管理以便灵活切换不同项目的特定需求： ```bash curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash nvm install node # Install latest stable version of Node.js npm install -g yarn # Optionally use Yarn as package manager instead of npm default one. ``` #### 编译与打包 进入 apises-dashbord 工程根目录后，依据 README.md 提供的具体指导运行相应的脚本来启动整个编译流程。一般情况下会包含以下几个主要阶段的操作指令集： - 初始化子模块（如果有） - 安装依赖关系 - 构建应用程序及其资源文件 - 创建可分发的产品形式 ```bash make setup # Prepare the environment and fetch dependencies make dev # Build for development mode with hot-reload enabled # For production release builds, consider using following command after testing thoroughly under 'dev' profile above make prod # Optimize assets and prepare final distributable artifacts ready to deploy into real-world usage scenarios ```