Repo-Viewer/.env.example at master · CQUT-OpenProject/Repo-Viewer · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
###########################################################
# 基础配置（必需）
###########################################################

# 站点标题 - 设置网站左上角显示的标题
# 注意：系统会自动将无前缀变量映射为VITE_前缀变量供前端使用
SITE_TITLE = Repo-Viewer

# SEO配置
SITE_DESCRIPTION = 基于MD3设计语言的GitHub仓库浏览应用
SITE_KEYWORDS = GitHub, 仓库, 浏览器, 代码, 查看器

# GitHub仓库信息 - 配置要浏览的GitHub仓库
GITHUB_REPO_OWNER = CQUT-OpenProject
GITHUB_REPO_NAME = Repo-Viewer
GITHUB_REPO_BRANCH = master

###########################################################
# 访问与代理设置
###########################################################

# API访问模式 - 控制API访问方式（本地开发时适用）
USE_TOKEN_MODE = false                                            # 是否启用令牌优先，本地开发时有效 ｜ 默认关闭

# GitHub访问令牌（至少需要一个）
GITHUB_PAT1 =
GITHUB_PAT2 =

# 代理设置 - 用于文件下载和浏览（可选）
DOWNLOAD_PROXY_URL = https://gh-proxy.com                         # 主代理URL
DOWNLOAD_PROXY_URL_BACKUP1 = https://ghproxy.com                  # 备选代理1
DOWNLOAD_PROXY_URL_BACKUP2 = https://raw.staticdn.net             # 备选代理2

###########################################################
# 内容显示控制（可选）
###########################################################

# 首页过滤 - 控制首页显示的内容
HOMEPAGE_FILTER_ENABLED = true                                    # 是否启用过滤，设置为 true开启过滤功能 ｜ 默认关闭
HOMEPAGE_ALLOWED_FOLDERS = docs,src                               # 允许在首页显示的文件夹列表，使用逗号分隔 ｜ 例如: docs,src,public
HOMEPAGE_ALLOWED_FILETYPES = md,pdf,txt                           # 允许在首页显示的文件类型列表，使用逗号分隔，不含点号 ｜ 例如: md,pdf,txt

# 下载按钮控制 - 管理文件夹下载按钮的显示
HIDE_MAIN_FOLDER_DOWNLOAD = false                                 # 是否启用隐藏下载按钮，设置为 true开启隐藏功能 ｜ 默认关闭
HIDE_DOWNLOAD_FOLDERS = node_modules,dist                         # 首页需要隐藏下载按钮的文件夹列表，使用逗号分隔 ｜ 例如: node_modules,dist

# 页脚显示控制
FOOTER_LEFT_TEXT = [text](link)                                   # 页脚左侧自定义信息｜ 默认为空

###########################################################
# 搜索索引功能（可选）
###########################################################

# 搜索索引开关
ENABLED_SEARCH_INDEX = true                                       # 是否启用索引搜索模式 ｜ 默认关闭

# 索引生成模式：build|action|off
# - build: 仅生产构建生成（默认）
# - action: 仅 GitHub Actions 生成
# - off: 禁用索引生成
SEARCH_INDEX_GENERATION_MODE = build

# 需要生成索引的分支列表（逗号/空格分隔），首个分支作为默认搜索分支｜留空则使用 GITHUB_REPO_BRANCH
# 注意：Actions 模式下，需将此变量置于仓库 Environments 中，并将环境名称设为 RV-Index，否则无法识别变量
SEARCH_INDEX_BRANCHES = master,dev

SEARCH_INDEX_EXTENSIONS =                                         # 覆盖默认扩展名白名单（逗号/空格分隔，不含点号）

# 索引产物固定发布到 /search-index（manifest/docfind.js/wasm）

###########################################################
# 开发者选项（可选）
###########################################################

# 开发者模式 - 控制调试信息显示
DEVELOPER_MODE = false                                            # 是否启用开发者模式 ｜ 默认关闭

# 前端部署基路径（子路径部署时使用，例如 /repo-viewer/ ｜ 根路径部署留空）
VITE_BASE_PATH =

# 开发者模式启用时提供以下功能：
# - 控制台详细日志输出（API请求、文件操作、组件生命周期等）
# - 分组调试信息（应用初始化、API请求流程等）
# - 请求/响应详细信息

# 控制台日志输出
CONSOLE_LOGGING = true                                            # 是否启用控制台日志记录 ｜ 默认开启

# 日志配置
# - 若未设置，系统会基于 DEVELOPER_MODE / CONSOLE_LOGGING 推导安全默认值
# - 下列开关全部可选，按需覆盖
LOGGER_ENABLE_CONSOLE =                                           # 是否强制启用前端控制台日志 ｜ 推荐 dev=true ｜ prod=false
LOGGER_ENABLE_ERROR_REPORTING =                                   # 是否启用错误上报（需配合 LOGGER_REPORT_URL 或 registerLoggerReporter）
LOGGER_REPORT_URL =                                               # 错误上报目标地址（可填 Sentry / 业务 API）
LOGGER_REPORT_WARNINGS =                                          # 是否连同 warn 级别上报 ｜ 默认仅上报 error
LOGGER_ENABLE_RECORDER =                                          # 是否启用前端会话日志录制 ｜ 推荐 dev=true ｜ prod=false
LOGGER_BASE_LEVEL =                                               # 覆盖默认日志级别：debug | info | warn | error