Zuplo
Zuplo CLI

​Tunnel Commands

zuplo tunnel --help
zuplo tunnel

Tunnel commands

Commands:
  zuplo tunnel create        Creates a new tunnel in your account
  zuplo tunnel delete        Deletes a tunnel in your account
  zuplo tunnel describe      Describes a tunnel in your account
  zuplo tunnel list          Lists the tunnels in your account
  zuplo tunnel rotate-token  Rotates the token for a tunnel in your account
  zuplo tunnel services      Tunnel services commands
bash

Use these commands to help your manage your tunnels. They must be run from the root of your Zuplo project.

​Creating a tunnel

# For brevity, the commands assume that you have exported your API key as an environment variable,
# export ZUPLO_API_KEY=zpka_d67b7e241bb948758f415b79aa8exxxx_2efbxxxx

zuplo tunnel create --tunnel-name my-tunnel
zuplo tunnel list
bash

​Deleting a tunnel

# For brevity, the commands assume that you have exported your API key as an environment variable,
# export ZUPLO_API_KEY=zpka_d67b7e241bb948758f415b79aa8exxxx_2efbxxxx

zuplo tunnel delete --tunnel-id tnl_xxxxxxxxxxx
bash

​Get Tunnel Info

# For brevity, the commands assume that you have exported your API key as an environment variable,
# export ZUPLO_API_KEY=zpka_d67b7e241bb948758f415b79aa8exxxx_2efbxxxx

zuplo tunnel describe --tunnel-id tnl_xxxxxxxxxxx
bash

​Running the tunnel

To run the Docker container on your own infrastructure, refer to instructions from your cloud provider or contact Zuplo support for assistance.

Your running container needs a single environment variable named TUNNEL_TOKEN. You should store the value as a secret using the recommended means of secret storage and environment variable injection for your platform.

​Configuring services

Once you have created a tunnel, you can configure which services it should expose using a configuration file. Below is a sample configuration file.

The properties in the services objects are explained below.

  • name - This is the name of the service that you will use from your Zuplo project
  • endpoint - This is the local endpoint of your service that you tunnel can connect to
  • configurations - This object specifies which projects and which environments can access this service.
    • project - The name of the Zuplo project
    • accessibleBy - The environments which can use the tunnel. Valid values are production, preview, and working-copy.
tunnel-config.json
{
  "version": 1,
  "services": [
    {
      "name": "my-awesome-service-prod",
      "endpoint": "http://localhost:8000",
      "configurations": [
        {
          "project": "my-project",
          "accessibleBy": ["production"]
        },
        {
          "project": "my-other-project",
          "accessibleBy": ["production"]
        }
      ]
    },
    {
      "name": "my-awesome-service-staging",
      "endpoint": "http://localhost:9000",
      "configurations": [
        {
          "project": "my-project",
          "accessibleBy": ["preview", "working-copy"]
        },
        {
          "project": "my-other-project",
          "accessibleBy": ["preview", "working-copy"]
        }
      ]
    }
  ]
}
json
zuplo tunnel services update \
--configuration-file <path-to-your-configuration-file> \
--tunnel-id <your-tunnel-id>
bash
Test CommandEnvironment Variables Commands