sublink 项目使用教程

sublink 项目使用教程

sublink 开源节点订阅转换生成管理系统，集成前后端部署在docker 项目地址: https://gitcode.com/gh_mirrors/su/sublink

1. 项目的目录结构及介绍

sublink 项目是一个开源的节点订阅转换生成管理系统，下面是该项目的目录结构及其简要介绍：

• app/：包含应用程序的主要逻辑，如数据库迁移脚本、初始化脚本等。
  • app/db/：数据库存储目录。
  • app/migrations/：数据库迁移脚本。
• web/：项目的前端文件，通常包含 HTML、CSS 和 JavaScript 文件。
• .dockerignore：Docker 构建时需要排除的文件和目录。
• .gitignore：Git 忽略文件，指定 Git 应该忽略的文件和目录。
• Dockerfile：定义如何构建 Docker 镜像的文件。
• LICENSE.md：项目的许可协议文件。
• README.md：项目的说明文档。
• docker-compose.yml：定义 Docker 服务和网络的配置文件。
• init_login_log.py：初始化登录日志的脚本。
• init_user_pw.py：初始化用户密码的脚本。
• requirements.txt：项目依赖的 Python 包列表。
• run.py：项目的启动文件。
• uwsgi.ini：uWSGI 服务的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 run.py，该文件负责启动 Flask 应用。以下是 run.py 文件的主要内容：

# 导入Flask应用实例
from app import app

# 设置环境变量，指定运行模式
import os
os.environ['FLASK_ENV'] = 'production'

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5000)

这段代码首先从 app 模块导入 Flask 应用实例，然后设置环境变量以确保应用运行在生成环境。最后，通过 app.run() 函数启动应用，监听所有公网 IP 的 5000 端口。

3. 项目的配置文件介绍

项目的配置主要通过环境变量和 uwsgi.ini 文件来管理。

• 环境变量：可以在 docker run 命令中使用 -e 参数来设置环境变量，例如 -e PORT=5000 用于指定应用运行的端口。
• uwsgi.ini：uWSGI 服务的配置文件，用于定义服务的运行参数，例如监听的端口、工作模式等。以下是一个基础的 uwsgi.ini 示例：

[uwsgi]
http = 0.0.0.0:8000
base = /path/to/your/project
app = wsgi:app
callable = app

在这个配置文件中，http 指定了 uWSGI 服务的监听地址和端口，base 是项目的基础目录，app 和 callable 指定了 Flask 应用的对象和入口点。

sublink 开源节点订阅转换生成管理系统，集成前后端部署在docker 项目地址: https://gitcode.com/gh_mirrors/su/sublink