summaryrefslogtreecommitdiff
path: root/Documentation/source/operations/environment.rst
diff options
context:
space:
mode:
authorBertrand Yuan <me@bertyuan.com>2026-04-27 20:52:54 +0800
committerBertrand Yuan <me@bertyuan.com>2026-04-27 20:53:14 +0800
commitdbb5e791f0c228369605d126dd590962ebe1eddc (patch)
tree8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/operations/environment.rst
parent658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff)
docs: add comprehensive documentation for operations
This commit introduces a complete set of documentation files covering various aspects of the project, including environment setup, quality checks, command references, and architecture. The documentation is structured to assist developers and contributors in understanding the project's configuration, workflow, and best practices. Additionally, translations for Simplified and Traditional Chinese have been added to ensure accessibility for a wider audience. This enhances the overall usability and maintainability of the project. Signed-off-by: Bertrand Yuan <github@bertyuan.com>
Diffstat (limited to 'Documentation/source/operations/environment.rst')
-rw-r--r--Documentation/source/operations/environment.rst60
1 files changed, 60 insertions, 0 deletions
diff --git a/Documentation/source/operations/environment.rst b/Documentation/source/operations/environment.rst
new file mode 100644
index 0000000..64e5c8e
--- /dev/null
+++ b/Documentation/source/operations/environment.rst
@@ -0,0 +1,60 @@
+Environment
+===========
+
+Validation Source
+-----------------
+
+Environment validation is defined in ``src/env.js`` with
+``@t3-oss/env-nextjs`` and ``zod``. Empty strings are treated as undefined.
+
+Server Variables
+----------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 34 44
+
+ * - Variable
+ - Purpose
+ * - ``DATABASE_URL``
+ - PostgreSQL connection string.
+ * - ``RESEND_API_KEY``
+ - Resend API key. Must start with ``re_``.
+ * - ``RESEND_AUDIENCE_ID``
+ - Resend audience identifier.
+ * - ``EMAIL_FROM``
+ - Sender email address.
+ * - ``BETTER_AUTH_SECRET``
+ - better-auth secret. Required in production.
+ * - ``BETTER_AUTH_URL``
+ - Optional explicit auth base URL.
+ * - ``GOOGLE_CLIENT_ID`` / ``GOOGLE_CLIENT_SECRET``
+ - Google OAuth credentials.
+ * - ``GITHUB_CLIENT_ID`` / ``GITHUB_CLIENT_SECRET``
+ - GitHub OAuth credentials.
+
+Client Variables
+----------------
+
+.. list-table::
+ :header-rows: 1
+ :widths: 34 44
+
+ * - Variable
+ - Purpose
+ * - ``NEXT_PUBLIC_UMAMI_URL``
+ - Optional Umami analytics script URL.
+ * - ``NEXT_PUBLIC_UMAMI_WEBSITE_ID``
+ - Optional Umami site identifier.
+
+Skipping Validation
+-------------------
+
+``SKIP_ENV_VALIDATION=1`` can be used for limited local or container workflows.
+Do not rely on it for production builds.
+
+Production Notes
+----------------
+
+Production should use explicit, non-default secrets for Payload and better-auth
+and an explicit public site URL for canonical links and generated metadata.