habsi/authentik
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tweaks

Browse Source
This commit is contained in:
Tana M Berry
2025-06-27 12:56:54 -05:00
parent 390f4d87da
commit e5c8229a83
2 changed files with 17 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
website/docs/sys-mgmt/events/logging-events.md
View File

@ -6,6 +6,10 @@ Logs are an important tool for system diagnoses, event auditing, user management
Event logging in authentik is highly configurable; you can define the [retention period](./index.md#event-retention-and-forwarding) for storing and displaying events, configure which exact events should trigger a [notification](./notifications.md), and view low-level details about when and where the event happened.
### Troubleshooting with event logs
For details about troubleshooting using logs, including setting the log level (info, warning, etc.), enabling `trace` mode, viewing past logs, and streaming logs in real-time, refer to [Capturing logs in authentik](../../troubleshooting/logs.mdx).
## Enhanced audit logging (Enterprise)
In the enterprise version, each Event details page in the UI, details about each event are abstracted and displayed in an easy-to-access table, and for any event that involves an object being created or modified, the code `diffs` are displayed as well. This allows you to quickly see the previous and new configuration settings.
@ -25,7 +29,3 @@ Areas of the authentik UI where you can view these audits details are:
With the enterprise version, you can view recent events on both a world map view with pinpoints of where events occurred and also as a color-coded chart displaying type of event and volume of each type.
![](./event-map-chart.png)
### Troubleshooting with event logs
For details about troubleshooting using logs, including setting the log level (info, warning, etc.), enabling `trace` mode, viewing past logs, and streaming logs in real-time, refer to [Capturing logs in authentik](../../troubleshooting/logs.mdx).

32
website/docs/sys-mgmt/events/notifications.md
View File

@ -12,23 +12,21 @@ An authentik administrator can create notification rules based on the creation o
To receive notifications about events, follow this workflow:
1. [Create a transport](./transports.md#create-a-transport) (or use an existing default transport)
2. [Create a policy](#create-a-policy)
3. [Create a notification rule, and bind the policy to the rule](#create-a-notification-rule)
1. Create a transport (or use an existing default transport)
2. Create a policy
3. Create a notification rule, and bind the policy to the rule
## 1. Create a notification transport
A transport method (email, UI, webhook) is how the notifications are delivered to a user. Follow these [instructions](./transports.md#create-a-transport) for creating a transport.
## 2. Create a policy
First you need to create a policy (either the **Event Matcher** policy or a custom Expression policy) that defines which events will trigger a notification.
You will need to create a policy (either the **Event Matcher** policy or a custom Expression policy) that defines which events will trigger a notification.
### **Event Matcher** policy
For simple filtering you can [create and configure](../../customize/policies/working_with_policies.md) a new **Event Matcher** policy to specify exactly which events (known as _Actions_ in the policy) you want to be notified about. For example, you get chose to create a policy for every time a user deletes a model object, or fails to successfully log in.
The authentik policy engine....
For simple filtering you can [create and configure](../../customize/policies/working_with_policies.md) a new **Event Matcher** policy to specify exactly which events (known as _Actions_ in the policy) you want to be notified about. For example, you can chose to create a policy for every time a user deletes a model object, or whenever any user fails to successfully log in.
Be aware that an event has to match all configured fields in the policy, otherwise the notification rule will not trigger.
@ -51,19 +49,15 @@ After you've created the policies to match the events you want, create a notific
2. Click **Create** to add a new notification rule, or click the **Edit** icon next to an existing rule to modify it.
3. Define the ------------, and then
3. Define the policy configurations, and click **Create** or \*\*Update to save the settings.
You have to select which group the generated notification should be sent to. If left empty, the rule will be disabled.
- Note that you have to select which group the generated notification should be sent to. If left empty, the rule will be disabled.
- You also have to select which [transports](./transports.md) should be used to send the notification. A transport with the name "default-email-transport" is created by default. This transport will use the [global email configuration](../../install-config/install/docker-compose.mdx#email-configuration-optional-but-recommended).
4. In the list of Notification rules, click the arrow in the row of the Notification rule to expand the details of the rule.
5. Click **Bind existing Policy/Group/User**, and in the **Create Binding** modal, select the policy that you created for this notification rule and then click **Create** to finalize the binding.
:::info
Be aware that policies are executed even when no group is selected.
:::
You also have to select which [transports](./transports.md) should be used to send the notification.
A transport with the name "default-email-transport" is created by default. This transport will use the [global email configuration](../../install-config/install/docker-compose.mdx#email-configuration-optional-but-recommended).
4. Click **Create**.