locally configure

Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

locally configure

This page is part of the CLI Reference and is generated from the CLI's own help output, so it matches what locally configure --help prints.

locally configure

Configure this machine for Locally, one change at a time.

Each subcommand makes one configuration change, and is safe to re-run. Use --status to check it,
or --remove to undo it.

To be walked through every change, run `locally setup`; to check them all, run `locally validate`.
For TLS certificates, see `locally certificate`.

Usage

locally configure [flags]
  locally configure [command]

Flags

-h, --help[=true|false]   help for configure

Subcommands

locally configure azure-storage-explorer

Add Locally to Azure Storage Explorer as a custom environment.

Adds a "Locally" custom environment to Azure Storage Explorer using this instance's endpoints, and
installs the Locally CA so that Storage Explorer trusts it.

Locally must be running and Storage Explorer must be closed. Afterwards, sign out of any account
already in the Locally environment and add it again. Re-run this if Locally's ports change.

Examples:
locally configure azure-storage-explorer
  locally configure azure-storage-explorer --status
  locally configure azure-storage-explorer --remove

Usage

locally configure azure-storage-explorer [flags]

Flags

--dry-run[=true|false]   Print what would change, without changing it.
  -h, --help[=true|false]      help for azure-storage-explorer
      --remove[=true|false]    Undo this configuration, removing only what Locally added.
      --status[=true|false]    Report whether this is configured, without changing anything.

locally configure dns

Configure this machine's resolver so *.locally addresses resolve.

Usage

locally configure dns [flags]

Flags

--dry-run[=true|false]   Print what would change, without changing it.
  -h, --help[=true|false]      help for dns
      --remove[=true|false]    Undo this configuration, removing only what Locally added.
      --status[=true|false]    Report whether this is configured, without changing anything.

locally configure docker

Set up Locally's DNS forwarder so containers on Docker Desktop resolve *.locally.

Builds the DNS forwarder image Locally runs alongside Docker Desktop, so the containers Locally
launches can resolve *.locally.

Docker Desktop's VM can't be configured the way Podman's can, so `locally build` runs a dnsmasq
container that forwards *.locally to Locally, and starts its own containers (Container Instances,
databases, Web Apps) with --dns pointing at it. Your own containers are not touched.

Running this ahead of time saves the first `locally build` pulling the image. While Locally is running,
it also starts the forwarder and checks that it resolves.

Pushing images to Locally's registry from Docker Desktop isn't supported, since --dns only applies to
containers and the Docker daemon can't be pointed at Locally. Use podman for that, via
`locally configure podman`.

Set LOCALLY_CONTAINER_DNS to "docker=<address>" to use your own forwarder, or "none" to opt out.

Usage

locally configure docker [flags]

Flags

--dry-run[=true|false]   Print what would change, without changing it.
  -h, --help[=true|false]      help for docker
      --remove[=true|false]    Undo this configuration, removing only what Locally added.
      --status[=true|false]    Report whether this is configured, without changing anything.

locally configure podman

Configure Podman's VM so its daemon and containers resolve *.locally.

Usage

locally configure podman [flags]

Flags

--dry-run[=true|false]       Print what would change, without changing it.
  -h, --help[=true|false]          help for podman
      --remove[=true|false]        Undo this configuration, removing only what Locally added.
      --restart-wsl[=true|false]   When enabling WSL mirrored networking on Windows, restart WSL to apply it without prompting (shuts down all WSL distributions).
      --status[=true|false]        Report whether this is configured, without changing anything.
Preview

During Public Preview you can use the Team plan for free, and get an early-adopter discount at GA. Sign in

A local cloud for you and your AI agents.

Your Azure infrastructure, running on your machine. Deploy in seconds, break things freely, and ship to Azure when you're ready.