You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+36-17Lines changed: 36 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -86,23 +86,42 @@ The frontend implements a caching mechanism for the public health check endpoint
86
86
87
87
## Environment Variables
88
88
89
-
This project uses environment variables for configuration, particularly for OIDC authentication details. Template files are provided:
90
-
91
-
-`.env.example` (at the project root, for backend configuration)
92
-
-`frontend/.env.example` (in the frontend directory, for frontend configuration)
93
-
94
-
These files list the required variables but contain placeholder values.
95
-
96
-
**To configure your local environment:**
97
-
98
-
1.**Copy the templates:**
99
-
```bash
100
-
cp .env.example .env
101
-
cp frontend/.env.example frontend/.env
102
-
```
103
-
2. **Edit the `.env` files:** Open the newly created `.env` files (in the root directory and the `frontend/` directory) and replace the placeholder values with your actual Zitadel application details (Issuer URI, Client IDs, Client Secret). Refer to `docs/auth-config.md`for details on each variable.
104
-
105
-
**Important:** The `.env` files contain sensitive information and are listed in`.gitignore`. **Never commit `.env` files to the Git repository.**
89
+
This project uses environment variables for configuration, particularly for OIDC authentication details.
90
+
91
+
**Frontend Configuration (Vite):**
92
+
93
+
- The frontend uses a standard `.env` file located at `frontend/.env`.
94
+
- A template file `frontend/.env.example` lists the required variables (like `VITE_ZITADEL_ISSUER_URI`, `VITE_ZITADEL_CLIENT_ID`).
95
+
-**To configure:**
96
+
1. Copy `frontend/.env.example` to `frontend/.env`.
97
+
2. Edit `frontend/.env` with your actual Zitadel **frontend** application details.
98
+
99
+
**Backend Configuration (Spring Boot):**
100
+
101
+
- The backend reads configuration from **actual environment variables** set in your system or terminal session. It **does not** automatically read from `.env` files.
102
+
- The `.env.example` file in the project root serves as a **template** listing the variables the backend expects (like `ZITADEL_AUTHDEMO_ISSUER_URI`, `ZITADEL_AUTHDEMO_BACKEND_CLIENT_ID`, `ZITADEL_AUTHDEMO_CLIENT_SECRET`).
103
+
-**To configure:**
104
+
1. Refer to `.env.example` for the required variable names.
105
+
2. Set these variables in your environment *before* launching the backend. Examples:
3. Alternatively, configure them via your IDE's run configuration settings.
123
+
124
+
**Important:** Environment variables (especially secrets like `ZITADEL_AUTHDEMO_CLIENT_SECRET`) should be handled securely. The `.env` files are listed in `.gitignore` and should **never be committed** to the repository.
0 commit comments