Locally Setup

Locally Setup

locally setup is a browser-based wizard. It launches a small HTTP server on a random local port, opens your browser, and walks you through configuring this installation. Setup presents the Locally CLI Terms & Conditions, the Website & Locally Account Terms & Conditions and the Privacy Policy - continuing accepts all three. You can re-run it any time - setup detects what's already in place and only applies the changes that are needed.

---

What setup does, and why

• Signs this installation in to your Locally Account - optional. Confirms your licence and ties this machine to your account so Team-plan content (policies, runbooks, directory) can sync to your install. You can skip this and carry on unsigned-in, which gets you 60-minute sessions, the six core Plugins and 3 more Plugins of your choice; signing in is free and extends sessions to 4 hours and unlocks the rest of the Starter Plugins. See Pricing for the details.
• Generates TLS certificates. Locally serves Azure-shaped endpoints over HTTPS - Azure SDKs require it, and your tools would surface TLS warnings otherwise. Setup builds a local Certificate Authority and a TLS certificate signed by it, so every endpoint Locally serves has a valid (locally-trusted) certificate.
• Installs Plugins. Each Azure service Locally emulates (Microsoft.Storage, Microsoft.KeyVault, Microsoft.ServiceBus, and so on) ships as its own Plugin. You pick which to install so what's running matches the services you actually need.

---

What setup can't do for you

Two things setup intentionally won't do without your go-ahead - both touch your system in security-sensitive ways. The wizard's last screen shows you the right command for your platform and you run them yourself with sudo or Administrator rights:

• Trust the local CA. Installing a root certificate into your OS trust store is security-sensitive enough that Locally won't do it silently. Without it, every connection to a *.locally endpoint will surface a TLS warning.
• Configure the DNS resolver. Locally serves *.locally domains so Azure SDKs can be redirected to its local services. Your OS won't resolve those by default - the resolver entry tells it to send *.locally lookups to Locally's DNS server - port 5673 on macOS and Linux, and on Windows an NRPT rule pointing .locally at 127.0.0.1, where Locally also listens on port 53. locally configure dns applies, reports on or removes this on its own. See Networking & Proxies for the full local port layout.

---

If something goes wrong

Common stumbles are covered on the Troubleshooting page.