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: audit-service/README.md
+112Lines changed: 112 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -191,6 +191,118 @@ go test ./... -cover
191
191
-**No authentication required**: Authentication is handled by upstream services (Orchestration Engine, Portal Backend)
192
192
-**Database security**: Uses SSL connections in production (Choreo) with configurable SSL modes
193
193
194
+
## Optional Deployment
195
+
196
+
The Audit Service is **optional** and can be deployed separately from the main OpenDIF services. Services (Orchestration Engine, Portal Backend) will function normally without audit logging enabled.
197
+
198
+
### Enabling/Disabling Audit Logging
199
+
200
+
#### Option 1: Disable via Environment Variable
201
+
Set `ENABLE_AUDIT=false` in your service configuration:
202
+
```bash
203
+
# In orchestration-engine/.env or portal-backend/.env
204
+
ENABLE_AUDIT=false
205
+
```
206
+
207
+
#### Option 2: Omit Audit Service URL
208
+
Leave `CHOREO_AUDIT_CONNECTION_SERVICEURL` unset or empty:
209
+
```bash
210
+
# Services will automatically disable audit logging if URL is not configured
211
+
# CHOREO_AUDIT_CONNECTION_SERVICEURL=
212
+
```
213
+
214
+
#### Option 3: Enable Audit Logging
215
+
Set the audit service URL:
216
+
```bash
217
+
# In orchestration-engine/.env or portal-backend/.env
0 commit comments