Kyoo 自助式媒体服务器部署与配置指南

一、项目目录结构及介绍

Kyoo 是一个以视频内容（电影、剧集和动漫）为中心的自托管媒体服务器，提供了一个替代Jellyfin或Plex的选择。下面是对其核心目录结构的一个概述：

• root 目录下包含了整个项目的核心组件。
  • kyoo: 应用主体代码所在位置，包含了逻辑处理和服务运行的核心部分。
  • editorconfig: 编辑器配置文件，确保跨编辑器的一致性。
  • env.example: 环境变量示例文件，用于引导用户设置其环境变量。
  • gitattributes, git-blame-ignore-revs, gitignore: 版本控制相关文件，指导Git如何操作此仓库。
  • pg_format: PostgreSQL相关的格式化工具配置。
  • AUTHORS, CONTRIBUTING, DIAGRAMS, INSTALLING, LICENSE, PRIVACY, README.md: 文档文件，涵盖了版权、贡献指南、安装说明、隐私政策等。
  • biome.json, docker-compose.build.yml, docker-compose.dev.yml, docker-compose.yml: Docker Compose配置文件，用于不同环境下的服务部署。
  • renovate.json5: 自动更新依赖的配置文件。
  • shell.nix: Nix壳脚本，用于特定构建或开发环境。

每个子目录或关键文件都有其特定的作用，为项目的构建、运行和维护提供了必要的结构和配置。

二、项目的启动文件介绍

在 Kyoo 中，启动过程主要通过 Docker Compose 来管理。核心的启动文件是 docker-compose.yml（以及可能的开发专用配置如 docker-compose.dev.yml）。这个文件定义了应用程序依赖的服务（如数据库、Meilisearch搜索服务、应用服务器等），配置了它们的网络连接、卷挂载以及环境变量，使得开发者或管理员只需一条命令即可启动整个服务栈：

# 示例docker-compose.yml简化版
version: '3'
services:
  app:
    build: .
    ports:
      - "8000:8000"
    depends_on:
      - db
      - meilisearch
  db:
    image: postgres
    volumes:
      - db_data:/var/lib/postgresql/data
  meilisearch:
    image: meilisearch/meilisearch
    environment:
      - MEILI_MASTER_KEY=your_key
volumes:
  db_data:

请注意，实际的docker-compose.yml文件将更加详细，并且应该根据最新的源码或者项目文档来调整。

三、项目的配置文件介绍

Kyoo 的配置通常涉及多个方面，包括但不限于环境变量和内部的配置文件。虽然具体配置细节需参考实际的源代码注释和官方文档，但关键配置通常通过环境变量或直接在Docker Compose文件中指定（例如数据库URL、API密钥等）。

环境变量

• KYOO_DB_URL: 数据库连接URL，对于PostgreSQL来说很常见。
• KYOO_MEILISEARCH_URL: Meilisearch服务的地址，用于搜索引擎功能。
• KYOO_OIDC_PROVIDER: 如果启用OIDC登录，需配置认证提供商的详情。

配置文件示例

除了环境变量，某些高级配置或个性化设定可能会要求修改特定的配置文件，比如.env或是在应用内部的配置文件。然而，这些细节需从项目仓库中的文档或样例配置文件获取最新信息。例如，如果存在一个.env.example文件，它会展示如何设置基本的环境变量。

在实际部署时，重要的是阅读官方文档，因为配置选项可能随版本更新而变化。确保查看Kyoo的GitHub页面上的最新发布说明和文档，以便获得最精确的配置步骤和建议。