Skip to content

Deploying a Private Location

To deploy a Private Location, you only need to retrieve your API key from the platform. With the API key, you will be able to create locations, list them, and delete them.

To get your API key, go to your profile page. Now save it in your environment variables as ESCAPE_API_KEY=....

Using the Escape CLI

If you have installed the Escape CLI, you can manage your Private Locations with the following commands:

escape-cli locations start location-name

This will start a new Private Location on your computer and will automatically connect it to your Escape account. If the location does not exist, it will be created, and you will be able to see its status in the Escape platform on the Private Locations page.

Using Helm

helm repo add escape-cli https://escape-technologies.github.io/cli/
helm repo update

# Get your API key from https://app.escape.tech/user/profile/
helm install escape-private-location escape-cli/private-location --set ESCAPE_API_KEY="${ESCAPE_API_KEY}"

Using Docker

You can start a Private Location with Docker by running:

docker run -e ESCAPE_API_KEY="${ESCAPE_API_KEY}" -it --rm escapetech/cli:latest locations start location-name

Using Podman

If you prefer Podman, you can use:

podman run -e ESCAPE_API_KEY="${ESCAPE_API_KEY}" -it --rm escapetech/cli:latest locations start location-name

Using Docker Compose

---
services:
  private-location:
    image: escapetech/cli:latest
    restart: always
    command: locations start -v location-name
    environment:
      - ESCAPE_API_KEY=<ESCAPE_API_KEY>