Congegni
/
sintonia
7
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: update releases notes 

- remove duplicate deprecations and upgrade procedures
- add emijeeezz
This commit is contained in:
jo 2022-02-21 15:05:24 +01:00 committed by Kyle Robbertze
parent 9ebd2c85ef
commit 3f6438383f
17 changed files with 322 additions and 819 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
docs/admin-manual/setup/install.md
View File

@ -65,6 +65,17 @@ git clone https://github.com/libretime/libretime
cd libretime
```
:::info
When upgrading, you can pull the latest changes from the repository before checking out the desired version:
```bash
cd libretime
git pull
```
:::
And checkout the latest version:
<CodeBlock language="bash">
@ -88,6 +99,12 @@ Additional options can be listed with the following command:
./install --help
```
:::info
When upgrading be sure to run the installer using the same arguments you used during the initial install.
:::
Once the installation is completed, open [http://localhost:80](http://localhost:80) to complete the [setup wizard](#setup-wizard).
:::note
@ -142,3 +159,16 @@ sudo rabbitmqctl change_password "airtime" "new-password"
```
Once completed, it's recommended to [install a reverse proxy](./reverse-proxy.md) to setup SSL termination and secure your installation.
## Using packages
:::note
Usually the packages are built soon after a release is published.
:::
You can install LibreTime using packages on the distributions listed below, please follow further instruction provided by the links below:
- [Debian / Ubuntu packages](https://github.com/LibreTime/libretime-debian-packaging/releases)
- [CentOS packages](https://build.opensuse.org/package/show/home:radiorabe:airtime/libretime)

19
docs/admin-manual/setup/upgrade.md
View File

@ -7,20 +7,23 @@ This guide walk you though the steps required to upgrade LibreTime.
:::tip
You should always have a fallback system available during the upgrade to ensure **broadcast continuity**.
You should always have proper backups 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**.
:::
#### Make a backup
## Make a backup
Follow [the backup guide](../backup.md) to make an extra backup of your installation in case of accidental data loss during
the upgrade process.
Follow [the backup guide](../backup.md) to make an extra backup of your installation and prepare a rollback scenario in case of accidental data loss during the upgrade process.
#### Install the new version
## Install the new version
Follow [the install guide](./install.md) to download and install the new version.
Follow [the install guide](./install.md#download) to download and install the new version, and re-run the `./install` script with the same arguments you used during the initial install.
#### Verify
## Apply upgrade instructions
Be sure to carefully read **all** the [releases notes](../../../releases), from your current version to the targeted version, to apply upgrade or breaking changes instructions to your installation.
## Verify
Verify that all the services are still running after the install process:
@ -37,7 +40,7 @@ sudo systemctl status \
Verify for any error in the logs after the install process:
```bash
sudo tail -n 20 /var/log/libretime/**/*.log
sudo tail -f -n 100 "/var/log/syslog" | grep "libretime-"
```
Log into the interface and verify for any error after the install process.

14
docs/releases/3.0.0-alpha.00.md
View File

@ -1,6 +1,14 @@
---
title: LibreTime 3.0.0 alpha
---
import ReleaseHead from './\_release-head.md';
<ReleaseHead date="2017-03-15" version="3.0.0-alpha"/>
The first release from the LibreTime Community.
## Features
## :rocket: Features
- Working installer for Debian and Ubuntu
- Automated Vagrant setup for developers on either Debian, Ubuntu or CentOS
@ -10,8 +18,6 @@ The first release from the LibreTime Community.
- AutoDJ support for shows
- Tons of bugfixes like working silan cue cuts and more
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
Since this is an alpha release there will be bugs in the code. Some features that went missing in legacy upstreams "pro" branch have been backported while others are still waiting for such treatment. Please report any issues and/or feature requests in [the issue tracker](https://github.com/LibreTime/libretime/issues).
Some features that went missing in legacy upstream "pro" branch have been back-ported while others are still waiting for such treatment.
The attached debian package is considered unstable as it has not had any serious testing at all. It mainly demonstrates that we are able to build one.

16
docs/releases/3.0.0-alpha.01.md
View File

@ -1,8 +1,12 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 1
---
Since this is an alpha release there will be bugs in the code. Please report any issues and/or feature requests in [the issue tracker](https://github.com/LibreTime/libretime/issues).
import ReleaseHead from './\_release-head.md';
## Features
<ReleaseHead date="2017-04-20" version="3.0.0-alpha.1"/>
## :rocket: Features
- Make overriding of album tag in downloaded Podcasts configurable
- Configurable master and show sources in settings
@ -11,7 +15,7 @@ Since this is an alpha release there will be bugs in the code. Please report any
- Allow closing "Scheduled Shows" tab in Showbuilder
- FreeIPA Auth Adaptor
## Bugfixes
## :bug: Bug fixes
- Use `restart=always` in systemd installs
- Do not depend on hardcoded admin password for autoplaylist feature
@ -21,11 +25,11 @@ Since this is an alpha release there will be bugs in the code. Please report any
- line-in recording almost works again
- no more oopsing on week info API
## Deprecated Features
## :fire: Deprecation and removal
- The `ubuntu` Vagrant box has been replaced with `ubuntu-xenial` and `ubuntu-trusty`. The `debian` box has been replaced with `debian-jessie` and `debian-wheezy`. Users of the old boxes should switch to a new box so we can drop the old box after this release.
## Known Issues
## :warning: Known issues
The following issues need a workaround for the time being. Please search the [issues](https://github.com/LibreTime/libretime/issues) before reporting problems not listed below.

71
docs/releases/3.0.0-alpha.02.md
View File

@ -1,71 +1,40 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 2
---
The full tarball for the `3.0.0-alpha.2` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.2/libretime-3.0.0-alpha.2.tar.gz).
import ReleaseHead from './\_release-head.md';
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).
<ReleaseHead date="2017-07-11" version="3.0.0-alpha.2"/>
## Table of Contents
- <a href="#features-3.0.0-alpha.2">Features</a>
- <a href="#bugfixes-3.0.0-alpha.2">Bugfixes</a>
- <a href="#deprecated-3.0.0-alpha.2">Deprecated Features</a>
- <a href="#update-3.0.0-alpha.2">Updating</a>
- <a href="#wheezy-deprecation-3.0.0-alpha.2">Deprecation Announcement for Debian 7 (Wheezy)</a>
- <a href="#issues-3.0.0-alpha.2">Known Issues</a>
- <a href="#issues-silan-3.0.0-alpha.2">Outdated silan reports unreliable cue in/out information</a>
- <a href="#issues-liquidsoap-3.0.0-alpha.2">Liquidsoap >= 1.3.0 Support</a>
- <a href="#colophon-3.0.0-alpha.2">Colophon</a>
<a id="features-3.0.0-alpha.2"/>
## Features
## :rocket: Features
- Updated [upgrade docs](http://libretime.org/manual/upgrading/)
- PHP 7.0 support
- Native systemd unit files on all supported distros
- Native systemd unit files on all supported distributions
<a id="bugfixes-3.0.0-alpha.2">
## Bugfixes
## :bug: Bug fixes
- Fix reversed name & description fields in stream 3 additional options
- Use file-magic instead of python-magic for working install with distro packages
- Use file-magic instead of python-magic for working install with distribution packages
- Use local angular install on radio page instead of cdn
- Allow deleting of initial admin user
- Fix gitattribute issues with the docs
- Fix git attribute issues with the docs
- and some more small stuff
<a id="deprecated-3.0.0-alpha.2">
## :fire: Deprecation and removal
## Deprecated Features
- The installer distribution selection process has been upgraded and the `--distribution` and `--release` parameters are not needed anymore. They are still supported for the time being but their use is not recommended.
- The installer distro selection process has been upgraded and the `--distribution` and `--release` parameters are not needed anymore. They are still supported for the time being but their use is not recommended.
### Deprecation of Debian 7 (Wheezy)
<a id="update-3.0.0-alpha.2">
This info is an early warning that we are deprecating a major os version.
## Updating
Debian 9 (Stretch) is now available and installing LibreTime on Wheezy probably never worked properly out of the box.
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 you 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.
<a id="wheezy-deprecation-3.0.0-alpha.2">
## Deprecation Announcement for Debian 7 (Wheezy)
Up until `3.0.0-alpha.2` Debian 7 (Wheezy) was in the list of supported distros.
Given that Debian 9 (Stretch) is now available and installing LibreTime on Wheezy probably never worked properly out of the box LibreTime has to update its support matrix. This info is in the release notes as an early warning since we are deprecating a major os version with an upcoming release.
<a id="issues-3.0.0-alpha.2">
## Known Issues
## :warning: Known issues
The following issues 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-silan-3.0.0-alpha.2">
### Outdated silan reports unreliable cue in/out information
Out of the box the installer installs a broken, outdated version of silan on all Debian based Platforms (ie. Ubuntu). This affects all distros supported by the installer except CentOS which 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).
@ -144,11 +113,9 @@ sudo apt-get uninstall silan
Reportedly this might wake the :cat2: (![happy-cuteness-overload-small](https://user-images.githubusercontent.com/116588/26853726-6d5bd6be-4b13-11e7-9dbd-9d7333e828c5.png) _aww_) or have other [side effects](https://github.com/LibreTime/libretime/issues/214#issuecomment-305748757).
<a id="issues-liquidsoap-3.0.0-alpha.2">
### Liquidsoap >= 1.3.0 Support
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.1` installed.
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](https://build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.1` installed.
You can check your liquidsoap version by running `liquidsoap --version`.
@ -175,9 +142,7 @@ You can downgrade an OPAM install of liquidsoap by running the following command
opam install "liquidsoap<1.3.0"
```
<a id="colophon-3.0.0-alpha.2">
## Colophon
## :memo: Colophon
I made some [git of theseus graphs](https://erikbern.com/2016/12/05/the-half-life-of-code.html) on the history of LibreTime. What makes these interesting is that the project started in CVS, was migrated to Subversion and then to Git the commit history always being preserved. Let's have a look down the shoulders of the giants we are standing on.

77
docs/releases/3.0.0-alpha.03.md
View File

@ -1,26 +1,12 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 3
---
The full tarball for the `3.0.0-alpha.3` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.3/libretime-3.0.0-alpha.3.tar.gz).
import ReleaseHead from './\_release-head.md';
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).
<ReleaseHead date="2017-10-18" version="3.0.0-alpha.3"/>
## Table of Contents
- <a href="#features-3.0.0-alpha.3">Features</a>
- <a href="#bugfixes-3.0.0-alpha.3">Bugfixes</a>
- <a href="#deprecated-3.0.0-alpha.3">Deprecated Features</a>
- <a href="#update-3.0.0-alpha.3">Updating</a>
- <a href="#issues-3.0.0-alpha.3">Known Issues</a>
- <a href="#issues-silan-3.0.0-alpha.3">Outdated silan reports unreliable cue in/out information</a>
- <a href="#issues-liquidsoap-3.0.0-alpha.3">Liquidsoap >= 1.3.0 support</a>
- <a href="#issues-watched-3.0.0-alpha.3">No watched folder support</a>
- <a href="#issues-line-in-3.0.0-alpha.3">No Line In recording support</a>
- <a href="#issues-no-locale-3.0.0-alpha.3">Playout won't work if locale is missing</a>
- <a href="#colophon-3.0.0-alpha.3">Colophon</a>
<a id="features-3.0.0-alpha.3"/>
## Features
## :rocket: Features
- Debian 9 support in installer shell script
- Simplify configuration file structure
@ -29,9 +15,7 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Duplicate Smartblock functionality in context menu
- Better server preparation docs with firewall infos
<a id="bugfixes-3.0.0-alpha.3">
## Bugfixes
## :bug: Bug fixes
- CORS responses work for all browsers and with TLS or on non default ports
- Fix update warning for pre-release candidates
@ -41,23 +25,15 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Fix chunked podcast downloading
- Fix TLS timestamp updating
<a id="deprecated-3.0.0-alpha.3">
## :fire: Deprecation and removal
## Deprecated Features
- Dropped support for Debian Wheezy
- The contents of `/etc/airtime/cloud_storage.conf` and `/etc/airtime/rabbitmq-analyzer.ini` have been moved to the main `/etc/airtime/airtime.ini` file and the env specific symlink is no longer needed. See below for instructions on how to migrate from a pre-release that created those files.
- As per [the announcement in the `3.0.0-alpha.2` release notes](https://github.com/LibreTime/libretime/releases/tag/3.0.0-alpha.2#wheezy-deprecation-3.0.0-alpha.2) we are dropping Debian 7/Wheezy as a supported platform.
- The installer distro selection process has been upgraded and the --distribution and --release parameters are not needed anymore. They are still supported for the time being but their use is not recommended.
<a id="update-3.0.0-alpha.3">
## :arrow_up: Upgrading
## Updating
### Configuration files merging
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 you 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 or 3.0.0-alpha.2
The contents of `/etc/airtime/cloud_storage.conf` and `/etc/airtime/rabbitmq-analyzer.ini` have been moved to the main `/etc/airtime/airtime.ini` file and the env specific symlink is no longer needed. See below for instructions on how to migrate from a pre-release that created those files.
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.ini`. In all known cases you need to add the following sections to the file.
@ -75,21 +51,18 @@ api_key_secret=0
You can then remove the files and the symlink.
```bash
rm /etc/airtime/cloud_storage.conf \
/etc/airtime/rabbitmq-analyzer.ini \
/etc/airtime/production
rm -f \
/etc/airtime/cloud_storage.conf \
/etc/airtime/rabbitmq-analyzer.ini \
/etc/airtime/production
```
Analyzer grabs all the needed info from the main `airtime.ini` file starting with `3.0.0-alpha.3`.
<a id="issues-3.0.0-alpha.3">
## Known Issues
## :warning: Known issues
The following issues 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-silan-3.0.0-alpha.3">
### Outdated silan reports unreliable cue in/out information
Out of the box the installer installs a broken, outdated version of silan on most Debian based Platforms (ie. Ubuntu). This affects all distros supported by the installer except Debian unstable which has the silan 0.3.3 and CentOS which 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).
@ -168,11 +141,9 @@ sudo apt-get uninstall silan
Reportedly this might wake the :cat2: (![happy-cuteness-overload-small](https://user-images.githubusercontent.com/116588/26853726-6d5bd6be-4b13-11e7-9dbd-9d7333e828c5.png) _aww_) or have other [side effects](https://github.com/LibreTime/libretime/issues/214#issuecomment-305748757).
<a id="issues-liquidsoap-3.0.0-alpha.3">
### Liquidsoap >= 1.3.0 Support
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.1` installed.
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](https://build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.1` installed.
You can check your liquidsoap version by running `liquidsoap --version`.
@ -199,20 +170,14 @@ You can downgrade an OPAM install of liquidsoap by running the following command
opam install "liquidsoap<1.3.0"
```
<a id="issues-watched-3.0.0-alpha.3">
### No watched folder support
Currently LibreTime does not support watching folders as [described in the manual](http://libretime.org/manual/media-folders/#watching-a-folder). 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.3">
### No line in support
Line In recording can be enabled in the UI but doesn't currently work. 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.3">
### 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.
@ -226,16 +191,14 @@ 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.
```
```bash
#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="colophon-3.0.0-alpha.3">
## Colophon
## :memo: Colophon
It's been awesome to see that the interest in LibreTime isn't dying off.

97
docs/releases/3.0.0-alpha.04.md
View File

@ -1,36 +1,19 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 4
---
The full tarball for the `3.0.0-alpha.4` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.4/libretime-3.0.0-alpha.4.tar.gz).
import ReleaseHead from './\_release-head.md';
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).
<ReleaseHead date="2018-02-01" version="3.0.0-alpha.4"/>
## Table of Contents
- <a href="#features-3.0.0-alpha.4">Features</a>
- <a href="#bugfixes-3.0.0-alpha.4">Bugfixes</a>
- <a href="#deprecated-3.0.0-alpha.4">Deprecated Features</a>
- <a href="#update-3.0.0-alpha.4">Updating</a>
- <a href="#issues-3.0.0-alpha.4">Known Issues</a>
- <a href="#issues-silan-3.0.0-alpha.4">Outdated silan reports unreliable cue in/out information</a>
- <a href="#issues-liquidsoap-3.0.0-alpha.4">Liquidsoap support</a>
- <a href="#issues-watched-3.0.0-alpha.4">No watched folder support</a>
- <a href="#issues-line-in-3.0.0-alpha.4">No Line In recording support</a>
- <a href="#issues-no-locale-3.0.0-alpha.4">Playout won't work if locale is missing</a>
- <a href="#issues-no-i18n-3.0.0-alpha.4">Lack of i18n toolchain is disturbing</a>
- <a href="#colophon-3.0.0-alpha.4">Colophon</a>
<a id="features-3.0.0-alpha.4"/>
## Features
## :rocket: Features
- Updated Hungarian translations
- Preview tracks in generated SmartBlocks
- New icon to mark autoplaylist based show on calendar page
- Relative date filters for Smartblocks
<a id="bugfixes-3.0.0-alpha.4">
## Bugfixes
## :bug: Bug fixes
- Fix updating track information from pypo on TLS only setups
- Fix seeking in track preview
@ -38,56 +21,10 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Validate contents of VERSION file to fix non-enriched git tarball install
- dead code removal of legacy media-monitor code base
<a id="deprecated-3.0.0-alpha.4">
## Deprecated Features
- The contents of `/etc/airtime/cloud_storage.conf` and `/etc/airtime/rabbitmq-analyzer.ini` have been moved to the main `/etc/airtime/airtime.ini` file and the env specific symlink is no longer needed. See below for instructions on how to migrate from a pre-release that created those files.
- As per [the announcement in the `3.0.0-alpha.2` release notes](https://github.com/LibreTime/libretime/releases/tag/3.0.0-alpha.2#wheezy-deprecation-3.0.0-alpha.2) we are dropping Debian 7/Wheezy as a supported platform.
- The installer distro selection process has been upgraded and the --distribution and --release parameters are not needed anymore. They are still supported for the time being but their use is not recommended.
<a id="update-3.0.0-alpha.4">
## 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 you 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 or 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.ini`. In all known cases you need to add the following sections to the file.
```ini
[current_backend]
storage_backend=file
[amazon_S3]
provider=amazon_S3
bucket=0
api_key=0
api_key_secret=0
```
You can then remove the files and the symlink.
```bash
rm /etc/airtime/cloud_storage.conf \
/etc/airtime/rabbitmq-analyzer.ini \
/etc/airtime/production
```
Analyzer grabs all the needed info from the main `airtime.ini` file starting with `3.0.0-alpha.4`.
<a id="issues-3.0.0-alpha.4">
## Known Issues
## :warning: 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-silan-3.0.0-alpha.4">
### Outdated silan reports unreliable cue in/out information
Out of the box the installer installs a broken, outdated version of silan on most Debian based Platforms (ie. Ubuntu). This affects all distros supported by the installer except Debian unstable which has the silan 0.3.3 and CentOS which 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).
@ -166,11 +103,9 @@ sudo apt-get uninstall silan
Reportedly this might have [side effects](https://github.com/LibreTime/libretime/issues/214#issuecomment-305748757).
<a id="issues-liquidsoap-3.0.0-alpha.4">
### Liquidsoap Support
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](https://build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
#352 reports that liquidsoap `< 1.3.0` can exhibit issues on some Debian based installs. One fix for the issue is to install liquidsoap `1.3.0` and to use the following patching steps. Kyle from silan fame is taking the needed steps to get liquidsoap maintained again in Debian so we expect the situation to improve over time.
@ -199,20 +134,14 @@ You can downgrade an OPAM install of liquidsoap by running the following command
opam install "liquidsoap<1.3.0"
```
<a id="issues-watched-3.0.0-alpha.4">
### No watched folder support
Currently LibreTime does not support watching folders as [described in the manual](http://libretime.org/manual/media-folders/#watching-a-folder). 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.4">
### No line in support
Line In recording can be enabled in the UI but doesn't currently work. 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.4">
### 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.
@ -226,22 +155,18 @@ 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.
```
```bash
#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.4">
### 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 proabably want to support bidirectional translation syncing with zanata.
<a id="colophon-3.0.0-alpha.4">
## Colophon
## :memo: Colophon
This is the first release that contains code contributions from more than 5 developers. Also, we reached :100: :star2: a while ago and this is the fifth release since we forked almost a year ago. I'm looking forward to celebrating the one year anniversary of LibreTime soon.

106
docs/releases/3.0.0-alpha.05.md
View File

@ -1,39 +1,20 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 5
---
The full tarball for the `3.0.0-alpha.5` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.5/libretime-3.0.0-alpha.5.tar.gz).
import ReleaseHead from './\_release-head.md';
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).
<ReleaseHead date="2018-10-12" version="3.0.0-alpha.5"/>
## Table of Contents
- <a href="#features-3.0.0-alpha.5">Features</a>
- <a href="#bugfixes-3.0.0-alpha.5">Bugfixes</a>
- <a href="#deprecated-3.0.0-alpha.5">Deprecated Features</a>
- <a href="#update-3.0.0-alpha.5">Updating</a>
- <a href="#trusty-deprecation-3.0.0-alpha.5">Deprecation Announcement for Ubuntu 14.04 (Trusty)</a>
- <a href="#issues-3.0.0-alpha.5">Known Issues</a>
- <a href="#issues-media-monitor-3.0.0-alpha.5">Media-Monitor config needs manual removing</a>
- <a href="#issues-silan-3.0.0-alpha.5">Outdated silan reports unreliable cue in/out information</a>
- <a href="#issues-liquidsoap-3.0.0-alpha.5">Liquidsoap support</a>
- <a href="#issues-watched-3.0.0-alpha.5">No watched folder support</a>
- <a href="#issues-line-in-3.0.0-alpha.5">No Line In recording support</a>
- <a href="#issues-no-locale-3.0.0-alpha.5">Playout won't work if locale is missing</a>
- <a href="#issues-no-i18n-3.0.0-alpha.5">Lack of i18n toolchain is disturbing</a>
- <a href="#colophon-3.0.0-alpha.5">Colophon</a>
<a id="features-3.0.0-alpha.5"/>
## Features
## :rocket: Features
- Interface improvements
- Raspbian 9 support in installer script
- Allow skipping RabbitMQ and PostgreSQL install in installer script with `--no-rabbitmq ` and `--no-postgres`
<a id="bugfixes-3.0.0-alpha.5">
## :bug: Bug fixes
## Bugfixes
- Remove `[media-monitor]` section from default install (look <a href="#issues-media-monitor-3.0.0-alpha.5">here</a> for workaround)
- Remove `[media-monitor]` section from default install
- Fix last help links that pointed to sourcefabric and update others to point to discourse
- Fix for ShoutCAST DNAS rejecting title updates when artist is missing
- Initial fixes for native IPv6 support
@ -41,68 +22,31 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Disable podcast subscription limit
- Return proper `Content-Length` for legacy database entries missing the info
<a id="deprecated-3.0.0-alpha.5">
## :fire: Deprecation and removal
## Deprecated Features
- The contents of `/etc/airtime/cloud_storage.conf` and `/etc/airtime/rabbitmq-analyzer.ini` have been moved to the main `/etc/airtime/airtime.conf` file and the env specific symlink is no longer needed. See below for instructions on how to migrate from a pre-release that created those files.
- As per [the announcement in the `3.0.0-alpha.2` release notes](https://github.com/LibreTime/libretime/releases/tag/3.0.0-alpha.2#wheezy-deprecation-3.0.0-alpha.2) we are dropping Debian 7/Wheezy as a supported platform.
- The installer distro selection process has been upgraded and the --distribution and --release parameters are not needed anymore. They are still supported for the time being but their use is not recommended.
- Removed Amazon S3 storage support
<a id="update-3.0.0-alpha.5">
### Deprecation of Ubuntu 14.04 (Trusty)
## Updating
This info is an early warning that we are deprecating a major os version.
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.
Ubuntu 16.04 (Xenial) and Ubuntu 18.04 (Bionic) are now available and Trusty is EOL in April 2019.
If you installed from GitHub you can `git pull` in you 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.
## :arrow_up: Upgrading
### Updating from 3.0.0-alpha or 3.0.0-alpha.2
### S3 storage support removal
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.
The configuration file structure has changed. Remove the `amazon_s3` configuration section from the `/etc/airtime/airtime.conf` file, as S3 storage support has been removed.
```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.5`.
<a id="trusty-deprecation-3.0.0-alpha.5"/>
## Deprecation Announcement for Ubuntu 14.04 (Trusty)
Up until `3.0.0-alpha.4` Ubuntu 14.04 (Trusty) was in the list of supported distros.
Given that Ubuntu 16.04 (Xenial) and Ubuntu 18.04 (Bionic) are now available and Trusty is EOL in April 2019 LibreTime has to update its support matrix. This info is in the release notes as an early warning since we are deprecating a major os version with an upcoming release.
<a id="issues-3.0.0-alpha.5">
## Known Issues
## :warning: 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-media-monitor-3.0.0-alpha.5">
### 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.5">
### Outdated silan reports unreliable cue in/out information
Out of the box the installer installs a broken, outdated version of silan on most Debian based Platforms (ie. Ubuntu). This affects all distros supported by the installer except Debian unstable which has the silan 0.3.3 and CentOS which 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).
@ -181,11 +125,9 @@ sudo apt-get uninstall silan
Reportedly this might have [side effects](https://github.com/LibreTime/libretime/issues/214#issuecomment-305748757).
<a id="issues-liquidsoap-3.0.0-alpha.5">
### Liquidsoap Support
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](https://build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
#352 reports that liquidsoap `< 1.3.0` can exhibit issues on some Debian based installs. One fix for the issue is to install liquidsoap `1.3.0` and to use the following patching steps. Kyle from silan fame is taking the needed steps to get liquidsoap maintained again in Debian so we expect the situation to improve over time.
@ -214,20 +156,14 @@ You can downgrade an OPAM install of liquidsoap by running the following command
opam install "liquidsoap<1.3.0"
```
<a id="issues-watched-3.0.0-alpha.5">
### No watched folder support
Currently LibreTime does not support watching folders as [described in the manual](http://libretime.org/manual/media-folders/#watching-a-folder). 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.5">
### No line in support
Line In recording can be enabled in the UI but doesn't currently work. 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.5">
### 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.
@ -241,21 +177,17 @@ 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.
```
```bash
#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.5">
### 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 proabably want to support bidirectional translation syncing with zanata.
<a id="colophon-3.0.0-alpha.5">
## Colophon
## :memo: Colophon
Sorry for the _late_ release, RelEng has been busy with adulting and generally having a life as of lately. I'm still very much committed to LibreTime but can only find a limited amount of time to look into Issues due to being busy qualifying LibreTime for production workloads at my station. I plan on re-shifting my focus on pull request reviews and RelEng to address my lack of time going further.

111
docs/releases/3.0.0-alpha.06.md
View File

@ -1,28 +1,12 @@
The full tarball for the `3.0.0-alpha.6` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.6/libretime-3.0.0-alpha.6.tar.gz).
---
title: LibreTime 3.0.0 alpha 6
---
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).
import ReleaseHead from './\_release-head.md';
## Table of Contents
<ReleaseHead date="2018-12-23" version="3.0.0-alpha.6"/>
- <a href="#features-3.0.0-alpha.6">Features</a>
- <a href="#bugfixes-3.0.0-alpha.6">Bugfixes</a>
- <a href="#deprecated-3.0.0-alpha.6">Deprecated Features</a>
- <a href="#install-3.0.0-alpha.6">Installation</a>
- <a href="#update-3.0.0-alpha.6">Updating</a>
- <a href="#issues-3.0.0-alpha.6">Known Issues</a>
- <a href="#issues-installer-issues-3.0.0-alpha.6">Installer Issues</a>
- <a href="#issues-media-monitor-3.0.0-alpha.6">Media-Monitor config needs manual removing</a>
- <a href="#issues-silan-3.0.0-alpha.6">Outdated silan reports unreliable cue in/out information</a>
- <a href="#issues-liquidsoap-3.0.0-alpha.6">Liquidsoap support</a>
- <a href="#issues-watched-3.0.0-alpha.6">No watched folder support</a>
- <a href="#issues-line-in-3.0.0-alpha.6">No Line In recording support</a>
- <a href="#issues-no-locale-3.0.0-alpha.6">Playout won't work if locale is missing</a>
- <a href="#issues-no-i18n-3.0.0-alpha.6">Lack of i18n toolchain is disturbing</a>
- <a href="#colophon-3.0.0-alpha.6">Colophon</a>
<a id="features-3.0.0-alpha.6"/>
## Features
## :rocket: Features
- Turn on the podcast album override by default on new installs.
- Ubuntu 18.04 (Bionic) **developer** tooling.
@ -33,9 +17,7 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Move advanced smartblock configuration to collapsed "Advanced options" section.
- Assume "Y" as answer for questions during installer.
<a id="bugfixes-3.0.0-alpha.6">
## Bugfixes
## :bug: Bug fixes
- Fix sizing for playlist and smart block on shorter screens.
- Increased celery timeout to 1800 seconds (affects podcast downloads and other tasks like things related to the soundcloud integration).
@ -54,66 +36,15 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Fix shuffling playlists that contain a smart block.
- Remove unused zfdebug from dev environment.
<a id="deprecated-3.0.0-alpha.6">
## :fire: Deprecation and removal
## Deprecated Features
- The contents of `/etc/airtime/cloud_storage.conf` and `/etc/airtime/rabbitmq-analyzer.ini` have been moved to the main `/etc/airtime/airtime.conf` file and the env specific symlink is no longer needed. See <a href="#update-3.0.0-alpha.6">below</a> for instructions on how to migrate from a pre-release that created those files.
- As per [the announcement in the `3.0.0-alpha.5` release notes](https://github.com/LibreTime/libretime/releases/tag/3.0.0-alpha.5#trusty-deprecation-3.0.0-alpha.5) we are dropping Ubuntu 14.04 (Trusty) as a supported platform.
- Removed Amazon S3 storage support.
- Dropped support for Ubuntu 14.04 (Trusty) as it is end-of-life
- Remove "Record & Rebroadcast" from ui.
<a id="install-3.0.0-alpha.6">
## Installation
The main installation docs may be found at [http://libretime.org/install/](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 Xenial packages](https://github.com/LibreTime/libretime-debian-packaging/releases)
- [CentOS 7 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.6">
## 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.6`.
<a id="issues-3.0.0-alpha.6">
## Known Issues
## :warning: 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.6">
### 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.
@ -126,15 +57,11 @@ If you want a secure environment you should work through the [preparing the serv
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.6">
### 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.6">
### Outdated silan reports unreliable cue in/out information
Out of the box the installer installs a broken, outdated version of silan on some Debian based Platforms (ie. Ubuntu). This affects all distros supported by the installer except Debian testing which has the silan 0.3.3 and CentOS which 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).
@ -145,11 +72,9 @@ To date silan 0.3.3 or higher is in Debian testing & Ubuntu Bionic. You can chec
tldr: **[Silan Installation](https://github.com/LibreTime/libretime/wiki/Silan-Installation)**
<a id="issues-liquidsoap-3.0.0-alpha.6">
### Liquidsoap Support
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](https://build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
#352 reports that liquidsoap `< 1.3.0` can exhibit issues on some Debian based installs. One fix for the issue is to install liquidsoap `1.3.0` and to use the following patching steps. Kyle from silan fame is taking the needed steps to get liquidsoap maintained again in Debian so we expect the situation to improve over time.
@ -178,20 +103,14 @@ You can downgrade an OPAM install of liquidsoap by running the following command
opam install "liquidsoap<1.3.0"
```
<a id="issues-watched-3.0.0-alpha.6">
### No watched folder support
Currently LibreTime does not support watching folders as [described in the manual](http://libretime.org/manual/media-folders/#watching-a-folder). 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.6">
### 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.6">
### 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.
@ -205,21 +124,17 @@ 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.
```
```bash
#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.6">
### 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.
<a id="colophon-3.0.0-alpha.6">
## Colophon
## :memo: Colophon
I would like to use this space to extend a warm welcome to our new Maintainers @paddatrapper, @frecuencialibre and @ned-kelly. We are happy to have you on board. Thank you very much for helping maintain LibreTime ❤️

130
docs/releases/3.0.0-alpha.07.md
View File

@ -1,29 +1,26 @@
The full tarball for the `3.0.0-alpha.7` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.7/libretime-3.0.0-alpha.7.tar.gz).
---
title: LibreTime 3.0.0 alpha 7
---
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/) if you need help and for general discussion.
import ReleaseHead from './\_release-head.md';
## Table of Contents
<ReleaseHead date="2019-04-22" version="3.0.0-alpha.7"/>
- <a href="#features-3.0.0-alpha.7">Features</a>
- <a href="#bugfixes-3.0.0-alpha.7">Bugfixes</a>
- <a href="#deprecated-3.0.0-alpha.7">Deprecated Features</a>
- <a href="#thankyous-3.0.0-alpha.7">Contributors</a>
- <a href="#install-3.0.0-alpha.7">Installation</a>
- <a href="#update-3.0.0-alpha.7">Updating</a>
- <a href="#jessie-deprecation-3.0.0-alpha.7">Deprecation Announcement for Debian 8 (Jessie)</a>
- <a href="#issues-3.0.0-alpha.7">Known Issues</a>
- <a href="#issues-installer-issues-3.0.0-alpha.7">Installer Issues</a>
- <a href="#issues-media-monitor-3.0.0-alpha.7">Media-Monitor config needs manual removing</a>
- <a href="#issues-silan-3.0.0-alpha.7">Outdated silan reports unreliable cue in/out information</a>
- <a href="#issues-liquidsoap-3.0.0-alpha.7">Liquidsoap support</a>
- <a href="#issues-watched-3.0.0-alpha.7">No watched folder support</a>
- <a href="#issues-line-in-3.0.0-alpha.7">No Line In recording support</a>
- <a href="#issues-no-locale-3.0.0-alpha.7">Playout won't work if locale is missing</a>
- <a href="#issues-no-i18n-3.0.0-alpha.7">Lack of i18n toolchain is disturbing</a>
## :sparkling_heart: Contributors
<a id="features-3.0.0-alpha.7"/>
The LibreTime project wants to thank the following contributors for contributing to this release:
## Features
- [@robbt](https://github.com/robbt)
- [@frecuencialibre](https://github.com/frecuencialibre)
- [@detobate](https://github.com/detobate)
- [@greenjon](https://github.com/greenjon)
- [@xabispacebiker](https://github.com/xabispacebiker)
- [@mikeopensauce](https://github.com/mikeopensauce)
- [@paddatrapper](https://github.com/paddatrapper)
- [@hairmare](https://github.com/hairmare)
- [@ryanrain](https://github.com/ryanrain)
## :rocket: Features
- Set default focus to search field on library page.
- PHP 7.2 and 7.3 compatibility (for Ubuntu 18.04.1 LTS (Bionic Beaver) and other modern distros)
@ -41,9 +38,7 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Update much of the documentation
- Allow program managers to view listeners statistics
<a id="bugfixes-3.0.0-alpha.7">
## Bugfixes
## :bug: Bug fixes
- Fix DOS line-endings in vendorized PHP dependencies for packaging.
- Fix overlapping show names if show does not fit in calendar.
@ -64,77 +59,18 @@ Since this is an alpha release there will be bugs in the code. Please report new
- Fix issue with multiple time remaining smartblocks in a single playlist not detecting remaining time correctly
- Fix occasional empty administration page due to null previous file reference
<a id="deprecated-3.0.0-alpha.7">
## :fire: Deprecation and removal
## Deprecated Features
### Deprecation of Debian 8 (Jessie)
- We are beginning to phase out support for Debian 8 (Jessie). See the <a href="#jessie-deprecation-3.0.0-alpha.7">announcement</a> for more details.
This info is an early warning that we are deprecating a major os version.
## Contributors
Debian 9 (Stretch) is now available and Jessie is EOL since June 2018.
<a id="thankyous-3.0.0-alpha.7">
The LibreTime project wants to thank the following contributors for adding PRs to this release: @robbt @frecuencialibre @detobate @greenjon @xabispacebiker @mikeopensauce @paddatrapper @hairmare @ryanrain
<a id="install-3.0.0-alpha.7">
## Installation
The main installation docs may be found at [http://libretime.org/install/](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 Xenial packages](https://github.com/LibreTime/libretime-debian-packaging/releases)
- [Debian Buster packages](https://github.com/LibreTime/libretime-debian-packaging/releases)
- [CentOS 7 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.7">
## 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.7`.
<a id="jessie-deprecation-3.0.0-alpha.7"/>
## Deprecation Announcement for Debian 8 (Jessie)
Up until `3.0.0-alpha.7` Debian 8 (Jessie) was in the list of supported distros.
Given that Debian 9 (Stretch) is now available and Jessie is EOL since June 2018 LibreTime has to update its support matrix. This info is in the release notes as an early warning since we are deprecating a major os version with an upcoming release.
<a id="issues-3.0.0-alpha.7">
## Known Issues
## :warning: 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.7">
### 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.
@ -147,15 +83,11 @@ If you want a secure environment you should work through the [preparing the serv
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.7">
### 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.7">
### 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 Debian based Platforms (ie. Ubuntu). This affects Ubuntu 16.04, Debian Jessie and Debian Stretch. 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).
@ -166,11 +98,9 @@ To date silan 0.3.3 or higher is in Debian testing & Ubuntu Bionic. You can chec
tldr: **[Silan Installation](https://github.com/LibreTime/libretime/wiki/Silan-Installation)**
<a id="issues-liquidsoap-3.0.0-alpha.7">
### Liquidsoap Support
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](https://build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
#352 reports that liquidsoap `< 1.3.0` can exhibit issues on Debian Stretch installs. One fix for the issue is to install liquidsoap `1.3.0` and to use the following patching steps.
@ -199,20 +129,14 @@ You can downgrade an OPAM install of liquidsoap by running the following command
opam install "liquidsoap<1.3.0"
```
<a id="issues-watched-3.0.0-alpha.7">
### 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.7">
### 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.7">
### 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.
@ -226,15 +150,13 @@ 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.
```
```bash
#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.7">
### 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.

140
docs/releases/3.0.0-alpha.08.md
View File

@ -1,62 +1,14 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 8
---
The full tarball for the `3.0.0-alpha.8` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.8/libretime-3.0.0-alpha.8.tar.gz).
import ReleaseHead from './\_release-head.md';
Since this is an alpha release there will be bugs in the code.
<ReleaseHead date="2019-08-02" version="3.0.0-alpha.8"/>
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 us up on [Slack](https://discourse.libretime.org/t/slack-for-libretime) if you need help and for general discussion.
## :sparkling_heart: Contributors
## Table of Contents
- <a href="#features-3.0.0-alpha.8">Features</a>
- <a href="#bugfixes-3.0.0-alpha.8">Bugfixes</a>
- <a href="#deprecated-3.0.0-alpha.8">Deprecated Features</a>
- <a href="#contributors-3.0.0-alpha.8">Contributors</a>
- <a href="#install-3.0.0-alpha.8">Installation</a>
- <a href="#update-3.0.0-alpha.8">Updating</a>
- <a href="#issues-3.0.0-alpha.8">Known Issues</a>
- <a href="#issues-installer-issues-3.0.0-alpha.8">Installer Issues</a>
- <a href="#issues-media-monitor-3.0.0-alpha.8">Media-Monitor config needs manual removing</a>
- <a href="#issues-silan-3.0.0-alpha.8">Outdated silan reports unreliable cue in/out information</a>
- <a href="#issues-liquidsoap-3.0.0-alpha.8">Liquidsoap support</a>
- <a href="#issues-watched-3.0.0-alpha.8">No watched folder support</a>
- <a href="#issues-line-in-3.0.0-alpha.8">No Line In recording support</a>
- <a href="#issues-no-locale-3.0.0-alpha.8">Playout won't work if locale is missing</a>
- <a href="#issues-no-i18n-3.0.0-alpha.8">Lack of i18n toolchain is disturbing</a>
<a id="features-3.0.0-alpha.8"/>
## Features
- The LibreTime project now has a proper logo!
- New "Show Listener Stats" in "Analytics" contains listeners statistics on specific shows.
- Display time of last podcast import in downloaded podcasts view.
- Allow sorting by last play date in smartblocks, makes creating playlists that play the least played track possible.
- Preliminary support for Debian Buster (Remember to [patch the liquidsoap scripts](https://github.com/LibreTime/libretime/releases#issues-liquidsoap-3.0.0-alpha.8) if you use Buster).
<a id="bugfixes-3.0.0-alpha.8">
## Bugfixes
- Widgets now use user specified timezones as they should.
- Podcast view now display proper number of downloaded podcasts rather than just the first 25 podcasts.
- Fix using non-ascii characters in podcast publishing service.
- Fix canceling current show for "linked" shows.
- Fix empty schedule page when previous track is empty.
- Fix focus jumping to search in advanced search.
<a id="deprecated-3.0.0-alpha.8">
## Deprecated Features
- We are phasing out support for Debian 8 (Jessie). See the <a href="https://github.com/LibreTime/libretime/releases#jessie-deprecation-3.0.0-alpha.7">announcement in the 3.0.0-alpha.7 release notes</a> for more details.
- Liquidsoap 1.1.1 support. 3.0.0-alpha.8 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 native liquidsoap 1.3.x support. 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.8">
## Contributors
The LibreTime project wants to thank the following contributors for adding PRs to this release:
The LibreTime project wants to thank the following contributors for contributing to this release:
- [@ciaby](https://github.com/ciaby)
- [@hairmare](https://github.com/hairmare)
@ -65,58 +17,32 @@ The LibreTime project wants to thank the following contributors for adding PRs t
- [@paddatrapper](https://github.com/paddatrapper)
- [@Robbt](https://github.com/Robbt)
<a id="install-3.0.0-alpha.8">
## :rocket: Features
## Installation
- The LibreTime project now has a proper logo!
- New "Show Listener Stats" in "Analytics" contains listeners statistics on specific shows.
- Display time of last podcast import in downloaded podcasts view.
- Allow sorting by last play date in smartblocks, makes creating playlists that play the least played track possible.
- Preliminary support for Debian Buster (Remember to [patch the liquidsoap scripts](https://github.com/LibreTime/libretime/releases#issues-liquidsoap-3.0.0-alpha.8) if you use Buster).
The main installation docs may be found at [http://libretime.org/install/](libretime.org/install/). They describe a "developer" install using the bundled `install` script.
## :bug: Bug fixes
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.
- Widgets now use user specified timezones as they should.
- Podcast view now display proper number of downloaded podcasts rather than just the first 25 podcasts.
- Fix using non-ascii characters in podcast publishing service.
- Fix canceling current show for "linked" shows.
- Fix empty schedule page when previous track is empty.
- Fix focus jumping to search in advanced search.
- [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)
## :fire: Deprecation and removal
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.
- Dropped support for Debian Jessie as it is end-of-life
- Liquidsoap 1.1.1 support. 3.0.0-alpha.8 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 native liquidsoap 1.3.x support. Users still on liquidsoap 1.1.1 will need to apply a patch to their liquidsoap scripts (or update liquidsoap).
<a id="update-3.0.0-alpha.8">
## 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.8">
## Known Issues
## :warning: 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.8">
### 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.
@ -129,15 +55,11 @@ If you want a secure environment you should work through the [preparing the serv
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.8">
### 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.8">
### 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 Debian based Platforms (ie. Ubuntu). This affects Ubuntu 16.04, Debian Jessie and Debian Stretch. 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).
@ -148,11 +70,9 @@ To date silan 0.3.3 or higher is in Debian testing & Ubuntu Bionic. You can chec
tldr: **[Silan Installation](https://github.com/LibreTime/libretime/wiki/Silan-Installation)**
<a id="issues-liquidsoap-3.0.0-alpha.8">
### Liquidsoap Support
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
Libretime currently only supports liquidsoap `< 1.3.0` out of the box. If you install a current version of liquidsoap [using OPAM](http://liquidsoap.fm/download.html) or through the [Rabe Liquidsoap Distribution for CentOS (RaBe LSD)](https://build.opensuse.org/project/show/home:radiorabe:liquidsoap) you will most likely have liquidsoap `1.3.2` or `1.3.3` installed.
#352 reports that liquidsoap `< 1.3.0` can exhibit issues on Debian Stretch installs. One fix for the issue is to install liquidsoap `1.3.0` and to use the following patching steps.
@ -181,20 +101,14 @@ You can downgrade an OPAM install of liquidsoap by running the following command
opam install "liquidsoap<1.3.0"
```
<a id="issues-watched-3.0.0-alpha.8">
### 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.8">
### 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.8">
### 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.
@ -208,15 +122,13 @@ 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.
```
```bash
#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.8">
### 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.

147
docs/releases/3.0.0-alpha.09.md
View File

@ -1,67 +1,14 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 9
---
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).
import ReleaseHead from './\_release-head.md';
Since this is an alpha release there will be bugs in the code.
<ReleaseHead date="2021-01-05" version="3.0.0-alpha.9"/>
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.
## :sparkling_heart: Contributors
## 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:
The LibreTime project wants to thank the following contributors for contributing to this release:
- [@caveman99](https://github.com/caveman99)
- [@codenift](https://github.com/codenift)
@ -82,58 +29,34 @@ The LibreTime project wants to thank the following contributors for committing P
- [@xabispacebiker](https://github.com/xabispacebiker)
- [@zklosko](https://github.com/zklosko)
<a id="install-3.0.0-alpha.9">
## :rocket: Features
## Installation
- 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
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.
## :bug: Bug fixes
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.
- 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
- [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
## :warning: 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.
@ -146,15 +69,11 @@ If you want a secure environment you should work through the [preparing the serv
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).
@ -163,20 +82,14 @@ Check your version of silan by running `silan --version`. This should report `0.
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.
@ -190,15 +103,13 @@ 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.
```
```bash
#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.

113
docs/releases/3.0.0-alpha.10.md
View File

@ -1,42 +1,39 @@
The complete LibreTime documentation is available at [libretime.org](http://libretime.org).
---
title: LibreTime 3.0.0 alpha 10
---
The full tarball for the `3.0.0-alpha.10` release of LibreTime is available [here](https://github.com/LibreTime/libretime/releases/download/3.0.0-alpha.10/libretime-3.0.0-alpha.10.tar.gz).
import ReleaseHead from './\_release-head.md';
Since this is an alpha release there will be bugs in the code.
<ReleaseHead date="2021-10-15" version="3.0.0-alpha.10"/>
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.
## :sparkling_heart: Contributors
## Table of Contents
The LibreTime project wants to thank the following contributors for contributing to this release:
- [Features](#features-3.0.0-alpha.10)
- [Bugfixes](#bugfixes-3.0.0-alpha.10)
- [Deprecated Features](#deprecated-3.0.0-alpha.10)
- [Contributors](#contributors-3.0.0-alpha.10)
- [Installation](#install-3.0.0-alpha.10)
- [Updating](#update-3.0.0-alpha.10)
- [Known Issues](#issues-3.0.0-alpha.10)
- [Interface Customization Issues](#issues-interface-issues-3.0.0-alpha.10)
- [No watched folder support](#issues-watched-3.0.0-alpha.10)
- [No Line In recording support](#issues-line-in-3.0.0-alpha.10)
- [Playout won't work if locale is missing](#issues-no-locale-3.0.0-alpha.10)
- [@jooola](https://github.com/jooola)
- [@paddatrapper](https://github.com/paddatrapper)
- [@xabispacebiker](https://github.com/xabispacebiker)
- [@malespiaut](https://github.com/malespiaut)
- [@zklosko](https://github.com/zklosko)
- [@brekemeier](https://github.com/brekemeier)
- [@jeromelebleu](https://github.com/jeromelebleu)
- [@danielhjames](https://github.com/danielhjames)
- [@rjhelms](https://github.com/rjhelms)
- [@hairmare](https://github.com/hairmare)
<a id="features-3.0.0-alpha.10"/>
## Features
## :rocket: Features
- Support `force_ssl` configuration option in Python applications
- Move `airtime_mvc` to `legacy` and move all PHP related files under it
- Support `Authorization: Api-Key` header in API v1
- Use pip for LibreTime Python package installation
- Move Python scripts into `/usr/local/bin`
- Add REST API v2 (unstable and subject to change)
- Add API v2 (unstable and subject to change)
<a id="bugfixes-3.0.0-alpha.10">
## :bug: Bug fixes
## Bug Fixes
- Renamed airtime_analyzer to libretime-analyzer
- Prevent autoload playlists running on deleted show instances
- Renamed `airtime_analyzer` to `libretime-analyzer`
- Prevent auto load playlists running on deleted show instances
- Playout history can be exported as CSV and PDF
- Explicitly fail if the HTTP requests made by the Python applications fail
- Fix API v2 schedule endpoint item filtering and overlapping playout
@ -46,9 +43,7 @@ Please report new issues and/or feature requests in [the issue tracker](https://
- Clean up CORS setup in the installer
- Pin the `setuptools` version to ensure older versions of LibreTime can still be installed
<a id="deprecated-3.0.0-alpha.10">
## Deprecated Features
## :fire: Deprecation and removal
- Removed broken Soundcloud integration
- Dropped support for Ubuntu Xenial as it is end-of-life
@ -56,51 +51,13 @@ Please report new issues and/or feature requests in [the issue tracker](https://
- Removed SysV and Upstart init system files
- Removed broken My Podcasts feature
<a id="contributors-3.0.0-alpha.10">
## :arrow_up: Upgrading
## Contributors
### Packages renaming and new install paths
The LibreTime project wants to thank the following contributors for authoring PRs to this release:
Once the upgrade has taken place, you need to run the following commands to clean up old scripts and configuration:
- @jooola
- @paddatrapper
- @xabispacebiker
- @malespiaut
- @zklosko
- @brekemeier
- @jeromelebleu
- @danielhjames
- @rjhelms
- @hairmare
<a id="install-3.0.0-alpha.10">
## 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.
If you want to skip the installer GUI completely you can configure LibreTime using `legacy/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="update-3.0.0-alpha.10">
## Updating
See [the docs](https://libretime.org/docs/upgrading) for complete information on updating. Please ensure that you have proper [backups](https://libretime.org/docs/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.
Once the update has taken place, you will need to run the following commands to clean up old scripts and configuration:
```
```bash
# Remove the old packages
sudo pip3 uninstall \
airtime-playout \
@ -144,32 +101,22 @@ sudo rm -f \
/usr/bin/sqlformat
```
<a id="issues-3.0.0-alpha.10">
## Known Issues
## :warning: 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-interface-issues-3.0.0-alpha.10">
### Interface Customization Issues
The UI works best if you don't use it in an opinionated fashion and change just the bare minimal.
<a id="issues-watched-3.0.0-alpha.10">
### 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. This is tracked in [#70](https://github.com/LibreTime/libretime/issues/70).
<a id="issues-line-in-3.0.0-alpha.10">
### 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. This is tracked in [#42](https://github.com/LibreTime/libretime/issues/42).
<a id="issues-no-locale-3.0.0-alpha.10">
### 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. This is tracked in [#317](https://github.com/LibreTime/libretime/issues/317).
@ -183,11 +130,9 @@ 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.
```
```bash
#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.10">

16
docs/releases/_release-head.md Normal file
View File

@ -0,0 +1,16 @@
import TarballLink from '@site/src/components/TarballLink';
<p>This version was released the <strong>{props.date}</strong>.</p>
:::info
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 with us on our [mattermost](https://chat.libretime.org/) if you need help and for general discussion.
:::
<p>
The full tarball for the <code>{props.version}</code> release of
LibreTime is available <TarballLink version={props.version}>here</TarballLink>.
</p>

22
docs/releases/unreleased.md
View File

@ -1,3 +1,25 @@
---
title: Unreleased
---
import ReleaseHead from './\_release-head.md';
<!-- <ReleaseHead date='2022-01-01' version='3.0.0-alpha.11'/> -->
## :sparkling_heart: Contributors
The LibreTime project wants to thank the following contributors for authoring PRs to this release:
## :rocket: Features
## :bug: Bug fixes
## :fire: Deprecation and removal
## :arrow_up: Upgrading
## :warning: 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.
## :memo: Colophon

16
website/docusaurus.config.js
View File

@ -40,6 +40,22 @@ const config = {
path: "../docs",
sidebarPath: require.resolve("./sidebars.js"),
editUrl: `${vars.repository.href}/blob/main/docs`,
async sidebarItemsGenerator({
defaultSidebarItemsGenerator,
...args
}) {
const items = await defaultSidebarItemsGenerator(args);
return items.map((item) => {
// Reverse releases pages ordering
if (item.type === "category" && item.label === "Releases") {
return { ...item, items: item.items.reverse() };
}
return item;
});
},
},
blog: false,
theme: {

16
website/src/components/TarballLink.tsx Normal file
View File

@ -0,0 +1,16 @@
import React, { FunctionComponent } from "react";
import Link from "@docusaurus/Link";
interface Props {
version: string;
}
const TarballLink: FunctionComponent<Props> = ({ version, children }) => (
<Link
to={`https://github.com/libretime/libretime/releases/download/${version}/libretime-${version}.tar.gz`}
>
{children}
</Link>
);
export default TarballLink;