fox1t/turborepo-remote-cache

Turborepo Remote Cache 镜像文档

镜像概述

该镜像是Turborepo自定义远程缓存服务器的开源实现。当Vercel官方缓存服务器不可用时，本镜像提供了自托管部署的替代方案，支持多种存储提供商和部署环境，并提供便捷的一键部署功能。

核心功能与特性

支持的存储提供商

• 本地文件系统：适用于简单的本地部署场景
• AWS S3：集成亚马逊云存储服务
• Google Cloud Storage：支持谷歌云存储
• Azure Blob Storage：兼容微软Azure blob存储服务

其他特性

• 轻量级部署：支持多种容器化部署环境
• 灵活配置：通过环境变量进行全面配置
• 开源可靠：活跃的社区维护和持续集成

使用场景与适用范围

• 自托管需求：需要完全控制缓存数据存储位置的组织
• 私有部署：在企业内部网络或私有云环境中部署缓存服务
• 多团队协作：为Turborepo monorepo项目提供共享缓存服务
• 成本优化：替代Vercel官方服务以降低云服务成本

使用方法与配置说明

基本部署（Docker Run）

bash
docker run -d \
  -p 3000:3000 \
  -e STORAGE_PROVIDER=local \
  -e STORAGE_PATH=/app/cache \
  -v ./cache-data:/app/cache \
  --name turborepo-remote-cache \
  fox1t/turborepo-remote-cache

Docker Compose 配置

yaml
version: '3.8'
services:
  turborepo-cache:
    image: fox1t/turborepo-remote-cache
    ports:
      - "3000:3000"
    environment:
      - STORAGE_PROVIDER=s3
      - AWS_ACCESS_KEY_ID=your-access-key
      - AWS_SECRET_ACCESS_KEY=your-secret-key
      - AWS_REGION=us-east-1
      - AWS_BUCKET_NAME=turborepo-cache
      - PORT=3000
      - TOKEN=your-secure-token
    restart: unless-stopped

环境变量配置

基础配置

• PORT: 服务器监听端口，默认值：3000
• STORAGE_PROVIDER: 存储提供商类型，可选值：local、s3、gcs、azure
• TOKEN: 访问认证令牌（可选）
• TOKEN_HEADER: 认证令牌请求头，默认值：Authorization

本地文件系统配置

• STORAGE_PATH: 本地存储路径，默认值：./cache

AWS S3 配置

• AWS_ACCESS_KEY_ID: AWS访问密钥ID
• AWS_SECRET_ACCESS_KEY: AWS秘密访问密钥
• AWS_REGION: AWS区域
• AWS_BUCKET_NAME: S3存储桶名称
• AWS_ENDPOINT: 自定义S3兼容服务端点（可选）

Google Cloud Storage 配置

• GCS_BUCKET_NAME: GCS存储桶名称
• GCS_KEY_FILE: GCS服务账户密钥文件路径（容器内路径）

Azure Blob Storage 配置

• AZURE_STORAGE_ACCOUNT_NAME: Azure存储账户名称
• AZURE_STORAGE_ACCOUNT_KEY: Azure存储账户密钥
• AZURE_CONTAINER_NAME: Azure容器名称

在Turborepo中启用自定义远程缓存

1. 在Turborepo项目根目录的turbo.json中添加配置：

json
{
  "remoteCache": {
    "url": "http://your-server-ip:3000",
    "headers": {
      "Authorization": "your-secure-token"
    }
  }
}

2. 运行Turborepo命令时使用远程缓存：

bash
turbo run build --remote-cache=always

更多资源

• https://ducktors.github.io/turborepo-remote-cache/
• https://github.com/ducktors/turborepo-remote-cache
• https://hub.docker.com/r/fox1t/turborepo-remote-cache