From 5797a7dfcfb139cc656679ad1986acf13b3ee1c7 Mon Sep 17 00:00:00 2001 From: DroneShipper Date: Fri, 22 Nov 2019 10:44:01 +0000 Subject: [PATCH] [SKIP CI] update readme --- README.md | 107 ++++++++++++++++++++++++++++++++---------------------- 1 file changed, 64 insertions(+), 43 deletions(-) diff --git a/README.md b/README.md index c9a78f7..b37e4b2 100644 --- a/README.md +++ b/README.md @@ -8,22 +8,24 @@ Setup a Jellyfin streaming server ## 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_base_dir](#jellyfin_base_dir) * [jellyfin_conf_dir](#jellyfin_conf_dir) * [jellyfin_data_dir](#jellyfin_data_dir) + * [jellyfin_extra_groups](#jellyfin_extra_groups) + * [jellyfin_group](#jellyfin_group) + * [jellyfin_http_bind_port](#jellyfin_http_bind_port) + * [jellyfin_https_bind_port](#jellyfin_https_bind_port) * [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_logrotate_config](#jellyfin_logrotate_config) + * [jellyfin_logrotate_enabled](#jellyfin_logrotate_enabled) + * [jellyfin_packages_extra](#jellyfin_packages_extra) + * [jellyfin_selinux_fcontext](#jellyfin_selinux_fcontext) + * [jellyfin_selinux_restorecon](#jellyfin_selinux_restorecon) + * [jellyfin_user](#jellyfin_user) + * [jellyfin_user_home](#jellyfin_user_home) + * [jellyfin_version](#jellyfin_version) * [Dependencies](#dependencies) * [License](#license) * [Author](#author) @@ -32,84 +34,90 @@ Setup a Jellyfin streaming server ## Default Variables -### jellyfin_version +### jellyfin_base_dir #### Default value ```YAML -jellyfin_version: 10.3.7 +jellyfin_base_dir: /opt/jellyfin ``` -### jellyfin_user +### jellyfin_conf_dir #### Default value ```YAML -jellyfin_user: jellyfin +jellyfin_conf_dir: '{{ jellyfin_base_dir }}/config' ``` -### jellyfin_user_home +### jellyfin_data_dir #### Default value ```YAML -jellyfin_user_home: /home/{{ jellyfin_user }} +jellyfin_data_dir: '{{ jellyfin_base_dir }}/data' ``` -### jellyfin_group +### jellyfin_extra_groups #### Default value ```YAML -jellyfin_group: '{{ jellyfin_user }}' +jellyfin_extra_groups: [] ``` -### jellyfin_extra_groups +### jellyfin_group #### Default value ```YAML -jellyfin_extra_groups: [] +jellyfin_group: '{{ jellyfin_user }}' ``` -### jellyfin_base_dir +### jellyfin_http_bind_port + +DONT change it! Changing the bind ports is currently not supported. #### Default value ```YAML -jellyfin_base_dir: /opt/jellyfin +jellyfin_http_bind_port: 8096 ``` -### jellyfin_conf_dir +### jellyfin_https_bind_port + +DONT change it! Changing the bind ports is currently not supported. #### Default value ```YAML -jellyfin_conf_dir: '{{ jellyfin_base_dir }}/config' +jellyfin_https_bind_port: 8920 ``` -### jellyfin_data_dir +### jellyfin_log_dir #### Default value ```YAML -jellyfin_data_dir: '{{ jellyfin_base_dir }}/data' +jellyfin_log_dir: '{{ jellyfin_base_dir }}/log' ``` -### jellyfin_log_dir +### jellyfin_log_level_console + +Possible value: `Verbose | Debug | Information | Warning | Error | Fatal`. Beware that the values are case sensitive! #### Default value ```YAML -jellyfin_log_dir: '{{ jellyfin_base_dir }}/log' +jellyfin_log_level_console: Fatal ``` -### jellyfin_logrotate_enabled +### jellyfin_log_level_file #### Default value ```YAML -jellyfin_logrotate_enabled: false +jellyfin_log_level_file: Information ``` ### jellyfin_logrotate_config @@ -128,6 +136,14 @@ jellyfin_logrotate_config: - create 640 {{ jellyfin_user }} {{ jellyfin_group }} ``` +### jellyfin_logrotate_enabled + +#### Default value + +```YAML +jellyfin_logrotate_enabled: false +``` + ### jellyfin_packages_extra #### Default value @@ -136,42 +152,47 @@ jellyfin_logrotate_config: jellyfin_packages_extra: [] ``` -### jellyfin_log_level_console - -Possible value: `Verbose | Debug | Information | Warning | Error | Fatal`. Beware that the values are case sensitive! +### jellyfin_selinux_fcontext #### Default value ```YAML -jellyfin_log_level_console: Fatal +jellyfin_selinux_fcontext: + - target: '{{ jellyfin_log_dir }}(/.*)?' + setype: var_log_t ``` -### jellyfin_log_level_file +### jellyfin_selinux_restorecon #### Default value ```YAML -jellyfin_log_level_file: Information +jellyfin_selinux_restorecon: + - -ir {{ jellyfin_log_dir }} ``` -### jellyfin_http_bind_port - -DONT change it! Changing the bind ports is currently not supported. +### jellyfin_user #### Default value ```YAML -jellyfin_http_bind_port: 8096 +jellyfin_user: jellyfin ``` -### jellyfin_https_bind_port +### jellyfin_user_home -DONT change it! Changing the bind ports is currently not supported. +#### Default value + +```YAML +jellyfin_user_home: /home/{{ jellyfin_user }} +``` + +### jellyfin_version #### Default value ```YAML -jellyfin_https_bind_port: 8920 +jellyfin_version: 10.3.7 ``` ## Dependencies