ghcr.io/ladybugdb/explorer:0.15.3

Ladybug Explorer

基于浏览器的Ladybug图数据库用户界面。

快速开始

Ladybug Explorer 是一个从已部署的 Docker 镜像启动的 Web 应用程序。有关如何安装和使用 Docker 的详细信息，请参考 Docker 文档。

下面我们展示两种不同的启动 Ladybug Explorer 的方式。这两种方式都可通过 http://localhost:8000 访问 Ladybug Explorer。如果启动成功，您应该会在 shell 中看到类似以下的日志：

Access mode: READ_WRITE
Version of Ladybug: v0.12.2
Deployed server started on port: 8000

选项 1：使用现有数据库

要访问现有的 Ladybug 数据库，您可以按以下方式将其路径挂载到 /database 目录：

docker run -p 8000:8000 \
-v {包含数据库文件的目录路径}:/database \
-e LBUG_FILE={数据库文件名} \
--rm ghcr.io/ladybugdb/explorer:latest

通过 -v {包含数据库文件的目录路径} 和 -e LBUG_FILE={数据库文件名} 将本地数据库文件挂载到 Docker，UI 中所做的更改在 UI 关闭后将持久化到本地数据库文件中。如果已挂载目录但未设置 LBUG_FILE 环境变量，Ladybug Explorer 将在挂载目录中查找名为 database.lbdb 的文件；如果该文件不存在，则在挂载目录中创建一个名为 database.lbdb 的新数据库文件。

--rm 标志告诉 docker，在关闭 docker 后应自动删除容器。

选项 2：使用带示例数据的空数据库启动

您也可以在不指定现有数据库的情况下启动 Ladybug Explorer。Ladybug Explorer 附带了捆绑数据集，您可以使用这些数据集探索 Ladybug 的基本功能。只需删除上述示例中的 -v 标志即可实现。如果未使用 -v 指定数据库路径，服务器将以空数据库启动。

docker run -p 8000:8000 --rm ghcr.io/ladybugdb/explorer:latest

点击右上角的 Datasets 选项卡，然后：(i) 从下拉菜单中选择一个您喜欢的捆绑数据集；(ii) 点击“Load Dataset”按钮将其加载到 Ladybug 中；(iii) 最后使用 Ladybug Explorer 进行探索。

开发（使用从源代码编译的 Ladybug）

技术栈

• 服务端 Node.js Express.js Ladybug
• Node.js
• Express.js
• Ladybug
• 客户端 Vue 3 Bootstrap 5 Monaco Editor G6
• Vue 3
• Bootstrap 5
• Monaco Editor

前提条件

• Node.js v20
• JDK 11+
• 用于构建 Ladybug 的工具链
• Git

环境设置

安装 Node.js 依赖

npm i

下载并编译 Ladybug

git submodule update --init --recursive
npm run build-lbug

生成语法文件

npm run generate-grammar

获取数据集

npm run fetch-datasets

运行开发服务器（带热重载）

env LBUG_DIR={directory containing ladybug database} LBUG_FILE={database file name} npm run serve

使用 ESLint 检查代码风格

npm run eslint

包含 -fix 可自动修复可修复的风格问题。

-fix

npm run eslint-fix

构建并部署生产环境

本地运行生产服务器

npm run build
env LBUG_DIR={directory containing ladybug database} LBUG_FILE={database file name} npm run serve-prod

使用 Docker 运行生产服务器

docker build -t ghcr.io/ladybugdb/explorer:latest .
docker run -p 8000:8000 \
-v {path to the directory containing the database file}:/database \
-e LBUG_FILE={database file name} \
--rm ghcr.io/ladybugdb/explorer:latest

部署

已配置 GitHub Actions 流水线，在推送到 master 分支时自动构建 Docker 镜像并部署到 GitHub Container Registry。该流水线将为 amd64 和 arm64 平台构建镜像。

amd64``arm64

贡献

我们欢迎对 Ladybug Explorer 的贡献。通过贡献 Ladybug Explorer，您同意您的贡献将根据 MIT 许可证进行许可。

docker run -p 8000:8000 \
-v {path to the directory containing the database file}:/database \
-e LBUG_FILE={database file name} \
--rm ghcr.io/ladybugdb/explorer:dev

dev标签每天更新，大约在Ladybug最新开发版本发布后两小时。

更新 Ladybug Explorer

初始启动后，当Ladybug Explorer发布新版本时，重新启动容器不会自动将本地镜像更新到最新版本。要将本地镜像更新到最新版本，可运行以下命令。

docker pull ghcr.io/ladybugdb/explorer:latest

拉取最新镜像后，可使用与之前相同的命令重新启动容器。

使用 Podman 启动

如果使用Podman而非Docker，可将上述命令中的docker替换为podman来启动Ladybug Explorer。但注意，默认情况下Podman会将默认用户账户映射到容器内的root用户。这在将本地数据库文件挂载到容器时可能导致权限问题。为避免此问题，可使用--userns=keep-id标志在容器内保留当前用户的用户ID，或为每个卷启用:U选项，将源卷的所有者和组更改为当前用户。

例如：

podman run -p 8000:8000 \
-v {path to the directory containing the database file}:/database:U \
-e LBUG_FILE={database file name} \
--rm ghcr.io/ladybugdb/explorer:latest

或

podman run -p 8000:8000 \
-v {path to the directory containing the database file}:/database \
-e LBUG_FILE={database file name} \
--userns=keep-id \
--rm ghcr.io/ladybugdb/explorer:latest

文档

有关启动和使用Ladybug Explorer的更多信息，请参阅文档。

开发（使用从源码编译的Ladybug）

技术栈

• 服务端
  • Node.js
  • Express.js
  • Ladybug
• 客户端
  • Vue 3
  • Bootstrap 5
  • https://microsoft.github.io/monaco-editor/
  • https://github.com/antvis/G6

前提条件

• Node.js v20
• JDK 11+
• Ladybug 构建工具链
• Git

环境设置

安装 Node.js 依赖

npm i

下载并编译 Ladybug

git submodule update --init --recursive
npm run build-lbug

生成语法文件

npm run generate-grammar

获取数据集

npm run fetch-datasets

运行开发服务器（带热重载）

env LBUG_DIR={包含ladybug数据库的目录} LBUG_FILE={数据库文件名} npm run serve

使用 ESLint 检查代码风格

npm run eslint

包含-fix可自动修正可修复的样式问题。

npm run eslint-fix

构建并部署生产环境

本地运行生产服务器

npm run build
env LBUG_DIR={包含ladybug数据库的目录} LBUG_FILE={数据库文件名} npm run serve-prod

使用 Docker 运行生产服务器

docker build -t ghcr.io/ladybugdb/explorer:latest .
docker run -p 8000:8000 \
-v {path to the directory containing the database file}:/database \
-e LBUG_FILE={database file name} \
--rm ghcr.io/ladybugdb/explorer:latest

部署

已配置GitHub Actions流水线，在推送到master分支时自动构建Docker镜像并部署到GitHub Container Registry。该流水线将为amd64和arm64平台构建镜像。

贡献

我们欢迎对Ladybug Explorer的贡献。通过贡献，您同意您的贡献将根据MIT许可证进行许可。