Skip to content

Commit f877785

Browse files
knqyf263kotakanbe
authored andcommitted
Add Syslog section (#15)
* Update usage-settings.md * Update usage-report.md * Update usage-report.md
1 parent 116db89 commit f877785

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

docs/usage-report.md

+4
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ report:
2424
[-ignore-unfixed]
2525
[-to-email]
2626
[-to-slack]
27+
[-to-syslog]
2728
[-to-localfile]
2829
[-to-s3]
2930
[-to-azure-blob]
@@ -127,6 +128,9 @@ report:
127128
Write report to S3 (bucket/dir/yyyyMMdd_HHmm/servername.json/xml/txt)
128129
-to-slack
129130
Send report via Slack
131+
-to-syslog
132+
Send report via Syslog
133+
130134
```
131135

132136
## How to read a report

docs/usage-settings.md

+28
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,34 @@ sidebar_label: Settings
6464
subjectPrefix = "[vuls]"
6565
```
6666
67+
- Syslog section
68+
```
69+
[syslog]
70+
protocol = "tcp"
71+
host = "localhost"
72+
port = "514"
73+
tag = "vuls"
74+
facility = "local0"
75+
severity = "alert"
76+
verbose = false
77+
```
78+
79+
- protocol : transfer protocol (default: empty)
80+
- `tcp` or `udp` or empty
81+
If protocol is empty, vuls will connect to the local syslog server.
82+
- host : syslog target host
83+
- domain name or IP address
84+
- port : syslog target port (default: 514)
85+
- tag : syslog tag
86+
- facility : syslog facility (default: `auth`)
87+
- kern, user, mail, daemon, etc.
88+
- severity : syslog severity (default: `info`)
89+
- emerg, alert, crit, etc.
90+
- verbose : verbose mode (default: false)
91+
- CVE detail, etc.
92+
93+
94+
6795
- Default section
6896
```
6997
[default]

0 commit comments

Comments
 (0)