docs: fix vale linting errors
- are not > aren't - auto-_ > auto _ - avoid backend - cannot > can't - do not > don't - does not > doesn't - ignore emoji code - has not > hasn't - ignore Microsoft.GeneralURL - is not > isn't - it is > it's - no exclamation point - put code inside code blocks - put commit sha inside code blocks - put exception message in code blocks - remove slang - should not > shouldn't - they are > they're - we are > we're - will not > won't
This commit is contained in:
jo
Kyle Robbertze
parent
722a683896
commit
50809a933c
42 changed files with 174 additions and 160 deletions
|
|
@ -15,7 +15,7 @@ Remember to **automate** and **test** the backup process and to have it run regu
|
|||
|
||||
:::caution
|
||||
|
||||
Feel free to pick the backup software of your choice, but know that rsync and similar tools are not backup tools. You could use [restic](https://restic.net/) or [borg](https://borgbackup.readthedocs.io/).
|
||||
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/).
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ To change the password for a different user (requires _Administrator_ privileges
|
|||
|
||||
Two of the most important passwords that should be changed _immediately_ after installation
|
||||
are the passwords used by the PostgreSQL database.
|
||||
It is strongly recommended that you do this before exposing your server to the internet beyond your internal network.
|
||||
It's strongly recommended that you do this before exposing your server to the internet beyond your internal network.
|
||||
|
||||
1. Login to PostgreSQL with `sudo -u postgres psql`. The PostgreSQL shell - `postgres=#` - means that you have logged in successfully.
|
||||
2. Change the admin password with `ALTER USER postgres PASSWORD 'myPassword';`, where `myPassword` is the new password.
|
||||
|
|
|
|||
|
|
@ -347,7 +347,7 @@ stream:
|
|||
# Icecast admin user.
|
||||
# > default is admin
|
||||
admin_user: "admin"
|
||||
# Icecast admin password. If not defined, statistics will not be collected.
|
||||
# Icecast admin password. If not defined, statistics won't be collected.
|
||||
admin_password: "hackme"
|
||||
|
||||
# Icecast output audio.
|
||||
|
|
@ -409,7 +409,7 @@ stream:
|
|||
# Shoutcast admin user.
|
||||
# > default is admin
|
||||
admin_user: "admin"
|
||||
# Shoutcast admin password. If not defined, statistics will not be collected.
|
||||
# Shoutcast admin password. If not defined, statistics won't be collected.
|
||||
admin_password: "hackme"
|
||||
|
||||
# Shoutcast output audio.
|
||||
|
|
|
|||
|
|
@ -110,7 +110,7 @@ cd libretime
|
|||
|
||||
:::caution
|
||||
|
||||
Don't use the https://github.com/libretime/libretime-debian-packaging repository, it is only used to create LibreTime packages.
|
||||
Don't use the https://github.com/libretime/libretime-debian-packaging repository, it's only used to create LibreTime packages.
|
||||
|
||||
:::
|
||||
|
||||
|
|
@ -154,9 +154,9 @@ If you need to change some configuration, the install script can be configured u
|
|||
|
||||
```bash
|
||||
# Install LibreTime on your system with the following tweaks:
|
||||
# - do not install the liquidsoap package (remember to install liquidsoap yourself)
|
||||
# - don't install the liquidsoap package (remember to install liquidsoap yourself)
|
||||
# - set the listen port to 8080
|
||||
# - do not run the PostgreSQL setup (remember to setup PostgreSQL yourself)
|
||||
# - don't run the PostgreSQL setup (remember to setup PostgreSQL yourself)
|
||||
sudo \
|
||||
LIBRETIME_PACKAGES_EXCLUDES='liquidsoap' \
|
||||
./install \
|
||||
|
|
@ -200,7 +200,7 @@ Next, run the following commands to setup the database:
|
|||
sudo -u libretime libretime-api migrate
|
||||
```
|
||||
|
||||
Finally, start the services, and check that they are running properly using the following commands:
|
||||
Finally, start the services, and check that they're running properly using the following commands:
|
||||
|
||||
```bash
|
||||
sudo systemctl start libretime.target
|
||||
|
|
@ -243,7 +243,7 @@ Once the files are downloaded, edit the [configuration file](./configuration.md)
|
|||
|
||||
:::info
|
||||
|
||||
The `docker/config.yml` configuration file you previously downloaded already contains specific values required by the container setup, you should not change them:
|
||||
The `docker/config.yml` configuration file you previously downloaded already contains specific values required by the container setup, you shouldn't change them:
|
||||
|
||||
```yaml
|
||||
database:
|
||||
|
|
@ -268,7 +268,7 @@ Next, run the following commands to setup the database:
|
|||
docker-compose run --rm api libretime-api migrate
|
||||
```
|
||||
|
||||
Finally, start the services, and check that they are running properly using the following commands:
|
||||
Finally, start the services, and check that they're running properly using the following commands:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ a single place.
|
|||
|
||||
:::warning
|
||||
|
||||
The current input and output streams are Icecast based protocols and does not support being behind a reverse proxy. **Do not attempt** to [reverse proxy Icecast](#icecast) or the Liquidsoap harbor inputs.
|
||||
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.
|
||||
|
||||
Modern protocols such as [HLS](https://en.wikipedia.org/wiki/HTTP_Live_Streaming) and [SRT](https://en.wikipedia.org/wiki/Secure_Reliable_Transport) will be implement in the future to fix those limitations.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ This guide walk you though the steps required to upgrade LibreTime.
|
|||
|
||||
:::tip
|
||||
|
||||
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**.
|
||||
You should always have proper backups and a rollback scenario in place before updating. If the update doesn't go smoothly, it may cause significant downtime, so you should always have a fallback system available during the update to ensure **broadcast continuity**.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -7,9 +7,9 @@ LibreTime supports direct connection to two popular streaming media servers, the
|
|||
|
||||
Ogg Vorbis playback is supported in most modern web browsers (see [this MDN article](https://developer.mozilla.org/en-US/docs/Web/Media/Formats/Audio_codecs#opus) for more information) and desktop players like [VLC](https://www.videolan.org/vlc/).
|
||||
|
||||
Streaming MP3 below a bitrate of 128kbps is not recommended for music, because of a perceptible loss of high audio frequencies in the broadcast playout. A 96kbps or 64kbps MP3 stream may be acceptable for voice broadcasts if there is a requirement for compatibility with legacy hardware playback devices which do not support Ogg Vorbis or Opus streams.
|
||||
Streaming MP3 below a bitrate of 128kbps isn't recommended for music, because of a perceptible loss of high audio frequencies in the broadcast playout. A 96kbps or 64kbps MP3 stream may be acceptable for voice broadcasts if there is a requirement for compatibility with legacy hardware playback devices which don't support Ogg Vorbis or Opus streams.
|
||||
|
||||
Because LibreTime supports simultaneous streaming in multiple formats, it is possible to offer one or more streams via your website, and another independent stream for direct connection from hardware players. You can test whether Ogg streams sound better at low bitrates for yourself, by using the **LISTEN** button in LibreTime's **Master Panel** to switch between streaming formats.
|
||||
Because LibreTime supports simultaneous streaming in multiple formats, it's possible to offer one or more streams via your website, and another independent stream for direct connection from hardware players. You can test whether Ogg streams sound better at low bitrates for yourself, by using the **LISTEN** button in LibreTime's **Master Panel** to switch between streaming formats.
|
||||
|
||||
:::tip
|
||||
|
||||
|
|
@ -21,7 +21,7 @@ Setting a higher bitrate for your output stream will only benefit your listeners
|
|||
|
||||
### UTF-8 metadata in Icecast MP3 streams
|
||||
|
||||
When sending metadata about your stream to an Icecast server in non-Latin alphabets, you may find that Icecast does not display the characters correctly for an MP3 stream, even though they're displayed correctly for an Ogg Vorbis stream. In the following screenshot, Russian characters are being displayed incorrectly in the _Current Song_ field for the MP3 stream:
|
||||
When sending metadata about your stream to an Icecast server in non-Latin alphabets, you may find that Icecast doesn't display the characters correctly for an MP3 stream, even though they're displayed correctly for an Ogg Vorbis stream. In the following screenshot, Russian characters are being displayed incorrectly in the _Current Song_ field for the MP3 stream:
|
||||
|
||||
|
||||
|
||||
|
|
@ -69,7 +69,7 @@ The example mount section provided in the `icecast.xml` file is commented out by
|
|||
</mount>
|
||||
```
|
||||
|
||||
These mount point definitions mean that a client connecting to a URL such as *http://icecast.example.com:8000/stream.ogg* will first fall back to the `/live.ogg` mount point if it is available. If not, the client will fall back in turn to the `/main` mount point for LibreTime playout.
|
||||
These mount point definitions mean that a client connecting to a URL such as *http://icecast.example.com:8000/stream.ogg* will first fall back to the `/live.ogg` mount point if it's available. If not, the client will fall back in turn to the `/main` mount point for LibreTime playout.
|
||||
|
||||
Setting the value of _fallback-override_ to 1 (enabled) means that when the `/live.ogg` mount point becomes available again, the client will be re-connected to it. If you wish to hide the `/main` and `/live.ogg` mount points from the public Icecast web interface, set the value of _hidden_ in each of these definitions to 1.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,11 +7,11 @@ This guide provide some guidance to uninstall LibreTime from your system.
|
|||
|
||||
We recommend using **disposable devices** for your installations, so you can delete your old system and install on a fresh one easily without worrying about old files.
|
||||
|
||||
If you do not have a way use disposable devices, below are commands that should help you remove most of the LibreTime files from your system.
|
||||
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
|
||||
|
||||
Use these commands at your **own risk**, we cannot guarantee that these commands are always up to date!
|
||||
Use these commands at your **own risk**, we can't guarantee that these commands are always up to date.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue