# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: LanguageTool spec: description: | LanguageTool is an open-source grammar, style, and spell checker supporting 30+ languages. Self-host your own proofreading API and point browser extensions or custom integrations to it. coverImage: https://raw.githubusercontent.com/languagetool-org/languagetool/master/languagetool-standalone/src/main/resources/org/languagetool/resource/TrayIcon.png icon: https://raw.githubusercontent.com/languagetool-org/languagetool/master/languagetool-standalone/src/main/resources/org/languagetool/resource/TrayIcon.png variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: The domain to access LanguageTool tags: - Tool - Productivity readme: | # LanguageTool A self-hosted grammar, style, and spell checking API that supports 30+ languages. Runs as a standalone Java server with no external database required. ## What You Can Do After Deployment LanguageTool exposes a REST API at `${ZEABUR_WEB_URL}`. The main endpoint for checking text is: ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **Quick test with curl:** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` The API returns JSON with detected errors, suggested corrections, and rule explanations. **Available API endpoints:** - `POST /v2/check` — Check text for grammar, spelling, and style issues - `GET /v2/languages` — List all supported languages - `POST /v2/words/add` — Add words to the user dictionary - `POST /v2/words/delete` — Remove words from the user dictionary ## Using with Browser Extensions The official LanguageTool browser extension (available for Chrome and Firefox) can be configured to use your self-hosted instance instead of the public API. In the extension settings, set the server URL to `${ZEABUR_WEB_URL}/v2`. ## Configuration - **Java_Xms** — Minimum Java heap size (default: `512m`). Increase for better performance with heavy usage. - **Java_Xmx** — Maximum Java heap size (default: `1g`). Increase if you need to check very long texts or handle many concurrent requests. Recommended: at least `1g` for production use. ## License LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool) services: - name: languagetool icon: https://raw.githubusercontent.com/languagetool-org/languagetool/master/languagetool-standalone/src/main/resources/org/languagetool/resource/TrayIcon.png template: PREBUILT_V2 spec: source: image: erikvl87/languagetool:6.7-dockerupdate-3 ports: - id: web port: 8010 type: HTTP env: Java_Xms: default: 512m Java_Xmx: default: 1g healthCheck: type: HTTP port: web http: path: /v2/languages domainKey: PUBLIC_DOMAIN localization: es-ES: description: | LanguageTool es un corrector gramatical, de estilo y ortográfico de código abierto que soporta más de 30 idiomas. Aloja tu propia API de revisión y conecta extensiones de navegador o integraciones personalizadas. variables: - key: PUBLIC_DOMAIN type: STRING name: Dominio description: El dominio para acceder a LanguageTool readme: | # LanguageTool API autoalojada de revisión gramatical, de estilo y ortográfica que soporta más de 30 idiomas. Servidor Java independiente sin necesidad de base de datos externa. ## Qué puedes hacer después del despliegue LanguageTool expone una API REST en `${ZEABUR_WEB_URL}`. El endpoint principal para verificar texto: ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **Prueba rápida con curl:** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` **Endpoints disponibles:** - `POST /v2/check` — Verificar texto para problemas de gramática, ortografía y estilo - `GET /v2/languages` — Listar todos los idiomas soportados - `POST /v2/words/add` — Agregar palabras al diccionario del usuario - `POST /v2/words/delete` — Eliminar palabras del diccionario del usuario ## Uso con extensiones de navegador La extensión oficial de LanguageTool (disponible para Chrome y Firefox) puede configurarse para usar tu instancia autoalojada. En la configuración de la extensión, establece la URL del servidor a `${ZEABUR_WEB_URL}/v2`. ## Configuración - **Java_Xms** — Tamaño mínimo del heap de Java (por defecto: `512m`) - **Java_Xmx** — Tamaño máximo del heap de Java (por defecto: `1g`), recomendado al menos `1g` para producción ## Licencia LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool) id-ID: description: | LanguageTool adalah pemeriksa tata bahasa, gaya, dan ejaan open-source yang mendukung 30+ bahasa. Host API proofreading Anda sendiri dan hubungkan ekstensi browser atau integrasi kustom. variables: - key: PUBLIC_DOMAIN type: STRING name: Domain description: Domain untuk mengakses LanguageTool readme: | # LanguageTool API pemeriksaan tata bahasa, gaya, dan ejaan self-hosted yang mendukung 30+ bahasa. Server Java standalone tanpa memerlukan database eksternal. ## Apa yang bisa dilakukan setelah deploy LanguageTool menyediakan REST API di `${ZEABUR_WEB_URL}`. Endpoint utama untuk memeriksa teks: ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **Tes cepat dengan curl:** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` **Endpoint API yang tersedia:** - `POST /v2/check` — Periksa teks untuk masalah tata bahasa, ejaan, dan gaya - `GET /v2/languages` — Daftar semua bahasa yang didukung - `POST /v2/words/add` — Tambahkan kata ke kamus pengguna - `POST /v2/words/delete` — Hapus kata dari kamus pengguna ## Penggunaan dengan ekstensi browser Ekstensi browser resmi LanguageTool (tersedia untuk Chrome dan Firefox) dapat dikonfigurasi untuk menggunakan instance self-hosted Anda. Di pengaturan ekstensi, atur URL server ke `${ZEABUR_WEB_URL}/v2`. ## Konfigurasi - **Java_Xms** — Ukuran minimum heap Java (default: `512m`) - **Java_Xmx** — Ukuran maksimum heap Java (default: `1g`), disarankan minimal `1g` untuk produksi ## Lisensi LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool) ja-JP: description: | LanguageToolは30以上の言語に対応するオープンソースの文法・スタイル・スペルチェッカーです。自前の校正APIをホストし、ブラウザ拡張機能やカスタム連携から利用できます。 variables: - key: PUBLIC_DOMAIN type: STRING name: ドメイン description: LanguageToolにアクセスするためのドメイン readme: | # LanguageTool 30以上の言語に対応するセルフホスト型の文法・スタイル・スペルチェックAPI。外部データベース不要のスタンドアロンJavaサーバーです。 ## デプロイ後にできること `${ZEABUR_WEB_URL}` でREST APIが利用可能です。テキストチェックのメインエンドポイント： ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **curlでクイックテスト：** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` **利用可能なAPIエンドポイント：** - `POST /v2/check` — テキストの文法・スペル・スタイルをチェック - `GET /v2/languages` — サポート言語一覧を取得 - `POST /v2/words/add` — ユーザー辞書に単語を追加 - `POST /v2/words/delete` — ユーザー辞書から単語を削除 ## ブラウザ拡張機能との連携 公式のLanguageToolブラウザ拡張機能（Chrome・Firefox対応）で、公開APIの代わりにセルフホストインスタンスを使用可能。拡張機能の設定でサーバーURLを `${ZEABUR_WEB_URL}/v2` に設定してください。 ## 設定 - **Java_Xms** — Javaヒープ最小サイズ（デフォルト：`512m`） - **Java_Xmx** — Javaヒープ最大サイズ（デフォルト：`1g`）、本番環境では最低 `1g` 推奨 ## ライセンス LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool) ko-KR: description: | LanguageTool은 30개 이상의 언어를 지원하는 오픈소스 문법, 스타일, 맞춤법 검사기입니다. 자체 교정 API를 호스팅하고 브라우저 확장 프로그램이나 커스텀 통합을 연결할 수 있습니다. variables: - key: PUBLIC_DOMAIN type: STRING name: 도메인 description: LanguageTool에 접속할 도메인 readme: | # LanguageTool 30개 이상의 언어를 지원하는 셀프호스팅 문법, 스타일, 맞춤법 검사 API. 외부 데이터베이스가 필요 없는 독립 실행형 Java 서버입니다. ## 배포 후 할 수 있는 것 `${ZEABUR_WEB_URL}`에서 REST API를 사용할 수 있습니다. 텍스트 검사의 주요 엔드포인트: ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **curl로 빠른 테스트:** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` **사용 가능한 API 엔드포인트:** - `POST /v2/check` — 텍스트의 문법, 맞춤법, 스타일 검사 - `GET /v2/languages` — 지원 언어 목록 조회 - `POST /v2/words/add` — 사용자 사전에 단어 추가 - `POST /v2/words/delete` — 사용자 사전에서 단어 삭제 ## 브라우저 확장 프로그램과 함께 사용 공식 LanguageTool 브라우저 확장 프로그램(Chrome, Firefox 지원)에서 공개 API 대신 셀프호스팅 인스턴스를 사용하도록 설정할 수 있습니다. 확장 프로그램 설정에서 서버 URL을 `${ZEABUR_WEB_URL}/v2`로 설정하세요. ## 설정 - **Java_Xms** — Java 힙 최소 크기 (기본값: `512m`) - **Java_Xmx** — Java 힙 최대 크기 (기본값: `1g`), 프로덕션 환경에서 최소 `1g` 권장 ## 라이선스 LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool) th-TH: description: | LanguageTool เป็นตัวตรวจไวยากรณ์ สไตล์ และการสะกดแบบโอเพนซอร์สที่รองรับมากกว่า 30 ภาษา โฮสต์ API ตรวจทานของคุณเองและเชื่อมต่อส่วนขยายเบราว์เซอร์หรือการผสานรวมที่กำหนดเอง variables: - key: PUBLIC_DOMAIN type: STRING name: โดเมน description: โดเมนสำหรับเข้าถึง LanguageTool readme: | # LanguageTool API ตรวจไวยากรณ์ สไตล์ และการสะกดแบบ self-hosted ที่รองรับมากกว่า 30 ภาษา เซิร์ฟเวอร์ Java แบบ standalone ไม่ต้องใช้ฐานข้อมูลภายนอก ## สิ่งที่ทำได้หลังจากติดตั้ง LanguageTool ให้บริการ REST API ที่ `${ZEABUR_WEB_URL}` Endpoint หลักสำหรับตรวจสอบข้อความ: ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **ทดสอบด่วนด้วย curl:** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` **Endpoint API ที่ใช้งานได้:** - `POST /v2/check` — ตรวจสอบข้อความสำหรับปัญหาไวยากรณ์ การสะกด และสไตล์ - `GET /v2/languages` — แสดงรายการภาษาที่รองรับทั้งหมด - `POST /v2/words/add` — เพิ่มคำในพจนานุกรมผู้ใช้ - `POST /v2/words/delete` — ลบคำจากพจนานุกรมผู้ใช้ ## ใช้งานร่วมกับส่วนขยายเบราว์เซอร์ ส่วนขยายเบราว์เซอร์ LanguageTool อย่างเป็นทางการ (สำหรับ Chrome และ Firefox) สามารถตั้งค่าให้ใช้ instance ที่ self-hosted แทน API สาธารณะ ในการตั้งค่าส่วนขยาย ตั้ง URL เซิร์ฟเวอร์เป็น `${ZEABUR_WEB_URL}/v2` ## การตั้งค่า - **Java_Xms** — ขนาด heap ขั้นต่ำของ Java (ค่าเริ่มต้น: `512m`) - **Java_Xmx** — ขนาด heap สูงสุดของ Java (ค่าเริ่มต้น: `1g`) แนะนำอย่างน้อย `1g` สำหรับใช้งานจริง ## สัญญาอนุญาต LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool) zh-CN: description: | LanguageTool 是开源的语法、风格与拼写检查工具，支持 30+ 种语言。自托管你自己的校对 API，并将浏览器扩展或自定义集成指向它。 variables: - key: PUBLIC_DOMAIN type: STRING name: 域名 description: 访问 LanguageTool 的域名 readme: | # LanguageTool 自托管的语法、风格与拼写检查 API，支持 30+ 种语言。以独立 Java 服务器运行，不需要外部数据库。 ## 部署后可以做什么 LanguageTool 在 `${ZEABUR_WEB_URL}` 提供 REST API。文本检查的主要端点为： ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **用 curl 快速测试：** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` **可用的 API 端点：** - `POST /v2/check` — 检查文本的语法、拼写与风格问题 - `GET /v2/languages` — 列出所有支持的语言 - `POST /v2/words/add` — 添加词语到用户字典 - `POST /v2/words/delete` — 从用户字典移除词语 ## 搭配浏览器扩展使用 官方 LanguageTool 浏览器扩展（支持 Chrome 和 Firefox）可以配置使用你的自托管实例。在扩展设置中，将服务器 URL 设为 `${ZEABUR_WEB_URL}/v2`。 ## 设置 - **Java_Xms** — Java 堆最小值（默认：`512m`） - **Java_Xmx** — Java 堆最大值（默认：`1g`），建议生产环境至少 `1g` ## 许可证 LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool) zh-TW: description: | LanguageTool 是開源的文法、風格與拼字檢查工具，支援 30+ 種語言。自架你自己的校對 API，並將瀏覽器擴充套件或自訂整合指向它。 variables: - key: PUBLIC_DOMAIN type: STRING name: 網域 description: 存取 LanguageTool 的網域 readme: | # LanguageTool 自架的文法、風格與拼字檢查 API，支援 30+ 種語言。以獨立 Java 伺服器運行，不需要外部資料庫。 ## 部署後可以做什麼 LanguageTool 在 `${ZEABUR_WEB_URL}` 提供 REST API。文字檢查的主要端點為： ``` POST ${ZEABUR_WEB_URL}/v2/check ``` **用 curl 快速測試：** ```bash curl -d "language=en-US&text=This is a example sentence with a error." \ "${ZEABUR_WEB_URL}/v2/check" ``` API 會回傳 JSON 格式的錯誤資訊、建議修正與規則說明。 **可用的 API 端點：** - `POST /v2/check` — 檢查文字的文法、拼字與風格問題 - `GET /v2/languages` — 列出所有支援的語言 - `POST /v2/words/add` — 新增字詞到使用者字典 - `POST /v2/words/delete` — 從使用者字典移除字詞 ## 搭配瀏覽器擴充套件使用 官方 LanguageTool 瀏覽器擴充套件（支援 Chrome 和 Firefox）可以設定使用你的自架實例取代公開 API。在擴充套件設定中，將伺服器 URL 設為 `${ZEABUR_WEB_URL}/v2`。 ## 設定 - **Java_Xms** — Java 堆積最小值（預設：`512m`） - **Java_Xmx** — Java 堆積最大值（預設：`1g`），建議正式環境至少 `1g` ## 授權 LGPL-2.1 — [GitHub](https://github.com/languagetool-org/languagetool)