erlend/lucky

Lucky Docker镜像文档

镜像概述和主要用途

该Docker镜像专为Lucky框架项目设计，提供便捷的开发和部署环境。Lucky是基于Crystal语言的高性能Web框架，镜像通过不同标签满足不同项目需求，支持API开发和包含前端工具的完整项目开发。

核心功能和特性

标签说明

• latest 或 ${LUCKY_VERSION}：API项目的最小镜像，仅包含运行Lucky后端所需的核心依赖
• full 或 full-${LUCKY_VERSION}：完整版本，额外包含node、yarn和chromium，适用于需要前端构建和浏览器环境的项目

使用场景和适用范围

• API项目：适用于仅需后端API开发的场景，不需要前端资源构建
• 完整项目：适用于需要前端资源构建（如使用yarn管理依赖）、浏览器测试（如集成chromium）的全栈项目

使用方法和配置说明

使用docker-compose部署

API项目配置

yaml
version: "3.4"
x-defaults: &defaults
  image: erlend/lucky:0.18  # 使用API项目最小镜像，指定版本0.18
  user: "${UID:-1000}:${GID:-1000}"  # 使用当前用户ID和组ID，避免权限问题
  environment:
    DB_HOST: database  # 数据库主机名，对应services中的database服务
  volumes:
    - .:/app  # 将当前目录挂载到容器内/app目录
    - crystal_libs:/app/lib  # 持久化Crystal依赖库
    - crystal_cache:/app/.crystal  # 持久化Crystal缓存
    - crystal_shards:/app/.shards  # 持久化Shards依赖管理工具数据
  restart: on-failure  # 失败时自动重启

services:
  setup:
    <<: *default  # 继承defaults配置
    command: script/setup  # 执行项目初始化脚本
    depends_on:
      - database  # 依赖database服务

  web:
    <<: *default
    command: lucky watch --reload-browser  # 启动Lucky开发服务器，支持浏览器自动重载
    ports:
      - 5000:5000  # 映射容器5000端口到主机5000端口
    depends_on:
      - database  # 依赖database服务

  database:
    image: postgres:11-alpine  # 使用PostgreSQL 11 Alpine版本作为数据库
    environment:
      POSTGRES_PASSWORD: "postgres"  # 数据库密码
    volumes:
      - postgres_data:/var/lib/postgresql/data  # 持久化数据库数据

volumes:
  crystal_libs:  # 定义Crystal依赖库卷
  crystal_cache:  # 定义Crystal缓存卷
  crystal_shards:  # 定义Shards数据卷
  postgres_data:  # 定义PostgreSQL数据卷

完整项目配置

yaml
version: "3.4"
x-defaults: &defaults
  image: erlend/lucky:full-0.18  # 使用完整版本镜像，指定版本0.18
  user: "${UID:-1000}:${GID:-1000}"  # 使用当前用户ID和组ID，避免权限问题
  environment:
    DB_HOST: database  # 数据库主机名，对应services中的database服务
  volumes:
    - .:/app  # 将当前目录挂载到容器内/app目录
    - crystal_libs:/app/lib  # 持久化Crystal依赖库
    - crystal_cache:/app/.crystal  # 持久化Crystal缓存
    - crystal_shards:/app/.shards  # 持久化Shards依赖管理工具数据
    - node_modules:/app/node_modules  # 持久化node依赖
  restart: on-failure  # 失败时自动重启

services:
  setup:
    <<: *default  # 继承defaults配置
    command: script/setup  # 执行项目初始化脚本
    depends_on:
      - database  # 依赖database服务

  web:
    <<: *default
    command: lucky watch --reload-browser  # 启动Lucky开发服务器，支持浏览器自动重载
    ports:
      - 5000:5000  # 映射容器5000端口到主机5000端口
      - 3001:3001  # 额外映射3001端口（通常用于前端开发服务器）
    depends_on:
      - database  # 依赖database服务

  assets:
    <<: *default
    command: yarn watch  # 启动yarn监听前端资源变化并自动构建

  database:
    image: postgres:11-alpine  # 使用PostgreSQL 11 Alpine版本作为数据库
    environment:
      POSTGRES_PASSWORD: "postgres"  # 数据库密码
    volumes:
      - postgres_data:/var/lib/postgresql/data  # 持久化数据库数据

volumes:
  crystal_libs:  # 定义Crystal依赖库卷
  crystal_cache:  # 定义Crystal缓存卷
  crystal_shards:  # 定义Shards数据卷
  node_modules:  # 定义node依赖卷
  postgres_data:  # 定义PostgreSQL数据卷