[SKIP CI] update readme

This commit is contained in:
Drone Shipper 2019-11-22 23:10:02 +00:00
parent db78872905
commit 3f233ef844

168
README.md
View File

@ -8,21 +8,21 @@ Role to setup unifi
## Table of content ## Table of content
* [Default Variables](#default-variables) * [Default Variables](#default-variables)
* [unifi_version](#unifi_version) * [unifi_base_dir](#unifi_base_dir)
* [unifi_group](#unifi_group)
* [unifi_openjdk_version](#unifi_openjdk_version) * [unifi_openjdk_version](#unifi_openjdk_version)
* [unifi_restore_after_upgrade](#unifi_restore_after_upgrade) * [unifi_restore_after_upgrade](#unifi_restore_after_upgrade)
* [unifi_group](#unifi_group)
* [unifi_user](#unifi_user)
* [unifi_base_dir](#unifi_base_dir)
* [unifi_tmp_dir](#unifi_tmp_dir)
* [unifi_tls_enabled](#unifi_tls_enabled)
* [unifi_tls_pkcs12_passphrase](#unifi_tls_pkcs12_passphrase)
* [unifi_tls_certs_dir](#unifi_tls_certs_dir)
* [unifi_tls_key_dir](#unifi_tls_key_dir)
* [unifi_tls_cert_file](#unifi_tls_cert_file) * [unifi_tls_cert_file](#unifi_tls_cert_file)
* [unifi_tls_key_file](#unifi_tls_key_file)
* [unifi_tls_cert_source](#unifi_tls_cert_source) * [unifi_tls_cert_source](#unifi_tls_cert_source)
* [unifi_tls_certs_dir](#unifi_tls_certs_dir)
* [unifi_tls_enabled](#unifi_tls_enabled)
* [unifi_tls_key_dir](#unifi_tls_key_dir)
* [unifi_tls_key_file](#unifi_tls_key_file)
* [unifi_tls_key_source](#unifi_tls_key_source) * [unifi_tls_key_source](#unifi_tls_key_source)
* [unifi_tls_pkcs12_passphrase](#unifi_tls_pkcs12_passphrase)
* [unifi_tmp_dir](#unifi_tmp_dir)
* [unifi_user](#unifi_user)
* [unifi_version](#unifi_version)
* [Dependencies](#dependencies) * [Dependencies](#dependencies)
* [License](#license) * [License](#license)
* [Author](#author) * [Author](#author)
@ -31,12 +31,20 @@ Role to setup unifi
## Default Variables ## Default Variables
### unifi_version ### unifi_base_dir
#### Default value #### Default value
```YAML ```YAML
unifi_version: 5.10.25 unifi_base_dir: /opt/unifi
```
### unifi_group
#### Default value
```YAML
unifi_group: ubnt
``` ```
### unifi_openjdk_version ### unifi_openjdk_version
@ -55,70 +63,6 @@ unifi_openjdk_version: 1.8.0
unifi_restore_after_upgrade: false unifi_restore_after_upgrade: false
``` ```
### unifi_group
#### Default value
```YAML
unifi_group: ubnt
```
### unifi_user
#### Default value
```YAML
unifi_user: ubnt
```
### unifi_base_dir
#### Default value
```YAML
unifi_base_dir: /opt/unifi
```
### unifi_tmp_dir
#### Default value
```YAML
unifi_tmp_dir: '{{ unifi_base_dir }}/tmp'
```
### unifi_tls_enabled
#### Default value
```YAML
unifi_tls_enabled: false
```
### unifi_tls_pkcs12_passphrase
#### Default value
```YAML
unifi_tls_pkcs12_passphrase: temppass
```
### unifi_tls_certs_dir
#### Default value
```YAML
unifi_tls_certs_dir: '{{ unifi_base_dir }}/tls/certs'
```
### unifi_tls_key_dir
#### Default value
```YAML
unifi_tls_key_dir: '{{ unifi_base_dir }}/tls/private'
```
### unifi_tls_cert_file ### unifi_tls_cert_file
#### Default value #### Default value
@ -127,14 +71,6 @@ unifi_tls_key_dir: '{{ unifi_base_dir }}/tls/private'
unifi_tls_cert_file: '{{ unifi_tls_certs_dir }}/mycert.pem' unifi_tls_cert_file: '{{ unifi_tls_certs_dir }}/mycert.pem'
``` ```
### unifi_tls_key_file
#### Default value
```YAML
unifi_tls_key_file: '{{ unifi_tls_key_dir }}/mykey.pem'
```
### unifi_tls_cert_source ### unifi_tls_cert_source
#### Default value #### Default value
@ -143,6 +79,38 @@ unifi_tls_key_file: '{{ unifi_tls_key_dir }}/mykey.pem'
unifi_tls_cert_source: mycert.pem unifi_tls_cert_source: mycert.pem
``` ```
### unifi_tls_certs_dir
#### Default value
```YAML
unifi_tls_certs_dir: '{{ unifi_base_dir }}/tls/certs'
```
### unifi_tls_enabled
#### Default value
```YAML
unifi_tls_enabled: false
```
### unifi_tls_key_dir
#### Default value
```YAML
unifi_tls_key_dir: '{{ unifi_base_dir }}/tls/private'
```
### unifi_tls_key_file
#### Default value
```YAML
unifi_tls_key_file: '{{ unifi_tls_key_dir }}/mykey.pem'
```
### unifi_tls_key_source ### unifi_tls_key_source
#### Default value #### Default value
@ -151,6 +119,38 @@ unifi_tls_cert_source: mycert.pem
unifi_tls_key_source: mykey.pem unifi_tls_key_source: mykey.pem
``` ```
### unifi_tls_pkcs12_passphrase
#### Default value
```YAML
unifi_tls_pkcs12_passphrase: temppass
```
### unifi_tmp_dir
#### Default value
```YAML
unifi_tmp_dir: '{{ unifi_base_dir }}/tmp'
```
### unifi_user
#### Default value
```YAML
unifi_user: ubnt
```
### unifi_version
#### Default value
```YAML
unifi_version: 5.10.25
```
## Dependencies ## Dependencies
None. None.