​
镜像版本

Teable 镜像分为企业版和社区版两个版本，在镜像名称后添加 -ee 后缀即可切换。

​
企业版

# 应用
registry.cn-shenzhen.aliyuncs.com/teable/teable-ee:latest
# 数据库初始化
registry.cn-shenzhen.aliyuncs.com/teable/teable-db-migrate-ee:latest

企业版可免费使用社区版包含的本全部功能，并支持使用 License 订阅企业版本独有功能，企业版功能可在价格页面查阅。企业版本数据与社区版本兼容，版本可以互相切换。

​
社区版

# 应用
registry.cn-shenzhen.aliyuncs.com/teable/teable:latest
# 数据库初始化
registry.cn-shenzhen.aliyuncs.com/teable/teable-db-migrate:latest

社区版是由开源代码构建出来的镜像，不包含企业版本的任何功能。数据与企业版兼容，可随时切换为企业版本。

​
Docker Compose 部署

适用规模：推荐 0-1000人

优点缺点
部署简单单机部署，扩容繁琐
自主可控
灵活可配置

服务器环境

确保您的服务器满足以下基本要求：

  • 操作系统：建议使用Linux发行版，如Ubuntu 20.04 LTS。
  • 内存：至少4GB RAM。
  • CPU：至少2核。
  • 磁盘空间：至少40GB的可用空间。
  • 网络：具有稳定的互联网连接，并允许必要的端口访问。

​
先决条件

在开始之前，请确保您具备以下条件：

  • 理解Docker和容器化原理的基本知识。
  • 在您的机器上安装了Docker和Docker Compose。访问官方Docker文档了解安装指南。

​
安装 Docker

# 下载最新版本的 Docker
curl -fsSL https://get.docker.com | bash -s docker --mirror Aliyun


# 验证安装是否正确
docker --version
docker-compose --version

​
安装应用

​
1. 创建 docker-compose 文件

进入服务器, 创建并进入 teable 文件夹

mkdir teable

cd teable

创建一个 docker-compose.yaml 以及一个 .env 文件，并粘贴下面内容，已使用国内镜像源以保证顺畅安装

vim docker-compose.yaml

​
最小化部署：

docker-compose.yaml
version: '3.9'

services:
  teable:
    image: registry.cn-shenzhen.aliyuncs.com/teable/teable-ee:latest
    restart: always
    ports:
      - '3000:3000'
    volumes:
      - teable-data:/app/.assets:rw
    env_file:
      - .env
    environment:
      - NEXT_ENV_IMAGES_ALL_REMOTE=true
    networks:
      - teable
    depends_on:
      teable-db-migrate:
        condition: service_completed_successfully
      teable-cache:
        condition: service_healthy
    healthcheck:
      test: ['CMD', 'curl', '-f', 'http://localhost:3000/health']
      start_period: 5s
      interval: 5s
      timeout: 3s
      retries: 3

  teable-db:
    image: postgres:15.4
    restart: always
    ports:
      - '42345:5432'
    volumes:
      - teable-db:/var/lib/postgresql/data:rw
    environment:
      - POSTGRES_DB=${POSTGRES_DB}
      - POSTGRES_USER=${POSTGRES_USER}
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}
    networks:
      - teable
    healthcheck:
      test: ['CMD-SHELL', "sh -c 'pg_isready -U ${POSTGRES_USER} -d ${POSTGRES_DB}'"]
      interval: 10s
      timeout: 3s
      retries: 3

  teable-db-migrate:
    image: registry.cn-shenzhen.aliyuncs.com/teable/teable-db-migrate-ee:latest
    environment:
      - PRISMA_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
    networks:
      - teable
    depends_on:
      teable-db:
        condition: service_healthy

  teable-cache:
    image: registry.cn-shenzhen.aliyuncs.com/teable/redis:7.2.4
    restart: always
    expose:
      - '6379'
    volumes:
      - teable-cache:/data:rw
    networks:
      - teable
    command: redis-server --appendonly yes --requirepass ${REDIS_PASSWORD}
    healthcheck:
      test: ['CMD', 'redis-cli', '--raw', 'incr', 'ping']
      interval: 10s
      timeout: 3s
      retries: 3

networks:
  teable:
    name: teable-network

volumes:
  teable-db: {}
  teable-data: {}
  teable-cache: {}
.env
# 替换下面默认密码, 推荐使用 8 位以上的强密码。
POSTGRES_PASSWORD=replace_this_password
REDIS_PASSWORD=replace_this_password
SECRET_KEY=replace_this_secret_key

# 请将下面替换为可公开访问的地址
PUBLIC_ORIGIN=http://127.0.0.1:3000

# ---------------------

# Postgres
POSTGRES_HOST=teable-db
POSTGRES_PORT=5432
POSTGRES_DB=teable
POSTGRES_USER=teable

# Redis
REDIS_HOST=teable-cache
REDIS_PORT=6379
REDIS_DB=0

# App
PRISMA_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
BACKEND_CACHE_PROVIDER=redis
BACKEND_CACHE_REDIS_URI=redis://default:${REDIS_PASSWORD}@${REDIS_HOST}:${REDIS_PORT}/${REDIS_DB}

​
增加存储服务（可选）：

Teable 默认使用本地存储管理附件资源，可以添加 minio 或云存储来获取更强大、稳定的服务

minio 提供了额外的存储管理界面（9001 端口）以及更强大的稳定的文件服务

docker-compose.yaml
version: '3.9'

services:
  # ...前面的内容
  teable-storage:
    image: registry.cn-shenzhen.aliyuncs.com/teable/minio:RELEASE.2024-02-17T01-15-57Z
    ports:
      - "9000:9000"
      - "9001:9001"
    environment:
      - MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY}
      - MINIO_SECRET_KEY=${MINIO_SECRET_KEY}
    volumes:
      - teable-storage:/data:rw
    networks:
      - teable
    command: server /data --console-address ":9001"
  createbuckets:
    image: registry.cn-shenzhen.aliyuncs.com/teable/mc
    networks:
      - teable
    entrypoint: >
      /bin/sh -c "
      /usr/bin/mc alias set teable-storage http://teable-storage:9000 ${MINIO_ACCESS_KEY} ${MINIO_SECRET_KEY};
      /usr/bin/mc mb teable-storage/public;
      /usr/bin/mc anonymous set public teable-storage/public;
      /usr/bin/mc mb teable-storage/private;
      exit 0;
      "
    depends_on:
      teable-storage:
        condition: service_started

networks:
  teable:
    name: teable-network

volumes:
  teable-db: {}
  teable-cache: {}
  # 增加一个卷
  teable-storage: {}
.env
# 替换下面默认密码, 推荐使用 8 位以上的强密码。
POSTGRES_PASSWORD=replace_this_password
REDIS_PASSWORD=replace_this_password
SECRET_KEY=replace_this_secret_key

# 如果启用 https，请将 PROTOCAL 设置为 https。
PROTOCAL=http
# 请将 PUBLIC_HOST 设置为当前部署的主机的 IP 或者域名。无法使用 localhost 或 127.0.0.1。
PUBLIC_HOST=192.168.x.x
# 请将最后端口修改为正式访问地址的端口，如 为 80 或 443 可去掉:和端口号。
PUBLIC_ORIGIN=${PROTOCAL}://${PUBLIC_HOST}:3000

# ---------------------

# Postgres
POSTGRES_HOST=teable-db
POSTGRES_PORT=5432
POSTGRES_DB=teable
POSTGRES_USER=teable

# Redis
REDIS_HOST=teable-cache
REDIS_PORT=6379
REDIS_DB=0

# Minio
MINIO_ACCESS_KEY=teable_minio_access
MINIO_SECRET_KEY=${SECRET_KEY}

# App
PRISMA_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
BACKEND_CACHE_PROVIDER=redis
BACKEND_CACHE_REDIS_URI=redis://default:${REDIS_PASSWORD}@${REDIS_HOST}:${REDIS_PORT}/${REDIS_DB}
BACKEND_STORAGE_PROVIDER=minio
BACKEND_STORAGE_PUBLIC_BUCKET=public
BACKEND_STORAGE_PRIVATE_BUCKET=private
BACKEND_STORAGE_MINIO_USE_SSL=false # 如果启用 https 请修改该值为 true
BACKEND_STORAGE_MINIO_ENDPOINT=${PUBLIC_HOST}
BACKEND_STORAGE_MINIO_PORT=9000
BACKEND_STORAGE_MINIO_ACCESS_KEY=${MINIO_ACCESS_KEY}
BACKEND_STORAGE_MINIO_SECRET_KEY=${MINIO_SECRET_KEY}
STORAGE_PREFIX=${PROTOCAL}://${PUBLIC_HOST}:${BACKEND_STORAGE_MINIO_PORT}

​
启动应用

在当前目录下执行启动应用，等待启动完毕访问 127.0.0.1:3000 即可进入应用

在进行大规模数据复制时，需要启用 HTTPS 环境，否则无法进行异步剪切板访问

docker-compose pull

docker-compose up -d

​
使用托管的数据库（可选）

如果希望使用托管的数据库和，则可以进一步精简部署过程。

  1. 删除 services.teable-db
  2. 删除 service.teable-db-migrate.depends_on
  3. 删除 volumes.teable-db
  4. 更新 .env 替换为托管数据库的配置

完整示例

docker-compose.yaml
version: '3.9'

services:
  teable:
    image: registry.cn-shenzhen.aliyuncs.com/teable/teable-ee:latest
    restart: always
    ports:
      - '3000:3000'
    env_file:
      - .env
    environment:
      - NEXT_ENV_IMAGES_ALL_REMOTE=true
    networks:
      - teable
    depends_on:
      teable-db-migrate:
        condition: service_completed_successfully
      teable-cache:
        condition: service_healthy
    healthcheck:
      test: ['CMD', 'curl', '-f', 'http://localhost:3000/health']
      start_period: 5s
      interval: 5s
      timeout: 3s
      retries: 3

  teable-db-migrate:
    image: registry.cn-shenzhen.aliyuncs.com/teable/teable-db-migrate-ee:latest
    environment:
      - TZ=${TIMEZONE}
      - PRISMA_DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}
    networks:
      - teable

  teable-cache:
    image: registry.cn-shenzhen.aliyuncs.com/teable/redis:7.2.4
    restart: always
    expose:
      - '6379'
    volumes:
      - teable-cache:/data:rw
    networks:
      - teable
    command: redis-server --appendonly yes --requirepass ${REDIS_PASSWORD}
    healthcheck:
      test: ['CMD', 'redis-cli', '--raw', 'incr', 'ping']
      interval: 10s
      timeout: 3s
      retries: 3
networks:
  teable:
    name: teable-network
    driver: bridge

volumes:
  teable-cache: {}

填写数据库参数为托管数据库的连接参数即可

.env
POSTGRES_HOST=your-database.com
POSTGRES_PORT=5432
POSTGRES_DB=teable
POSTGRES_USER=teable

注意127.0.0.1 为容器内网，如果你想连接本机部署的数据库 POSTGRES_HOST 请不要使用 127.0.0.1 而要是用 host.docker.internal 作为本机地址，否则将无法连接

如果使用外部托管 redis 则同理

  • 删除 service.teable-cache
  • 删除 service.teable.depends_on.teable-cache
  • 删除 volumes.teable-cache
  • 更新 .env 替换为托管redis的配置

​
下一步

配置邮件服务

配置外部数据库连接

​
支持与反馈

如果您在部署过程中遇到任何问题，请联系我们的支持团队 support@teable.io 或提交 issue。

​
许可证

Teable 社区版本在 AGPL-3.0 协议下开源。企业版本请联系我们获取商业许可。

一键云部署
Next