自架指南

把 Yuralume 裝在自己機器上

一行指令用 Docker 把整套服務跑起來。你的角色、記憶、對話都留在本機——自帶 LLM key,不計量、不回傳。

macOS / Linux
curl -fsSL https://yuralume.com/install.sh | bash
Windows · PowerShell
irm https://yuralume.com/install.ps1 | iex

需要 Docker · 約 2 GB 空間 · 大約一分鐘

看它跑起來

3 分鐘,從零到能聊

從一行指令到建好角色開始聊,全程實錄,沒有加速也沒有剪接。

第一次啟動

三步驟,從零到開始聊

1

先裝 Docker,再執行上面那行。它會下載 image 並把所有服務跑起來。

2

http://127.0.0.1:8012Admin → Provider Keys 填一組 LLM key。

3

建一個角色就能開始聊。記憶、行程、主動訊息都會從這裡開始運作。

唯一的手動步驟:Yuralume 是 BYOK(自帶金鑰),所以聊天至少要一組 LLM provider。到 Admin → Provider Keys 填(OpenAI、OpenRouter、本地模型——相容的都行);金鑰會加密存進你的資料庫,不會離開你的機器。內建的 fake provider 只是讓 app 能起來做煙霧測試,不會產生真正的對話。

需求

開始前需要什麼

Docker

macOS / Windows 用 Docker Desktop,Linux 用 Docker Engine。安裝器會檢查,沒裝就給你下載連結。

一組 LLM key

自帶即可——OpenAI、OpenRouter、本地 OpenAI 相容端點,相容的都行。裝完再填,不以明文存放。

約 2 GB 空間

放 image 加上你的資料。全部跑在容器裡,一行指令就能乾淨移除。

日常操作

啟動、更新、停止

所有指令都在安裝目錄(~/yuralume)裡執行。重跑安裝器也安全——會升級 image 並保留你的密鑰與資料。

看 log

docker compose logs -f app

更新到最新版

docker compose pull && docker compose up -d

停止(保留資料)

docker compose down

重置——刪除所有本機資料

docker compose down -v

跑起來的服務

服務Port(localhost)用途
app8012API + 網頁介面
postgres5554資料庫(named volume)
storage-local9012物件儲存(./uploads
whatsapp-sidecar32190選用的 WhatsApp 管道

每個 port 都只綁 127.0.0.1。要在區網或 VPS 對外開放,請放在反向代理後面,並在 .env.container 設好 APP_BASE_URL

進階

可調參數、手動安裝、prompt 調校

可調參數

變數預設意義
YURALUME_HOME~/yuralume安裝目錄
YURALUME_IMAGE_TAGlatest釘住某個發佈版本(例如 v0.1.0
YURALUME_INSTALL_BASEhttps://yuralume.com從哪裡抓 bundle

在跑那行指令之前,先在 shell 裡設定這些。

手動安裝(不用腳本)

mkdir -p ~/yuralume/prompts/tuned ~/yuralume/uploads && cd ~/yuralume
curl -fsSL https://yuralume.com/selfhost/docker-compose.yml -o docker-compose.yml
curl -fsSL https://yuralume.com/selfhost/env.example -o .env.container
# 編輯 .env.container:把每個 __...__ token 換成一段長亂數
COMPOSE_PROJECT_NAME=yuralume docker compose pull
COMPOSE_PROJECT_NAME=yuralume docker compose up -d

Prompt 調校

image 已內建 baseline prompt pack,所以這是選用的。要覆寫的話,把 .txt 檔放進 prompts/tuned/,用跟 baseline 一樣的相對路徑(例如 chat/instructions_footer.txt),在 .env.containerYURALUME_PROMPT_PACK_DIR=/app/prompts/tuned,再跑 docker compose up -d。啟動 log 就會出現 Prompt pack overlay loaded 並顯示覆寫的範本數。

疑難排解

如果看起來怪怪的

Docker 沒在跑

安裝器會停下並提示。開 Docker Desktop(等鯨魚圖示穩定),或 Linux 上 sudo systemctl start docker,再重跑。

App 沒回應 /health

第一次開機可能還在做 migration。用 docker compose pslogs -f app 看;一次性的 migrate 會在 app 啟動前先跑。

Port 被占用

有別的東西占了 8012/5554/9012/32190。把它停掉,或在 docker-compose.yml 改 host port 並同步 APP_BASE_URL

從頭來過

重跑那行會原地升級。想全清的話,docker compose down -v 會移除所有容器與本機資料。

安裝之前

想先玩玩看?

不用安裝就能玩 live demo,或進 Discord 找自架支援。