HiddifyPanel 项目安装与使用指南

1. 项目目录结构及介绍

HiddifyPanel 项目的目录结构如下：

HiddifyPanel/
├── docs/
│   └── ...
├── hiddifypanel/
│   └── ...
├── project/
│   └── ...
├── scripts/
│   └── ...
├── .gitignore
├── .gitchangelog.rc
├── .gitignore
├── .release_notes.tpl
├── pyproject.toml
├── ABOUT_THIS_TEMPLATE.md
├── CONTRIBUTING.md
├── Containerfile
├── HISTORY.md
├── LICENSE.md
├── MANIFEST.in
├── Makefile
├── README.md
├── a.txt
├── app.cfg
├── apply.sh
├── mkdocs.yml
├── release.sh
├── requirements-base.txt
├── requirements-test.txt
├── requirements.txt
├── run.sh
├── settings.toml
├── setup.py
└── wsgi.py

目录结构介绍

• docs/: 存放项目的文档文件。
• hiddifypanel/: 存放项目的主要代码文件。
• project/: 存放项目相关的配置文件。
• scripts/: 存放项目的脚本文件。
• .gitignore: Git 忽略文件配置。
• .gitchangelog.rc: Git 变更日志配置文件。
• .release_notes.tpl: 发布说明模板文件。
• pyproject.toml: Python 项目配置文件。
• ABOUT_THIS_TEMPLATE.md: 项目模板说明文件。
• CONTRIBUTING.md: 贡献指南文件。
• Containerfile: Docker 容器配置文件。
• HISTORY.md: 项目历史记录文件。
• LICENSE.md: 项目许可证文件。
• MANIFEST.in: Python 包清单文件。
• Makefile: 项目构建文件。
• README.md: 项目说明文件。
• a.txt: 示例文本文件。
• app.cfg: 应用配置文件。
• apply.sh: 应用配置脚本。
• mkdocs.yml: MkDocs 配置文件。
• release.sh: 发布脚本。
• requirements-base.txt: 基础依赖文件。
• requirements-test.txt: 测试依赖文件。
• requirements.txt: 项目依赖文件。
• run.sh: 运行脚本。
• settings.toml: 项目设置文件。
• setup.py: Python 项目安装脚本。
• wsgi.py: WSGI 入口文件。

2. 项目启动文件介绍

HiddifyPanel 项目的启动文件是 wsgi.py。该文件是 WSGI 应用程序的入口点，用于启动 Flask 应用。

# wsgi.py
from hiddifypanel import create_app

app = create_app()

if __name__ == "__main__":
    app.run()

启动文件介绍

• create_app(): 该函数用于创建 Flask 应用实例。
• app.run(): 启动 Flask 应用。

3. 项目配置文件介绍

HiddifyPanel 项目的主要配置文件是 settings.toml。该文件包含了项目的各种配置选项。

# settings.toml
[app]
debug = true
secret_key = "your_secret_key"

[database]
uri = "sqlite:///database.db"

[logging]
level = "DEBUG"

配置文件介绍

• [app]: 应用配置部分，包含调试模式和密钥配置。
• [database]: 数据库配置部分，包含数据库 URI。
• [logging]: 日志配置部分，包含日志级别。

通过以上配置文件，可以灵活地调整项目的运行环境和行为。