Skip to content

Commit 2cb7f92

Browse files
committed
docs: update env setup docs to reflect secret-from-env change
- Trim .env.sample to only env-backed vars (KUBECONFIG, KEYCLOAK_CLIENT_SECRET) - Update CONTRIBUTING.md to clarify which values are env vars vs CLI flags Signed-off-by: Bastian Echterhölter <bastian.echterhoelter@sap.com> On-behalf-of: @SAP <bastian.echterhoelter@sap.com>
1 parent 14dbbf3 commit 2cb7f92

File tree

2 files changed

+7
-19
lines changed

2 files changed

+7
-19
lines changed

.env.sample

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,2 @@
1-
IS_LOCAL=true
2-
PORT=8083
3-
OPENFGA_GRPC_ADDR=localhost:8081
4-
OPENFGA_LISTEN_ADDR=localhost:8082
51
KUBECONFIG=/path/to/kubeconfig
6-
LOG_LEVEL=debug
7-
8-
# Keycloak Configuration (required for identity management)
9-
KEYCLOAK_BASE_URL=https://portal.dev.local:8443/keycloak
10-
KEYCLOAK_CLIENT_ID=iam
11-
KEYCLOAK_CLIENT_SECRET=your-keycloak-client-secret-here
2+
KEYCLOAK_CLIENT_SECRET=your-keycloak-client-secret-here

CONTRIBUTING.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,20 +14,17 @@ This is the Platform Mesh IAM (Identity and Access Management) service, a Go-bas
1414
3. Task runner (optional but recommended)
1515

1616
### Environment Setup
17-
1. Copy `.env.sample` to `.env`
18-
2. Configure required services:
19-
- OpenFGA server (OPENFGA_GRPC_ADDR)
20-
- **Keycloak client credentials** (required for identity management):
21-
- `KEYCLOAK_CLIENT_SECRET`: Your Keycloak client secret (mandatory)
22-
- `KEYCLOAK_CLIENT_ID`: Client ID (default: `iam`)
23-
- `KEYCLOAK_BASE_URL`: Keycloak server URL
24-
- Kubernetes context (KUBECONFIG)
17+
1. Copy `.env.sample` to `.env` and configure your IDE to load it
18+
2. Configure required environment variables:
19+
- `KUBECONFIG`: Path to your kubeconfig file
20+
- `KEYCLOAK_CLIENT_SECRET`: Your Keycloak client secret (mandatory, read from environment only — never passed as a CLI arg)
21+
3. Other settings (Keycloak base URL, client ID, OpenFGA address, etc.) are configured via CLI flags — see `go run ./main.go serve --help`
2522

2623
## Development Commands
2724

2825
### Building and Running
2926
```bash
30-
# Run locally (requires .env file from .env.sample)
27+
# Run locally (configure env vars via your IDE)
3128
task run
3229
# OR
3330
go run ./main.go serve

0 commit comments

Comments
 (0)