[SKIP CI] update readme

This commit is contained in:
Drone Shipper 2019-11-22 10:44:01 +00:00
parent 52938efac3
commit 5797a7dfcf

215
README.md
View File

@ -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_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_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_log_level_console](#jellyfin_log_level_console)
* [jellyfin_log_level_file](#jellyfin_log_level_file)
* [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,46 +34,6 @@ Setup a Jellyfin streaming server
## 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_base_dir
#### Default value
@ -96,62 +58,20 @@ jellyfin_conf_dir: '{{ jellyfin_base_dir }}/config'
jellyfin_data_dir: '{{ jellyfin_base_dir }}/data'
```
### jellyfin_log_dir
### jellyfin_extra_groups
#### Default value
```YAML
jellyfin_log_dir: '{{ jellyfin_base_dir }}/log'
jellyfin_extra_groups: []
```
### jellyfin_logrotate_enabled
### jellyfin_group
#### 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_group: '{{ jellyfin_user }}'
```
### jellyfin_http_bind_port
@ -174,6 +94,107 @@ DONT change it! Changing the bind ports is currently not supported.
jellyfin_https_bind_port: 8920
```
### jellyfin_log_dir
#### Default value
```YAML
jellyfin_log_dir: '{{ jellyfin_base_dir }}/log'
```
### 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_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_logrotate_enabled
#### Default value
```YAML
jellyfin_logrotate_enabled: false
```
### jellyfin_packages_extra
#### Default value
```YAML
jellyfin_packages_extra: []
```
### jellyfin_selinux_fcontext
#### Default value
```YAML
jellyfin_selinux_fcontext:
- target: '{{ jellyfin_log_dir }}(/.*)?'
setype: var_log_t
```
### jellyfin_selinux_restorecon
#### Default value
```YAML
jellyfin_selinux_restorecon:
- -ir {{ jellyfin_log_dir }}
```
### jellyfin_user
#### Default value
```YAML
jellyfin_user: jellyfin
```
### jellyfin_user_home
#### Default value
```YAML
jellyfin_user_home: /home/{{ jellyfin_user }}
```
### jellyfin_version
#### Default value
```YAML
jellyfin_version: 10.3.7
```
## Dependencies
None.