sourceforgery/tachikoma-webserver

Tachikoma 镜像文档

镜像概述和主要用途

Tachikoma 是一个自托管的电子邮件服务提供商（Email Service Provider），由 tachikoma-postfix（邮件服务器组件）和 tachikoma-webserver（Web服务组件）构成。其核心用途是提供自主可控的邮件服务解决方案，支持多账户与多域名管理，适用于需要自建邮件系统的场景。

核心功能和特性

多账户与域名支持

• 可管理多个独立电子邮件账户及域名
• 每个域名需部署独立的 tachikoma-postfix 容器实例，实现域名级隔离

跨语言集成能力

• 内置 gRPC API 接口，支持与主流编程语言无缝集成，包括 C、C++、C#、Go、Java、JavaScript、Python、Rust 等
• API 设计简洁，降低二次开发与系统对接门槛

轻量化依赖架构

• 不内置数据库和消息队列，需外部部署 PostgreSQL（数据库）和 RabbitMQ（消息队列）
• 对 PostgreSQL 和 RabbitMQ 无特殊插件依赖或定制配置要求，使用默认配置即可正常工作

使用场景和适用范围

• 企业/组织内部邮件系统：需搭建私有邮件服务，实现数据自主管理的场景
• 多域名邮件管理：需为不同业务线、部门或项目管理独立邮件域名的场景
• 定制化邮件集成：通过 gRPC API 与现有业务系统（如 CRM、OA 系统）集成，实现定制化邮件发送/接收功能

使用方法和配置说明

前置依赖准备

部署前需预先准备以下服务：

• PostgreSQL 数据库（推荐版本 12+）
• RabbitMQ 消息队列（推荐版本 3.8+）

环境变量配置

Tachikoma-webserver 容器需通过环境变量配置外部依赖连接信息，关键参数如下：

部署示例

Docker Run 部署（单域名场景）

1. 启动 Webserver 容器

bash
docker run -d \
  --name tachikoma-webserver \
  -p 50051:50051 \  # gRPC API 端口
  -e DB_HOST=your-postgres-ip \
  -e DB_PORT=5432 \
  -e DB_NAME=tachikoma \
  -e DB_USER=dbuser \
  -e DB_PASSWORD=dbpass \
  -e RABBITMQ_HOST=your-rabbitmq-ip \
  -e RABBITMQ_USER=rabbituser \
  -e RABBITMQ_PASSWORD=rabbitpass \
  tachikoma-webserver:latest

2. 启动 Postfix 容器（单域名示例）

为 example.com 域名部署独立 Postfix 容器：

bash
docker run -d \
  --name tachikoma-postfix-example.com \
  -e DOMAIN=example.com \
  --link tachikoma-webserver:webserver \
  tachikoma-postfix:latest

Docker Compose 完整部署示例

yaml
version: '3'

services:
  # 数据库服务
  postgres:
    image: postgres:14
    environment:
      POSTGRES_DB: tachikoma
      POSTGRES_USER: tachikoma
      POSTGRES_PASSWORD: securepass
    volumes:
      - postgres-data:/var/lib/postgresql/data

  # 消息队列服务
  rabbitmq:
    image: rabbitmq:3.10-management
    environment:
      RABBITMQ_DEFAULT_USER: rabbituser
      RABBITMQ_DEFAULT_PASS: rabbitpass
    ports:
      - "15672:15672"  # 管理界面端口

  # Web 服务组件
  tachikoma-webserver:
    image: tachikoma-webserver:latest
    depends_on:
      - postgres
      - rabbitmq
    environment:
      DB_HOST: postgres
      DB_PORT: 5432
      DB_NAME: tachikoma
      DB_USER: tachikoma
      DB_PASSWORD: securepass
      RABBITMQ_HOST: rabbitmq
      RABBITMQ_PORT: 5672
      RABBITMQ_USER: rabbituser
      RABBITMQ_PASSWORD: rabbitpass
    ports:
      - "50051:50051"  # gRPC API 端口

  # Postfix 组件（example.com 域名）
  tachikoma-postfix-example.com:
    image: tachikoma-postfix:latest
    depends_on:
      - tachikoma-webserver
    environment:
      DOMAIN: example.com
    links:
      - tachikoma-webserver:webserver

volumes:
  postgres-data:  # 持久化数据库数据

注意事项

• 域名隔离要求：每个域名必须部署独立的 tachikoma-postfix 容器，并通过 DOMAIN 环境变量指定域名
• 网络互通配置：确保 tachikoma-webserver 与 tachikoma-postfix 容器网络互通（可通过 --link 或自定义网络实现）
• 数据持久化：生产环境需为 PostgreSQL 配置数据卷，避免容器重启导致数据丢失
• 安全配置：建议为数据库和消息队列设置强密码，并限制访问来源 IP