docs: fix prose linting errors
- Properly enclose code between triple backticks - Put paths and url between backticks - Remove links <> enclosing - Libretime styled name is LibreTime - Put urls and paths betwen backticks - Use sentence like capitalization for headings - Put tools name between backticks - Update links
This commit is contained in:
jo
Jonas L
parent
75e3760f2e
commit
94d3c5e496
37 changed files with 414 additions and 319 deletions
|
|
@ -1,4 +1,4 @@
|
|||
{
|
||||
"label": "Getting Started",
|
||||
"label": "Getting started",
|
||||
"position": 2
|
||||
}
|
||||
|
|
|
|||
|
|
@ -3,17 +3,17 @@ title: Change Default Passwords
|
|||
sidebar_position: 3
|
||||
---
|
||||
|
||||
## Libretime
|
||||
## LibreTime
|
||||
|
||||
To change the password of the current user:
|
||||
|
||||
1. Log in to Libretime
|
||||
1. Log in to LibreTime
|
||||
2. Click on the username in the upper right corner (next to Log Out)
|
||||
3. Enter the new password twice and click **Save**
|
||||
|
||||
To change the password for a different user (requires _Administrator_ privileges):
|
||||
|
||||
1. Log in to Libretime
|
||||
1. Log in to LibreTime
|
||||
2. Go to **Settings** > **Manage Users**
|
||||
3. Select the user, enter the new password twice, and click **Save**
|
||||
|
||||
|
|
@ -28,7 +28,7 @@ It is strongly recommended that you do this before exposing your server to the i
|
|||
Make sure to include the semicolon at the end! A response of `ALTER ROLE` means that the command ran successfully.
|
||||
3. Change the password for the _airtime_ user with `ALTER USER airtime WITH PASSWORD 'new_password';`
|
||||
A response of `ALTER ROLE` means that the command ran successfully.
|
||||
4. If all is successful, logout of PostgreSQL with `\q`, go back to _/etc/airtime/airtime.conf_ to edit the password
|
||||
4. If all is successful, logout of PostgreSQL with `\q`, go back to `/etc/airtime/airtime.conf` to edit the password
|
||||
in the config file, and restart all services mentioned in the previous section.
|
||||
|
||||
## Icecast
|
||||
|
|
@ -51,7 +51,7 @@ Replace the admin and _changeme_ fields below.
|
|||
|
||||
Then, restart your icecast2 service with `sudo systemctl restart icecast2`.
|
||||
|
||||
> Note: If you change the source password, you may need to manually configure Libretime to use the new password: go to **Settings** > **Streams**, set the streaming server to **Custom** and fill out the **Additional Options** below Stream 1.
|
||||
> Note: If you change the source password, you may need to manually configure LibreTime to use the new password: go to **Settings** > **Streams**, set the streaming server to **Custom** and fill out the **Additional Options** below Stream 1.
|
||||
|
||||
## RabbitMQ
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ title: Installation
|
|||
sidebar_position: 1
|
||||
---
|
||||
|
||||
## Minimum System Requirements
|
||||
## Minimum system requirements
|
||||
|
||||
- One of the following Linux distributions
|
||||
- Ubuntu [current LTS](https://wiki.ubuntu.com/Releases)
|
||||
|
|
@ -16,7 +16,7 @@ sidebar_position: 1
|
|||
|
||||
Configure the server to have a static IP address by modifying the Netplan configuration.
|
||||
|
||||
```
|
||||
```bash
|
||||
cd /etc/netplan && ls # find the netplan filename
|
||||
sudo nano ##-network-manager-all.yaml
|
||||
```
|
||||
|
|
@ -107,7 +107,7 @@ If an error is returned, try adding `.service` to the end of each command.
|
|||
|
||||
:::
|
||||
|
||||
## User Permissions
|
||||
## User permissions
|
||||
|
||||
If you plan to have LibreTime output analog audio directly to a mixing console or transmitter,
|
||||
the `www-data` user needs to be added to the `audio` user group using the command below:
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ domains that will be used externally to connect to your reverse proxy that you
|
|||
want handled by LibreTime. These URLS can also be set during the first run configuration
|
||||
that is displayed when you first install LibreTime
|
||||
|
||||
### Reverse Proxy Basics
|
||||
### Reverse proxy basics
|
||||
|
||||
A reverse proxy allows the LibreTime server to not be connected to the open internet. In
|
||||
this configuration, it is rather behind another server that proxies traffic to it from
|
||||
|
|
@ -42,7 +42,7 @@ access on both. `libretime` also needs to be able to be accessed from `proxy`
|
|||
On `libretime`, install LibreTime as described in the [install guide](/docs/getting-started/install). Once it has installed, replace `<hostname>localhost</hostname>` in
|
||||
`/etc/icecast2/icecast.xml` with the following:
|
||||
|
||||
```
|
||||
```xml
|
||||
<hostname>icecast.example.com</hostname>
|
||||
```
|
||||
|
||||
|
|
@ -103,7 +103,7 @@ http://localhost
|
|||
Finally, the configuration file needs updating. Under `[general]`, `force_ssl`
|
||||
needs to be set to true:
|
||||
|
||||
```
|
||||
```ini
|
||||
[general]
|
||||
...
|
||||
force_ssl = true
|
||||
|
|
|
|||
|
|
@ -18,9 +18,11 @@ Although it is possible to set the date and time of the server manually, this is
|
|||
|
||||
Optionally, open the **ntp** configuration file in the **nano** editor to add further time server names:
|
||||
|
||||
sudo nano /etc/ntp.conf
|
||||
```
|
||||
sudo nano /etc/ntp.conf
|
||||
```
|
||||
|
||||
On Ubuntu GNU/Linux, the default time server is _ntp.ubuntu.com_, but there are many other time servers available on the public Internet, including the group of servers listed at <http://www.pool.ntp.org/> for each country. Using a variety of NTP servers located closely to your LibreTime server should produce the most accurate results. For example, for a server in the United Kingdom you could use the following list:
|
||||
On Ubuntu GNU/Linux, the default time server is `ntp.ubuntu.com`, but there are many other time servers available on the public Internet, including the group of servers listed at https://www.pool.ntp.org/ for each country. Using a variety of NTP servers located closely to your LibreTime server should produce the most accurate results. For example, for a server in the United Kingdom you could use the following list:
|
||||
|
||||
```title="/etc/ntp.conf"
|
||||
# You do need to talk to an NTP server or two (or three).
|
||||
|
|
@ -31,7 +33,7 @@ server 2.uk.pool.ntp.org
|
|||
server 3.uk.pool.ntp.org
|
||||
```
|
||||
|
||||
Enter the server names you require, press **Ctrl+O** to write out the _/etc/ntp.conf_ file, then **Ctrl+X** to exit **nano**. Restart the **ntp** service with `sudo systemctl restart ntp`.
|
||||
Enter the server names you require, press **Ctrl+O** to write out the `/etc/ntp.conf` file, then **Ctrl+X** to exit **nano**. Restart the **ntp** service with `sudo systemctl restart ntp`.
|
||||
|
||||
The server should respond:
|
||||
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ To increase the security of your server, you can enable encrypted access to the
|
|||
## Deploying a certificate with Certbot (Recommended)
|
||||
|
||||
One of the fastest, easiest, and cheapest ways to get an SSL certificate is through [Certbot](https://certbot.eff.org/), as created by the
|
||||
Electronic Frontier Foundation. To use Certbot, your Libretime installation must be open to the internet on port 80.
|
||||
Electronic Frontier Foundation. To use Certbot, your LibreTime installation must be open to the internet on port 80.
|
||||
|
||||
Follow [Certbot's documentation](https://certbot.eff.org/instructions) for your OS and webserver to install an SSL certificate. You'll need to renew the certificate every 90 days to keep your installation secure.
|
||||
|
||||
|
|
@ -16,15 +16,19 @@ If you aren't able to use Certbot, you may want to try a self-signed certificate
|
|||
|
||||
## Deploying a self-signed certificate
|
||||
|
||||
The Debian/Ubuntu package _ssl-cert_ creates a _snakeoil_ certificate and key based on your server's hostname. This gratis certificate and key pair created under the _/etc/ssl/certs_/ and _/etc/ssl/private/_ directories will not be recognised by users' browsers without manual intervention. You can install the _ssl-cert_ package with `sudo apt-get install ssl-cert`.
|
||||
The Debian/Ubuntu package `ssl-cert` creates a `snakeoil` certificate and key based on your server's hostname. This gratis certificate and key pair created under the `/etc/ssl/certs/` and `/etc/ssl/private/` directories will not be recognised by users' browsers without manual intervention. You can install the `ssl-cert` package with `sudo apt-get install ssl-cert`.
|
||||
|
||||
If the hostname of your server does not match the domain name you intend to use with the LibreTime virtual host, the user's browser will present an additional security warning. You can set the domain name of the certificate by editing the file _/usr/share/ssl-cert/ssleay.cnf_ to replace the _@HostName@_ variable:
|
||||
If the hostname of your server does not match the domain name you intend to use with the LibreTime virtual host, the user's browser will present an additional security warning. You can set the domain name of the certificate by editing the file `/usr/share/ssl-cert/ssleay.cnf` to replace the `@HostName@` variable:
|
||||
|
||||
commonName = @HostName@
|
||||
```
|
||||
commonName = @HostName@
|
||||
```
|
||||
|
||||
with the domain name used by LibreTime:
|
||||
|
||||
commonName = airtime.example.com
|
||||
```
|
||||
commonName = airtime.example.com
|
||||
```
|
||||
|
||||
Then save the file and regenerate the certificate with
|
||||
|
||||
|
|
@ -44,7 +48,7 @@ Next, edit the virtual host configuration for your LibreTime server to include a
|
|||
sudo nano /etc/apache2/sites-available/airtime-vhost.conf
|
||||
```
|
||||
|
||||
Using the following configuration as a guide, replace _libretime.example.com_ with the name of your server and *admin@example.com* with your email address. The older SSLv2 and SSLv3 protocols and SSL compression should be disabled, as they are generally believed to be insecure. You may wish to create a _ServerAlias_ for users to access the administration interface over https:// if required.
|
||||
Using the following configuration as a guide, replace `libretime.example.com` with the name of your server and *admin@example.com* with your email address. The older SSLv2 and SSLv3 protocols and SSL compression should be disabled, as they are generally believed to be insecure. You may wish to create a _ServerAlias_ for users to access the administration interface over https:// if required.
|
||||
|
||||
On port 80, Apache's _alias_ module is used to set a _Redirect permanent_ for the login page. Optionally, access could be denied to all sites except _localhost_ and any other LibreTime servers on your network, so that unencrypted communication between LibreTime components can continue.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue