Skip to content

Commit 750a224

Browse files
committed
docs: update docs for the audit log
1 parent 9bf819f commit 750a224

File tree

1 file changed

+39
-2
lines changed

1 file changed

+39
-2
lines changed

adminforth/documentation/docs/tutorial/07-Plugins/01-AuditLog.md

Lines changed: 39 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -292,8 +292,22 @@ Update the resource configuration in `./resources/auditLogs.ts`:
292292
} },
293293
{ name: 'record_id', required: false },
294294
{ name: 'ip_address', required: false },
295-
//diff-add
296-
{ name: "country", required: false },
295+
//diff-add
296+
{
297+
//diff-add
298+
name: "country",
299+
//diff-add
300+
required: false,
301+
//diff-add
302+
components: {
303+
//diff-add
304+
list: '@/renderers/CountryFlag.vue'
305+
//diff-add
306+
show: '@/renderers/CountryFlag.vue'
307+
//diff-add
308+
},
309+
//diff-add
310+
},
297311
],
298312
...
299313
plugins: [
@@ -312,4 +326,27 @@ Update the resource configuration in `./resources/auditLogs.ts`:
312326
}),
313327
],
314328
}
329+
```
330+
331+
### Providing Country Headers
332+
333+
If your deployed app has header with user country in ISO 3166-1 alpha-2 format, you can specify this header, so country will be taken from it:
334+
335+
```ts
336+
plugins: [
337+
new AuditLogPlugin({
338+
//diff-add
339+
isoCountryCodeRequestHeader: 'CF-IPCountry',
340+
resourceColumns: {
341+
resourceIdColumnName: 'resource_id',
342+
resourceActionColumnName: 'action',
343+
resourceDataColumnName: 'diff',
344+
resourceUserIdColumnName: 'user_id',
345+
resourceRecordIdColumnName: 'record_id',
346+
resourceCreatedColumnName: 'created_at'
347+
resourceIpColumnName: "ip_address",
348+
resourceCountryColumnName: "country",
349+
}
350+
}),
351+
],
315352
```

0 commit comments

Comments
 (0)