ContextQMD
Back to Gitlabhq

GitLab Language Server

doc/editor_extensions/language_server/_index.md

18.11.23.9 KB
Original Source

The GitLab Language Server powers various GitLab editor extensions across IDEs.

Configure the Language Server to use a proxy

The gitlab-lsp child process uses the proxy-from-env NPM module to determine proxy settings from these environment variables:

  • NO_PROXY
  • HTTPS_PROXY
  • http_proxy (in lowercase)

To configure the Language Server to use a proxy:

{{< tabs >}}

{{< tab title="Visual Studio Code" >}}

  1. In Visual Studio Code, open your user or workspace settings.
  2. Configure http.proxy to point at your HTTP proxy.
  3. Restart Visual Studio Code to ensure connections to GitLab use the latest proxy settings.

{{< /tab >}}

{{< tab title="JetBrains IDEs" >}}

  1. In your JetBrains IDE, configure the HTTP Proxy settings.
  2. Restart your IDE to ensure connections to GitLab use the latest proxy settings.
  3. From the Tools > GitLab Duo menu, select Verify setup. Make sure the health check passes.

{{< /tab >}}

{{< /tabs >}}

Troubleshooting

Update your editor extension

The Language Server is bundled with each editor extension for GitLab. To ensure you have the latest features and bug fixes available, update to the latest version of your extension:

Enable proxy authentication

You might encounter a 407 Access Denied (authentication_failed) error when using an authenticated proxy:

plaintext
Request failed: Can't add GitLab account for https://gitlab.com. Check your instance URL and network connection.
Fetching resource from https://gitlab.com/api/v4/personal_access_tokens/self failed

To enable proxy authentication in the Language Server, follow the steps for your IDE:

{{< tabs >}}

{{< tab title="Visual Studio Code" >}}

  1. Open your user or workspace settings.
  2. Configure http.proxy, including username and password, to authenticate with your HTTP proxy.
  3. Restart Visual Studio Code to ensure connections to GitLab use the latest proxy settings.

[!note] The VS Code extension does not support the legacy http.proxyAuthorization setting in VS Code for authenticating the language server with an HTTP proxy. Support is proposed in issue 1672.

{{< /tab >}}

{{< tab title="JetBrains IDEs" >}}

  1. Configure HTTP Proxy settings in your JetBrains IDE.
    1. If using Manual proxy configuration, enter your credentials under Proxy authentication and select Remember.
  2. Restart your JetBrains IDE to ensure connections to GitLab use the latest proxy settings.
  3. From the Tools > GitLab Duo menu, select Verify setup. Make sure the health check passes.

{{< /tab >}}

{{< /tabs >}}

[!note] Bearer authentication is proposed in issue 548.