@@ -183,42 +183,52 @@ for more information about this automation
183183
184184To run the application make sure to install the dependencies with
185185
186+ #### Preparing the app
187+
186188``` sh
187189pnpm install
188190```
189191
190- then generate the GRPC stubs with
192+ then generate the GRPC stubs with (a [ Buf ] ( https://buf.build ) account is required)
191193
192194``` sh
193195pnpm generate
194196```
195197
196- To run the application against a local ZITADEL instance, run the following command:
198+ #### Running app against a local Instance of ZITADEL
199+
200+ To run the application against a local ZITADEL instance, use the following command:
197201
198202``` sh
199- pnpm run-zitadel
203+ docker compose up
200204```
201205
202- This sets up ZITADEL using docker compose and writes the configuration to the file ` apps/login/.env.local ` .
206+ - ** ZITADEL Admin email** : ` zitadel-admin@zitadel.localhost `
207+ - ** ZITADEL Admin password** : ` Password1! `
208+
209+ > [ !NOTE]
210+ > When using Docker Compose, a local SMTP server can be configured for testing email functionality.
211+ > The SMTP provider UI is available at: ` http://localhost:8025 `
212+
213+ To configure the local SMTP provider:
214+
215+ 1 . Navigate to ` http://localhost:8080/ui/console/instance?id=smtpprovider `
216+ 2 . Select Generic SMTP
217+ 3 . Set the Host and Port to ` mailhog:1025 `
218+ 4 . Fill in the remaining fields with any data (they won’t be validated)
219+ 5 . Click Test on step 3
220+ 6 . Finally, activate the SMTP provider
203221
204- <details >
205- <summary >Alternatively, use another environment</summary >
206- You can develop against any ZITADEL instance in which you have sufficient rights to execute the following steps.
207- Just create or overwrite the file ` apps/login/.env.local ` yourself.
208- Add your instances base URL to the file at the key ` ZITADEL_API_URL ` .
209- Go to your instance and create a service user for the login application.
210- The login application creates users on your primary organization and reads policy data.
211- For the sake of simplicity, just make the service user an instance member with the role ` IAM_OWNER ` .
212- Create a PAT and copy it to the file ` apps/login/.env.local ` using the key ` ZITADEL_SERVICE_USER_TOKEN ` .
222+ #### Pointing app to a backend
213223
214- The file should look similar to this :
224+ Update ` apps/login/.env.local ` with :
215225
216226``` env
217- ZITADEL_API_URL=https ://zitadel-tlx3du.us1.zitadel.cloud
218- ZITADEL_SERVICE_USER_TOKEN=1S6w48thfWFI2klgfwkCnhXJLf9FQ457E-_3H74ePQxfO3Af0Tm4V5Xi-ji7urIl_xbn-Rk
227+ ZITADEL_API_URL=<http ://localhost:8080 or Zitadel URL instance>
228+ ZITADEL_SERVICE_USER_TOKEN=<Personal Access Token from machine user with Org Owener and Iam Owener memberships>
219229```
220230
221- </ details >
231+ #### Starting the app
222232
223233Start the login application in dev mode:
224234
0 commit comments