docs: update admonitions to use correct levels (#3140)
https://docusaurus.io/blog/preparing-your-site-for-docusaurus-v3#admonition-warning
This commit is contained in:
Kyle Robbertze
GitHub
parent
d3f6ee2507
commit
794f25be6e
@ -4,7 +4,7 @@ title: Administrator manual
|
||||
|
||||
Welcome to the **LibreTime administrator manual**, you should find guides and references to setup and configure LibreTime.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
This documentation assumes that you:
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ Remember to **automate** and **test** the backup process and to have it run regu
|
||||
|
||||
:::
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Feel free to pick the backup software of your choice, but know that rsync and similar tools aren't backup tools. You could use [restic](https://restic.net/) or [borg](https://borgbackup.readthedocs.io/).
|
||||
|
||||
|
||||
@ -78,7 +78,7 @@ storage:
|
||||
path: "/srv/libretime"
|
||||
```
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
After editing the `storage.path` field, make sure to update the LibreTime Nginx configuration file with the new value.
|
||||
|
||||
@ -102,7 +102,7 @@ In the example below, we are changing the path from `/srv/libretime` to `/mnt/da
|
||||
|
||||
The `database` section configure the PostgreSQL connection.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Before editing this section be sure to update the PostgreSQL server with the desired values.
|
||||
|
||||
@ -139,7 +139,7 @@ database:
|
||||
|
||||
The `rabbitmq` section configure the RabbitMQ connection.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Before editing this section be sure to update the RabbitMQ server with the desired values.
|
||||
|
||||
@ -235,7 +235,7 @@ email:
|
||||
|
||||
The `playout` section configure anything related to the playout service.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
When changing the `playout.liquidsoap_*` entries, make sure to also configure the `liquidsoap.server_listen_*` entries accordingly.
|
||||
|
||||
@ -272,7 +272,7 @@ playout:
|
||||
|
||||
The `liquidsoap` section configure anything related to the liquidsoap service.
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
When changing the `liquidsoap.server_listen_*` entries, make sure to also configure the `playout.liquidsoap_*` entries accordingly.
|
||||
|
||||
@ -399,7 +399,7 @@ stream:
|
||||
|
||||
The `stream.outputs.icecast` section configures the icecast output streams.
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
If you configure more than 2 icecast stream on a **single icecast server**, make sure to raise the icecast sources limit:
|
||||
|
||||
|
||||
@ -3,7 +3,7 @@ title: Custom authentication
|
||||
sidebar_position: 40
|
||||
---
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Since LibreTime v3.0.0-alpha.13, this documentation is out of date, as it relies on the Apache2 web server and the default web server installed by LibreTime is now NGINX.
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ This guide walk you though the steps required to install LibreTime on your syste
|
||||
- 2 GB RAM recommended (1 GB required)
|
||||
- A static external IP address ([How to setup a static ip using Netplan](../tutorials/setup-a-static-ip-using-netplan.md))
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Make sure that you have configured a **firewall** and it's not blocking connection to the desired ports.
|
||||
|
||||
|
||||
@ -126,7 +126,7 @@ Once LibreTime is running, it's recommended to [install a reverse proxy](./rever
|
||||
|
||||
Once the setup is completed, log in the interface (with the default user `admin` and password `admin`), and edit the project settings (go to **Settings** > **General**) to match your needs.
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Remember to change your password.
|
||||
|
||||
|
||||
@ -89,7 +89,7 @@ git clone https://github.com/libretime/libretime
|
||||
cd libretime
|
||||
```
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Don't use the https://github.com/libretime/libretime-debian-packaging repository, it's only used to create LibreTime packages.
|
||||
|
||||
@ -124,7 +124,7 @@ Install LibreTime with the following command, be sure to replace `https://libret
|
||||
sudo ./install https://libretime.example.org
|
||||
```
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
When upgrading be sure to run the installer using the same arguments you used during the initial install.
|
||||
|
||||
@ -417,7 +417,7 @@ sudo systemctl restart libretime.target
|
||||
|
||||
Once the setup is completed, log in the interface (with the default user `admin` and password `admin`), and edit the project settings (go to **Settings** > **General**) to match your needs.
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Remember to change your password.
|
||||
|
||||
|
||||
@ -34,7 +34,7 @@ flowchart LR
|
||||
internet ==> front_https
|
||||
```
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
The current input and output streams are Icecast based protocols and doesn't support being behind a reverse proxy. **Don't attempt** to [reverse proxy Icecast](#icecast) or the Liquidsoap harbor inputs.
|
||||
|
||||
@ -256,7 +256,7 @@ will be raised by your browser and should prevent your player from listening to
|
||||
|
||||
### Securing the Icecast output streams
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Before you start, make sure to have a working and secured LibreTime server, and that the TLS certificates generated by Cerbot are on the same host as Icecast.
|
||||
|
||||
@ -308,7 +308,7 @@ Enable the secure socket and set the SSL certificate bundle path in the Icecast
|
||||
</paths>
|
||||
```
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Don't forget to open the new Icecast secure port `8443` in your firewall.
|
||||
|
||||
|
||||
@ -45,7 +45,7 @@ If you are migrating LibreTime to a new server, you must **not** apply the upgra
|
||||
|
||||
:::
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
You might need to run steps before and after the install procedure. Be sure to follow these steps thoroughly.
|
||||
|
||||
@ -55,7 +55,7 @@ You might need to run steps before and after the install procedure. Be sure to f
|
||||
|
||||
Follow [the install guide](./README.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
|
||||
:::warning
|
||||
|
||||
If you are migrating LibreTime to a new server, you must **stop before the [setup tasks](./README.md#setup)** and [restore the backups](../backup.md#restore-a-backup) on the new server.
|
||||
|
||||
|
||||
@ -17,7 +17,7 @@ Setting a higher bitrate for your output stream will only benefit your listeners
|
||||
|
||||
:::
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
The liquidsoap playout handler version 1.4.3 shipped in Debian Bullseye and 1.4.1 shipped in Ubuntu Focal doesn't support AAC streaming output. If you want to stream AAC, you will need to replace the liquidsoap package with a version that supports AAC. See this [tutorial](./tutorials/setup-liquidsoap-aac-streaming.md) for more information.
|
||||
|
||||
|
||||
@ -38,7 +38,7 @@ See `man default.pa` for more details on how to persist a PulseAudio configurati
|
||||
|
||||
:::
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Make sure that the PulseAudio connection socket is owned by the same user running inside the container. By default the user inside the container will be `1000:1000`, so you should be fine if your host user also has the uid `1000`.
|
||||
|
||||
|
||||
@ -4,7 +4,7 @@ title: How to update liquidsoap to support AAC streaming
|
||||
|
||||
This tutorials walks you though the steps required to replace the liquidsoap package with a version that supports AAC streaming.
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Replacing the liquidsoap package has security implications, since this will remove the package from the system's package manager. This means that the package manager will not be able to update the liquidsoap package in the future. This includes backports of security fixes.
|
||||
|
||||
@ -56,7 +56,7 @@ Nothing to do, this is a drop-in replacement. Just restart the libretime target
|
||||
sudo systemctl restart libretime.target
|
||||
```
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
If you want to update LibreTime in the future, you'll need to re-run the installer schript. This will replace the liquidsoap package with the version that doesn't support AAC streaming. Add `--packages-excludes liquidsoap` to the installer command to prevent this from happening.
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ We recommend using **disposable devices** for your installations, so you can del
|
||||
|
||||
If you don't have a way use disposable devices, below are commands that should help you remove most of the LibreTime files from your system.
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Use these commands at your **own risk**, we can't guarantee that these commands are always up to date.
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ A microservice architecture was rejected as it won't fix or improve any aspect o
|
||||
|
||||
:::
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
This document tries to focus on creating and playing a schedule, it doesn't consider features such as monitoring, logging or archiving.
|
||||
|
||||
|
||||
@ -112,7 +112,7 @@ The allowed CORS origins configuration moved from the database to the configurat
|
||||
|
||||
## :arrow_up: Before upgrading
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Please run this **before the upgrade procedure**.
|
||||
|
||||
@ -254,7 +254,7 @@ sudo deluser celery
|
||||
|
||||
### New installer
|
||||
|
||||
:::warning
|
||||
:::danger
|
||||
|
||||
Please be careful when running this new installer, it might not be bug free.
|
||||
|
||||
|
||||
@ -129,7 +129,7 @@ Along with the Debian Buster deprecation, the following dependencies versions ar
|
||||
|
||||
## :arrow_up: Before upgrading
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Please follow this **before the upgrade procedure**.
|
||||
|
||||
|
||||
@ -22,7 +22,7 @@ Please see the [changelog](https://github.com/libretime/libretime/blob/main/CHAN
|
||||
|
||||
## :arrow_up: Before upgrading
|
||||
|
||||
:::caution
|
||||
:::warning
|
||||
|
||||
Please follow this **before the upgrade procedure**.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user