Update required environment variables documentation

未关闭 适合新手
#47 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
84/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
领域
documentation

调研方向

该 issue 指向 content/docs/environment-variables.mdx,具体是将 DATABASE_URL 描述为唯一必需变量的章节。阅读该章节,并核查 issue 中引用的 Umami 3.5.0 版本发布详情。更新必需变量文档,加入 APP_SECRET 及其生成指南;完成标准是文档不再声称 DATABASE_URL 是唯一必需变量。

由索引模型根据 Issue 内容生成。

描述

In Umami 3.5.0, a new variable became required, APP_SECRET. Previously it was only DATABASE_URL, documented as "This is the only required variable.":

https://github.com/umami-software/docs/blob/1460232d912a8f83402a7e2920b6e139963ec8f7/content/docs/environment-variables.mdx?plain=1#L60-L68

The documentation must be updated, since DATABASE_URL is no longer the only required variable, APP_SECRET is also required, everyone failing to provide that will have Umami error with:

⨯ Failed to preload entries: Error: An error occurred while loading instrumentation hook: APP_SECRET must be set to a non-empty secret and cannot use the default placeholder. Generate one with "openssl rand -hex 32" and set APP_SECRET in your environment or .env file.
    at <unknown> (.next/server/chunks/_1xzz-0tjw-9km._.js:1:6882)
    at Module.register (.next/server/chunks/_1xzz-0tjw-9km._.js:1:7070)
主要语言
MDX
星标
6
派生
34
PR 合并指标
30 天内没有已合并 PR

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

umami-software/docs 的其他 Issue

查看 umami-software/docs 的全部 Issue

相似的 Issue

更多 Documentation Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。