docs: fix prose linting errors
- Properly enclose code between triple backticks - Put paths and url between backticks - Remove links <> enclosing - Libretime styled name is LibreTime - Put urls and paths betwen backticks - Use sentence like capitalization for headings - Put tools name between backticks - Update links
This commit is contained in:
jo
Jonas L
parent
75e3760f2e
commit
94d3c5e496
37 changed files with 414 additions and 319 deletions
|
|
@ -1,4 +1,4 @@
|
|||
{
|
||||
"label": "Server Configuration",
|
||||
"label": "Server configuration",
|
||||
"position": 5
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,14 +1,14 @@
|
|||
---
|
||||
title: Backing Up Libretime
|
||||
title: Backing up LibreTime
|
||||
---
|
||||
|
||||
:::info
|
||||
|
||||
At the moment, there is no script to cleanly restore a Libretime backup. To restore a Libretime backup, install a fresh copy, go through the standard setup process, and reupload the backed-up media files.
|
||||
At the moment, there is no script to cleanly restore a LibreTime backup. To restore a LibreTime backup, install a fresh copy, go through the standard setup process, and reupload the backed-up media files.
|
||||
|
||||
:::
|
||||
|
||||
A backup script is supplied for your convenience in the _utils/_ folder of the Libretime repo.
|
||||
A backup script is supplied for your convenience in the `utils/` folder of the LibreTime repo.
|
||||
Run it using:
|
||||
|
||||
```
|
||||
|
|
@ -37,13 +37,13 @@ be backed up.
|
|||
/organize - A temporary holding place for uploaded media as the importer works
|
||||
/etc
|
||||
/airtime
|
||||
airtime.conf - The main Libretime configuration
|
||||
airtime.conf - The main LibreTime configuration
|
||||
icecast_pass - Holds the password for the Icecast server
|
||||
liquidsoap.cfg - The main configuration file for Liquidsoap
|
||||
```
|
||||
|
||||
In addition, you should keep a copy of the database current to the backup. The below code
|
||||
can be used to export the Libretime database to a file.
|
||||
can be used to export the LibreTime database to a file.
|
||||
|
||||
```
|
||||
sudo -u postgres pg_dumpall filename
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: FreeIPA Configuration
|
||||
title: FreeIPA configuration
|
||||
---
|
||||
|
||||
You can configure LibreTime to delegate all authentication to a FreeIPA server.
|
||||
|
|
@ -7,12 +7,12 @@ You can configure LibreTime to delegate all authentication to a FreeIPA server.
|
|||
This allows you users to use their existing FreeIPA credentials. For this to
|
||||
work you need to configure Apache to use `mod_authnz_pam` and `mod_intercept_form_submit`.
|
||||
|
||||
## Apache configuration {#apache}
|
||||
## Apache configuration
|
||||
|
||||
After installing the needed modules you can set up Apache to intercept form logins and
|
||||
check them against pam.
|
||||
|
||||
```apache
|
||||
```apacheconf
|
||||
<Location /login>
|
||||
InterceptFormPAMService http-libretime
|
||||
InterceptFormLogin username
|
||||
|
|
@ -37,7 +37,7 @@ check them against pam.
|
|||
</Location>
|
||||
```
|
||||
|
||||
## PAM configuration {#pam}
|
||||
## PAM configuration
|
||||
|
||||
The above configuration expects a PAM configuration for the `http-libretime` service.
|
||||
|
||||
|
|
@ -48,7 +48,7 @@ auth required pam_sss.so
|
|||
account required pam_sss.so
|
||||
```
|
||||
|
||||
## LDAP configuration {#ldap}
|
||||
## LDAP configuration
|
||||
|
||||
LibreTime needs direct access to LDAP so it can fetch additional information. It does so with
|
||||
a [system account](https://www.freeipa.org/page/HowTo/LDAP#System_Accounts) that you need to
|
||||
|
|
@ -94,7 +94,7 @@ groupmap_admin = 'cn=admins,cn=groups,cn=accounts,dc=int,dc=example,dc=org'
|
|||
groupmap_superadmin = 'cn=superadmin,cn=groups,cn=accounts,dc=int,dc=example,dc=org'
|
||||
```
|
||||
|
||||
## Enable FreeIPA Authentication {#freeipa}
|
||||
## Enable FreeIPA authentication
|
||||
|
||||
After everything is set up properly you can enable FreeIPA auth in `airtime.conf`:
|
||||
|
||||
|
|
|
|||
|
|
@ -1,12 +1,12 @@
|
|||
---
|
||||
title: Host Configuration
|
||||
title: Host configuration
|
||||
---
|
||||
|
||||
The streaming host configuration for LibreTime is shown in the file _/etc/airtime/liquidsoap.cfg_ which is automatically generated by the **Streams** page, found on the **System** menu of the LibreTime administration interface. For this reason, you would not normally edit the streaming configuration manually, as any changes are likely to be overwritten by the administration interface.
|
||||
The streaming host configuration for LibreTime is shown in the file `/etc/airtime/liquidsoap.cfg` which is automatically generated by the **Streams** page, found on the **System** menu of the LibreTime administration interface. For this reason, you would not normally edit the streaming configuration manually, as any changes are likely to be overwritten by the administration interface.
|
||||
|
||||
## Database and RabbitMQ hosts
|
||||
|
||||
Optionally, you may wish to edit the file _/etc/airtime/airtime.conf_ to set the PostgreSQL database host, and the username and password to connect to the database with.
|
||||
Optionally, you may wish to edit the file `/etc/airtime/airtime.conf` to set the PostgreSQL database host, and the username and password to connect to the database with.
|
||||
|
||||
You can also set options for RabbitMQ messaging and the LibreTime server in this file, although you should not normally need to adjust the defaults unless you are running a large LibreTime system distributed across multiple servers. To run the LibreTime server in demo mode, which changes the greeting on the login page and prevents user accounts from being created or modified, set the value of _demo_ to 1.
|
||||
|
||||
|
|
@ -42,7 +42,7 @@ monit_password = airtime
|
|||
demo = 0
|
||||
```
|
||||
|
||||
Save and close the file then, run the following commands to restart Libretime's services:
|
||||
Save and close the file then, run the following commands to restart LibreTime's services:
|
||||
|
||||
```bash
|
||||
sudo systemctl restart libretime-liquidsoap
|
||||
|
|
@ -53,11 +53,11 @@ sudo systemctl restart libretime-analyzer
|
|||
|
||||
## API client configuration
|
||||
|
||||
The LibreTime API enables many types of information about the broadcast schedule and configuration to be retrieved from the LibreTime server. Other than the live-info and week-info data fetched by website widgets (see the chapter _Exporting the schedule_), all API requests must be authenticated using the secret API key stored in the file _/etc/airtime/api_client.cfg_ on the LibreTime server. This key is autogenerated during LibreTime installation and should be unique for each server.
|
||||
The LibreTime API enables many types of information about the broadcast schedule and configuration to be retrieved from the LibreTime server. Other than the live-info and week-info data fetched by website widgets (see the chapter _Exporting the schedule_), all API requests must be authenticated using the secret API key stored in the file `/etc/airtime/api_client.cfg` on the LibreTime server. This key is autogenerated during LibreTime installation and should be unique for each server.
|
||||
|
||||
If you intend to use the LibreTime API across a public network, for security reasons it is highly recommended that all API requests are sent over encrypted https: and that the web server is configured to accept requests to the api/ directory from specific host names or IP addresses only.
|
||||
|
||||
If you have changed the _base_url_, _base_port_ or _base_dir_ setting in _/etc/airtime/airtime.conf_ from the defaults, you will probably also have to update the _Hostname_ settings in the file _/etc/airtime/api_client.cfg_ accordingly.
|
||||
If you have changed the _base_url_, _base_port_ or _base_dir_ setting in `/etc/airtime/airtime.conf` from the defaults, you will probably also have to update the _Hostname_ settings in the file `/etc/airtime/api_client.cfg` accordingly.
|
||||
|
||||
```ini
|
||||
bin_dir = /usr/lib/airtime/api_clients
|
||||
|
|
@ -70,7 +70,7 @@ base_dir = /
|
|||
|
||||
## Apache max file size configuration
|
||||
|
||||
By default, the maximum upload file size is 40 MB, which may not be large enough for some stations, especially if they are uploading prerecorded shows. The setting for this is located in _/etc/apache2/sites-available/airtime.config_. Search for and update the following in megabytes:
|
||||
By default, the maximum upload file size is 40 MB, which may not be large enough for some stations, especially if they are uploading prerecorded shows. The setting for this is located in `/etc/apache2/sites-available/airtime.config`. Search for and update the following in megabytes:
|
||||
|
||||
```ini
|
||||
; Maximum allowed size for uploaded files.
|
||||
|
|
@ -84,7 +84,7 @@ For quick reference, 1024 MB = 1 GB and 2048 MB = 2 GB, but most will be okay wi
|
|||
|
||||
## Playout settings
|
||||
|
||||
Settings for pypo, the playout engine used by LibreTime, are found in the file _/etc/airtime/airtime.conf_. After making changes to this file, run `sudo systemctl restart libretime-playout`.
|
||||
Settings for pypo, the playout engine used by LibreTime, are found in the file `/etc/airtime/airtime.conf`. After making changes to this file, run `sudo systemctl restart libretime-playout`.
|
||||
|
||||
```ini
|
||||
############################################
|
||||
|
|
@ -168,9 +168,9 @@ If the Airtime logs indicate failures to connect to the RabbitMQ server, such as
|
|||
2013-10-31 08:21:11,255 ERROR - \[pypomessagehandler.py : main() : line 99\] - Error connecting to RabbitMQ Server. Trying again in few seconds - See more at: https://forum.sourcefabric.org/discussion/16050/#sthash.W8OJrNFm.dpuf
|
||||
```
|
||||
|
||||
but the RabbitMQ server is running normally, this error might be due to a change in the server's hostname since Libretime installation. Directory names under _/var/lib/rabbitmq/mnesia/_ indicate that RabbitMQ's database files are organised according to the hostname of the server (ex. `rabbit@airtime`) where the hostname is _airtime.example.com_. If the hostname has changed, it may be necessary to reconfigure RabbitMQ manually, as follows:
|
||||
but the RabbitMQ server is running normally, this error might be due to a change in the server's hostname since LibreTime installation. Directory names under `/var/lib/rabbitmq/mnesia/` indicate that RabbitMQ's database files are organised according to the hostname of the server (ex. `rabbit@airtime`) where the hostname is `airtime.example.com`. If the hostname has changed, it may be necessary to reconfigure RabbitMQ manually, as follows:
|
||||
|
||||
1. Delete the files in _/var/lib/rabbitmq/mnesia/_
|
||||
1. Delete the files in `/var/lib/rabbitmq/mnesia/`
|
||||
|
||||
```bash
|
||||
sudo rm -r /var/lib/rabbitmq/mnesia/*
|
||||
|
|
|
|||
|
|
@ -4,9 +4,9 @@ title: Icecast Configuration
|
|||
|
||||
## Background
|
||||
|
||||
LibreTime supports direct connection to two popular streaming media servers, the open source Icecast (<http://www.icecast.org>) and the proprietary SHOUTcast (<http://www.shoutcast.com>). Apart from the software license, the main difference between these two servers is that Icecast supports simultaneous MP3, AAC, Ogg Vorbis or Ogg Opus streaming from LibreTime, whereas SHOUTcast only supports MP3 and AAC streams. The royalty-free Ogg Vorbis format has the advantage of better sound quality than MP3 at lower bitrates, which has a direct impact on the amount of bandwidth that your station will require to serve the same number of listeners. Ogg Opus also benefits from good sound quality at low bitrates, with the added advantage of lower latency than other streaming formats. Opus is now an [IETF standard](http://tools.ietf.org/html/rfc6716) and requires Icecast 2.4 or later to be installed on the streaming server.
|
||||
LibreTime supports direct connection to two popular streaming media servers, the open source Icecast (https://www.icecast.org/) and the proprietary SHOUTcast (https://www.shoutcast.com). Apart from the software license, the main difference between these two servers is that Icecast supports simultaneous MP3, AAC, Ogg Vorbis or Ogg Opus streaming from LibreTime, whereas SHOUTcast only supports MP3 and AAC streams. The royalty-free Ogg Vorbis format has the advantage of better sound quality than MP3 at lower bitrates, which has a direct impact on the amount of bandwidth that your station will require to serve the same number of listeners. Ogg Opus also benefits from good sound quality at low bitrates, with the added advantage of lower latency than other streaming formats. Opus is now an [IETF standard](https://datatracker.ietf.org/doc/html/rfc6716) and requires Icecast 2.4 or later to be installed on the streaming server.
|
||||
|
||||
Ogg Vorbis playback is supported in most modern web browsers (see [this MDN article](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Audio_codecs#opus) for more information) and desktop players like [VLC](http://www.videolan.org/vlc/).
|
||||
Ogg Vorbis playback is supported in most modern web browsers (see [this MDN article](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Audio_codecs#opus) for more information) and desktop players like [VLC](https://www.videolan.org/vlc/).
|
||||
|
||||
Streaming MP3 below a bitrate of 128kbps is not recommended for music, because of a perceptible loss of high audio frequencies in the broadcast playout. A 96kbps or 64kbps MP3 stream may be acceptable for voice broadcasts if there is a requirement for compatibility with legacy hardware playback devices which do not support Ogg Vorbis or Opus streams.
|
||||
|
||||
|
|
@ -14,7 +14,7 @@ Because LibreTime supports simultaneous streaming in multiple formats, it is pos
|
|||
|
||||
:::tip
|
||||
|
||||
Setting a higher bitrate for your output stream will only benefit your listeners if you have high bitrate source material to play. Libretime can convert bitrates down for lower-quality streams but _cannot_ convert up for higher-quality streams.
|
||||
Setting a higher bitrate for your output stream will only benefit your listeners if you have high bitrate source material to play. LibreTime can convert bitrates down for lower-quality streams but _cannot_ convert up for higher-quality streams.
|
||||
|
||||
:::
|
||||
|
||||
|
|
@ -24,7 +24,7 @@ When sending metadata about your stream to an Icecast server in non-Latin alphab
|
|||
|
||||
|
||||
|
||||
The solution is to specify that the metadata for the MP3 mount point you are using should be interpreted using UTF-8 encoding. You can do this by adding the following stanza to the _/etc/icecast2/icecast.xml_ file, where _libretime.mp3_ is the name of your mount point:
|
||||
The solution is to specify that the metadata for the MP3 mount point you are using should be interpreted using UTF-8 encoding. You can do this by adding the following stanza to the `/etc/icecast2/icecast.xml` file, where `libretime.mp3` is the name of your mount point:
|
||||
|
||||
```xml
|
||||
<mount>
|
||||
|
|
@ -33,7 +33,7 @@ The solution is to specify that the metadata for the MP3 mount point you are usi
|
|||
</mount>
|
||||
```
|
||||
|
||||
After saving the _/etc/icecast2/icecast.xml_ file, restart the Icecast server with `sudo systemctl restart icecast2`.
|
||||
After saving the `/etc/icecast2/icecast.xml` file, restart the Icecast server with `sudo systemctl restart icecast2`.
|
||||
|
||||
## Icecast handover configuration
|
||||
|
||||
|
|
@ -45,7 +45,7 @@ The Icecast server has a _fallback-mount_ feature which can be used to move clie
|
|||
|
||||
To enable fallback mounts, edit the main Icecast configuration file (`/etc/icecast2/icecast.xml`) to define the mount points you will use, and the relationship between them.
|
||||
|
||||
The example mount section provided in the _icecast.xml_ file is commented out by default. Before or after the commented section, add three mount point definitions. The default mount point used by LibreTime is _/airtime_128_ which is shown in the _/etc/airtime/liquidsoap.cfg_ file. You must also define a mount point for the live source (ex. _/live.ogg_) and a mount point for the public to connect to (ex. _/stream.ogg_).
|
||||
The example mount section provided in the `icecast.xml` file is commented out by default. Before or after the commented section, add three mount point definitions. The default mount point used by LibreTime is `/airtime_128` which is shown in the `/etc/airtime/liquidsoap.cfg` file. You must also define a mount point for the live source (ex. `/live.ogg`) and a mount point for the public to connect to (ex. `/stream.ogg`).
|
||||
|
||||
```xml title="/etc/icecast2/icecast.xml"
|
||||
<mount>
|
||||
|
|
@ -68,13 +68,13 @@ The example mount section provided in the _icecast.xml_ file is commented out by
|
|||
</mount>
|
||||
```
|
||||
|
||||
These mount point definitions mean that a client connecting to a URL such as *http://icecast.example.com:8000/stream.ogg* will first fall back to the _/live.ogg_ mount point if it is available. If not, the client will fall back in turn to the _/airtime_128_ mount point for LibreTime playout.
|
||||
These mount point definitions mean that a client connecting to a URL such as *http://icecast.example.com:8000/stream.ogg* will first fall back to the `/live.ogg` mount point if it is available. If not, the client will fall back in turn to the `/airtime_128` mount point for LibreTime playout.
|
||||
|
||||
Setting the value of _fallback-override_ to 1 (enabled) means that when the _/live.ogg_ mount point becomes available again, the client will be re-connected to it. If you wish to hide the _/airtime_128_ and _/live.ogg_ mount points from the public Icecast web interface, set the value of _hidden_ in each of these definitions to 1.
|
||||
Setting the value of _fallback-override_ to 1 (enabled) means that when the `/live.ogg` mount point becomes available again, the client will be re-connected to it. If you wish to hide the `/airtime_128` and `/live.ogg` mount points from the public Icecast web interface, set the value of _hidden_ in each of these definitions to 1.
|
||||
|
||||
## Source configuration
|
||||
|
||||
Connect the other source to the Icecast server with the same parameters defined in the _/etc/airtime/liquidsoap.cfg_ file, except for the mount point. This should one of the mount points you have defined in the _/etc/icecast2/icecast.xml_ file, such as _/live.ogg_ in the example above.
|
||||
Connect the other source to the Icecast server with the same parameters defined in the `/etc/airtime/liquidsoap.cfg` file, except for the mount point. This should one of the mount points you have defined in the `/etc/icecast2/icecast.xml` file, such as `/live.ogg` in the example above.
|
||||
|
||||
:::tip Streaming with Mixxx
|
||||
|
||||
|
|
@ -94,23 +94,23 @@ This section covers how to edit Icecast's configuration to broadcast your statio
|
|||
|
||||
There are many online radio station directories you can add your station to for additional exposure.
|
||||
|
||||
On an Icecast server, you can uncomment the `directory` section in the _/etc/icecast2/icecast.xml_ file to have
|
||||
your station automatically listed on the [Icecast directory website](http://dir.xiph.org).
|
||||
On an Icecast server, you can uncomment the `directory` section in the `/etc/icecast2/icecast.xml` file to have
|
||||
your station automatically listed on the [Icecast directory website](https://dir.xiph.org/).
|
||||
|
||||
```xml
|
||||
<!-- Uncomment this if you want directory listings -->
|
||||
|
||||
<directory>
|
||||
<yp-url-timeout>15</yp-url-timeout>
|
||||
<yp-url>http://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
|
||||
<yp-url>https://dir.xiph.org/cgi-bin/yp-cgi</yp-url>
|
||||
</directory>
|
||||
```
|
||||
|
||||
The Indymedia stream directory at <http://radio.indymedia.org/en/yp> links to grassroots independent radio projects around the world. You can add your station to their list with an additional _directory_ section, as follows:
|
||||
The Indymedia stream directory at https://radio.indymedia.org links to grassroots independent radio projects around the world. You can add your station to their list with an additional _directory_ section, as follows:
|
||||
|
||||
```xml
|
||||
<directory>
|
||||
<yp-url-timeout>15</yp-url-timeout>
|
||||
<yp-url>http://radio.indymedia.org/cgi-bin/yp-cgi</yp-url>
|
||||
<yp-url>https://radio.indymedia.org/cgi-bin/yp-cgi</yp-url>
|
||||
</directory>
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue