Congegni
/
libretime
mirror of https://github.com/libretime/libretime.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: improve config comments

This commit is contained in:
jo 2022-08-19 22:15:28 +02:00 committed by Kyle Robbertze
parent ffc03095f3
commit 82502fb608
2 changed files with 119 additions and 72 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

117
docs/admin-manual/setup/configuration.md
View File

@ -11,21 +11,26 @@ The `general` section configure anything related to the legacy and API services.
```yml ```yml
general: general:
# The public url, this field is REQUIRED # The public url.
public_url: https://example.com # > this field is REQUIRED
# The internal API authentication key, this field is REQUIRED public_url: "https://example.com"
api_key: some_random_generated_secret! # The internal API authentication key.
# > this field is REQUIRED
api_key: "some_random_generated_secret!"
# List of origins allowed to access resources on the server, default is [] # List of origins allowed to access resources on the server, the public url
# The public url origin is automatically included # origin is automatically included.
# > default is []
allowed_cors_origins: [] allowed_cors_origins: []
# How many hours ahead Playout should cache scheduled media files, default is 1 # How many hours ahead Playout should cache scheduled media files.
# > default is 1
cache_ahead_hours: 1 cache_ahead_hours: 1
# Authentication adaptor to use for the legacy service, default is local # Authentication adaptor to use for the legacy service, specify a class like
# Specify a class like LibreTime_Auth_Adaptor_FreeIpa to replace the built-in adaptor # LibreTime_Auth_Adaptor_FreeIpa to replace the built-in adaptor.
auth: local # > default is local
auth: "local"
``` ```
In order to apply the changes made in this section, please restart the following services: In order to apply the changes made in this section, please restart the following services:
@ -57,16 +62,21 @@ sudo -u postgres psql -c "ALTER USER libretime PASSWORD 'new-password';"
```yml ```yml
database: database:
# The hostname of the PostgreSQL server, default is localhost # The hostname of the PostgreSQL server.
host: localhost # > default is localhost
# The port of the PostgreSQL server, default is 5432 host: "localhost"
# The port of the PostgreSQL server.
# > default is 5432
port: 5432 port: 5432
# The name of the PostgreSQL database, default is libretime # The name of the PostgreSQL database.
name: libretime # > default is libretime
# The username of the PostgreSQL user, default is libretime name: "libretime"
user: libretime # The username of the PostgreSQL user.
# The password of the PostgreSQL user, default is libretime # > default is libretime
password: some_random_generated_secret! user: "libretime"
# The password of the PostgreSQL user.
# > default is libretime
password: "some_random_generated_secret!"
``` ```
In order to apply the changes made in this section, please restart the following services: In order to apply the changes made in this section, please restart the following services:
@ -95,16 +105,21 @@ sudo rabbitmqctl change_password "libretime" "new-password"
```yml ```yml
rabbitmq: rabbitmq:
# The hostname of the RabbitMQ server, default is localhost # The hostname of the RabbitMQ server.
host: localhost # > default is localhost
# The port of the RabbitMQ server, default is 5672 host: "localhost"
# The port of the RabbitMQ server.
# > default is 5672
port: 5672 port: 5672
# The virtual host of RabbitMQ server, default is /libretime # The virtual host of RabbitMQ server.
vhost: /libretime # > default is /libretime
# The username of the RabbitMQ user, default is libretime vhost: "/libretime"
user: libretime # The username of the RabbitMQ user.
# The password of the RabbitMQ user, default is libretime # > default is libretime
password: some_random_generated_secret! user: "libretime"
# The password of the RabbitMQ user.
# > default is libretime
password: "some_random_generated_secret!"
``` ```
In order to apply the changes made in this section, please restart the following services: In order to apply the changes made in this section, please restart the following services:
@ -122,20 +137,28 @@ The `playout` section configure anything related to the playout service.
```yml ```yml
playout: playout:
# Liquidsoap connection host, default is localhost # Liquidsoap connection host.
liquidsoap_host: localhost # > default is localhost
# Liquidsoap connection port, default is 1234 liquidsoap_host: "localhost"
# Liquidsoap connection port.
# > default is 1234
liquidsoap_port: 1234 liquidsoap_port: 1234
# The format for recordings, allowed values are ogg,mp3, default is ogg # The format for recordings.
# > must be one of (ogg, mp3)
# > default is ogg
record_file_format: ogg record_file_format: ogg
# The bitrate for recordings, default is 256 # The bitrate for recordings.
# > default is 256
record_bitrate: 256 record_bitrate: 256
# The samplerate for recordings, default is 44100 # The samplerate for recordings.
# > default is 44100
record_samplerate: 44100 record_samplerate: 44100
# The number of channels for recordings, default is 2 # The number of channels for recordings.
# > default is 2
record_channels: 2 record_channels: 2
# The sample size for recordings, default is 16 # The sample size for recordings.
# > default is 16
record_sample_size: 16 record_sample_size: 16
``` ```
@ -151,21 +174,21 @@ The `ldap` section provide additional configuration for the authentication mecha
```yml ```yml
ldap: ldap:
# Hostname of LDAP server # Hostname of LDAP server.
hostname: ldap.example.org hostname: "ldap.example.org"
# Complete DN of user used to bind to LDAP # Complete DN of user used to bind to LDAP.
binddn: "uid=libretime,cn=sysaccounts,cn=etc,dc=int,dc=example,dc=org" binddn: "uid=libretime,cn=sysaccounts,cn=etc,dc=int,dc=example,dc=org"
# Password for binddn user # Password for binddn user.
password: hackme password: "hackme"
# Domain part of username # Domain part of username.
account_domain: INT.EXAMPLE.ORG account_domain: "INT.EXAMPLE.ORG"
# Base search DN # Base search DN.
basedn: "cn=users,cn=accounts,dc=int,dc=example,dc=org" basedn: "cn=users,cn=accounts,dc=int,dc=example,dc=org"
# Name of the uid field for searching. Usually uid, may be cn # Name of the uid field for searching. Usually uid, may be cn.
filter_field: uid filter_field: "uid"
# Map user types to LDAP groups. Assign user types based on the group of a given user # Map user types to LDAP groups. Assign user types based on the group of a given user
# Key format is groupmap_* # Key format is groupmap_*.
groupmap_superadmin: "cn=superadmin,cn=groups,cn=accounts,dc=int,dc=example,dc=org" groupmap_superadmin: "cn=superadmin,cn=groups,cn=accounts,dc=int,dc=example,dc=org"
groupmap_admin: "cn=admin,cn=groups,cn=accounts,dc=int,dc=example,dc=org" groupmap_admin: "cn=admin,cn=groups,cn=accounts,dc=int,dc=example,dc=org"
groupmap_program_manager: "cn=program_manager,cn=groups,cn=accounts,dc=int,dc=example,dc=org" groupmap_program_manager: "cn=program_manager,cn=groups,cn=accounts,dc=int,dc=example,dc=org"

74
installer/config.yml
View File

@ -1,63 +1,87 @@
# See https://libretime.org/docs/admin-manual/setup/configuration/ # See https://libretime.org/docs/admin-manual/setup/configuration/
general: general:
# The public url, this field is REQUIRED # The public url.
# > this field is REQUIRED
public_url: public_url:
# The internal API authentication key, this field is REQUIRED # The internal API authentication key.
# > this field is REQUIRED
api_key: api_key:
# List of origins allowed to access resources on the server, default is [] # List of origins allowed to access resources on the server, the public url
# The public url origin is automatically included # origin is automatically included.
# > default is []
allowed_cors_origins: [] allowed_cors_origins: []
# How many hours ahead Playout should cache scheduled media files, default is 1 # How many hours ahead Playout should cache scheduled media files.
# > default is 1
cache_ahead_hours: 1 cache_ahead_hours: 1
# Authentication adaptor to use for the legacy service, default is local # Authentication adaptor to use for the legacy service, specify a class like
# Specify a class like LibreTime_Auth_Adaptor_FreeIpa to replace the built-in adaptor # LibreTime_Auth_Adaptor_FreeIpa to replace the built-in adaptor.
# > default is local
auth: local auth: local
storage: storage:
# Path of the storage directory, default is /srv/libretime # Path of the storage directory.
# > default is /srv/libretime
path: /srv/libretime path: /srv/libretime
database: database:
# The hostname of the PostgreSQL server, default is localhost # The hostname of the PostgreSQL server.
# > default is localhost
host: localhost host: localhost
# The port of the PostgreSQL server, default is 5432 # The port of the PostgreSQL server.
# > default is 5432
port: 5432 port: 5432
# The name of the PostgreSQL database, default is libretime # The name of the PostgreSQL database.
# > default is libretime
name: libretime name: libretime
# The username of the PostgreSQL user, default is libretime # The username of the PostgreSQL user.
# > default is libretime
user: libretime user: libretime
# The password of the PostgreSQL user, default is libretime # The password of the PostgreSQL user.
# > default is libretime
password: libretime password: libretime
rabbitmq: rabbitmq:
# The hostname of the RabbitMQ server, default is localhost # The hostname of the RabbitMQ server.
# > default is localhost
host: localhost host: localhost
# The port of the RabbitMQ server, default is 5672 # The port of the RabbitMQ server.
# > default is 5672
port: 5672 port: 5672
# The virtual host of RabbitMQ server, default is /libretime # The virtual host of RabbitMQ server.
# > default is /libretime
vhost: /libretime vhost: /libretime
# The username of the RabbitMQ user, default is libretime # The username of the RabbitMQ user.
# > default is libretime
user: libretime user: libretime
# The password of the RabbitMQ user, default is libretime # The password of the RabbitMQ user.
# > default is libretime
password: libretime password: libretime
playout: playout:
# Liquidsoap connection host, default is localhost # Liquidsoap connection host.
# > default is localhost
liquidsoap_host: localhost liquidsoap_host: localhost
# Liquidsoap connection port, default is 1234 # Liquidsoap connection port.
# > default is 1234
liquidsoap_port: 1234 liquidsoap_port: 1234
# The format for recordings, allowed values ogg,mp3, default is ogg # The format for recordings.
# > must be one of (ogg, mp3)
# > default is ogg
record_file_format: ogg record_file_format: ogg
# The bitrate for recordings, default is 256 # The bitrate for recordings.
# > default is 256
record_bitrate: 256 record_bitrate: 256
# The samplerate for recordings, default is 256 # The samplerate for recordings.
# > default is 44100
record_samplerate: 44100 record_samplerate: 44100
# The number of channels for recordings, default is 2 # The number of channels for recordings.
# > default is 2
record_channels: 2 record_channels: 2
# The sample size for recordings, default is 16 # The sample size for recordings.
# > default is 16
record_sample_size: 16 record_sample_size: 16