Copyparty 项目使用教程

1. 项目目录结构及介绍

Copyparty 项目的目录结构如下：

copyparty/
├── bin/
├── contrib/
├── copyparty/
├── docs/
├── scripts/
├── srvs/
├── tests/
├── .eslintrc.json
├── .gitattributes
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── SECURITY.md
├── flake.lock
├── flake.nix
├── pyproject.toml
└── setup.py

目录介绍

• bin/: 包含一些可执行脚本和工具。
• contrib/: 包含一些额外的配置文件和脚本，如 systemd 服务文件、nginx 配置等。
• copyparty/: 项目的主要代码库，包含 Python 源代码。
• docs/: 包含项目的文档，如开发笔记、TODO 列表等。
• scripts/: 包含一些用于构建和部署的脚本。
• srvs/: 包含一些服务相关的文件。
• tests/: 包含项目的测试代码。
• .eslintrc.json: ESLint 配置文件。
• .gitattributes: Git 属性配置文件。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• SECURITY.md: 安全相关信息。
• flake.lock: Nix 包管理器的锁定文件。
• flake.nix: Nix 包管理器的配置文件。
• pyproject.toml: Python 项目的配置文件。
• setup.py: Python 项目的安装脚本。

2. 项目启动文件介绍

Copyparty 的启动文件是 copyparty-sfx.py，这是一个自包含的 Python 脚本，可以直接运行。以下是启动文件的介绍：

copyparty-sfx.py

• 功能: 这是一个自包含的 Python 脚本，包含了 Copyparty 的所有依赖，可以直接运行。
• 使用方法:
  • 直接运行：python copyparty-sfx.py
  • 双击运行（Windows）：双击 copyparty-sfx.py 文件即可启动。

启动参数

Copyparty 支持多种启动参数，可以通过 -h 或 --help 查看所有可用参数。以下是一些常用的启动参数：

• -h, --help: 显示帮助信息。
• -v, --volume: 指定挂载点，例如 -v /mnt/nas/music:/music:r。
• -a, --account: 指定用户账户，例如 -a foo:bar。
• -e2dsa: 启用文件索引。
• -e2ts: 启用音频元数据索引。

3. 项目的配置文件介绍

Copyparty 的配置可以通过命令行参数、配置文件或环境变量进行。以下是一些常用的配置文件和配置方法：

配置文件

Copyparty 没有固定的配置文件格式，配置主要通过命令行参数进行。但可以通过 --cgen 参数生成一个配置文件模板。

配置示例

以下是一个简单的配置示例，展示了如何通过命令行参数配置 Copyparty：

python copyparty-sfx.py -v /mnt/nas/music:/music:r -a foo:bar -e2dsa -e2ts

环境变量

Copyparty 支持通过环境变量配置一些选项，例如：

• PRTY_NO_ARGON2: 禁用 Argon2 密码哈希。
• PRTY_NO_FFMPEG: 禁用 FFmpeg 支持。
• PRTY_NO_MUTAGEN: 禁用 Mutagen 支持。

配置文件生成

可以通过 --cgen 参数生成一个配置文件模板：

python copyparty-sfx.py --cgen config.txt

生成的 config.txt 文件可以作为配置参考。

总结

Copyparty 是一个功能强大的文件服务器项目，支持多种协议和功能。通过本教程，您可以了解项目的目录结构、启动文件的使用方法以及配置文件的配置方式。希望这些信息能帮助您更好地使用和配置 Copyparty。