Pinchflat 项目教程

1. 项目的目录结构及介绍

Pinchflat 项目的目录结构如下：

pinchflat/
├── devcontainer/
├── github/
│   └── assets/
├── config/
├── docker/
├── lib/
├── priv/
├── rel/
│   └── overlays/
│       └── bin/
├── test/
├── tooling/
├── .dockerignore
├── .formatter.exs
├── .gitignore
├── .iex.exs
├── .prettierignore
├── .prettierrc.js
├── .sobelow-conf
├── LICENSE
├── README.md
├── docker-compose.ci.yml
├── docker-compose.yml
├── mix.exs
├── mix.lock
├── package.json
└── yarn.lock

目录结构介绍

• devcontainer/: 包含开发容器相关的配置文件。
• github/assets/: 包含 GitHub 相关的资源文件。
• config/: 包含项目的配置文件。
• docker/: 包含 Docker 相关的配置文件。
• lib/: 包含项目的主要代码库。
• priv/: 包含私有资源文件。
• rel/overlays/bin/: 包含发布相关的覆盖文件。
• test/: 包含测试相关的文件。
• tooling/: 包含工具相关的文件。
• .dockerignore: Docker 忽略文件。
• .formatter.exs: 代码格式化配置文件。
• .gitignore: Git 忽略文件。
• .iex.exs: IEx 配置文件。
• .prettierignore: Prettier 忽略文件。
• .prettierrc.js: Prettier 配置文件。
• .sobelow-conf: Sobelow 配置文件。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文件。
• docker-compose.ci.yml: CI 环境下的 Docker Compose 配置文件。
• docker-compose.yml: Docker Compose 配置文件。
• mix.exs: Mix 项目配置文件。
• mix.lock: Mix 锁定文件。
• package.json: Node.js 包配置文件。
• yarn.lock: Yarn 锁定文件。

2. 项目的启动文件介绍

Pinchflat 项目的启动文件主要是 mix.exs 和 docker-compose.yml。

mix.exs

mix.exs 是 Elixir 项目的配置文件，包含了项目的依赖、任务、版本等信息。通过 mix 命令可以启动项目。

docker-compose.yml

docker-compose.yml 是 Docker Compose 的配置文件，用于定义和运行多容器 Docker 应用程序。通过 docker-compose up 命令可以启动项目。

3. 项目的配置文件介绍

Pinchflat 项目的配置文件主要位于 config/ 目录下。

config/

• config.exs: 主配置文件，包含项目的全局配置。
• dev.exs: 开发环境配置文件。
• test.exs: 测试环境配置文件。
• prod.exs: 生产环境配置文件。

这些配置文件定义了项目的各种设置，如数据库连接、日志级别、端口等。

环境变量

Pinchflat 还支持通过环境变量进行配置，常见的环境变量包括：

• TZ: 时区设置。
• LOG_LEVEL: 日志级别。
• BASIC_AUTH_USERNAME: 基本认证用户名。
• BASIC_AUTH_PASSWORD: 基本认证密码。
• EXPOSE_FEED_ENDPOINTS: 是否暴露 RSS 订阅端点。
• ENABLE_IPV6: 是否启用 IPv6。
• JOURNAL_MODE: 数据库日志模式。
• TZ_DATA_DIR: 时区数据库路径。
• BASE_ROUTE_PATH: 路由基础路径。
• YT_DLP_WORKER_CONCURRENCY: yt-dlp 工作线程并发数。

通过这些配置文件和环境变量，可以灵活地配置和启动 Pinchflat 项目。