Skip to content

World's first open-source enterprise world model.

The database init script survives being sourced (#459)

WaylandYangd6c1fe27a7be
diff --git a/.env.example b/.env.example
index 77f5ad10..61ee3c22 100644
--- a/.env.example
+++ b/.env.example
@@ -23,6 +23,9 @@ UTOPIA_OPEN_REGISTRATION=true
# --- 以下几项由 docker-compose 读取,不是应用配置 ---
# 数据库口令。默认值只适合本机开发,公开部署务必改。
+# 只在数据卷首次初始化时写进库;之后再改这里只改了应用这一头,库里那份要用
+# docker compose exec db psql -U utopia -c "ALTER USER utopia PASSWORD '新口令'" 同步改,
+# 或者 docker compose --profile app down -v 从头来过(会删掉全部数据)。
# UTOPIA_DB_PASSWORD=utopia
# 数据库端口映射。默认只绑回环,仅供本地开发连接;宿主机端口被占时改这里。
# UTOPIA_DB_BIND=127.0.0.1:1517
diff --git a/README.md b/README.md
index 5b236d8b..f77ed307 100644
--- a/README.md
+++ b/README.md
@@ -80,6 +80,8 @@ docker compose --profile app up -d
Open http://localhost:1516 and register. The first account automatically becomes the administrator, and a public knowledge base readable by everyone is created at the same time. Before extracting business documents, configure the model endpoints (chat and embedding) under Administration → Models.
+The database password (`UTOPIA_DB_PASSWORD` in `.env`, default `utopia`) is applied when the data volume is first initialised. To change it on a running deployment, change it in the database as well — `docker compose exec db psql -U utopia -c "ALTER USER utopia PASSWORD '<new password>'"` — or start over with `docker compose --profile app down -v`, which deletes all data.
+
Or build from source:
```bash
diff --git a/README.zh-CN.md b/README.zh-CN.md
index d74bcbf2..6f6c3b8c 100644
--- a/README.zh-CN.md
+++ b/README.zh-CN.md
@@ -81,6 +81,8 @@ docker compose --profile app up -d
打开 http://localhost:1516 注册 —— 第一个账户自动成为管理员,同时系统会创建所有人可读的公共知识库。抽取业务文档前,请先在「管理 → 模型」里配置模型端点(chat 与 embedding)。
+数据库口令(`.env` 里的 `UTOPIA_DB_PASSWORD`,默认 `utopia`)在数据卷首次初始化时写入。已经跑起来的部署要改口令,得同时改库里那份——`docker compose exec db psql -U utopia -c "ALTER USER utopia PASSWORD '<新口令>'"`——或者 `docker compose --profile app down -v` 从头来过(会删掉全部数据)。
+
或者从源码构建:
```bash
diff --git a/crates/utopia-server/src/main.rs b/crates/utopia-server/src/main.rs
index 503420b0..026c3d96 100644
--- a/crates/utopia-server/src/main.rs
+++ b/crates/utopia-server/src/main.rs
@@ -63,6 +63,23 @@ fn payload_document_id(payload: &serde_json::Value) -> anyhow::Result<Uuid> {
.ok_or_else(|| anyhow::anyhow!("payload 缺少 document_id"))
}
+/// 连库失败里最常见的一种误会,当场说清楚(#456):compose 部署的数据库口令
+/// 只在数据卷首次初始化时生效,之后改 .env 只改了应用这一头。看日志的人
+/// 应该直接拿到那句该跑的命令,而不是来开 issue。
+fn explain_db_error(e: anyhow::Error) -> anyhow::Error {
+ if format!("{e:#}").contains("password authentication failed") {
+ e.context(
+ "The database rejected the password. In a docker compose deployment the password \
+ is set only when the data volume is first initialised, so changing UTOPIA_DB_PASSWORD \
+ later only changes what the app sends. Either set it in the database too — \
+ docker compose exec db psql -U utopia -c \"ALTER USER utopia PASSWORD '<new password>'\" \
+ — or start over with `docker compose --profile app down -v` (this deletes all data).",
+ )
+ } else {
+ e
+ }
+}
+
#[tokio::main]
async fn main() -> anyhow::Result<()> {
dotenvy::dotenv().ok();
@@ -80,7 +97,9 @@ async fn main() -> anyhow::Result<()> {
let migration_url = cfg.migration_url().to_string();
let separate_migration_role = cfg.migration_url.is_some();
{
- let mig_pool = utopia_store::db::connect(&migration_url, Some(2)).await?;
+ let mig_pool = utopia_store::db::connect(&migration_url, Some(2))
+ .await
+ .map_err(explain_db_error)?;
utopia_store::db::migrate(&mig_pool).await?;
mig_pool.close().await;
}
@@ -90,7 +109,9 @@ async fn main() -> anyhow::Result<()> {
tracing::info!("数据库迁移完成");
}
- let pool = utopia_store::db::connect(&cfg.database_url, cfg.db_max_connections).await?;
+ let pool = utopia_store::db::connect(&cfg.database_url, cfg.db_max_connections)
+ .await
+ .map_err(explain_db_error)?;
// 凭据封印钥匙:环境变量优先,否则数据目录下的 secret.key(首次启动生成)。
// **钥匙不进库**——库泄漏不等于凭据泄漏,是这一层的全部意义。空串按未设置处理,
diff --git a/docker/init-app-role.sh b/docker/init-app-role.sh
old mode 100644
new mode 100755
index dfdadaac..44d325c9
--- a/docker/init-app-role.sh
+++ b/docker/init-app-role.sh
@@ -4,22 +4,27 @@
#
# 权限不在这里给——由迁移 0031 授予,那样每次升级都能把新表补进来。
# 这里只负责角色本身存在,且拥有一个可登录的口令。
-set -euo pipefail
+#
+# **这个文件可能被 source,不是被执行。** Postgres 的 entrypoint 对没有执行位的
+# `*.sh` 用 `. "$f"` 读进它自己的 shell(Linux/macOS 上 clone 下来的文件就没有执行位;
+# Windows 的 Docker Desktop 把 bind mount 全显示成可执行,所以本机看不出来)。
+# 被 source 的脚本里一句 `exit 0` 退的是 entrypoint——数据库容器在 initdb 之后、
+# 真正起 postgres 之前以 0 退出,app 跟着报 "dependency db failed to start"(#456)。
+# 所以这里不写 exit,也不动 shell 选项(`set -u` 同样会改到 entrypoint)。
+set -e
-APP_PASSWORD="${UTOPIA_APP_DB_PASSWORD:-}"
-if [ -z "$APP_PASSWORD" ]; then
+if [ -z "${UTOPIA_APP_DB_PASSWORD:-}" ]; then
echo "未设置 UTOPIA_APP_DB_PASSWORD,跳过受限角色创建;应用将以 owner 身份运行。" >&2
- exit 0
-fi
-
-psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<SQL
+else
+ psql -v ON_ERROR_STOP=1 --username "$POSTGRES_USER" --dbname "$POSTGRES_DB" <<SQL
DO \$\$
BEGIN
IF NOT EXISTS (SELECT 1 FROM pg_roles WHERE rolname = 'utopia_app') THEN
- CREATE ROLE utopia_app LOGIN PASSWORD '${APP_PASSWORD}';
+ CREATE ROLE utopia_app LOGIN PASSWORD '${UTOPIA_APP_DB_PASSWORD}';
RAISE NOTICE '已创建受限角色 utopia_app';
END IF;
END
\$\$;
GRANT CONNECT ON DATABASE "$POSTGRES_DB" TO utopia_app;
SQL
+fi