Skip to content

Commit d2ff7fb

Browse files
committed
Add documentation about database imports
1 parent e758261 commit d2ff7fb

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

doc/role-icingaweb2/module-x509.md

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ icingaweb2_modules:
4747
#### Import Certificates
4848

4949
To import certificates use the **list** `certificate_files` all files need to be
50-
available locally beforehand.
50+
available locally beforehand.
5151

5252
```
5353
icingaweb2_modules:
@@ -60,3 +60,36 @@ icingaweb2_modules:
6060
certificate_files:
6161
- /etc/ssl/certs/ca-certificates.crt
6262
```
63+
64+
#### Database Schema Setup
65+
66+
To import the database schema use `database` dictionary with the following variables.
67+
68+
| Variable | Type | Description | Default |
69+
|----------|------|-------------|---------|
70+
| `import_schema` | `Boolean` | Defines wether the schema will be imported or not. | false |
71+
| `host` | `String` | Defines database address to connect to. | `localhost` |
72+
| `port` | `int` | Defines the database port to connect to. | `3306` or `5432` |
73+
| `user` | `string` | Defines database user | `x509` |
74+
| `name` | `String` | Defines the database to connect to. | `x509` |
75+
| `password` | `String` | Defines the database password to connect with. | `x509` |
76+
| `ssl_mode` | `String` | Clients attempt to connect using encryption, falling back to an unencrypted connection if an encrypted connection cannot be established |**n/a** |
77+
|`ssl_ca`| `String`| Defines the path to the ca certificate for client authentication. | **n/a** |
78+
|`ssl_cert`|`String`| Defines the path to the certificate for client authentication. | **n/a** |
79+
|`ssl_key`| `String` | Defines the path to the certificate key for client key authentication. | **n/a** |
80+
|`ssl_cipher`|`String`| Ciphers for the client authentication. | **n/a** |
81+
|`ssl_extra_options`|`String`| Extra options for the client authentication. | **n/a** |
82+
83+
84+
```
85+
icingaweb2_modules:
86+
x509:
87+
source: package
88+
enabled: true
89+
database:
90+
import_schema: true
91+
host: localhost
92+
port: 3306
93+
user: x509
94+
password: secret
95+
```

0 commit comments

Comments
 (0)