Update required environment variables documentation

オープン 初心者向け
#47 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

umami-software/docs のほかの issue

umami-software/docs の issue をすべて見る

似ている issue

Documentation の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。