From b570b004d7a9fa4aafd8961bdc784b9938357942 Mon Sep 17 00:00:00 2001
From: Yuzhong Zhang <141388234+BetterAndBetterII@users.noreply.github.com>
Date: Sun, 6 Jul 2025 20:33:03 +0800
Subject: [PATCH] =?UTF-8?q?=E6=B7=BB=E5=8A=A0env=20example?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .env.example | 8 ++++++++
 README.md    | 1 +
 README_zh.md | 1 +
 3 files changed, 10 insertions(+)
 create mode 100644 .env.example

diff --git a/.env.example b/.env.example
new file mode 100644
index 0000000..891833b
--- /dev/null
+++ b/.env.example
@@ -0,0 +1,8 @@
+GITHUB_CLIENT_ID="xxxxxxxxxxxxxxxxxxx"
+GITHUB_CLIENT_SECRET="xxxxxxxxxxxxxx"
+GITHUB_REDIRECT_URL="http://localhost:3000/auth/github/callback" # 或者你部署后的回调地址
+JWT_SECRET="YOUR_SUPER_SECRET_RANDOM_STRING"
+
+OPENAI_API_KEY=sk-xxxxxxxxxxxxxx
+OPENAI_BASE_URL=https://xxxxxx.xxxxx # 不加/v1...
+STORAGE_TYPE=sqlite  # 支持memory，filesystem, kv, s3，具体看README
diff --git a/README.md b/README.md
index 6a82b08..0f2d2b6 100644
--- a/README.md
+++ b/README.md
@@ -46,6 +46,7 @@ One Click Docker run [Excalidraw-Full](https://github.com/BetterAndBetterII/exca
 # Example for Linux
 git clone https://github.com/BetterAndBetterII/excalidraw-full.git
 cd excalidraw-full
+mv .env.example .env
 touch ./excalidraw.db  # IMPORTANT: Initialize the SQLite DB, OTHERWISE IT WILL NOT START
 docker compose up -d
 ```
diff --git a/README_zh.md b/README_zh.md
index 51d99a9..9013552 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -46,6 +46,7 @@ Excalidraw Full 已经进化。它不再仅仅是 Excalidraw 的一个简单封
 # Linux 示例
 git clone https://github.com/BetterAndBetterII/excalidraw-full.git
 cd excalidraw-full
+mv .env.example .env
 touch ./excalidraw.db  # 重要：初始化 SQLite 数据库，否则无法启动
 docker compose up -d
 ```