diff --git a/.gitignore b/.gitignore index 7c31eca..a9e4618 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,4 @@ node_modules *.db data/ .idea +.htpasswd diff --git a/README.md b/README.md index 553728a..ca820b5 100644 --- a/README.md +++ b/README.md @@ -53,6 +53,33 @@ docker compose up -d The server will start, and you can access the application at `http://localhost:3002`. + + +
+Use Simple Password Authentication(Dex OIDC) + +```bash +# 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 -f docker-compose.dex.yml up -d +``` + +Change your password in `.env` file. + +```bash +# apt install apache2-utils +# Generate the password hash +echo YOUR_NEW_PASSWORD | htpasswd -BinC 10 admin | cut -d: -f2 > .htpasswd +# Update your .env file +sed -i 's/ADMIN_PASSWORD_HASH=.*/ADMIN_PASSWORD_HASH=$(cat .htpasswd)/' .env +``` + +
+ + ## Configuration Configuration is managed via environment variables. For a full template, see the `.env.example` section below. diff --git a/README_zh.md b/README_zh.md index 6e66c4e..53e7a4f 100644 --- a/README_zh.md +++ b/README_zh.md @@ -53,6 +53,32 @@ docker compose up -d 服务器将启动,您可以在 `http://localhost:3002` 访问该应用。 + +
+使用简单密码认证(Dex OIDC) + +```bash +# 示例 +git clone https://github.com/BetterAndBetterII/excalidraw-full.git +cd excalidraw-full +mv .env.example .env +touch ./excalidraw.db # 重要:初始化 SQLite 数据库,否则无法启动 +docker compose -f docker-compose.dex.yml up -d +``` + +修改 `.env` 文件中的密码。 + +```bash +# apt install apache2-utils +# 生成密码哈希 +echo YOUR_NEW_PASSWORD | htpasswd -BinC 10 admin | cut -d: -f2 > .htpasswd +# 更新 .env 文件 +sed -i 's/ADMIN_PASSWORD_HASH=.*/ADMIN_PASSWORD_HASH=$(cat .htpasswd)/' .env +``` + +
+ + ## 配置 配置通过环境变量进行管理。有关完整模板,请参阅下面的 `.env.example` 部分。