Ngrok

Base image¶

Launchpad uses the ngrok/ngrok image.

Usage¶

Ngrok support can be enabled by passing the --ngrok flag

Services and service settings can also be specified in a .dlp.yml file.
See project configuration for more info.

Endpoints¶

You can access the ngrok admin UI via https://ngrok.<project>.docker.localhost:444/

Configuration¶

Specifing an authtoken¶

Since december 2021, ngrok requires an authtoken to work.
This authtoken can be configured via the NGROK_AUTHTOKEN environment variable for the ngrok service.

  ngrok:
    environment:
      - NGROK_AUTHTOKEN=<THE TOKEN>

General documentation on how to override Docker services in Launchpad, can be found here.

Setting extra flags¶

Adding extra flags to the ngrok command can be done by overriding the command of the ngrok service in the docker-compose configuration files.
In following example we add the --host-header flag.

  ngrok:
    command: http apache.${COMPOSE_PROJECT_NAME}-docker:80 --region=eu --host-header=${COMPOSE_PROJECT_NAME}.docker.localhost

General documentation on how to override Docker services in Launchpad, can be found here.