快速入门

在五分钟内在本地主机上运行 SQLly Embedded 包:启动桥接和示例应用,绑定许可证,添加配置文件,并以用户身份打开 SQLly。

这会在一台机器上运行完整的 SQLly Embedded 套件:桥接服务、引擎和示例管理应用。一切都保留在 localhost,而且你 sqlly.app 账户的免费试用就包含它。你需要 Node.js 20 或更新版本,以及一个 SQLly 可以访问的数据库。

运行它

  1. 下载并解压 适用于你所在平台的 SQLly Embedded 软件包来自 下载 (Linux x86-64 和 arm64,macOS Apple silicon,Windows x86-64 和 arm64)。在 Linux 上,解压用 tar -xzf 这样可执行文件就能保留其权限。

    若要用脚本下载,每个平台都有一个稳定的链接,该链接总是提供为该平台构建的最新软件包。如果发布版本未为你的平台构建,该链接会提供最近一次成功构建的版本。

    平台最新软件包
    Linux x86-64https://sqlly.app/download/embedded/latest/linux-amd64
    Linux arm64https://sqlly.app/download/embedded/latest/linux-arm64
    macOS Apple Siliconhttps://sqlly.app/download/embedded/latest/macos-arm64
    Windows x86-64https://sqlly.app/download/embedded/latest/windows-amd64
    Windows arm64https://sqlly.app/download/embedded/latest/windows-arm64
    curl -fsSL -o sqlly-embedded.tar.gz https://sqlly.app/download/embedded/latest/linux-amd64
    tar -xzf sqlly-embedded.tar.gz

    添加 /version 到任何一个(例如 /download/embedded/latest/linux-amd64/version),以 JSON 形式获取版本号和文件名,无需下载。

  2. 全部启动 从 sqlly-embedded 文件夹:

    macOS / Linux
    ./start-sample.sh
    Windows
    start-sample.cmd

    该脚本创建 .env 来自 .env.example,检查 Node.js,首次运行时生成共享管理令牌,启动桥接,等待其管理 API,并把示例应用跑在 http://127.0.0.1:8090.

  3. 以管理员身份登录 在 http://127.0.0.1:8090/admin 与 sqlly-admin / GoodLittlePiggy。(示例应用除非你更改密码,否则拒绝监听除环回地址之外的任何地址。)

  4. 关联一个许可证。 开 状态,点击 连接到 sqlly.app,然后 打开 sqlly.app 进行批准。登录 sqlly.app,核对代码与你管理页面上的一致,选一个许可证(试用版就行)并点击 批准。状态页会自行察觉并显示已关联的账户。这个安装现在有了自己的密钥,桥接器会跨重启保留它。

    更喜欢手动配置?在 你的 Embedded 页面 并设置 SQLLY_EMBEDDED_LICENSE_KEY in .env 在启动之前。离线计划将 SQLLY_EMBEDDED_LICENSE_FILE 改为指向已下载的文件。

  5. 创建配置文件。 配置文件 → 创建配置文件,给它起个名字,然后添加连接:选好引擎,填上服务器、数据库和登录信息。点击 测试 以验证桥接是否能够访问它;结果会显示在表单上,然后你再保存。然后 启动 会在新标签页中用该配置文件打开 SQLly。

  6. 添加用户。 用户 → 创建用户 使用用户名、密码和配置文件。打开 http://127.0.0.1:8090/ 在隐私窗口中,以该用户身份登录,然后点击 打开 SQLly。这就是你自己的用户会得到的体验。

回到 状态 你将看到该用户当前持有的座位。关闭他们的 SQLly 标签页即可释放。

设置在 .env

设置项它的用途
SQLLY_EMBEDDED_LICENSE_KEY一个已连接的许可证密钥(sqe_…)。留空则改为在管理页面里关联。
SQLLY_EMBEDDED_LICENSE_FILE离线许可证文件。不要同时设置两者。
SQLLY_EMBEDDED_MANAGE_TOKEN桥接与管理应用之间的共享密钥。在第一次运行时生成。
SQLLY_EMBEDDED_DOMAIN你的应用所使用的域名。在 localhost 上留空。设置后,会在首次签入时绑定一个尚未绑定的许可证。
SQLLY_EMBEDDED_PUBLIC_URL这 wss://…/proxy 反向代理之后浏览器所用的 URL。
SQLLY_EMBEDDED_STATE_DIR桥接存放配置文件、许可证缓存和已链接密钥的位置。

每个桥接标志都有一个环境变量;完整列表在 走向生产环境.

包中包含的内容

路径它是什么
bin/sqlly-bridgeSQLly 桥接器; sqlly-bridge embedded … 是此包使用的模式。
bin/sqlly-cli桥接程序为每个会话启动的引擎。请将它与桥接程序放在一起。
web/SQLly 浏览器构建: index.html, boot.js, spill-worker.js, sqlly_browser.js, sqlly_browser_bg.wasm, sqlly2.svg。平台无关。
sample-app/示例管理端和启动器应用。 server.js 负责路由, lib/bridge.js 一个完整的管理 API 客户端, lib/credentials.js 构建凭证文档。
start-sample.sh, start-sample.cmd一起启动桥接器和示例应用,配置读自 .env.

下一篇

拿走 示例应用导览 一起启动桥接和示例应用程序以查看每个屏幕,或者直接前往 构建你自己的应用.