Skip to main content

Configure HTTP/HTTPS Proxy

When Appsmith runs behind a corporate firewall or a Virtual Private Network (VPN), it may require proxy settings to access the internet and communicate with cs.appsmith.com. This page shows how to set up HTTP/HTTPS proxy on your self-hosted Appsmith instance so that you can access Appsmith using a proxy.

Prerequisites​

  • Self-hosted Appsmith instance. If not installed yet, see the installation guides for installing Appsmith.

Verify connectivity​

Before you begin proxy configuration, verify whether your Appsmith instance can connect to cs.appsmith.com for internal communication. See Verify connectivity to cs.appsmith.com for Docker and Kubernetes test steps.

For Docker, connect to the container and run:

docker exec -it -u root appsmith bash
curl -i -v https://cs.appsmith.com/api/v1/health

If you see connection errors (for example, Connection timed out or Network unreachable), a proxy setup may be required.

Set up proxy​

Follow below steps to configure proxy by setting environment variables:

  1. Open the Appsmith installation configuration file:

    • Docker: docker.env
    • Kubernetes: values.yaml

  2. Use any one of the below pair of environment variables to set proxy:

    • HTTP_PROXY and HTTPS_PROXY (uppercase)
    • http_proxy and https_proxy (lowercase)

    For example, set up proxy using uppercase environment variables:

    HTTP_PROXY=http://1.2.3.4:8080
    HTTPS_PROXY=http://1.2.3.4:8080

  3. Save the file and restart Appsmith instance.

  4. Confirm proxy configuration with:

    curl -i -v https://cs.appsmith.com/api/v1/health

  5. When using an HTTPS proxy, you may want to add a trusted custom Certificate Authority to Appsmith. For more information, see Custom Root CA Certificate guide.

Troubleshooting​

You may face some common issues while configuring the proxy. Troubleshoot by:

  • Verifying the proxy address and port.
  • Confirming that you've set up correct environment variables.
  • Reviewing the network or firewall settings.

If you continue to face issues, contact the support team using the chat widget at the bottom right of this page.