shftyshft/memos

镜像概述

这是一个以隐私保护为核心的轻量级笔记服务镜像，旨在提供简单、高效的笔记管理解决方案。该服务专注于用户数据隐私，同时保持轻量级架构，确保资源占用低、部署便捷，帮助用户轻松记录、整理和分享各类想法与信息。

核心功能与特性

• 隐私优先：采用本地数据存储模式，确保用户笔记数据不被第三方访问，保护个人隐私安全
• 轻量级设计：镜像体积小，运行时资源占用低，可在低配置设备上稳定运行
• 易用性：提供简洁直观的操作界面，支持快速创建、编辑和组织笔记内容
• 分享功能：支持生成分享链接或导出笔记，方便与他人协作或共享信息

使用场景与适用范围

• 个人日常笔记：适用于记录灵感、待办事项、学习笔记等个人日常内容管理
• 团队协作：可作为小型团队的想法收集与协作工具，支持多人共享笔记内容
• 隐私敏感场景：适合对数据隐私有较高要求的用户，如个人私密日记、项目规划等
• 轻量部署需求：适用于个人服务器、开发环境或资源受限的设备（如树莓派）部署

使用方法与配置说明

基本部署（docker run）

通过以下命令快速启动服务：

bash
docker run -d -p 8080:8080 -v ./note-data:/app/data --name note-service note-image:latest

参数说明：

• -p 8080:8080：将容器内服务端口映射到主机8080端口，可根据需要修改主机端口
• -v ./note-data:/app/data：挂载本地目录作为数据卷，实现笔记数据持久化存储
• --name note-service：指定容器名称，便于管理

环境变量配置

可通过环境变量自定义服务配置（根据实际镜像支持情况调整）：

• DATA_PATH：笔记数据存储路径，默认值为/app/data
• AUTH_ENABLED：是否启用访问认证（true/false），默认值为false
• PORT：服务监听端口，默认值为8080

示例（启用认证）：

bash
docker run -d -p 8080:8080 -v ./note-data:/app/data -e AUTH_ENABLED=true --name note-service note-image:latest

docker-compose配置示例

创建docker-compose.yml文件进行编排部署：

yaml
version: '3'
services:
  note-service:
    image: note-image:latest
    container_name: note-service
    ports:
      - "8080:8080"
    volumes:
      - ./note-data:/app/data
    environment:
      - DATA_PATH=/app/data
      - AUTH_ENABLED=true
    restart: unless-stopped

启动命令：docker-compose up -d