EdgelessDB 开源项目安装与使用指南

EdgelessDB 开源项目安装与使用指南

edgelessdb EdgelessDB is a MySQL-compatible database for confidential computing. It runs entirely inside a secure enclave and comes with advanced features for collaboration, recovery, and access control. 项目地址: https://gitcode.com/gh_mirrors/ed/edgelessdb

1. 目录结构及介绍

EdgelessDB 的仓库遵循了清晰的组织结构，以下是主要的目录和它们的简要说明：

• cmd/edb: 包含主命令行程序的源代码，用于启动和管理数据库实例。
• demo: 提供了一个示例或演示应用程序，帮助理解如何集成和使用EdgelessDB。
• docs: 文档目录，含有项目说明、概念指南等。
• edgedb: 可能是指向核心数据库逻辑的代码，尽管名称可能有误（应当是edgelesssys/edgelessdb中的某个特定部分，实际命名应以仓库为准）。
• src: 包含数据库的主要源代码，如存储引擎、业务逻辑等。
• .gitignore, CODE_OF_CONDUCT.md, CONTRIBUTING.md, Dockerfile, LICENSE, README.md, ROADMAP.md: 这些是常见的Git管理、贡献指导、许可协议、读我文件、路线图以及Docker构建文件，对于开发者了解项目政策、快速入门至关重要。
• build-base/Dockerfile: 特定于基础构建环境的Dockerfile，用于构建开发或测试环境。
• github/workflows: 包含GitHub Actions的工作流程定义，用于自动化构建、测试等。

2. 项目的启动文件介绍

EdgelessDB 的启动并不直接依赖于单一的“启动文件”，而是通过Docker容器化的方式进行部署。关键的启动指令展示在项目的说明中：

在SGX支持的系统上启动

docker run -t --name my-edb -p3306:3306 -p8080:8080 --device /dev/sgx_enclave --device /dev/sgx_provision ghcr.io/edgelesssys/edgelessdb-sgx-1gb

模拟模式下启动（适用于所有系统）

docker run -t --name my-edb -p3306:3306 -p8080:8080 -e OE_SIMULATION=1 ghcr.io/edgelesssys/edgelessdb-sgx-1gb

这里的命令展示了如何利用Docker容器来运行EdgelessDB服务，其中包含了必要的端口映射以及针对Intel SGX硬件的设备访问参数（或者模拟此环境的环境变量）。

3. 项目的配置文件介绍

EdgelessDB的核心配置很大程度上可以通过环境变量或在其提供的JSON格式的manifest文件来设置，该manifest文件可以看作是一种特殊的配置，定义了数据库的初始状态包括访问控制等安全属性。然而，具体的配置文件路径和详细配置项在提供的信息中没有明确指出。通常，在使用Docker部署时，高级配置可能通过挂载宿主机上的配置文件到容器内实现，或者通过环境变量直接设定。

为了调整数据库的行为，用户可能会在运行命令中通过 -e 参数指定环境变量来定制配置，例如控制端口、加密设置或启用特定功能。详细的配置选项通常会在项目的官方文档中列出，建议参考EdgelessDB的文档获取最新且详尽的配置指南。

请注意，由于该项目已归档且可能不再维护，最新的配置细节需查阅其归档版本的文档或历史记录。

edgelessdb EdgelessDB is a MySQL-compatible database for confidential computing. It runs entirely inside a secure enclave and comes with advanced features for collaboration, recovery, and access control. 项目地址: https://gitcode.com/gh_mirrors/ed/edgelessdb