Skip to content

Commit 73aca89

Browse files
committed
audit logs: better documentation for feature flag
1 parent 857465a commit 73aca89

File tree

2 files changed

+9
-5
lines changed

2 files changed

+9
-5
lines changed

docs/operate/customize/audit-logs.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,17 @@ This is the list of actions:
1616

1717
You will be able to view all actions performed in your instance and query actions performed on resources.
1818

19-
The feature can be enabled by setting the `AUDIT_LOGS_ENABLED` flag to `True`.
20-
2119
You can learn about its internals [here](../../maintenance/internals/audit-logs.md).
2220

23-
## Add your actions
21+
## Enabling audit logs
22+
To enable audit logs, you need to set the following configuration in your `invenio.cfg`:
23+
24+
```python
25+
# Enable the feature flag
26+
AUDIT_LOGS_ENABLED = True
27+
```
2428

29+
## Add your actions
2530
To track more actions on resources in InvenioRDM using audit logs, follow these steps to add new actions:
2631

2732
### 1. Define the action

docs/use/administration.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,7 @@ You can filter by:
5252
- Action type (e.g. draft.edit, record.publish)
5353

5454
!!! info
55-
56-
If you want to configure or extend audit logging, see [configuration guide](../operate/customize/audit-logs.md).
55+
If you want to enable, configure or extend audit logging, see [configuration guide](../operate/customize/audit-logs.md).
5756

5857
## Records & files
5958

0 commit comments

Comments
 (0)