[SKIP CI] update readme

2019-10-17 19:07:01 +00:00 · 2019-10-17 19:07:01 +00:00 · 2879095c3a
commit 2879095c3a
parent 022d2e4173
1 changed files with 263 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -1,2 +1,265 @@
 # xoxys.jellyfin
+  
+[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.jellyfin/status.svg)](https://drone.rknet.org/ansible/xoxys.jellyfin)

+
+## Table of content
+
+* [Default Variables](#default-variables)
+  * [jellyfin_version](#jellyfin_version)
+  * [jellyfin_user](#jellyfin_user)
+  * [jellyfin_user_home](#jellyfin_user_home)
+  * [jellyfin_group](#jellyfin_group)
+  * [jellyfin_extra_groups](#jellyfin_extra_groups)
+  * [jellyfin_lvm_enabled](#jellyfin_lvm_enabled)
+  * [jellyfin_base_dir](#jellyfin_base_dir)
+  * [jellyfin_conf_dir](#jellyfin_conf_dir)
+  * [jellyfin_data_dir](#jellyfin_data_dir)
+  * [jellyfin_log_dir](#jellyfin_log_dir)
+  * [jellyfin_logrotate_enabled](#jellyfin_logrotate_enabled)
+  * [jellyfin_logrotate_config](#jellyfin_logrotate_config)
+  * [jellyfin_packages_extra](#jellyfin_packages_extra)
+  * [jellyfin_log_level_console](#jellyfin_log_level_console)
+  * [jellyfin_log_level_file](#jellyfin_log_level_file)
+  * [jellyfin_http_bind_port](#jellyfin_http_bind_port)
+  * [jellyfin_https_bind_port](#jellyfin_https_bind_port)
+  * [jellyfin_iptables_enabled](#jellyfin_iptables_enabled)
+  * [jellyfin_open_ports](#jellyfin_open_ports)
+  * [jellyfin_lvm_pvs](#jellyfin_lvm_pvs)
+  * [jellyfin_lvm_vg](#jellyfin_lvm_vg)
+  * [jellyfin_lvm_lv](#jellyfin_lvm_lv)
+  * [jellyfin_lvm_fstype](#jellyfin_lvm_fstype)
+  * [jellyfin_lvm_size](#jellyfin_lvm_size)
+* [Dependencies](#dependencies)
+* [License](#license)
+* [Author](#author)
+
+---
+
+## Default Variables
+
+### jellyfin_version
+
+#### Default value
+
+```YAML
+jellyfin_version: 10.3.7
+```
+
+### jellyfin_user
+
+#### Default value
+
+```YAML
+jellyfin_user: jellyfin
+```
+
+### jellyfin_user_home
+
+#### Default value
+
+```YAML
+jellyfin_user_home: /home/{{ jellyfin_user }}
+```
+
+### jellyfin_group
+
+#### Default value
+
+```YAML
+jellyfin_group: '{{ jellyfin_user }}'
+```
+
+### jellyfin_extra_groups
+
+#### Default value
+
+```YAML
+jellyfin_extra_groups: []
+```
+
+### jellyfin_lvm_enabled
+
+#### Default value
+
+```YAML
+jellyfin_lvm_enabled: false
+```
+
+### jellyfin_base_dir
+
+#### Default value
+
+```YAML
+jellyfin_base_dir: /opt/jellyfin
+```
+
+### jellyfin_conf_dir
+
+#### Default value
+
+```YAML
+jellyfin_conf_dir: '{{ jellyfin_base_dir }}/config'
+```
+
+### jellyfin_data_dir
+
+#### Default value
+
+```YAML
+jellyfin_data_dir: '{{ jellyfin_base_dir }}/data'
+```
+
+### jellyfin_log_dir
+
+#### Default value
+
+```YAML
+jellyfin_log_dir: '{{ jellyfin_base_dir }}/log'
+```
+
+### jellyfin_logrotate_enabled
+
+#### Default value
+
+```YAML
+jellyfin_logrotate_enabled: false
+```
+
+### jellyfin_logrotate_config
+
+#### Default value
+
+```YAML
+jellyfin_logrotate_config:
+  - log: '{{ jellyfin_log_dir }}/jellyfin.log'
+    options:
+      - weekly
+      - rotate 5
+      - maxsize 512K
+      - compress
+      - delaycompress
+      - create 640 {{ jellyfin_user }} {{ jellyfin_group }}
+```
+
+### jellyfin_packages_extra
+
+#### Default value
+
+```YAML
+jellyfin_packages_extra: []
+```
+
+### jellyfin_log_level_console
+
+Possible value: `Verbose | Debug | Information | Warning | Error | Fatal`. Beware that the values are case sensitive!
+
+#### Default value
+
+```YAML
+jellyfin_log_level_console: Fatal
+```
+
+### jellyfin_log_level_file
+
+#### Default value
+
+```YAML
+jellyfin_log_level_file: Information
+```
+
+### jellyfin_http_bind_port
+
+DONT change it! Changing the bind ports is currently not supported.
+
+#### Default value
+
+```YAML
+jellyfin_http_bind_port: 8096
+```
+
+### jellyfin_https_bind_port
+
+DONT change it! Changing the bind ports is currently not supported.
+
+#### Default value
+
+```YAML
+jellyfin_https_bind_port: 8920
+```
+
+### jellyfin_iptables_enabled
+
+#### Default value
+
+```YAML
+jellyfin_iptables_enabled: false
+```
+
+### jellyfin_open_ports
+
+#### Default value
+
+```YAML
+jellyfin_open_ports:
+  - name: allow_jellyfin_web
+    rules: "-A INPUT -m state --state NEW -p tcp --dport {{ jellyfin_http_bind_port\
+      \ }} -j ACCEPT\n"
+    state: present
+  - name: allow_jellyfin_multicast
+    rules: "-A OUTPUT -m state --state NEW -p udp --destination 239.255.255.250 --dport\
+      \ 1900 -j ACCEPT\n"
+    state: present
+```
+
+### jellyfin_lvm_pvs
+
+#### Default value
+
+```YAML
+jellyfin_lvm_pvs: _unset_
+```
+
+### jellyfin_lvm_vg
+
+#### Default value
+
+```YAML
+jellyfin_lvm_vg: _unset_
+```
+
+### jellyfin_lvm_lv
+
+#### Default value
+
+```YAML
+jellyfin_lvm_lv: _unset_
+```
+
+### jellyfin_lvm_fstype
+
+#### Default value
+
+```YAML
+jellyfin_lvm_fstype: ext4
+```
+
+### jellyfin_lvm_size
+
+#### Default value
+
+```YAML
+jellyfin_lvm_size: 50G
+```
+
+## Dependencies
+
+None.
+
+## License
+
+Robert Kaussow
+
+## Author
+
+Robert Kaussow