Skip to content

Commit 6308d7e

Browse files
committed
docs: update README with instructions for running the production UI locally
1 parent c7ecceb commit 6308d7e

1 file changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -247,6 +247,39 @@ pnpm test
247247

248248
To satisfy your unique workflow requirements, check out the package.json in the root directory for more detailed scripts.
249249

250+
### Run Production UI Locally
251+
252+
To run the production build of the Login UI locally, follow these steps:
253+
254+
1. **Build the production Docker image:**
255+
256+
```sh
257+
make login_standalone_build
258+
```
259+
260+
This command will build the Docker image for the production-ready Login UI.
261+
262+
2. **Prepare your environment file:**
263+
264+
Create or update your environment file (e.g., `.env.production`) with the necessary environment variables. At a minimum, you will need:
265+
266+
```env
267+
ZITADEL_API_URL=<your-zitadel-instance-url>
268+
ZITADEL_SERVICE_USER_TOKEN=<your-service-user-token>
269+
```
270+
271+
3. **Run the Docker image:**
272+
273+
```sh
274+
docker run --env-file <env file path> -p 3000:3000 zitadel-login:local
275+
```
276+
277+
Replace `<env file path>` with the path to your environment file (e.g., `.env.production`).
278+
279+
4. **Access the UI:**
280+
281+
Open your browser and navigate to [localhost:3000/ui/v2/login/register](localhost:3000/ui/v2/login/register) to view the production registration component running locally as example.
282+
250283
### Run Login UI Acceptance tests
251284

252285
To run the acceptance tests you need a running ZITADEL environment and a component which receives HTTP requests for the emails and sms's.

0 commit comments

Comments
 (0)