Docker Emacs 镜像文档

!CI状态

1. 镜像概述与主要用途

Docker Emacs 镜像旨在提供一个便捷的方式在 Docker 容器中运行 Emacs 编辑器。该项目基于 nix-emacs-ci 构建，封装了不同操作系统环境、Emacs 版本及开发工具链，满足多样化的 Emacs 使用与开发需求。

主要用途：

• 在隔离环境中运行 Emacs，避免系统环境冲突
• 为 Emacs 插件开发提供标准化测试环境
• 支持 CI/CD 流程中自动化测试 Emacs 配置或插件
• 快速部署轻量级 Emacs 开发环境

2. 核心功能与特性

2.1 多环境支持

• 操作系统：基于 Debian 和 Alpine Linux，兼顾兼容性与轻量性
• Emacs 版本：支持从 23.4 到最新 29.4 的多个稳定版本

2.2 分层镜像设计

• 基础镜像：仅包含 Emacs 及核心工具（curl、gnupg、ssh、wget）
• CI 镜像：在基础镜像上扩展 git、make 等构建工具
• 工具链镜像：进一步集成 Cask、Eask、eldev 等 Emacs 包管理工具

2.3 轻量级选项

• Alpine 系列镜像体积显著小于 Debian 系列（基础版约 240MB vs 370MB），适合资源受限环境

2.4 开发工具集成

• 内置多种 Emacs 生态工具：
  • Cask：Emacs 包管理工具
  • Eask：现代化 Emacs 包开发工具
  • eldev：Emacs Lisp 项目管理工具
  • keg：Emacs 包构建工具

3. 镜像变体与标签

3.1 镜像变体说明

Debian 系列（默认）

Alpine 系列

3.2 主要标签别名

3.3 版本标签示例

• 特定版本：29.4、28.2、27.2
• 版本系列：29（指向最新 29.x）、28（指向最新 28.x）
• Alpine 版本：29.4-alpine、28.2-alpine-ci
• CI 工具版本：29.4-ci-eask、28.2-alpine-ci-cask

4. 使用场景与适用范围

4.1 本地开发环境

• 快速试用不同 Emacs 版本：无需在系统中安装多个版本，直接通过容器启动
• 隔离配置测试：挂载不同配置目录测试插件兼容性，如：

  docker run -it --rm -v ~/test-emacs.d:/root/.emacs.d silex/emacs:29.4
  

4.2 CI/CD 流程集成

• 插件自动化测试：在 CI 中使用带 Eask/Cask 的镜像测试插件在不同 Emacs 版本下的兼容性
• 配置验证：自动测试 Emacs 配置文件在干净环境中的加载情况

4.3 Emacs 包开发

• 使用对应工具链镜像进行标准化开发：
  • Cask 项目：silex/emacs:ci-cask
  • Eask 项目：silex/emacs:ci-eask
  • eldev 项目：silex/emacs:ci-eldev

4.4 轻量级部署

• 在服务器或嵌入式设备中使用 Alpine 镜像运行轻量级 Emacs 服务

5. 使用方法与配置说明

5.1 基础使用

启动交互式 Emacs

# 默认 latest 镜像（Debian 29.4 基础版）
docker run -it --rm silex/emacs

# 指定 Alpine 版本
docker run -it --rm silex/emacs:alpine

# 指定具体版本
docker run -it --rm silex/emacs:28.2

运行 Emacs 命令

# 查看版本
docker run --rm silex/emacs emacs --version

# 执行 Lisp 表达式
docker run --rm silex/emacs emacs -Q --eval '(message "Hello from Docker Emacs")'

5.2 挂载本地文件

# 挂载当前目录到容器内 /app
docker run -it --rm -v $(pwd):/app -w /app silex/emacs

# 持久化 Emacs 配置和缓存
docker run -it --rm \
  -v ~/.emacs.d:/root/.emacs.d \
  -v ~/.emacs.cache:/root/.emacs.cache \
  silex/emacs

5.3 CI 环境使用示例（Eask 项目测试）

单命令测试

docker run --rm -v $(pwd):/app -w /app silex/emacs:ci-eask \
  sh -c "eask install-deps && eask build && eask test"

Docker Compose 配置

# docker-compose.yml
version: '3'
services:
  emacs-test:
    image: silex/emacs:ci-eask
    volumes:
      - ./:/app
    working_dir: /app
    command: sh -c "eask install-deps && eask test"

运行测试：

docker-compose up emacs-test

5.4 后台运行 Emacs 服务（如 Emacs Server）

# 启动 Emacs 服务并保持运行
docker run -d --name emacs-server silex/emacs emacs --daemon

# 连接到运行中的服务
docker exec -it emacs-server emacsclient -t

6. 替代方案

• flycheck/emacs-cask：专注于 Cask 的最小化 Emacs 镜像（源码编译）
• flycheck/emacs-travis：通过 Makefile 在 Travis CI 中安装 Emacs 的脚本工具
• jgkamat/airy-docker-emacs：基于 Alpine 的 Emacs 包管理器镜像
• JAremko/docker-emacs：专注于 GUI 支持的 Emacs 镜像

7. 贡献指南

欢迎贡献代码或改进，基本工作流程：

1. 修改 images.yml 配置文件
2. 修改 /templates 目录下的模板文件
3. 运行 bin/images --generate 命令生成新的 Dockerfile
4. 提交 PR 至 项目仓库