快速入門

在五分鐘內於本機執行 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 在 .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.

下一個

來一趟 範例應用程式導覽 以檢視每個畫面,或直接前往 建立你自己的應用程式.