Running LanguageTool locally

readme.md

Running LanguageTool locally

Running the server

1. Install LanguageTool

brew install languagetool

2. Download the n-gram model for English (it’s 8 GB!) https://dev.languagetool.org/finding-errors-using-n-gram-data
3. Create a config file that will tell it to use the n-gram model

languageModel=/path/to/directory/languagetools-ngrams

4. Start the server

languagetool-server --allow-origin "*" --config ~/path/to/languagetool-config/config

HTTPS proxy

Set up HTTPS (otherwise some browser extensions might not work).

1. Install caddy

brew install caddy

2. Start caddy

caddy run --config ~/path/to/caddy/config.json

(See snippet for the caddy config, feel free to change the ports accordingly)

Set up the browser extensions

1. Install the extension for your browser (Firefox, Safari, Chrome)
2. Go to "Advanced Settings" and choose "Local server (localhost)" as the "LanguageTool API server URL"

caddy-config.json

{
    "apps": {
        "http": {
            "servers": {
                "localhost": {
                    "listen": [
                        ":9081"
                    ],
                    "automatic_https": {
                        "disable_redirects": true
                    },
                    "routes": [
                        {
                            "match": [{
                                "host": [
                                    "localhost"
                                ]
                            }],
                            "handle": [
                                {
                                    "handler": "reverse_proxy",
                                    "upstreams": [
                                        {
                                            "dial": "127.0.0.1:8081"
                                        }
                                    ]
                                }
                            ]
                        }
                    ]
                }
            }
        }
    }
}