[SKIP CI] update readme

2019-10-19 14:02:03 +00:00 · 2019-10-19 14:02:03 +00:00 · d7ee41cdce
parent be462d3153
commit d7ee41cdce
1 changed files with 256 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,258 @@
 # xoxys.unifi
+  
+[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.unifi/status.svg)](https://drone.rknet.org/ansible/xoxys.unifi)

+
+Role to setup unifi
+
+## Table of content
+
+* [Default Variables](#default-variables)
+  * [unifi_version](#unifi_version)
+  * [unifi_openjdk_version](#unifi_openjdk_version)
+  * [unifi_restore_after_upgrade](#unifi_restore_after_upgrade)
+  * [unifi_group](#unifi_group)
+  * [unifi_user](#unifi_user)
+  * [unifi_lvm_enabled](#unifi_lvm_enabled)
+  * [unifi_lvm_pvs](#unifi_lvm_pvs)
+  * [unifi_lvm_vg](#unifi_lvm_vg)
+  * [unifi_lvm_lv](#unifi_lvm_lv)
+  * [unifi_lvm_size](#unifi_lvm_size)
+  * [unifi_lvm_fstype](#unifi_lvm_fstype)
+  * [unifi_base_dir](#unifi_base_dir)
+  * [unifi_tmp_dir](#unifi_tmp_dir)
+  * [unifi_iptables_enabled](#unifi_iptables_enabled)
+  * [unifi_open_ports](#unifi_open_ports)
+  * [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_key_file](#unifi_tls_key_file)
+  * [unifi_tls_cert_source](#unifi_tls_cert_source)
+  * [unifi_tls_key_source](#unifi_tls_key_source)
+* [Dependencies](#dependencies)
+* [License](#license)
+* [Author](#author)
+
+---
+
+## Default Variables
+
+### unifi_version
+
+#### Default value
+
+```YAML
+unifi_version: 5.10.25
+```
+
+### unifi_openjdk_version
+
+#### Default value
+
+```YAML
+unifi_openjdk_version: 1.8.0
+```
+
+### unifi_restore_after_upgrade
+
+#### Default value
+
+```YAML
+unifi_restore_after_upgrade: false
+```
+
+### unifi_group
+
+#### Default value
+
+```YAML
+unifi_group: ubnt
+```
+
+### unifi_user
+
+#### Default value
+
+```YAML
+unifi_user: ubnt
+```
+
+### unifi_lvm_enabled
+
+#### Default value
+
+```YAML
+unifi_lvm_enabled: false
+```
+
+### unifi_lvm_pvs
+
+#### Default value
+
+```YAML
+unifi_lvm_pvs:
+  - /dev/sdxx
+```
+
+### unifi_lvm_vg
+
+#### Default value
+
+```YAML
+unifi_lvm_vg: vg_unifi
+```
+
+### unifi_lvm_lv
+
+#### Default value
+
+```YAML
+unifi_lvm_lv: lv_unifi
+```
+
+### unifi_lvm_size
+
+#### Default value
+
+```YAML
+unifi_lvm_size: 10G
+```
+
+### unifi_lvm_fstype
+
+#### Default value
+
+```YAML
+unifi_lvm_fstype: xfs
+```
+
+### 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_iptables_enabled
+
+#### Default value
+
+```YAML
+unifi_iptables_enabled: false
+```
+
+### unifi_open_ports
+
+#### Default value
+
+```YAML
+unifi_open_ports:
+  - name: allow_unifi_web
+    rules: "-A INPUT -m state --state NEW -p tcp --dport 8443 -j ACCEPT\n"
+    state: present
+  - name: allow_unifi_comm
+    rules: "-A INPUT -m state --state NEW -p tcp --dport 8080 -j ACCEPT\n-A OUTPUT\
+      \ -m state --state NEW -p tcp --dport 8080 -j ACCEPT\n"
+    state: present
+  - name: allow_unifi_stun
+    rules: "-A INPUT -m state --state NEW -p udp --dport 3478 -j ACCEPT\n-A OUTPUT\
+      \ -m state --state NEW -p udp --dport 3478 -j ACCEPT\n"
+    state: present
+  - name: allow_unifi_discover
+    rules: "-A INPUT -m state --state NEW -p udp --dport 10001 -j ACCEPT\n-A OUTPUT\
+      \ -m state --state NEW -p udp --dport 10001 -j ACCEPT\n"
+    state: present
+  - name: allow_unifi_sped
+    rules: "-A INPUT -m state --state NEW -p tcp --dport 6789 -j ACCEPT\n"
+    state: present
+  - name: allow_unifi_adopt
+    rules: "-A OUTPUT -m state --state NEW -p tcp --dport 22 -j ACCEPT\n"
+    state: present
+```
+
+### 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
+
+#### Default value
+
+```YAML
+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
+
+#### Default value
+
+```YAML
+unifi_tls_cert_source: mycert.pem
+```
+
+### unifi_tls_key_source
+
+#### Default value
+
+```YAML
+unifi_tls_key_source: mykey.pem
+```
+
+## Dependencies
+
+None.
+
+## License
+
+MIT
+
+## Author
+
+xoxys