MISP
/
misp-website
mirror of https://github.com/MISP/misp-website
2
0
Fork 0
Code Issues Releases Wiki Activity

fix: [periodic_notification] Fixed typos

pull/69/head
Sami Mokaddem 2022-09-13 11:10:16 +02:00
parent 4da184ddd6
commit 52d089306c
No known key found for this signature in database
GPG Key ID: 164C473F627A06FA
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
content/blog/2022-09-12_periodic_notifications.md
View File

@ -9,34 +9,39 @@ banner: /img/blog/periodic-summary/periodic-summary-1.png
As of version 2.4.162, MISP includes a **periodic summary** feature allowing users to consult a summary based on a requested time-frame for data the user has access to.
Currently, the summaries can be generated for 3 different periods: `daily`, `weekly` and `monthly` and then sent to all users that subscribed one of these periods.
Currently, the summaries can be generated for 3 different periods: `daily`, `weekly` and `monthly` and then sent to all users that subscribed to one of these periods.
In addition to choose which period users want to subscribed to, they can also specify filtering options such as tags or distribution level to be used to generate the summary.
In addition to allowing users to subscribed, they can also specify filtering options such as tags or distribution level to be applied when generating the report.
![Periodic summary](/img/blog/periodic-summary/periodic-summary-2.png)
![Periodic summary](/img/blog/periodic-summary/periodic-summary-3.png)
## Viewing summaries
There are currently two ways to view a periodic summary:
- In the MISP ui, click on the `View periodic summary` link when browsing events
- In the MISP ui, click on the *View periodic summary* link when browsing events
- Subscribe to one of the available period and receive the summary directly in the user's mailbox
## Automatic delivery
In order to have MISP send periodic mails, the periodic notification task should be scheduled. One of the easiest way to schedule recurring task is to use CRON jobs.
## [admin] Automatic delivery
In order to have MISP send periodic mails, the periodic notification task should be scheduled. One of the easiest way to do it is to use CRON jobs.
For example, this entry could be added
```text
0 6 * * * /var/www/MISP/app/Console/cake Server sendPeriodicSummaryToUsers >/dev/null 2>&1
```
The `sendPeriodicSummaryToUsers` should be called daily and takes care of sending the summary to every users that subscribed to the `daily` notification. For the `weekly` and `monthly`, they will be sent on Mondays and on the first day of the month respectively.
The `sendPeriodicSummaryToUsers` should be called daily and takes care of sending the summaries to every users that subscribed to the `daily` notification.
For the `weekly` and `monthly` periods, they will be sent on Mondays and on the first day of each months respectively.
More details about setting the scheduled task and the CLI tool can be found in the *automation page* (/events/automation).
## Extending / Overriding
## [admin] Extending / Overriding
Site administrators of MISP can also extend, replace or remove parts of a periodic summary.
Site administrators of MISP can also extend, replace or remove parts of each periodic summary.
The notification templates can be found under the `app/View/Emails/html` folder. Each template extend a parametrized common template allowing site-admins to customize the summary to fit theirs needs.
For example, the default `monthly` notification template is configured to only include a subset of the *detailed summary*.
For example, the default `monthly` notification template is configured to only include a subset of the *detailed summary* section.
Options and developer documentation can be found in the `notification_common.ctp` file.