-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#82 Allow setting the logback configuration file
- Loading branch information
Showing
4 changed files
with
183 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| logback.xml |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,126 +1,144 @@ | ||
| [](https://github.com/Erikvl87/docker-languagetool) [](https://github.com/Erikvl87/docker-languagetool) [](https://hub.docker.com/r/erikvl87/languagetool) [](https://github.com/Erikvl87/docker-languagetool/releases) | ||
|
|
||
| # Dockerfile for LanguageTool | ||
| This repository contains a Dockerfile to create a Docker image for [LanguageTool](https://github.com/languagetool-org/languagetool). | ||
|
|
||
| > [LanguageTool](https://www.languagetool.org/) is an Open Source proofreading software for English, French, German, Polish, Russian, and [more than 20 other languages](https://languagetool.org/languages/). It finds many errors that a simple spell checker cannot detect. | ||
| # Setup | ||
|
|
||
| ## Setup using Docker Hub | ||
|
|
||
| ```sh | ||
| docker pull erikvl87/languagetool | ||
| docker run --rm -p 8010:8010 erikvl87/languagetool | ||
| ``` | ||
|
|
||
| This will pull the `latest` tag from Docker Hub. Optionally, specify a [tag](https://hub.docker.com/r/erikvl87/languagetool/tags) to pin onto a fixed version. These versions are derived from the official LanguageTool releases. Updates to the Dockerfile for already published versions are released with a `-dockerupdate-{X}` postfix in the tag (where `{X}` is an incremental number). | ||
|
|
||
| ## Setup using the Dockerfile | ||
| This approach could be used when you plan to make changes to the `Dockerfile`. | ||
|
|
||
| ```sh | ||
| git clone https://github.com/Erikvl87/docker-languagetool.git --config core.autocrlf=input | ||
| docker build -t languagetool . | ||
| docker run --rm -it -p 8010:8010 languagetool | ||
| ``` | ||
|
|
||
| # Configuration | ||
|
|
||
| ## Java heap size | ||
| LanguageTool will be started with a minimal heap size (`-Xms`) of `256m` and a maximum (`-Xmx`) of `512m`. You can overwrite these defaults by setting the [environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) `Java_Xms` and `Java_Xmx`. | ||
|
|
||
| An example startup configuration: | ||
|
|
||
| ```sh | ||
| docker run --rm -it -p 8010:8010 -e Java_Xms=512m -e Java_Xmx=2g erikvl87/languagetool | ||
| ``` | ||
|
|
||
| ## LanguageTool HTTPServerConfig | ||
| You are able to use the [HTTPServerConfig](https://languagetool.org/development/api/org/languagetool/server/HTTPServerConfig.html) configuration options by prefixing the fields with `langtool_` and setting them as [environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file). | ||
|
|
||
| An example startup configuration: | ||
|
|
||
| ```sh | ||
| docker run --rm -it -p 8010:8010 -e langtool_pipelinePrewarming=true -e Java_Xms=1g -e Java_Xmx=2g erikvl87/languagetool | ||
| ``` | ||
|
|
||
| ## Using n-gram datasets | ||
| > LanguageTool can make use of large n-gram data sets to detect errors with words that are often confused, like __their__ and __there__. | ||
| *Source: [https://dev.languagetool.org/finding-errors-using-n-gram-data](https://dev.languagetool.org/finding-errors-using-n-gram-data)* | ||
|
|
||
| [Download](http://languagetool.org/download/ngram-data/) the n-gram dataset(s) onto your local machine and unzip them into a local ngrams directory: | ||
|
|
||
| ``` | ||
| home/ | ||
| ├─ john/ | ||
| │ ├─ ngrams/ | ||
| │ │ ├─ en/ | ||
| │ │ │ ├─ 1grams/ | ||
| │ │ │ ├─ 2grams/ | ||
| │ │ │ ├─ 3grams/ | ||
| │ │ ├─ nl/ | ||
| │ │ │ ├─ 1grams/ | ||
| │ │ │ ├─ 2grams/ | ||
| │ │ │ ├─ 3grams/ | ||
| ``` | ||
|
|
||
| Mount the local ngrams directory to the `/ngrams` directory in the Docker container [using the `-v` configuration](https://docs.docker.com/engine/reference/commandline/container_run/#read-only) and set the `languageModel` configuration to the `/ngrams` folder. | ||
|
|
||
| An example startup configuration: | ||
|
|
||
| ```sh | ||
| docker run --rm -it -p 8010:8010 -e langtool_languageModel=/ngrams -v /home/john/ngrams:/ngrams:ro erikvl87/languagetool | ||
| ``` | ||
|
|
||
| ## Improving the spell checker | ||
|
|
||
| > You can improve the spell checker without touching the dictionary. For single words (no spaces), you can add your words to one of these files: | ||
| > * `spelling.txt`: words that the spell checker will ignore and use to generate corrections if someone types a similar word | ||
| > * `ignore.txt`: words that the spell checker will ignore but not use to generate corrections | ||
| > * `prohibited.txt`: words that should be considered incorrect even though the spell checker would accept them | ||
| *Source: [https://dev.languagetool.org/hunspell-support](https://dev.languagetool.org/hunspell-support)* | ||
|
|
||
| The following `Dockerfile` contains an example on how to add words to `spelling.txt`. It assumes you have your own list of words in `en_spelling_additions.txt` next to the `Dockerfile`. | ||
|
|
||
| ```dockerfile | ||
| FROM erikvl87/languagetool | ||
|
|
||
| # Improving the spell checker | ||
| # http://wiki.languagetool.org/hunspell-support | ||
| USER root | ||
| COPY en_spelling_additions.txt en_spelling_additions.txt | ||
| RUN (echo; cat en_spelling_additions.txt) >> org/languagetool/resource/en/hunspell/spelling.txt | ||
| USER languagetool | ||
| ``` | ||
|
|
||
| You can build & run the custom Dockerfile with the following two commands: | ||
|
|
||
| ```sh | ||
| docker build -t languagetool-custom . | ||
| docker run --rm -it -p 8010:8010 languagetool-custom | ||
| ``` | ||
|
|
||
| You can add words to other languages by changing the `en` language tag in the target path. Note that for some languages, e.g. for `nl` the `spelling.txt` file is not in the `hunspell` folder: `org/languagetool/resource/nl/spelling/spelling.txt`. | ||
|
|
||
| # Docker Compose | ||
|
|
||
| This image can also be used with [Docker Compose](https://docs.docker.com/compose/). An example [`docker-compose.yml`](docker-compose.yml) is located at the root of this project. | ||
|
|
||
| # Usage | ||
| By default this image is configured to listen on port 8010 which deviates from the default port of LanguageTool 8081. | ||
|
|
||
| An example cURL request: | ||
|
|
||
| ```sh | ||
| curl --data "language=en-US&text=a simple test" http://localhost:8010/v2/check | ||
| ``` | ||
|
|
||
| Please refer to the official LanguageTool documentation for further usage instructions. | ||
|
|
||
| # Known issues & workarounds | ||
|
|
||
| If you experience problems when connecting local server to the official Firefox extension, see [cors-workaround](cors-workaround/). | ||
|
|
||
| [](https://github.com/Erikvl87/docker-languagetool) [](https://github.com/Erikvl87/docker-languagetool) [](https://hub.docker.com/r/erikvl87/languagetool) [](https://github.com/Erikvl87/docker-languagetool/releases) | ||
|
|
||
| # Dockerfile for LanguageTool | ||
| This repository contains a Dockerfile to create a Docker image for [LanguageTool](https://github.com/languagetool-org/languagetool). | ||
|
|
||
| > [LanguageTool](https://www.languagetool.org/) is an Open Source proofreading software for English, French, German, Polish, Russian, and [more than 20 other languages](https://languagetool.org/languages/). It finds many errors that a simple spell checker cannot detect. | ||
| # Setup | ||
|
|
||
| ## Setup using Docker Hub | ||
|
|
||
| ```sh | ||
| docker pull erikvl87/languagetool | ||
| docker run --rm -p 8010:8010 erikvl87/languagetool | ||
| ``` | ||
|
|
||
| This will pull the `latest` tag from Docker Hub. Optionally, specify a [tag](https://hub.docker.com/r/erikvl87/languagetool/tags) to pin onto a fixed version. These versions are derived from the official LanguageTool releases. Updates to the Dockerfile for already published versions are released with a `-dockerupdate-{X}` postfix in the tag (where `{X}` is an incremental number). | ||
|
|
||
| ## Setup using the Dockerfile | ||
| This approach could be used when you plan to make changes to the `Dockerfile`. | ||
|
|
||
| ```sh | ||
| git clone https://github.com/Erikvl87/docker-languagetool.git --config core.autocrlf=input | ||
| docker build -t languagetool . | ||
| docker run --rm -it -p 8010:8010 languagetool | ||
| ``` | ||
|
|
||
| # Configuration | ||
|
|
||
| ## Java heap size | ||
| LanguageTool will be started with a minimal heap size (`-Xms`) of `256m` and a maximum (`-Xmx`) of `512m`. You can overwrite these defaults by setting the [environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) `Java_Xms` and `Java_Xmx`. | ||
|
|
||
| An example startup configuration: | ||
|
|
||
| ```sh | ||
| docker run --rm -it -p 8010:8010 -e Java_Xms=512m -e Java_Xmx=2g erikvl87/languagetool | ||
| ``` | ||
|
|
||
| ## LanguageTool HTTPServerConfig | ||
| You are able to use the [HTTPServerConfig](https://languagetool.org/development/api/org/languagetool/server/HTTPServerConfig.html) configuration options by prefixing the fields with `langtool_` and setting them as [environment variables](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file). | ||
|
|
||
| An example startup configuration: | ||
|
|
||
| ```sh | ||
| docker run --rm -it -p 8010:8010 -e langtool_pipelinePrewarming=true -e Java_Xms=1g -e Java_Xmx=2g erikvl87/languagetool | ||
| ``` | ||
|
|
||
| ## Overwrite logging configuration | ||
| To overwrite the [default LanguageTool logback.xml logging configuration](https://github.com/languagetool-org/languagetool/blob/master/languagetool-server/src/main/resources/logback.xml), create a new `logback.xml` file and mount it into the container. | ||
|
|
||
| For example, create the following `logback.xml` file: | ||
| ```xml | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <configuration> | ||
| <logger name="org.languagetool" level="ERROR"/> | ||
| </configuration> | ||
| ``` | ||
|
|
||
| An example startup configuration: | ||
|
|
||
| ```sh | ||
| docker run --rm -it -p 8010:8010 -v /home/john/logback.xml:/LanguageTool/logback.xml erikvl87/languagetool | ||
| ``` | ||
|
|
||
|
|
||
| ## Using n-gram datasets | ||
| > LanguageTool can make use of large n-gram data sets to detect errors with words that are often confused, like __their__ and __there__. | ||
| *Source: [https://dev.languagetool.org/finding-errors-using-n-gram-data](https://dev.languagetool.org/finding-errors-using-n-gram-data)* | ||
|
|
||
| [Download](http://languagetool.org/download/ngram-data/) the n-gram dataset(s) onto your local machine and unzip them into a local ngrams directory: | ||
|
|
||
| ``` | ||
| home/ | ||
| ├─ john/ | ||
| │ ├─ ngrams/ | ||
| │ │ ├─ en/ | ||
| │ │ │ ├─ 1grams/ | ||
| │ │ │ ├─ 2grams/ | ||
| │ │ │ ├─ 3grams/ | ||
| │ │ ├─ nl/ | ||
| │ │ │ ├─ 1grams/ | ||
| │ │ │ ├─ 2grams/ | ||
| │ │ │ ├─ 3grams/ | ||
| ``` | ||
|
|
||
| Mount the local ngrams directory to the `/ngrams` directory in the Docker container [using the `-v` configuration](https://docs.docker.com/engine/reference/commandline/container_run/#read-only) and set the `languageModel` configuration to the `/ngrams` folder. | ||
|
|
||
| An example startup configuration: | ||
|
|
||
| ```sh | ||
| docker run --rm -it -p 8010:8010 -e langtool_languageModel=/ngrams -v /home/john/ngrams:/ngrams:ro erikvl87/languagetool | ||
| ``` | ||
|
|
||
| ## Improving the spell checker | ||
|
|
||
| > You can improve the spell checker without touching the dictionary. For single words (no spaces), you can add your words to one of these files: | ||
| > * `spelling.txt`: words that the spell checker will ignore and use to generate corrections if someone types a similar word | ||
| > * `ignore.txt`: words that the spell checker will ignore but not use to generate corrections | ||
| > * `prohibited.txt`: words that should be considered incorrect even though the spell checker would accept them | ||
| *Source: [https://dev.languagetool.org/hunspell-support](https://dev.languagetool.org/hunspell-support)* | ||
|
|
||
| The following `Dockerfile` contains an example on how to add words to `spelling.txt`. It assumes you have your own list of words in `en_spelling_additions.txt` next to the `Dockerfile`. | ||
|
|
||
| ```dockerfile | ||
| FROM erikvl87/languagetool | ||
|
|
||
| # Improving the spell checker | ||
| # http://wiki.languagetool.org/hunspell-support | ||
| USER root | ||
| COPY en_spelling_additions.txt en_spelling_additions.txt | ||
| RUN (echo; cat en_spelling_additions.txt) >> org/languagetool/resource/en/hunspell/spelling.txt | ||
| USER languagetool | ||
| ``` | ||
|
|
||
| You can build & run the custom Dockerfile with the following two commands: | ||
|
|
||
| ```sh | ||
| docker build -t languagetool-custom . | ||
| docker run --rm -it -p 8010:8010 languagetool-custom | ||
| ``` | ||
|
|
||
| You can add words to other languages by changing the `en` language tag in the target path. Note that for some languages, e.g. for `nl` the `spelling.txt` file is not in the `hunspell` folder: `org/languagetool/resource/nl/spelling/spelling.txt`. | ||
|
|
||
| # Docker Compose | ||
|
|
||
| This image can also be used with [Docker Compose](https://docs.docker.com/compose/). An example [`docker-compose.yml`](docker-compose.yml) is located at the root of this project. | ||
|
|
||
| # Usage | ||
| By default this image is configured to listen on port 8010 which deviates from the default port of LanguageTool 8081. | ||
|
|
||
| An example cURL request: | ||
|
|
||
| ```sh | ||
| curl --data "language=en-US&text=a simple test" http://localhost:8010/v2/check | ||
| ``` | ||
|
|
||
| Please refer to the official LanguageTool documentation for further usage instructions. | ||
|
|
||
| # Known issues & workarounds | ||
|
|
||
| If you experience problems when connecting local server to the official Firefox extension, see [cors-workaround](cors-workaround/). | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,17 @@ | ||
| --- | ||
|
|
||
| version: "3" | ||
|
|
||
| services: | ||
| languagetool: | ||
| --- | ||
|
|
||
| version: "3" | ||
|
|
||
| services: | ||
| languagetool: | ||
| image: erikvl87/languagetool | ||
| container_name: languagetool | ||
| ports: | ||
| - 8010:8010 # Using default port from the image | ||
| environment: | ||
| - langtool_languageModel=/ngrams # OPTIONAL: Using ngrams data | ||
| - Java_Xms=512m # OPTIONAL: Setting a minimal Java heap size of 512 mib | ||
| - Java_Xmx=1g # OPTIONAL: Setting a maximum Java heap size of 1 Gib | ||
| volumes: | ||
| - /path/to/ngrams/data:/ngrams # OPTIONAL: The location of ngrams data on the local machine | ||
| container_name: languagetool | ||
| ports: | ||
| - 8010:8010 # Using default port from the image | ||
| environment: | ||
| - langtool_languageModel=/ngrams # OPTIONAL: Using ngrams data | ||
| - Java_Xms=512m # OPTIONAL: Setting a minimal Java heap size of 512 mib | ||
| - Java_Xmx=1g # OPTIONAL: Setting a maximum Java heap size of 1 Gib | ||
| volumes: | ||
| - /path/to/ngrams/data:/ngrams # OPTIONAL: The location of ngrams data on the local machine | ||
| - /path/to/logback.xml:/LanguageTool/logback.xml:ro # OPTIONAL: Overwrite the logging configuration |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters