205 lines
11 KiB
Markdown
205 lines
11 KiB
Markdown
|
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
|
||
|
|
|
||
|
|
The full tarball for the `3.0.0-alpha.9` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.9/libretime-3.0.0-alpha.9.tar.gz).
|
||
|
|
|
||
|
|
Since this is an alpha release there will be bugs in the code.
|
||
|
|
|
||
|
|
Please report new issues and/or feature requests in [the issue tracker](https://github.com/LibreTime/libretime/issues). Join our [discourse](https://discourse.libretime.org/) or chat to us on our [Mattermost instance](https://chat.libretime.org/e) if you need help and for general discussion.
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
- <a href="#features-3.0.0-alpha.9">Features</a>
|
||
|
|
- <a href="#bugfixes-3.0.0-alpha.9">Bugfixes</a>
|
||
|
|
- <a href="#deprecated-3.0.0-alpha.9">Deprecated Features</a>
|
||
|
|
- <a href="#contributors-3.0.0-alpha.9">Contributors</a>
|
||
|
|
- <a href="#install-3.0.0-alpha.9">Installation</a>
|
||
|
|
- <a href="#update-3.0.0-alpha.9">Updating</a>
|
||
|
|
- <a href="#issues-3.0.0-alpha.9">Known Issues</a>
|
||
|
|
- <a href="#issues-installer-issues-3.0.0-alpha.9">Installer Issues</a>
|
||
|
|
- <a href="#issues-media-monitor-3.0.0-alpha.9">Media-Monitor config needs manual removing</a>
|
||
|
|
- <a href="#issues-silan-3.0.0-alpha.9">Outdated silan reports unreliable cue in/out information</a>
|
||
|
|
- <a href="#issues-watched-3.0.0-alpha.9">No watched folder support</a>
|
||
|
|
- <a href="#issues-line-in-3.0.0-alpha.9">No Line In recording support</a>
|
||
|
|
- <a href="#issues-no-locale-3.0.0-alpha.9">Playout won't work if locale is missing</a>
|
||
|
|
- <a href="#issues-no-i18n-3.0.0-alpha.9">Lack of i18n toolchain is disturbing</a>
|
||
|
|
|
||
|
|
<a id="features-3.0.0-alpha.9"/>
|
||
|
|
|
||
|
|
## Features
|
||
|
|
|
||
|
|
- Display artwork from ID3 tags if available
|
||
|
|
- Expose track metadata or artwork in new API endpoint
|
||
|
|
- "Track Type" feature to classify tracks for auto-DJ
|
||
|
|
- support liquidsoap versions 1.1.1, 1.3.x and 1.4.x out of the box
|
||
|
|
- Improved French translation
|
||
|
|
- Updated jquery.cookie to js.cookie
|
||
|
|
- `forceSSL` config to support TLS on non default ports
|
||
|
|
- macOS Catalina support for Vagrant
|
||
|
|
- CentOS 8 Support
|
||
|
|
- Installer creates a secure icecast password on first run
|
||
|
|
- Support Multipass as an alternative to Vagrant dev environments
|
||
|
|
|
||
|
|
<a id="bugfixes-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
## Bugfixes
|
||
|
|
|
||
|
|
- Fix using outro playlist in "repeat until full" smartblock
|
||
|
|
- Switch to reliable message consumption to prevent RabbitMQ connections getting dropped side-effects
|
||
|
|
- Replace absolute css and js URLs with relative URLs
|
||
|
|
- remove legacy upstream conversion tracking, provisioning, and billing code
|
||
|
|
- disabled version notification to avoid confusion, users can check current version in Settings > Status.
|
||
|
|
- Swap out MusesPlayer for HTML5Player for playout
|
||
|
|
- Make lots of untranslatable strings translatable
|
||
|
|
|
||
|
|
<a id="deprecated-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
## Deprecated Features
|
||
|
|
|
||
|
|
- Liquidsoap 1.1.1 support. 3.0.0-alpha.9 is most likely the last version to support liquidsoap 1.1.1 out of the box. The number of distros that install a current version of liquidsoap are gaining the majority and once Ubuntu releases a version of their distro that has liquidsoap 1.3.x we will switch to liquidsoap 1.3.x support only. Users still on liquidsoap 1.1.1 will need to apply a patch to their liquidsoap scripts (or update liquidsoap).
|
||
|
|
|
||
|
|
<a id="contributors-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
## Contributors
|
||
|
|
|
||
|
|
The LibreTime project wants to thank the following contributors for committing PRs to this release:
|
||
|
|
|
||
|
|
- [@caveman99](https://github.com/caveman99)
|
||
|
|
- [@codenift](https://github.com/codenift)
|
||
|
|
- [@farggus](https://github.com/farggus)
|
||
|
|
- [@glibloc](https://github.com/glibloc)
|
||
|
|
- [@hairmare](https://github.com/hairmare)
|
||
|
|
- [@jeromelebleu](https://github.com/jeromelebleu)
|
||
|
|
- [@kmahelona](https://github.com/kmahelona)
|
||
|
|
- [@monkeywithacupcake](https://github.com/monkeywithacupcake)
|
||
|
|
- [@Numerico](https://github.com/Numerico)
|
||
|
|
- [@paddatrapper](https://github.com/paddatrapper)
|
||
|
|
- [@q84fh](https://github.com/q84fh)
|
||
|
|
- [@rjhelms](https://github.com/rjhelms)
|
||
|
|
- [@Robbt](https://github.com/Robbt)
|
||
|
|
- [@samkitk](https://github.com/samkitk)
|
||
|
|
- [@teotikalki](https://github.com/teotikalki)
|
||
|
|
- [@valerio-bozzolan](https://github.com/valerio-bozzolan)
|
||
|
|
- [@xabispacebiker](https://github.com/xabispacebiker)
|
||
|
|
- [@zklosko](https://github.com/zklosko)
|
||
|
|
|
||
|
|
<a id="install-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
The main installation docs may be found at [https://libretime.org/install/](https://libretime.org/install). They describe a "developer" install using the bundled `install` script.
|
||
|
|
|
||
|
|
We are preparing packages for supported distros and you can take those for a spin if you would like to. Usually the packages get built pretty soon after a release is published. If the current version is not available from the below sources you should wait for a while until they get uploaded.
|
||
|
|
|
||
|
|
- [Ubuntu packages](https://github.com/LibreTime/libretime-debian-packaging/releases)
|
||
|
|
- [Debian packages](https://github.com/LibreTime/libretime-debian-packaging/releases)
|
||
|
|
- [CentOS packages](https://build.opensuse.org/package/show/home:radiorabe:airtime/libretime)
|
||
|
|
|
||
|
|
Please reference these links for further information on how to install from packages. The install docs will get updated to show how to install packages once we have validated that the packages work properly and when the packages are available from a repository allowing you to automate updating to a new version.
|
||
|
|
|
||
|
|
<a id="update-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
## Updating
|
||
|
|
|
||
|
|
See [the docs](http://libretime.org/manual/upgrading/) for complete information on updating. Please ensure that you have proper [backups](http://libretime.org/manual/backing-up-the-server/) and a rollback scenario in place before updating.
|
||
|
|
If the update does not go smoothly, it may cause significant downtime, so you should always have a fallback system available during the update to ensure broadcast continuity.
|
||
|
|
|
||
|
|
If you installed from GitHub you can `git pull` in your local working copy and re-run the `./install` script with the same `--web-root` and `--web-user` arguments you used during the initial install. Tarball users can leave out the git pull part and just call the new version of the install script.
|
||
|
|
|
||
|
|
### Updating from 3.0.0-alpha, 3.0.0-alpha.1 and, 3.0.0-alpha.2
|
||
|
|
|
||
|
|
The configuration file structure has changed. Please move the contents of the `/etc/airtime/cloud_storage.conf` and `/etc/airtime/rabbitmq-analyzer.ini` files into the main `/etc/airtime/airtime.conf`. In all known cases you need to add the following section to the file.
|
||
|
|
|
||
|
|
```ini
|
||
|
|
[current_backend]
|
||
|
|
storage_backend=file
|
||
|
|
```
|
||
|
|
|
||
|
|
You can then remove the files and the symlink.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
rm /etc/airtime/cloud_storage.conf \
|
||
|
|
/etc/airtime/rabbitmq-analyzer.ini \
|
||
|
|
/etc/airtime/production
|
||
|
|
```
|
||
|
|
|
||
|
|
While you're at you may also want to remove the `amazon_s3` section if it was in any of the files.
|
||
|
|
|
||
|
|
Analyzer grabs all the needed info from the main `airtime.conf` file starting with `3.0.0-alpha.8`.
|
||
|
|
|
||
|
|
<a id="issues-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
## Known Issues
|
||
|
|
|
||
|
|
The following issues may need a workaround for the time being. Please search the [issues](https://github.com/LibreTime/libretime/issues) before reporting problems not listed below.
|
||
|
|
|
||
|
|
<a id="issues-installer-issues-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
### Installer Issues
|
||
|
|
|
||
|
|
The installer is generally a bit unstable, we hope to be able to offer some reasonable packages at some point. Some of the GUI driven parts before the first login are also in a somewhat questionable state, ymmv.
|
||
|
|
|
||
|
|
For now the installer distro selection is pretty good at auto-detecting your os and usually does an ok job depending on your distro. You should usually not need to pass a --distribution and --release parameter, those are still supported for the time being but their use is not recommended.
|
||
|
|
|
||
|
|
The UI works best if you don't use it in an opinionated fashion and change just the bare minimal.
|
||
|
|
|
||
|
|
If you want a secure environment you should work through the [preparing the server](https://libretime.org/install#preparing-the-server) docs (up until the dragons) and be prepared to fix some of the issues the installer gets wrong manually by hacking the config file after the fact.
|
||
|
|
|
||
|
|
If you want to skip the installer GUI completely you can configure LibreTime using `airtime_mvc/build/airtime.example.conf` as an template. Due to some python/PHP differences you must remove all comments from the example to use it 😞. You'll also have to create some folder structures manually and check if the music dir got properly created directly in the database. Referencing a second `install -fiap` install on a non productive system for reference can help with this type of bootstrap.
|
||
|
|
|
||
|
|
<a id="issues-media-monitor-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
### Media-Monitor config needs manual removing
|
||
|
|
|
||
|
|
If you are using the `install` script you should most likely remove the `[media-monitor]` config section from your `/etc/airtime/airtime.conf` file to ensure you do not run into the problems described in
|
||
|
|
https://github.com/LibreTime/libretime/issues/450. We recommend you do this before running the update since there are no known LibreTime releases that depend on the config value.
|
||
|
|
|
||
|
|
<a id="issues-silan-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
### Outdated silan reports unreliable cue in/out information
|
||
|
|
|
||
|
|
Out of the box the installer installs a broken, outdated version of silan (0.3.2) on some Ubuntu 16.04. CentOS does not have upstream packages and you may either install from source or use the [0.3.3 packages](https://github.com/radiorabe/centos-rpm-silan) from [RaBe APEL](https://build.opensuse.org/project/show/home:radiorabe:audio).
|
||
|
|
|
||
|
|
Check your version of silan by running `silan --version`. This should report `0.3.3` or higher. If not please see the [Silan Installation](https://github.com/LibreTime/libretime/wiki/Silan-Installation) wiki page for more details & workarounds.
|
||
|
|
|
||
|
|
tldr: **[Silan Installation](https://github.com/LibreTime/libretime/wiki/Silan-Installation)**
|
||
|
|
|
||
|
|
<a id="issues-watched-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
### No watched folder support
|
||
|
|
|
||
|
|
Currently LibreTime does not support watching folders. Uploading files through the web interface works fine and can be automated via a REST API. Re-implementing watched folder support is on the roadmap. Please consider helping out with the code to help speed things along if you want to use the feature.
|
||
|
|
|
||
|
|
<a id="issues-line-in-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
### No line in support
|
||
|
|
|
||
|
|
This feature went missing from LibreTime due to the fact that we based our code off of the saas-dev branch of legacy upstream and support for recording hasn't been ported to the new airtime analyzer ingest system. #42 currently tracks the progress being made on line in recording.
|
||
|
|
|
||
|
|
<a id="issues-no-locale-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
### Playout won't work if locale is missing
|
||
|
|
|
||
|
|
Some minimal OS installs do not have a default locale configured. This only seems to affect some VPS installs as they often do not have a locale setup in the default images provided.
|
||
|
|
|
||
|
|
You can set up the locale using a combination of the following commands. You might also want to consult the documentation of your VPS provider as it may contain an official way to set up locales when provisioning a VPS.
|
||
|
|
|
||
|
|
```bash
|
||
|
|
# Set locale using systemds localectl
|
||
|
|
localectl set-locale LANG="en_US.utf8"
|
||
|
|
```
|
||
|
|
|
||
|
|
These instructions do not seem to work on all Debian based distros so you might need to use `update-locale` as follows.
|
||
|
|
|
||
|
|
```
|
||
|
|
#Purge all locales but en_US.UTF-8
|
||
|
|
sudo locale-gen --purge en_US.UTF-8
|
||
|
|
#Populate LANGUAGE=
|
||
|
|
sudo update-locale LANGUAGE="en_US.UTF-8"
|
||
|
|
```
|
||
|
|
|
||
|
|
<a id="#issues-no-i18n-3.0.0-alpha.9">
|
||
|
|
|
||
|
|
### Lack of i18n toolchain is disturbing
|
||
|
|
|
||
|
|
Some translations might miss the tarball. They didn't get lost, but the build chain needs fixing. Work is in #301 and additional work is needed as it has become clear that we probably want to support bidirectional translation syncing with zanata.
|