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

Merge branch 'stable'

Browse source
This commit is contained in:
jo 2023-04-03 12:31:50 +02:00
commit 49d4fafa0c
No known key found for this signature in database
GPG key ID: B2FEC9B22722B984
17 changed files with 218 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

24
docs/admin-manual/backup.md
View file

@ -27,17 +27,17 @@ On common setups, you need to backup the entire `/etc/libretime` folder.
You need to backup the PostgreSQL database, which holds the entire data of your installation.
Here is an example to dump your PostgreSQL database:
Here is an example to dump your PostgreSQL database to a plain text SQL file:
```bash
sudo -u postgres pg_dump --file=libretime.sql libretime
sudo -u postgres pg_dump --no-owner --no-privileges libretime > libretime.sql
```
:::note
Consider using the `--no-owner` and `--no-privileges` flags to ignore roles
We use the `--no-owner` and `--no-privileges` flags to ignore roles
and permissions details about the database. This can be useful when restoring
to database or role that have different names.
to database or role that have different names (e.g. `airtime` to `libretime`).
:::
@ -65,15 +65,25 @@ If you are upgrading LibreTime, edit the configuration file to match the new con
### Restore the database
Restore the database by using the following command:
Restore the database by using the one of the following command depending on the format of you backup file:
```bash
sudo -u postgres pg_restore --dbname=libretime libretime.sql
# With a plain text SQL file
sudo -u libretime libretime-api dbshell < libretime.sql
# With a custom pg_dump format
sudo -u postgres pg_restore --no-owner --no-privileges --dbname=libretime libretime.dump
```
:::info
The `libretime-api dbshell` command is a shortcut to the `psql` command, and automatically passes the database access details (e.g. database name, user, password).
:::
:::note
Consider using the `--no-owner` and `--no-privileges` flags to ignore roles
We use the `--no-owner` and `--no-privileges` flags to ignore roles
and permissions details about the database. This can be useful when restoring
to database or role that have different names.

2
docs/admin-manual/setup/install.md
View file

@ -46,7 +46,7 @@ LibreTime requires the following default ports to be open:
The installer is shipped in the released tarballs or directly in the project repository.
We recommend installing on one of the following [distribution releases](../../developer-manual/development/releases.md#distributions-releases-support):
We recommend installing on one of the following [distribution releases](../../contributor-manual/releases.md#distributions-releases-support):
- [Debian 11](https://www.debian.org/releases/)
- [Ubuntu 20.04 LTS](https://wiki.ubuntu.com/Releases)

18
docs/admin-manual/setup/upgrade.md
View file

@ -11,6 +11,12 @@ You should always have proper backups and a rollback scenario in place before up
:::
:::info
You may upgrade LibreTime by migrating to a new server. This is probably the cleanest way if you are coming from [Airtime](./migrate-from-airtime.md), if you wish to upgrade the underlying system, or if you want to skip multiple upgrade procedures.
:::
## Stop the services
Run the following commands to stop the services:
@ -33,6 +39,12 @@ Follow [the backup guide](../backup.md) to make an extra backup of your installa
Be sure to carefully read **all** the [releases notes](../../releases/README.md), from your current version to the targeted version, to apply upgrade or breaking changes instructions to your installation.
:::danger
If you are migrating LibreTime to a new server, you must **not** apply the upgrade procedure.
:::
:::caution
You might need to run steps before and after the install procedure. Be sure to follow these steps thoroughly.
@ -43,6 +55,12 @@ You might need to run steps before and after the install procedure. Be sure to f
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.
:::caution
If you are migrating LibreTime to a new server, you must **stop before the [setup tasks](./install.md#setup)** and [restore the backups](../backup.md#restore-a-backup) on the new server.
:::
## Apply migrations
Run the following command to apply the database migrations: