BookLore开源项目安装与配置指南

1. 项目基础介绍

BookLore 是一个自托管的网络应用程序，用于组织和管理工作个人书籍收藏。它提供了一个直观的界面来浏览、阅读和跟踪 PDF 和电子书阅读进度。该项目拥有强大的元数据管理功能、多用户支持以及时尚现代的用户界面，使得构建和探索个人图书馆变得简单。

该项目主要使用的编程语言包括 Java 和 TypeScript，同时也使用了一些 HTML 和 SCSS。

2. 项目使用的关键技术和框架

• Java: 后端开发语言。
• TypeScript: 前端开发语言。
• HTML/SCSS: 用于构建用户界面。
• MariaDB: 数据库管理系统。
• Docker: 容器化技术，用于简化部署。

3. 项目安装和配置的准备工作

在开始安装前，请确保您的系统满足以下要求：

• Docker 和 Docker Compose 已经安装。
• 具备基本的命令行操作知识。

详细安装步骤

步骤 1: 克隆项目仓库

首先，您需要在您的计算机上克隆该项目仓库。打开命令行工具，执行以下命令：

git clone https://github.com/adityachandelgit/BookLore.git
cd BookLore

步骤 2: 创建 Docker Compose 文件

在项目根目录下创建一个名为 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

请确保将 /your/local/path/to/booklore/data 和 /your/local/path/to/booklore/books 替换为您希望存储数据的具体本地路径。

步骤 3: 启动容器

使用以下命令启动 Docker 容器：

docker-compose up -d

步骤 4: 访问 BookLore

容器启动后，您可以在浏览器中通过 http://localhost:6060 访问 BookLore。

步骤 5: 首次登录

容器启动后，您可以使用默认管理员凭据登录 BookLore：

• 用户名：admin
• 密码：admin123

请注意，在首次登录时，系统会提示您更改默认密码以提高安全性。

以上就是 BookLore 项目的详细安装和配置指南。按照上述步骤操作，您应该能够成功部署并运行该开源项目。