Alist-Sync 项目使用教程

Alist-Sync 项目使用教程

alist-sync 项目地址: https://gitcode.com/gh_mirrors/al/alist-sync

1. 项目目录结构及介绍

Alist-Sync 的目录结构如下：

alist-sync/
├── .github/              # GitHub 工作流文件
│   └── workflows/
├── static/               # 静态文件，如 CSS 和 JavaScript
├── templates/            # HTML 模板文件
├── .dockerignore         # Docker 构建时的忽略文件
├── .gitignore            # Git 忽略文件
├── Dockerfile            # Docker 镜像构建文件
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文件
├── RELEASE.md            # 项目发布说明文件
├── VERSION               # 项目版本文件
├── action.txt            # 未知作用文件
├── alist-sync-ql.py      #青龙面板定时任务脚本
├── alist-sync-web.py      # Web 界面相关 Python 文件
├── alist_sync.py         # 项目主 Python 文件
├── docker-compose.yml    # Docker 编排文件
├── requirements.txt      # 项目依赖文件
├── xiaojin.txt           # 未知作用文件
└── data/                 # 项目数据文件夹，包含配置文件和日志

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来配置和启动服务。以下是 docker-compose.yml 的基本内容：

version: '3'
services:
  alist-sync-web:
    image: xjxjin/alist-sync:latest
    container_name: alist-sync
    restart: unless-stopped
    ports:
      - "52441:52441"
    volumes:
      - /DATA/AppData/alist-sync/data:/app/data
    environment:
      - TZ=Asia/Shanghai

启动服务时，执行以下命令：

docker-compose up -d

访问 Web 界面：

http://localhost:52441

默认登录账号：

• 用户名：admin
• 密码：admin

3. 项目的配置文件介绍

Alist-Sync 的配置文件位于 data/config 目录下，主要包括以下几个文件：

• alist_sync_base_config.json：基础连接配置文件，用于配置 Alist 服务的基本信息。
• alist_sync_sync_config.json：同步任务配置文件，用于设置同步任务的相关参数。
• alist_sync_users_config.json：用户认证配置文件，用于管理用户登录的账号和密码。

这些配置文件通常是 JSON 格式，需要根据实际情况进行编辑，以适应不同的同步需求和环境配置。在修改配置文件后，需要重新启动服务以使配置生效。

alist-sync 项目地址: https://gitcode.com/gh_mirrors/al/alist-sync