srgr0/misskey

Srgr0/Misskey Docker 镜像文档

一、镜像概述和主要用途

1.1 镜像概述

Srgr0/Misskey 是由 Srgr0 维护的 Docker 镜像，基于 misskey-dev/misskey 官方镜像进行分支开发。该镜像专为开发环境设计，不适合用于生产环境。

1.2 主要用途

提供 Misskey 去中心化社交网络平台的开发环境，供开发者进行代码调试、功能测试及开发工作流验证。

二、核心功能和特性

2.1 核心功能

• 基于官方 Misskey 分支构建，保留 Misskey 核心功能（如去中心化社交、内容发布、用户互动等）；
• 针对开发场景优化，支持代码热重载及开发工具集成（具体依赖镜像内置配置）。

2.2 特性

• 开发环境专用：包含开发所需依赖及调试工具，不包含生产环境安全加固及性能优化；
• 与官方 Misskey 兼容性：基于官方代码分支开发，功能行为与对应版本官方镜像基本一致。

三、使用场景和适用范围

3.1 适用场景

• Misskey 平台二次开发调试；
• 新功能原型验证；
• 开发环境下的功能测试与问题排查。

3.2 适用范围

仅限本地或开发服务器环境使用，禁止用于生产环境（缺乏生产级安全配置、数据备份机制及性能优化）。

四、使用方法和配置说明

4.1 基本使用条件

• 依赖 Docker 环境（Docker Engine 20.10+）；
• 建议配备至少 2GB 内存及 20GB 存储空间（开发环境资源需求）；
• 需提前配置外部数据库（如 PostgreSQL、Redis），具体依赖与官方 Misskey 一致（参考 Misskey 官方文档）。

4.2 快速启动（docker run）

bash
docker run -d \
  --name srgr0-misskey-dev \
  -p 3000:3000 \  # 默认应用端口（需与内部配置一致）
  -v ./your-code:/app  # 挂载本地代码目录（开发调试用）
  -e NODE_ENV=development \  # 强制开发环境模式
  srgr0/misskey

说明：

• 端口映射：3000 为默认应用端口，需根据实际配置调整；
• 代码挂载：通过 -v 将本地开发代码挂载至容器内 /app 目录，实现热重载（需镜像支持）；
• 环境变量：NODE_ENV=development 确保容器以开发模式运行。

4.3 Docker Compose 配置示例

yaml
version: '3'

services:
  misskey-dev:
    image: srgr0/misskey
    container_name: srgr0-misskey-dev
    ports:
      - "3000:3000"
    volumes:
      - ./your-code:/app  # 本地代码目录挂载
      - ./node_modules:/app/node_modules  # 依赖缓存（可选）
    environment:
      - NODE_ENV=development
      - DB_HOST=postgres  # 外部数据库地址（需自行部署 PostgreSQL/Redis）
      - DB_PORT=5432
      - REDIS_HOST=redis
      - REDIS_PORT=6379
    depends_on:
      - postgres  # 需额外定义 postgres/redis 服务（参考官方 Misskey docker-compose）
      - redis

注意：
完整配置需包含 PostgreSQL、Redis 等依赖服务，具体可参考 https://github.com/misskey-dev/misskey/blob/develop/docker-compose.yml 并适配本镜像。

4.4 配置说明

4.4.1 必要配置

• 端口映射：需暴露应用端口（默认 3000，具体以镜像内配置为准）；
• 代码挂载：开发模式下需挂载本地代码目录至容器内应用路径（通常为 /app）；
• 环境变量：通过 -e 或 environment 配置开发环境必要参数（如数据库连接信息、NODE_ENV 等）。

4.4.2 注意事项

• 该镜像未内置数据库服务，需自行部署并配置 PostgreSQL、Redis 等依赖；
• 开发环境下数据持久化需通过卷挂载实现，避免容器重启导致数据丢失；
• 具体配置细节（如环境变量、目录结构）请参考镜像维护者（Srgr0）提供的文档或源码说明。

五、注意事项

1. 生产环境禁用：该镜像缺乏生产环境所需的安全加固、性能优化及数据备份机制，禁止用于生产部署；
2. 兼容性：功能兼容性与 misskey-dev/misskey 官方镜像对应分支保持一致，建议优先参考官方文档进行环境配置；
3. 更新维护：镜像更新频率及维护策略请关注 https://github.com/Srgr0/misskey%EF%BC%88%E5%A6%82%E6%9C%89%EF%BC%89%E3%80%82