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

Update upgrade documentation 

Fixes: #71 #623
This commit is contained in:
Kyle Robbertze 2021-07-02 12:32:12 +02:00
parent fa5db502ed
commit 39a8b66b49
1 changed files with 43 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
docs/_docs/upgrading.md
View File

@ -6,18 +6,17 @@ category: admin
## LibreTime versioning
LibreTime 3.x versions support upgrading from Airtime 2.5.x versions. LibreTime follows the [Semantic Versioning (semver)](http://semver.org/spec/v2.0.0.html) standards.
In a nutshell, given a version number MAJOR.MINOR.PATCH we increment the:
1. MAJOR version when we make incompatible API changes,
2. MINOR version when we add functionality in a backwards-compatible manner, and
3. PATCH version when we make backwards-compatible bug fixes.
Any pre-release versions of LibreTime are denoted by appending a hyphen and a series
of dot separated identifiers immediately following the patch version. This pre-release indicates
that the version is unstable in a sense that it might contain incomplete features or not satisfy the
intended compatibility requirements as per semver.
Any pre-release versions of LibreTime are denoted by appending a hyphen and a
series of dot separated identifiers immediately following the patch version.
This pre-release indicates that the version is unstable in a sense that it might
contain incomplete features or not satisfy the intended compatibility
requirements as per semver.
## Upgrading
@ -27,20 +26,46 @@ intended compatibility requirements as per semver.
> downtime, so you should always have a fallback system available during the
> upgrade to ensure broadcast continuity.
Before upgrading a production LibreTime server, you should back up both the PostgreSQL
database and the storage server used by LibreTime. This is especially important if you have not already
set up a regular back up routine. This extra back up is a safety measure in case of accidental data loss
during the upgrade, for example due to the wrong command being entered when moving files. See
[Backing up the server](/docs/backing-up-the-server) in this manual for details of how to perform these back ups.
Before upgrading a production LibreTime server, you should back up both the
PostgreSQL database and the storage server used by LibreTime. This is especially
important if you have not already set up a regular back up routine. This extra
back up is a safety measure in case of accidental data loss during the upgrade,
for example due to the wrong command being entered when moving files. See
[Backing up the server](/docs/backing-up-the-server) in this manual for details
of how to perform these back ups.
The LibreTime [installation script](/install) will detect an existing LibreTime or Airtime deployment and back up any configuration files that it finds. We recommend taking your own manual backups of the configuration yourself nevertheless. The install script also tries to restart the needed services during an upgrade. In any case you should monitor if this happened and also take a quick look at the logs files to be sure everything is still fine. Now might be the time to reboot the system or virtual machine LibreTime is running on since regular reboots are part of a healthy system anyway.
The LibreTime [installation script](/install) will detect an existing LibreTime
deployment and back up any configuration files that it finds. We recommend
taking your own manual backups of the configuration yourself nevertheless. The
install script also tries to restart the needed services during an upgrade. In
any case you should monitor if this happened and also take a quick look at the
logs files to be sure everything is still fine. Now might be the time to reboot
the system or virtual machine LibreTime is running on since regular reboots are
part of a healthy system anyway.
After the upgrade has completed, you may need to clear your web browser's cache before logging into the new version of the LibreTime administration interface. If the playout engine starts up and detects that a show should be playing at the current time, it will skip to the correct point in the current item and start playing.
After the upgrade has completed, you may need to clear your web browser's cache
before logging into the new version of the LibreTime administration interface.
If the playout engine starts up and detects that a show should be playing at the
current time, it will skip to the correct point in the current item and start
playing.
There will be tested ways to switch from a LibreTime pre-release to a packaged version of LibreTime.
> **Note:** Airtime's _linked files_ and _watched folders_ features currently do
> not work in Libretime.
Airtime 2.5.x versions support upgrading from version 2.3.0 and above. If you are
running a production server with a version of Airtime prior to 2.3.0, you should
upgrade it to version 2.3.0 before continuing.
### Migrating from Airtime
> **Note:** Airtime's _linked files_ and _watched folders_ features currently do not work in Libretime.
LibreTime has dropped support for Ubuntu 16.04, which is the last supported
version of Ubuntu that Airtime supports. The following instructions describe how
to migrate from Airtime to LibreTime. If there are issues encountered while
upgrading, please [file a bug](https://github.com/libretime/libretime/issues/new?labels=bug&template=bug_report.md)
1. Take a [backup of the server](/docs/backing-up-the-server)
2. Create a new system for LibreTime and run the install script, as described in
[install](/install).
3. Before running the web-configuration, restore the Airtime database to the new
PostgreSQL server, media database and configuration file
4. Edit the configuration file to update any changed values
5. Edit the Icecast password in `/etc/icecast2/icecast.xml` to reflect the
password used in Airtime
6. Restart the LibreTime services
7. Navigate to the LibreTime web-page