Skip to content

Commit e758261

Browse files
committed
Add documentation for x509 module
1 parent 014b0c8 commit e758261

File tree

1 file changed

+62
-0
lines changed

1 file changed

+62
-0
lines changed

doc/role-icingaweb2/module-x509.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
## Module x509
2+
3+
### Variables and Configuration
4+
5+
The general module parameter like `enabled` and `source` can be applied here.
6+
7+
| Variable | Value |
8+
|----------|------------|
9+
| enabled | true/false |
10+
| source | package |
11+
12+
#### Section configuration
13+
14+
The backend database for the module needs to be available and configured at the `icingaweb2_resources` variable.
15+
16+
```
17+
icingaweb2_modules:
18+
x509:
19+
source: package
20+
enabled: true
21+
config:
22+
backend:
23+
resource: x509
24+
```
25+
26+
#### Configure SNI Names.
27+
28+
To configure SNIs for a IP address, use the dictionary `sni`.
29+
30+
Example:
31+
32+
```
33+
icingaweb2_modules:
34+
x509:
35+
source: package
36+
enabled: true
37+
config:
38+
backend:
39+
resource: x509
40+
sni:
41+
192.168.56.213:
42+
hostnames:
43+
- icinga.com
44+
- test2.icinga.com
45+
```
46+
47+
#### Import Certificates
48+
49+
To import certificates use the **list** `certificate_files` all files need to be
50+
available locally beforehand.
51+
52+
```
53+
icingaweb2_modules:
54+
x509:
55+
source: package
56+
enabled: true
57+
config:
58+
backend:
59+
resource: x509
60+
certificate_files:
61+
- /etc/ssl/certs/ca-certificates.crt
62+
```

0 commit comments

Comments
 (0)