BookLore 项目使用与配置指南

1. 项目目录结构及介绍

BookLore 是一个用于托管、管理和探索书籍的 Web 应用程序，支持 PDF 和电子书格式，可以跟踪阅读进度、管理元数据和统计信息。以下是项目的目录结构及各部分的简要介绍：

BookLore/
├── assets/               # 存储项目资产，如图片和演示 GIF
├── booklore-api/         # 包含后端 API 相关代码
├── booklore-ui/          # 包含前端用户界面代码
├── Dockerfile            # Docker 容器配置文件
├── example-docker/       # 提供示例 Docker 配置文件
├── .github/              # 存储 GitHub Actions 工作流配置
├── .gitignore            # 指定 Git 忽略的文件和目录
├── LICENSE               # 项目许可证文件
├── README.md             # 项目说明文档
├── nginx.conf            # Nginx 配置文件
└── ...

• assets/: 存储项目的静态资源，如图像文件等。
• booklore-api/: 包含构成应用程序后端的 API 代码。
• booklore-ui/: 包含应用程序的前端代码，通常是 HTML、CSS 和 JavaScript 文件。
• Dockerfile: 用于构建 Docker 容器的配置文件。
• example-docker/: 包含示例 Docker 配置文件，用于本地开发。
• .github/: 包含用于自动化项目工作流程的 GitHub Actions 脚本。
• .gitignore: 指定 Git 忽略的文件和目录，以避免将不必要的文件提交到仓库。
• LICENSE: 项目遵循的许可证文件，这里是 GNU GPL v3。
• README.md: 项目的主要说明文档，介绍了项目的用途、如何使用和贡献指南。

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来配置和启动。以下是一个基本的 docker-compose.yml 文件示例：

version: '3.8'
services:
  booklore:
    image: ghcr.io/adityachandelgit/booklore-app:latest
    container_name: booklore
    environment:
      PUID: 1000
      PGID: 1000
      TZ: Etc/UTC
      DATABASE_URL: jdbc:mariadb://mariadb:3306/booklore
      DATABASE_USERNAME: booklore
      DATABASE_PASSWORD: your_secure_password
    depends_on:
      mariadb:
        condition: service_healthy
    ports:
      - "6060:6060"
    volumes:
      - /your/local/path/to/booklore/data:/app/data
      - /your/local/path/to/booklore/books:/books
    restart: unless-stopped

  mariadb:
    image: lscr.io/linuxserver/mariadb:11.4.5
    container_name: mariadb
    environment:
      PUID: 1000
      PGID: 1000
      TZ: Etc/UTC
      MYSQL_ROOT_PASSWORD: super_secure_password
      MYSQL_DATABASE: booklore
      MYSQL_USER: booklore
      MYSQL_PASSWORD: your_secure_password
    volumes:
      - /your/local/path/to/mariadb/config:/config
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "mariadb-admin", "ping", "-h", "localhost"]
      interval: 5s
      timeout: 5s
      retries: 10

使用 docker-compose up -d 命令启动服务。

3. 项目的配置文件介绍

项目的配置主要通过环境变量来管理。以下是一些主要的环境变量及其用途：

• DATABASE_URL: JDBC 数据库连接 URL。
• DATABASE_HOST: 数据库主机名。
• DATABASE_PORT: 数据库端口。
• DATABASE_NAME: 数据库名称。
• DATABASE_USERNAME: 数据库应用程序用户名。
• DATABASE_PASSWORD: 数据库应用程序密码。

确保在 docker-compose.yml 文件中正确设置这些环境变量，以匹配你的数据库配置。此外，如果你需要自定义应用程序的行为，你可以添加额外的环境变量。

以上是 BookLore 项目的基本目录结构和启动文件介绍，以及配置文件的说明。使用这些信息，你可以开始配置和运行你自己的 BookLore 实例。