msdeluise/plant-it-backend

Plant-it 后端镜像文档

镜像概述

Plant-it 是一款自托管的园艺伴侣应用，旨在帮助用户管理植物养护活动。它不提供养护建议，而是专注于记录用户的养护行为，帮助用户记住上次养护时间、管理植物收藏、存储植物照片，并提醒用户植物养护间隔。后端服务负责数据处理、API 接口和业务逻辑，需配合前端、MySQL 数据库和 Redis 缓存使用。

核心功能与特性

• 植物管理：通过 Trefle API 添加现有植物或创建自定义植物
• 养护记录：记录浇水、施肥、生物刺激等植物养护事件
• 事件查看：按植物和事件类型筛选查看所有记录的养护活动
• 图片上传：支持上传植物照片并存储
• 即将推出功能：植物分享、养护提醒（如每4天未浇水通知）、深色/浅色模式

使用场景

适合园艺爱好者、家庭植物养护者、植物收藏家等需要系统跟踪植物状态和养护历史的用户。尤其适合希望自托管数据、保护隐私的个人或小团体使用。

使用方法

部署准备

推荐使用 Docker Compose 部署，需同时运行后端、前端、MySQL 和 Redis 服务。仓库提供预配置的 docker-compose.yml 文件，包含所有必要服务。

Docker Compose 配置

yaml
version: "3"

name: plant-it
services:
  backend:
    image: docker.xuanyuan.run/msdeluise/plant-it-backend:latest
    env_file: backend.env
    depends_on:
      - db
      - cache
    restart: unless-stopped
    volumes:
      - "./upload-dir:/upload-dir"
    ports:
      - "8080:8080"

  db:
    image: docker.xuanyuan.run/mysql:8.0
    restart: always
    env_file: backend.env

  cache:
    image: docker.xuanyuan.run/redis:7.2.1
    restart: always

  frontend:
    image: docker.xuanyuan.run/msdeluise/plant-it-frontend:latest
    env_file: frontend.env
    links:
      - backend
    ports:
      - "3000:3000"

启动服务

1. 创建 backend.env 和 frontend.env 配置文件（详见配置说明）
2. 运行命令启动服务：

   bash
   docker compose up -d
   

3. 服务启动后：
   • 前端访问地址：http://localhost:3000
   • 后端 API 地址：http://localhost:8080/api
   • API 文档地址：http://localhost:8080/api/swagger-ui/index.html

远程访问配置

若在服务器部署并从其他设备（如手机）访问，需修改：

1. frontend.env 中的 API_URL 为服务器 IP，如 http://192.168.1.100:8080/api
2. 前端访问地址变为 http://服务器IP:3000，后端 API 地址变为 http://服务器IP:8080/api

端口修改

后端端口修改

1. 在 docker-compose.yml 中修改端口映射，如 9090:8080（将主机端口 9090 映射到容器 8080）
2. 更新 frontend.env 中的 API_URL 为新端口，如 http://localhost:9090/api

前端端口修改

在 docker-compose.yml 中修改前端端口映射，如 4040:3000（将主机端口 4040 映射到容器 3000）

DNS 与 CORS 说明

DNS 限制

浏览器无法解析 Docker 内部服务名（如 backend），因此需使用服务器 IP 而非 Docker 服务名配置 API_URL 和 ALLOWED_ORIGINS。例如：

• 不能使用 http://backend:8080/api 作为 API_URL，需使用 http://服务器IP:8080/api
• ALLOWED_ORIGINS 需设置为客户端浏览器的 IP，而非 Docker 服务名

CORS 配置

ALLOWED_ORIGINS 默认为 *（允许所有来源），可根据需求设置为具体 IP 列表（逗号分隔），以增强安全性。

配置说明

后端配置（backend.env）

前端配置（frontend.env）