State example values

Author: soundstorm

.env.example

@@ -2,26 +2,26 @@
 DATABASE_URL=mysql+pymysql://makerspace:makerspace@localhost:3306/makerspaceapi
 
 # MariaDB (used by docker-compose)
-DB_ROOT_PASSWORD=rootpassword
+DB_ROOT_PASSWORD=rootpassword # Generate a safe password
 DB_NAME=makerspaceapi
 DB_USER=makerspace
 DB_PASSWORD=makerspace
 
 # OIDC
-OIDC_CLIENT_ID=makerspaceapi
-OIDC_CLIENT_SECRET=your-client-secret-here
+OIDC_CLIENT_ID=makerspaceapi # Paste from your OIDC provider
+OIDC_CLIENT_SECRET=your-client-secret-here # Paste from your OIDC provider
 OIDC_DISCOVERY_URL=https://auth.example.com/.well-known/openid-configuration
-OIDC_ADMIN_GROUP=makerspace-admins
+OIDC_ADMIN_GROUP=makerspace-admins # or what ever your admin group is called
 # Optional: OIDC group whose members can manage products, inventory, aliases and categories.
 # Leave empty (or omit) to restrict product management to admins only.
 # OIDC_PRODUCT_MANAGER_GROUP=
 OIDC_GROUP_CLAIM=groups
-OIDC_REDIRECT_URI=http://localhost:8000/auth/callback
+OIDC_REDIRECT_URI=http://localhost:8000/auth/callback # Adjust to your production url like https://api.makerspace.example/auth/callback
 
 # App
 SECRET_KEY=change-me-to-a-long-random-string
 DEBUG=false
-BASE_URL=http://localhost:8000
+BASE_URL=http://localhost:8000 # Also adjust this to your production url
 
 # Optional: set true to overwrite user.name from OIDC claims on NFC self-service card linking
 # OIDC_LINK_UPDATE_NAME=false