msdeluise/plant-it-server

Plant-it

镜像概述

Plant-it 是一款自托管的园艺伴侣应用，旨在帮助用户更好地照顾植物。它不会主动推荐护理操作，而是专注于记录用户的护理活动，帮助用户记住上次对植物进行护理的时间、管理个人植物 collection、收集植物照片，并在植物长时间未护理时发送提醒通知。

核心功能与特性

• 通过 Trefle API 添加现有植物或创建用户自定义植物到个人收藏
• 记录植物的浇水、施肥、生物刺激等各类护理事件
• 查看所有已记录事件，并支持按植物和事件类型进行筛选
• 上传植物照片，记录植物生长状态
• 为植物的特定操作设置提醒（例如，每4天未浇水则发送通知）

使用场景

适合园艺爱好者自托管使用，尤其适合需要系统管理多株植物、希望跟踪护理历史、避免遗忘植物护理时间的用户。可帮助用户建立完整的植物护理记录，通过照片记录植物生长变化，并通过提醒功能确保植物得到及时照顾。

详细使用方法

快速开始

通过Docker Compose可快速部署Plant-it，具体步骤如下：

1. 创建一个文件夹用于存放Plant-it相关文件
2. 在该文件夹中创建docker-compose.yml文件，内容如下：

yaml
version: "3"
name: plant-it
services:
  server:
    image: docker.xuanyuan.run/msdeluise/plant-it-server:latest
    env_file: server.env
    depends_on:
      - db
      - cache
    restart: unless-stopped
    volumes:
      - "./upload-dir:/upload-dir"  # 映射上传文件存储目录
      - "./certs:/certificates"    # 映射证书存储目录（若启用SSL）
    ports:
      - "8080:8080"  # API服务端口
      - "3000:3000"  # Web界面端口

  db:
    image: docker.xuanyuan.run/mysql:8.0
    restart: always
    env_file: server.env
    volumes:
      - "./db:/var/lib/mysql"  # 映射MySQL数据存储目录

  cache:
    image: docker.xuanyuan.run/redis:7.2.1
    restart: always  # Redis缓存服务

3. 在同一文件夹中创建server.env配置文件，内容如下：

env
#
# 数据库配置
#
MYSQL_HOST=db               # 数据库主机名（与compose中db服务名一致）
MYSQL_PORT=3306             # 数据库端口
MYSQL_USERNAME=root         # 数据库用户名
MYSQL_PSW=root              # 数据库用户密码
MYSQL_DATABASE=bootdb       # 数据库名称
MYSQL_ROOT_PASSWORD=root    # MySQL root用户密码

#
# JWT配置
#
JWT_SECRET=putTheSecretHere  # JWT签名密钥（请替换为安全随机字符串）
JWT_EXP=1                    # JWT令牌过期时间（单位：天）

#
# 服务器配置
#
USERS_LIMIT=-1               # 用户数量限制（-1表示无限制）
UPLOAD_DIR=/upload-dir       # 上传文件存储路径（与volume映射一致）
API_PORT=8080                # API服务端口
TREFLE_KEY=                  # Trefle API密钥（使用Trefle功能时需填写）
LOG_LEVEL=DEBUG              # 日志级别（DEBUG/INFO/WARN/ERROR）
ALLOWED_ORIGINS=*            # 跨域允许源（*表示允许所有）

#
# 缓存配置
#
CACHE_TTL=86400              # 缓存过期时间（单位：秒）
CACHE_HOST=cache             # 缓存服务主机名（与compose中cache服务名一致）
CACHE_PORT=6379              # 缓存服务端口

#
# SSL配置
#
SSL_ENABLED=false            # 是否启用SSL（true/false）
CERTIFICATE_PATH=/certificates/  # SSL证书存储路径（与volume映射一致）

4. 启动服务：

   bash
   docker compose -f docker-compose.yml up -d
   

服务启动后，可通过以下地址访问：

• Web界面：localhost:3000
• API服务：localhost:8080/api
• API文档：localhost:8080/api/swagger-ui/index.html

配置参数说明

数据库配置

JWT安全配置

服务器核心配置

缓存配置

SSL配置