**AutoFilm技术文档**

AutoFilm技术文档

AutoFilm 一个为Emby、Jellyfin服务器提供Strm直链播放的小项目 项目地址: https://gitcode.com/gh_mirrors/au/AutoFilm

一、安装指南

Docker部署方式：

对于那些寻求快速且标准化部署的用户，Docker是最便捷的选择。

docker run -d --name autofilm -v /path/to/local/config:/config -v /path/to/local/media:/media -v /path/to/logfolder:/logs akimio/autofilm

记得替换/path/to/local/config、/path/to/local/media和/path/to/logfolder为实际的本地路径。

Python环境部署：

如果你偏好直接在已有Python3.12环境上运行，遵循以下步骤：

首先，确保你的环境已安装Python3.12，然后执行以下命令来克隆项目和安装必要的依赖：

git clone https://github.com/Akimio521/AutoFilm.git
cd AutoFilm
pip install -r requirements.txt

之后，启动应用：

python app/main.py

二、项目使用说明

AutoFilm设计用来为Emby和Jellyfin媒体服务器生成直连播放链接，减少服务器负担，提升用户体验。一旦部署成功，你需要配置相应的Alist或类似的WebDAV服务，确保AutoFilm能够访问到你的媒体文件。

配置文件 (config.yaml) 示例：

你的配置文件应包含Alist服务器信息和目标媒体库的路径设置。这里涉及到的关键参数包括但不限于source_dir, target_dir, cron定时任务设置等。

Settings:
  DEV: False
Alist2StrmList:
  - id: "你的媒体类别"
    cron: "0 0 * * *" # 例如，每日执行的时间点
    url: "你的Alist服务器地址"
    username: "用户名"
    password: "密码"
    source_dir: "/your/source/path"
    target_dir: "/local/target/path"

三、项目API使用文档

目前文档没有直接提及API接口细节，但基于上下文理解，AutoFilm主要是通过内部处理机制（如定时任务Cron表达式），而不是直接对外提供传统意义上的RESTful API。不过，对于开发者来说，可以通过修改和调用app/main.py中的函数来间接实现定制化逻辑，这可以视为一种“内部API”使用方式。

四、项目安装方式

安装方式已在“一、安装指南”中详述，主要通过Docker容器化部署或Python环境的传统安装两种途径。

---

注意: 由于本项目遵守GNU Affero General Public License (AGPL)，任何基于此代码的衍生工作和网络部署都需要遵循开源协议的规定，公开源代码。请在商业使用前咨询法律意见，并尊重开源精神。通过Star项目或捐赠是对开发者工作的一种认可和支持。

AutoFilm 一个为Emby、Jellyfin服务器提供Strm直链播放的小项目 项目地址: https://gitcode.com/gh_mirrors/au/AutoFilm