chn2guevara/languagetool

languagetool

支持ngrams自动下载的LanguageTool镜像

镜像概述和主要用途

本镜像基于LanguageTool构建，提供语言检查服务，支持ngrams数据集的自动下载与更新。LanguageTool是一款开源的语法、拼写和风格检查工具，可用于多种语言的文本校对。本镜像简化了ngrams数据的管理，方便用户快速部署具备高级语言检查能力的服务。

核心功能和特性

• 内置LanguageTool服务，默认运行在8010端口
• 支持ngrams数据集的自动下载与更新
• 可通过环境变量配置Java运行参数（如堆大小）
• 支持通过LT_前缀环境变量配置HTTPServer参数
• 提供Prometheus监控指标（需配置LT_prometheusMonitoring=true）

使用场景和适用范围

• 内容平台的实时文本校对服务
• 写作工具的语法检查插件后端
• 多语言应用的文本质量检测
• 需要自定义语言检查规则的企业级应用

使用方法和配置说明

基本使用

服务默认运行在8010端口，需暴露该端口。

1. 拉取镜像：

   bash
   docker pull docker.io/chn2guevara/languagetool
   

2. 运行容器：

   bash
   docker run --rm -p 8010:8010 docker.io/chn2guevara/languagetool
   

3. 验证服务： 访问http://localhost:8010/v2/languages可查看支持的语言列表。完整API文档见LanguageTool HTTP API。

配置选项

Java堆大小

通过JAVAOPTIONS环境变量设置Java相关参数：

bash
docker run --rm -it -p 8010:8010 -e JAVAOPTIONS="-Xmx382M" docker.io/chn2guevara/languagetool

HTTPServerConfig配置

所有以LT_为前缀的环境变量将被解析为HTTPServerConfig选项。例如启用Prometheus监控：

bash
docker run --rm -it -p 8010:8010 -p 9301:9301 \
  -e LT_prometheusMonitoring=true \
  docker.io/chn2guevara/languagetool

验证监控指标：

bash
curl -s localhost:9301 | grep -v '^\s*$\|^\s*\#'

n-gram数据集支持

需将目录或卷挂载到/ngrams目录以支持ngrams功能：

bash
docker run ... -v /本地目录:/ngrams ...

自动下载ngrams

挂载/ngrams目录并通过NGRAM_LANGUAGES环境变量指定需要下载的语言（逗号分隔）：

bash
docker run ... -v /path/to/ngrams:/ngrams -e NGRAM_LANGUAGES="en,es" ...

手动下载ngrams

手动下载并解压ngrams数据：

bash
mkdir ngrams
wget https://languagetool.org/download/ngram-data/ngrams-en-YYYYMMDD.zip  # 替换YYYYMMDD为具体日期
(cd ngrams && unzip ../ngrams-en-YYYYMMDD.zip)
rm -f ngrams-en-YYYYMMDD.zip

目录结构需满足：

ngrams/
 en/
  ...
 es/
  ...