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

docs: move configuration documentation

Browse source
This commit is contained in:
jo 2023-04-21 11:46:30 +02:00 • committed by Kyle Robbertze
parent 5a083886c5
commit 8052622e69
8 changed files with 15 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/admin-manual/README.md
View file

@ -24,7 +24,7 @@ Before following any steps, be sure that your system is up-to-date.
- [:rocket: Install LibreTime](./setup/install.md) - [:rocket: Install LibreTime](./setup/install.md)
- [:arrow_up: Upgrade from a previous install](./setup/upgrade.md) - [:arrow_up: Upgrade from a previous install](./setup/upgrade.md)
- [:airplane_arriving: Migrate from Airtime](./setup/migrate-from-airtime.md) - [:airplane_arriving: Migrate from Airtime](./setup/migrate-from-airtime.md)
- [:gear: Configure your installation](./setup/configuration.md) - [:gear: Configure your installation](./configuration.md)
- [:lock: Put your installation behind a reverse proxy](./setup/reverse-proxy.md) - [:lock: Put your installation behind a reverse proxy](./setup/reverse-proxy.md)
## Advanced ## Advanced

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

@ -47,7 +47,7 @@ Please read the `pg_dump` usage for additional details.
You need to backup the entire file storage, which holds all the files of your installation. You need to backup the entire file storage, which holds all the files of your installation.
The path to your storage is defined in the [configuration](./setup/configuration.md) file. The path to your storage is defined in the [configuration](./configuration.md) file.
## Restore a backup ## Restore a backup
@ -59,9 +59,9 @@ If you are restoring a backup on an existing system, make sure to clean the old
### Restore the configuration ### Restore the configuration
Copy the backed configuration files back to the [configuration](./setup/configuration.md) folder. Copy the backed configuration files back to the [configuration](./configuration.md) folder.
If you are upgrading LibreTime, edit the configuration file to match the new configuration schema and update any changed values. See the [configuration](./setup/configuration.md) documentation for more details. If you are upgrading LibreTime, edit the configuration file to match the new configuration schema and update any changed values. See the [configuration](./configuration.md) documentation for more details.
### Restore the database ### Restore the database
@ -95,4 +95,4 @@ If you are upgrading LibreTime, make sure to apply the [database migration](./se
Copy the entire backed file storage back to the storage path. Copy the entire backed file storage back to the storage path.
The path to your storage is defined in the [configuration](./setup/configuration.md) file. The path to your storage is defined in the [configuration](./configuration.md) file.

4
docs/admin-manual/setup/configuration.md → docs/admin-manual/configuration.md
View file

@ -1,6 +1,6 @@
--- ---
title: Configuration title: Configuration
sidebar_position: 20 sidebar_position: 5
--- ---
To configure LibreTime, you need to edit the `/etc/libretime/config.yml` file. This page describe the available options to configure your installation. To configure LibreTime, you need to edit the `/etc/libretime/config.yml` file. This page describe the available options to configure your installation.
@ -455,7 +455,7 @@ stream:
## LDAP ## LDAP
The `ldap` section provide additional configuration for the authentication mechanism defined in `general.auth`, please see the [custom authentication documentation](../custom-authentication.md) for more details. The `ldap` section provide additional configuration for the authentication mechanism defined in `general.auth`, please see the [custom authentication documentation](./custom-authentication.md) for more details.
```yml ```yml
ldap: ldap:

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

@ -198,7 +198,7 @@ sudo adduser libretime audio
### Setup ### Setup
Once the installation is completed, edit the [configuration file](./configuration.md) at `/etc/libretime/config.yml` to fill required information and to match your needs. Once the installation is completed, edit the [configuration file](../configuration.md) at `/etc/libretime/config.yml` to fill required information and to match your needs.
Next, run the following commands to setup the database: Next, run the following commands to setup the database:
@ -265,7 +265,7 @@ You can find more details in the `docker-compose.yml` file or on the external se
::: :::
Next, edit the [configuration file](./configuration.md) at `./config.yml` to set the previously generated passwords, fill required information, and to match your needs. Next, edit the [configuration file](../configuration.md) at `./config.yml` to set the previously generated passwords, fill required information, and to match your needs.
:::info :::info

2
docs/admin-manual/setup/migrate-from-airtime.md
View file

@ -49,7 +49,7 @@ You have to restore the **database**, the **files storage** and the **configurat
## Update the configuration files ## Update the configuration files
Update the configuration file to match the new configuration schema and update any changed values. See the [configuration](./configuration.md) documentation for more details. Update the configuration file to match the new configuration schema and update any changed values. See the [configuration](../configuration.md) documentation for more details.
Edit the Icecast password in `/etc/icecast2/icecast.xml` to reflect the password used in Airtime. Edit the Icecast password in `/etc/icecast2/icecast.xml` to reflect the password used in Airtime.

2
docs/releases/3.0.0-alpha.11.md
View file

@ -195,7 +195,7 @@ ls_port = '1234'
liquidsoap_port = 1234 liquidsoap_port = 1234
``` ```
Please see the [configuration documentation](../admin-manual/setup/configuration.md) for more details. Please see the [configuration documentation](../admin-manual/configuration.md) for more details.
### Environment variables ### Environment variables

4
docs/releases/3.0.0-alpha.13.md
View file

@ -108,7 +108,7 @@ The LibreTime project wants to thank the following contributors for authoring PR
### Allowed CORS origins configuration location ### Allowed CORS origins configuration location
The allowed CORS origins configuration moved from the database to the configuration file. The field in the general preference form is deprecated and will be removed in the next release. Be sure to move your allowed CORS origins configuration to the [configuration file](../admin-manual/setup/configuration.md). The allowed CORS origins configuration moved from the database to the configuration file. The field in the general preference form is deprecated and will be removed in the next release. Be sure to move your allowed CORS origins configuration to the [configuration file](../admin-manual/configuration.md).
## :arrow_up: Before upgrading ## :arrow_up: Before upgrading
@ -178,7 +178,7 @@ The configuration directory changed from `/etc/airtime` to `/etc/libretime`. Ple
sudo mv /etc/airtime /etc/libretime sudo mv /etc/airtime /etc/libretime
``` ```
The configuration file format changed to `yml` and the configuration schema changed. Please rewrite your [configuration file](../admin-manual/setup/configuration.md) using the [yaml format](https://yaml.org/). An example configuration file `installer/config.yml` is present in the sources. The configuration file format changed to `yml` and the configuration schema changed. Please rewrite your [configuration file](../admin-manual/configuration.md) using the [yaml format](https://yaml.org/). An example configuration file `installer/config.yml` is present in the sources.
The `general` section has been changed: The `general` section has been changed:

4
docs/releases/3.0.0-beta.0.md
View file

@ -137,7 +137,7 @@ Please follow this **before the upgrade procedure**.
### File based stream configuration ### File based stream configuration
The stream configuration moved from the database to the [configuration](../admin-manual/setup/configuration.md#stream) file. A configuration sample can be found in the project folder under `installer/config.yml`. Make sure to save your existing stream config to the configuration file. The stream configuration moved from the database to the [configuration](../admin-manual/configuration.md#stream) file. A configuration sample can be found in the project folder under `installer/config.yml`. Make sure to save your existing stream config to the configuration file.
:::info :::info
@ -167,7 +167,7 @@ sudo -u libretime libretime-api dbshell --command="
### Timezone configuration ### Timezone configuration
The timezone preference moved from the database to the [configuration](../admin-manual/setup/configuration.md#general) file. Make sure to save your existing timezone preference to the configuration file. The timezone preference moved from the database to the [configuration](../admin-manual/configuration.md#general) file. Make sure to save your existing timezone preference to the configuration file.
:::info :::info