Skip to content

Self-hosted personal gallery application with online photo management and albums, supporting Live/Motion Photos, EXIF parsing, geolocation recognition, and an explore map.

feat!(auth): add GitHub OAuth configuration options and update related documentation

HoshinoSuzumif9e581d3a5be
diff --git a/.env.example b/.env.example
index 324180b9..40c5542f 100644
--- a/.env.example
+++ b/.env.example
@@ -33,6 +33,7 @@ NUXT_PROVIDER_S3_CDN_URL=
NUXT_SESSION_PASSWORD=
# GitHub OAuth app credentials
+NUXT_PUBLIC_OAUTH_GITHUB_ENABLED=false
NUXT_OAUTH_GITHUB_CLIENT_ID=
NUXT_OAUTH_GITHUB_CLIENT_SECRET=
diff --git a/README.md b/README.md
index 403418e0..bb3a9d98 100644
--- a/README.md
+++ b/README.md
@@ -78,6 +78,7 @@ NUXT_PROVIDER_S3_CDN_URL=
NUXT_SESSION_PASSWORD=
# GitHub OAuth
+NUXT_PUBLIC_OAUTH_GITHUB_ENABLED=false
NUXT_OAUTH_GITHUB_CLIENT_ID=
NUXT_OAUTH_GITHUB_CLIENT_SECRET=
```
@@ -116,28 +117,29 @@ docker-compose up -d
### Environment Variables
-| Variable | Description | Default | Required |
-| :--------------------------------- | :------------------------------------- | :---------- | :--------------------------------------------------- |
-| CFRAME_ADMIN_EMAIL | Email of the initial admin user | None | Yes, must be the GitHub account email used for login |
-| CFRAME_ADMIN_NAME | Username of the initial admin | Chronoframe | No |
-| CFRAME_ADMIN_PASSWORD | Password of the initial admin | CF1234@! | No |
-| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |
-| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |
-| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |
-| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |
-| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token for map service | None | Yes |
-| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token for location info | None | No |
-| NUXT_STORAGE_PROVIDER | Storage provider (s3, github, local) | s3 | Yes |
-| NUXT_PROVIDER_S3_ENDPOINT | S3 endpoint | None | Required if provider is s3 |
-| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required if provider is s3 |
-| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required if provider is s3 |
-| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required if provider is s3 |
-| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required if provider is s3 |
-| NUXT_PROVIDER_S3_PREFIX | S3 object prefix | photos/ | No |
-| NUXT_PROVIDER_S3_CDN_URL | S3 CDN URL | None | No |
-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | Yes |
-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | Yes |
-| NUXT_SESSION_PASSWORD | Session encryption password (32 chars) | None | Yes |
+| Variable | Description | Default | Required |
+| :--------------------------------- | :------------------------------------- | :---------- | :------------------------------ |
+| CFRAME_ADMIN_EMAIL | Email of the initial admin user | None | Yes |
+| CFRAME_ADMIN_NAME | Username of the initial admin | Chronoframe | No |
+| CFRAME_ADMIN_PASSWORD | Password of the initial admin | CF1234@! | No |
+| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |
+| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |
+| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |
+| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |
+| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token for map service | None | Yes |
+| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token for location info | None | No |
+| NUXT_STORAGE_PROVIDER | Storage provider (s3, github, local) | s3 | Yes |
+| NUXT_PROVIDER_S3_ENDPOINT | S3 endpoint | None | Required if provider is s3 |
+| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required if provider is s3 |
+| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required if provider is s3 |
+| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required if provider is s3 |
+| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required if provider is s3 |
+| NUXT_PROVIDER_S3_PREFIX | S3 object prefix | photos/ | No |
+| NUXT_PROVIDER_S3_CDN_URL | S3 CDN URL | None | No |
+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | false | No |
+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |
+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |
+| NUXT_SESSION_PASSWORD | Session encryption password (32 chars) | None | Yes |
## 📖 User Guide
diff --git a/README_zh.md b/README_zh.md
index 57608391..889c4b2e 100644
--- a/README_zh.md
+++ b/README_zh.md
@@ -3,7 +3,10 @@
<p align="center">
<img src="public/favicon.svg" alt="Chronoframe Logo" width="192">
<br/>
- <img src="https://img.shields.io/badge/License-MIT-green.svg" alt="License">
+ <img src="https://i| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |
+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |
+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |
+| NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |hields.io/badge/License-MIT-green.svg" alt="License">
<img src="https://img.shields.io/badge/Nuxt-4.0+-00DC82.svg" alt="Nuxt">
<img src="https://img.shields.io/badge/TypeScript-5.0+-3178C6.svg" alt="TypeScript">
<img src="https://img.shields.io/badge/WebGL-2.0-FF6600.svg" alt="WebGL">
@@ -118,7 +121,7 @@ docker-compose up -d
| 环境变量 | 说明 | 默认值 | 必需 |
| :--------------------------------- | :--------------------------------------------- | :---------- | :---------------------------------------- |
-| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | 无 | 是,填写登录使用的 GitHub 账户的邮箱 |
+| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | 无 | 是 |
| CFRAME_ADMIN_NAME | 初始管理员用户的用户名 | Chronoframe | 否 |
| CFRAME_ADMIN_PASSWORD | 初始管理员用户的密码 | CF1234@! | 否 |
| NUXT_PUBLIC_APP_TITLE | 应用标题 | ChronoFrame | 否 |
@@ -135,8 +138,9 @@ docker-compose up -d
| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 访问密钥 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
| NUXT_PROVIDER_S3_PREFIX | S3 存储前缀 | photos/ | 否 |
| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |
-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 是 |
-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 是 |
+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | 是否启用 GitHub OAuth 登录 | false | 否 |
+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |
+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |
| NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |
## 📖 使用指南
diff --git a/app/components/ui/AuthForm.vue b/app/components/ui/AuthForm.vue
index de8d2274..110ef5e1 100644
--- a/app/components/ui/AuthForm.vue
+++ b/app/components/ui/AuthForm.vue
@@ -7,7 +7,7 @@ defineProps<{
icon?: string
title?: string
subtitle?: string
- providers?: Array<ButtonProps>
+ providers?: Array<ButtonProps | false | undefined>
class?: string
loading?: boolean
}>()
@@ -74,18 +74,18 @@ const onSubmit = async (event: FormSubmitEvent<Schema>) => {
</div>
<div class="flex flex-col gap-4">
<div
- v-if="providers && providers.length > 0"
+ v-if="providers && providers.filter((item) => !!item).length > 0"
:class="providers.length > 3 ? 'space-y-2' : 'flex items-center gap-2'"
>
<UButton
- v-for="provider in providers"
+ v-for="provider in providers.filter((item) => !!item)"
:key="provider.icon"
v-bind="provider"
:loading="loading"
/>
</div>
<USeparator
- v-if="providers && providers.length > 0"
+ v-if="providers && providers.filter((item) => !!item).length > 0"
:label="$t('auth.form.action.or')"
/>
<UForm
diff --git a/app/pages/signin.vue b/app/pages/signin.vue
index fc72149a..e6616d0e 100644
--- a/app/pages/signin.vue
+++ b/app/pages/signin.vue
@@ -4,6 +4,7 @@ useHead({
})
const { fetch: fetchUserSession } = useUserSession()
+const config = useRuntimeConfig()
const toast = useToast()
const route = useRoute()
const router = useRouter()
@@ -46,7 +47,7 @@ const onAuthSubmit = async (event: any) => {
:subtitle="$t('auth.form.signin.subtitle')"
:loading="isLoading"
:providers="[
- {
+ config.public.OAUTH_GITHUB_ENABLED && {
icon: 'tabler:brand-github',
size: 'lg',
color: 'neutral',
diff --git a/docs/guide/configuration.md b/docs/guide/configuration.md
index 826f7c35..4428c66a 100644
--- a/docs/guide/configuration.md
+++ b/docs/guide/configuration.md
@@ -4,26 +4,27 @@ Whether using Docker or Docker Compose (.env) deployment, configuration is done
## Environment Variables List
-| Environment Variable | Description | Default | Required |
-| ---------------------------------- | --------------------------------------------------------------- | ----------- | ---------------------------------------------------- |
-| CFRAME_ADMIN_EMAIL | Initial admin user email | None | Yes, fill in the GitHub account email used for login |
-| CFRAME_ADMIN_NAME | Initial admin username | Chronoframe | No |
-| CFRAME_ADMIN_PASSWORD | Initial admin user password | CF1234@! | No |
-| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |
-| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |
-| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |
-| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |
-| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token (URL restricted), for map services | None | Yes |
-| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token (no URL restriction), for location services | None | No |
-| NUXT_STORAGE_PROVIDER | Storage provider, supports `s3`, `github`, `local` | `s3` | Yes |
-| NUXT_PROVIDER_S3_ENDPOINT | S3 compatible storage service endpoint | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
-| NUXT_PROVIDER_S3_PREFIX | S3 storage prefix | photos/ | No |
-| NUXT_PROVIDER_S3_CDN_URL | S3 storage CDN URL | None | No |
-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | Yes |
-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | Yes |
-| NUXT_SESSION_PASSWORD | Password for encrypting sessions, 32-character random string | None | Yes |
-| NUXT_PUBLIC_GTAG_ID | Google Analytics Tracking ID | None | No |
+| Environment Variable | Description | Default | Required |
+| ---------------------------------- | --------------------------------------------------------------- | ----------- | --------------------------------------------- |
+| CFRAME_ADMIN_EMAIL | Initial admin user email | None | Yes |
+| CFRAME_ADMIN_NAME | Initial admin username | Chronoframe | No |
+| CFRAME_ADMIN_PASSWORD | Initial admin user password | CF1234@! | No |
+| NUXT_PUBLIC_APP_TITLE | Application title | ChronoFrame | No |
+| NUXT_PUBLIC_APP_SLOGAN | Application slogan | None | No |
+| NUXT_PUBLIC_APP_AUTHOR | Application author | None | No |
+| NUXT_PUBLIC_APP_AVATAR_URL | Application avatar URL | None | No |
+| NUXT_PUBLIC_MAPBOX_ACCESS_TOKEN | Mapbox access token (URL restricted), for map services | None | Yes |
+| NUXT_MAPBOX_ACCESS_TOKEN | Mapbox access token (no URL restriction), for location services | None | No |
+| NUXT_STORAGE_PROVIDER | Storage provider, supports `s3`, `github`, `local` | `s3` | Yes |
+| NUXT_PROVIDER_S3_ENDPOINT | S3 compatible storage service endpoint | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_BUCKET | S3 bucket name | chronoframe | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_REGION | S3 bucket region | auto | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_ACCESS_KEY_ID | S3 access key ID | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 secret access key | None | Required when `NUXT_STORAGE_PROVIDER` is `s3` |
+| NUXT_PROVIDER_S3_PREFIX | S3 storage prefix | photos/ | No |
+| NUXT_PROVIDER_S3_CDN_URL | S3 storage CDN URL | None | No |
+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | Enable GitHub OAuth login | false | No |
+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth app Client ID | None | No (optional, for GitHub login) |
+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth app Client Secret | None | No (optional, for GitHub login) |
+| NUXT_SESSION_PASSWORD | Password for encrypting sessions, 32-character random string | None | Yes |
+| NUXT_PUBLIC_GTAG_ID | Google Analytics Tracking ID | None | No |
diff --git a/docs/guide/getting-started.md b/docs/guide/getting-started.md
index f8552bb9..3cdd00cb 100644
--- a/docs/guide/getting-started.md
+++ b/docs/guide/getting-started.md
@@ -22,6 +22,9 @@ Documentation is being written, some feature documentation is not yet complete.
:::tip
When creating the OAuth app, the `Authorization callback URL` should be set to `http(s)://<your-domain>/api/auth/github`.
:::
+ :::info
+ GitHub OAuth credentials are **optional**. If not configured, you can still use the default admin account to log in.
+ :::
## Quick Deployment
diff --git a/docs/zh/guide/configuration.md b/docs/zh/guide/configuration.md
index 9e6fd2aa..18290e02 100644
--- a/docs/zh/guide/configuration.md
+++ b/docs/zh/guide/configuration.md
@@ -6,7 +6,7 @@
| 环境变量 | 说明 | 默认值 | 必需 |
| ---------------------------------- | ---------------------------------------------- | ----------- | ----------------------------------------- |
-| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | 无 | 是,填写登录使用的 GitHub 账户的邮箱 |
+| CFRAME_ADMIN_EMAIL | 初始管理员用户的邮箱 | 无 | 是 |
| CFRAME_ADMIN_NAME | 初始管理员用户的用户名 | Chronoframe | 否 |
| CFRAME_ADMIN_PASSWORD | 初始管理员用户的密码 | CF1234@! | 否 |
| NUXT_PUBLIC_APP_TITLE | 应用标题 | ChronoFrame | 否 |
@@ -23,7 +23,8 @@
| NUXT_PROVIDER_S3_SECRET_ACCESS_KEY | S3 访问密钥 | 无 | 当 `NUXT_STORAGE_PROVIDER` 为 `s3` 时必需 |
| NUXT_PROVIDER_S3_PREFIX | S3 存储前缀 | photos/ | 否 |
| NUXT_PROVIDER_S3_CDN_URL | S3 存储的 CDN 地址 | 无 | 否 |
-| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 是 |
-| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 是 |
+| NUXT_PUBLIC_OAUTH_GITHUB_ENABLED | 是否启用 GitHub OAuth 登录 | false | 否 |
+| NUXT_OAUTH_GITHUB_CLIENT_ID | GitHub OAuth 应用的 Client ID | 无 | 否(可选,用于 GitHub 登录) |
+| NUXT_OAUTH_GITHUB_CLIENT_SECRET | GitHub OAuth 应用的 Client Secret | 无 | 否(可选,用于 GitHub 登录) |
| NUXT_SESSION_PASSWORD | 用于加密会话的密码,32 位随机字符串 | 无 | 是 |
-| NUXT_PUBLIC_GTAG_ID | Google Analytics 追踪 ID | 无 | 否 |
+| NUXT_PUBLIC_GTAG_ID | Google Analytics 追踪 ID | 无 | 否 |
diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md
index 59ceea8a..6e1c3e3b 100644
--- a/docs/zh/guide/getting-started.md
+++ b/docs/zh/guide/getting-started.md
@@ -22,6 +22,9 @@
:::tip
创建 OAuth 应用时,`Authorization callback URL` 应设置为 `http(s)://<你的域名>/api/auth/github`。
:::
+ :::info
+ GitHub OAuth 凭据是**可选的**。如果不配置,您仍然可以使用默认管理员账号登录。
+ :::
## 快速部署
diff --git a/nuxt.config.ts b/nuxt.config.ts
index 466cacb4..6a027f83 100644
--- a/nuxt.config.ts
+++ b/nuxt.config.ts
@@ -39,6 +39,7 @@ export default defineNuxtConfig({
APP_SLOGAN: '',
APP_AUTHOR: '',
APP_AVATAR_URL: '/avatar.webp',
+ OAUTH_GITHUB_ENABLED: false,
},
MAPBOX_ACCESS_TOKEN: '',
STORAGE_PROVIDER: 's3',
@@ -98,7 +99,7 @@ export default defineNuxtConfig({
},
gtag: {
- enabled: process.env.NODE_ENV === 'production'
+ enabled: process.env.NODE_ENV === 'production',
},
colorMode: {