streetwriters/identity

Notesnook 认证服务器镜像

镜像概述和主要用途

Notesnook 认证服务器镜像是为 Notesnook 应用提供登录、注册及用户认证功能的后端服务组件。该镜像作为 Notesnook 客户端的核心后端服务之一，负责处理用户身份验证流程，包括凭证校验、令牌生成与管理，确保用户访问的安全性与合法性。

核心功能和特性

核心功能

• 用户认证流程：支持用户登录、注册、密码重置等基础认证操作。
• 令牌管理：生成、验证和刷新用户认证令牌（如 JWT），维持会话状态。
• 用户数据处理：存储和管理用户基础信息（如用户名、加密密码等）。

关键特性

• 安全加密：用户密码采用不可逆加密算法存储，敏感数据传输支持 TLS/SSL。
• 轻量高效：基于优化的后端框架构建，资源占用低，响应速度快。
• 可配置性：通过环境变量灵活调整服务参数，适配不同部署场景。

使用场景和适用范围

使用场景

• Notesnook 自托管部署：配合 Notesnook 客户端，搭建私有或企业级笔记系统。
• 开发/测试环境：为 Notesnook 应用的本地开发、功能测试提供认证服务支持。
• 企业内部部署：满足企业对用户数据本地化存储、访问权限管控的需求。

适用范围

仅作为 Notesnook 生态的后端组件使用，需与 Notesnook 客户端（Web/桌面/移动）配合，不支持独立运行或作为通用认证服务使用。

使用方法和配置说明

前置要求

• Docker 19.03+ 环境
• 网络环境支持（客户端需访问该服务端口）
• （可选）持久化存储需求：建议挂载数据卷或配置外部数据库

镜像拉取

bash
docker pull notesnook/auth-server:latest

Docker Run 命令示例

基础运行命令（默认配置，仅用于测试）：

bash
docker run -d \
  --name notesnook-auth \
  -p 3000:3000 \
  notesnook/auth-server:latest

带基础配置的生产环境示例（含环境变量与数据持久化）：

bash
docker run -d \
  --name notesnook-auth \
  -p 3000:3000 \
  -e PORT=3000 \
  -e JWT_SECRET="your_secure_jwt_secret" \
  -e DATABASE_URL="postgres://user:password@db-host:5432/notesnook_auth" \
  -e LOG_LEVEL="info" \
  -v /path/on/host/data:/var/lib/notesnook-auth/data \
  notesnook/auth-server:latest

Docker Compose 配置示例

适用于与数据库（如 PostgreSQL）联动的完整部署：

yaml
version: '3.8'

services:
  auth-server:
    image: notesnook/auth-server:latest
    container_name: notesnook-auth
    restart: unless-stopped
    ports:
      - "3000:3000"
    environment:
      - PORT=3000
      - JWT_SECRET="your_secure_jwt_secret"  # 建议使用 32 位以上随机字符串
      - DATABASE_URL="postgres://auth_user:auth_pass@db:5432/auth_db"
      - LOG_LEVEL="warn"  # 生产环境建议使用 warn/error 级别
      - CORS_ALLOWED_ORIGINS="https://your-notesnook-client.com,http://localhost:8080"
    volumes:
      - auth-data:/var/lib/notesnook-auth/data  # 持久化用户数据与日志
    depends_on:
      - db

  db:
    image: postgres:14-alpine
    container_name: notesnook-auth-db
    restart: unless-stopped
    environment:
      - POSTGRES_USER=auth_user
      - POSTGRES_PASSWORD=auth_pass
      - POSTGRES_DB=auth_db
    volumes:
      - postgres-data:/var/lib/postgresql/data

volumes:
  auth-data:
  postgres-data:

环境变量说明

数据持久化

• 用户数据与配置：容器内路径 /var/lib/notesnook-auth/data，建议通过 -v 挂载宿主机目录或命名卷，避免容器重建导致数据丢失。
• 数据库数据：若使用外部数据库（如示例中的 PostgreSQL），需单独配置数据库的持久化存储（如 postgres-data 卷）。

健康检查

服务启动后，可通过访问 http://<容器IP>:<PORT>/health 验证状态，返回 {"status":"ok"} 表示服务正常运行。