Scrypted 项目安装与使用教程

1. 项目目录结构及介绍

Scrypted 项目的目录结构如下：

scrypted/
├── common/
├── external/
├── install/
├── packages/
├── plugins/
├── sdk/
├── server/
├── sites/static/
├── .dockerignore
├── .gitignore
├── .gitmodules
├── LICENSE.md
├── README.md
├── npm-install.sh
└── repository.yaml

目录介绍

• common/: 包含项目共用的代码和资源。
• external/: 包含外部依赖或插件。
• install/: 包含安装脚本和相关文件。
• packages/: 包含项目的各个包和模块。
• plugins/: 包含各种插件的代码。
• sdk/: 包含项目使用的软件开发工具包。
• server/: 包含服务器端的代码和配置。
• sites/static/: 包含静态网站资源。
• .dockerignore: Docker 构建时忽略的文件列表。
• .gitignore: Git 版本控制时忽略的文件列表。
• .gitmodules: Git 子模块配置文件。
• LICENSE.md: 项目许可证文件。
• README.md: 项目介绍和使用说明。
• npm-install.sh: npm 安装脚本。
• repository.yaml: 项目仓库配置文件。

2. 项目启动文件介绍

Scrypted 项目的启动文件主要位于 server/ 目录下。以下是主要的启动文件：

• server/index.ts: 这是 Scrypted 服务器的主入口文件，负责初始化服务器并启动服务。
• server/config.ts: 包含服务器的配置信息，如端口、数据库连接等。

启动步骤

1. 克隆项目代码：

   git clone https://github.com/koush/scrypted.git
   cd scrypted
   

2. 安装依赖：

   ./npm-install.sh
   

3. 启动服务器：

   cd server
   npm start
   

3. 项目的配置文件介绍

Scrypted 项目的配置文件主要位于 server/ 目录下，以下是主要的配置文件：

• server/config.ts: 包含服务器的全局配置，如端口、数据库连接、日志级别等。
• server/env.ts: 包含环境变量的配置，如开发环境、测试环境、生产环境的配置。

配置文件示例

// server/config.ts
export const config = {
  port: 3000,
  database: {
    host: 'localhost',
    port: 5432,
    username: 'scrypted',
    password: 'password',
    database: 'scrypted_db'
  },
  logLevel: 'info'
};

环境变量配置

// server/env.ts
export const env = {
  development: {
    port: 3000,
    logLevel: 'debug'
  },
  production: {
    port: 8080,
    logLevel: 'error'
  }
};

通过这些配置文件，可以灵活地调整 Scrypted 项目的运行环境和行为。