mirakc-timeshift-fs 镜像文档

镜像概述和主要用途

mirakc-timeshift-fs 是一个用户空间文件系统（Userspace Filesystem），旨在将时移记录（timeshift records）以文件形式暴露出来。通过该文件系统，用户可以像访问普通文件一样便捷地访问和管理时移记录，简化了对时移内容的处理流程。

该镜像基于 mirakc 项目的组件实现，具体细节可参考 官方文档。

核心功能和特性

• 用户空间实现：采用用户空间文件系统架构，无需修改内核即可运行，降低了部署和维护门槛。
• 时移记录映射：将时移记录以文件系统的层级结构呈现，提供直观的文件访问方式。
• 无缝集成：可与依赖文件系统接口的应用程序兼容，便于集成到现有工作流中。

使用场景和适用范围

• 媒体中心应用：适用于需要访问时移记录的媒体中心软件，如 Kodi、Plex 等。
• PVR 系统：作为个人视频录像机（PVR）系统的辅助组件，简化时移内容的管理和播放。
• 开发与测试：供开发者在需要模拟或访问时移记录文件的场景中使用。

详细使用方法和配置说明

前提条件

• 宿主系统需支持 FUSE（Filesystem in Userspace），并已安装 FUSE 相关依赖。
• Docker 环境已正确配置，具备容器运行权限。

基本使用命令

通过 docker run 命令启动容器，需指定 FUSE 设备挂载及文件系统挂载点：

docker run -d \
  --device /dev/fuse \
  --cap-add SYS_ADMIN \
  -v /path/on/host:/mnt/timeshift:shared \
  mirakc/mirakc-timeshift-fs \
  mirakc-timeshift-fs /mnt/timeshift [options]

参数说明：

• --device /dev/fuse：允许容器访问宿主系统的 FUSE 设备。
• --cap-add SYS_ADMIN：赋予容器必要的系统权限以挂载文件系统。
• -v /path/on/host:/mnt/timeshift:shared：将宿主目录 /path/on/host 挂载到容器内 /mnt/timeshift，作为时移文件系统的挂载点（需使用 shared 挂载选项以支持嵌套挂载）。
• [options]：mirakc-timeshift-fs 的具体运行参数，可参考 官方文档 获取详细选项。

配置说明

详细配置参数、环境变量及高级用法，请查阅项目官方文档：
mirakc-timeshift-fs README.md

注意事项

• 容器运行时需确保挂载点目录权限正确，避免因权限问题导致挂载失败。
• 如需自定义文件系统行为，可通过命令行参数或配置文件进行调整，具体参考官方文档。