Congegni
/
libretime
mirror of https://github.com/libretime/libretime.git
7
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: be consistent with example domain (#2568)

This commit is contained in:
Jonas L 2023-05-26 15:00:34 +02:00 committed by GitHub
parent 17fb1c45df
commit e207b6e388
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 30 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
docs/admin-manual/install/install-using-the-installer.md
View File

@ -119,10 +119,10 @@ git checkout {vars.version}
By default the installer will configure LibreTime to listen at the port `80`, but this isn't the recommended way to install LibreTime. Instead you should configure a [reverse proxy in front of LibreTime](./reverse-proxy.md) to secure the connection using HTTPS, and route the traffic to the LibreTime server. By default the installer will configure LibreTime to listen at the port `80`, but this isn't the recommended way to install LibreTime. Instead you should configure a [reverse proxy in front of LibreTime](./reverse-proxy.md) to secure the connection using HTTPS, and route the traffic to the LibreTime server.
Install LibreTime with the following command, be sure to replace `https://libretime.example.com` with the public url of your installation: Install LibreTime with the following command, be sure to replace `https://libretime.example.org` with the public url of your installation:
```bash ```bash
sudo ./install --listen-port 8080 https://libretime.example.com sudo ./install --listen-port 8080 https://libretime.example.org
``` ```
:::caution :::caution
@ -149,7 +149,7 @@ LIBRETIME_PACKAGES_EXCLUDES='liquidsoap' \
./install \ ./install \
--listen-port 8080 \ --listen-port 8080 \
--no-setup-postgresql \ --no-setup-postgresql \
https://libretime.example.com https://libretime.example.org
``` ```
You can persist the install configuration in a `.env` file next to the install script. For example, the above command could be persisted using the `.env` file below, and you should be able to run the install script without arguments: You can persist the install configuration in a `.env` file next to the install script. For example, the above command could be persisted using the `.env` file below, and you should be able to run the install script without arguments:
@ -158,7 +158,7 @@ You can persist the install configuration in a `.env` file next to the install s
LIBRETIME_PACKAGES_EXCLUDES='liquidsoap' LIBRETIME_PACKAGES_EXCLUDES='liquidsoap'
LIBRETIME_LISTEN_PORT='8080' LIBRETIME_LISTEN_PORT='8080'
LIBRETIME_SETUP_POSTGRESQL=false LIBRETIME_SETUP_POSTGRESQL=false
LIBRETIME_PUBLIC_URL='https://libretime.example.com' LIBRETIME_PUBLIC_URL='https://libretime.example.org'
``` ```
:::note :::note
@ -227,14 +227,14 @@ sudo systemctl status certbot.timer
Next, you have to [configure a reverse proxy](./reverse-proxy.md) to route the traffic from port `80` to LibreTime (port `8080`). Next, you have to [configure a reverse proxy](./reverse-proxy.md) to route the traffic from port `80` to LibreTime (port `8080`).
Copy the following in a new Nginx configuration file, make sure to replace `libretime.example.com` with your own domain name: Copy the following in a new Nginx configuration file, make sure to replace `libretime.example.org` with your own domain name:
```nginx title="/etc/nginx/sites-available/libretime.example.com.conf" ```nginx title="/etc/nginx/sites-available/libretime.example.org.conf"
server { server {
listen 80; listen 80;
listen [::]:80; listen [::]:80;
server_name libretime.example.com; server_name libretime.example.org;
location / { location / {
proxy_set_header Host $host; proxy_set_header Host $host;
@ -249,10 +249,10 @@ server {
} }
``` ```
Enable the new reverse proxy configuration, make sure to replace `libretime.example.com` with your own domain name: Enable the new reverse proxy configuration, make sure to replace `libretime.example.org` with your own domain name:
```bash ```bash
sudo ln -s /etc/nginx/sites-{available,enabled}/libretime.example.com.conf sudo ln -s /etc/nginx/sites-{available,enabled}/libretime.example.org.conf
``` ```
Then, check that the nginx config is valid and reload nginx: Then, check that the nginx config is valid and reload nginx:
@ -267,23 +267,23 @@ sudo systemctl reload nginx
Certbot provides a variety of ways to obtain SSL certificates through plugins. The Nginx plugin will take care of reconfiguring Nginx and reloading the config whenever necessary. Certbot provides a variety of ways to obtain SSL certificates through plugins. The Nginx plugin will take care of reconfiguring Nginx and reloading the config whenever necessary.
To request a Let’s Encrypt certificate using Certbot with the Nginx plugin, be sure to replace `libretime.example.com` with the domain name of your installation and run the following: To request a Let’s Encrypt certificate using Certbot with the Nginx plugin, be sure to replace `libretime.example.org` with the domain name of your installation and run the following:
```bash ```bash
sudo certbot --nginx -d libretime.example.com sudo certbot --nginx -d libretime.example.org
``` ```
### Setup the certificate for Icecast ### Setup the certificate for Icecast
By default, browsers will [prevent loading mixed content](https://developer.mozilla.org/en-US/docs/Web/Security/Mixed_content) on secure pages, so you won't be able to listen the insecure Icecast streams on a secure website. To fix that you need to secure the Icecast streams. By default, browsers will [prevent loading mixed content](https://developer.mozilla.org/en-US/docs/Web/Security/Mixed_content) on secure pages, so you won't be able to listen the insecure Icecast streams on a secure website. To fix that you need to secure the Icecast streams.
Create a Icecast specific SSL certificate bundle, be sure to replace `libretime.example.com` with the domain name of your installation: Create a Icecast specific SSL certificate bundle, be sure to replace `libretime.example.org` with the domain name of your installation:
```bash ```bash
sudo bash -c "install \ sudo bash -c "install \
--group=icecast \ --group=icecast \
--mode=640 \ --mode=640 \
<(cat /etc/letsencrypt/live/libretime.example.com/{fullchain,privkey}.pem) \ <(cat /etc/letsencrypt/live/libretime.example.org/{fullchain,privkey}.pem) \
/etc/icecast2/bundle.pem" /etc/icecast2/bundle.pem"
``` ```
@ -338,7 +338,7 @@ Next, you need to change the LibreTime `stream.outputs.icecast.*.public_url` con
- <<: *default_icecast_output - <<: *default_icecast_output
enabled: true enabled: true
- public_url: - public_url:
+ public_url: https://libretime.example.com:8443/main.ogg + public_url: https://libretime.example.org:8443/main.ogg
mount: main.ogg mount: main.ogg
audio: audio:
format: ogg format: ogg
@ -347,7 +347,7 @@ Next, you need to change the LibreTime `stream.outputs.icecast.*.public_url` con
- <<: *default_icecast_output - <<: *default_icecast_output
enabled: true enabled: true
- public_url: - public_url:
+ public_url: https://libretime.example.com:8443/main.mp3 + public_url: https://libretime.example.org:8443/main.mp3
mount: main.mp3 mount: main.mp3
audio: audio:
format: mp3 format: mp3
@ -362,7 +362,7 @@ sudo systemctl restart libretime.target
Finally, you need to configure the Certbot renewal to bundle a Icecast specific SSL certificate and restart the Icecast service: Finally, you need to configure the Certbot renewal to bundle a Icecast specific SSL certificate and restart the Icecast service:
```git title="/etc/letsencrypt/renewal/libretime.example.com.conf" ```git title="/etc/letsencrypt/renewal/libretime.example.org.conf"
# Options used in the renewal process # Options used in the renewal process
[renewalparams] [renewalparams]
account = d76ce6a241c7c74f79e5443216ee420e account = d76ce6a241c7c74f79e5443216ee420e
@ -383,14 +383,14 @@ sudo certbot renew --dry-run
To stream audio content from an external source to the LibreTime server, Liquidsoap creates input harbors (Icecast mount points) for the clients to connect to. These mount points are insecure by default, so it's recommended secure them. To stream audio content from an external source to the LibreTime server, Liquidsoap creates input harbors (Icecast mount points) for the clients to connect to. These mount points are insecure by default, so it's recommended secure them.
To enable the secure input streams, edit the [configuration file](../configuration.md) at `/etc/libretime/config.yml` with the following, be sure to replace `libretime.example.com` with the domain name of your installation: To enable the secure input streams, edit the [configuration file](../configuration.md) at `/etc/libretime/config.yml` with the following, be sure to replace `libretime.example.org` with the domain name of your installation:
```git title="/etc/libretime/config.yml" ```git title="/etc/libretime/config.yml"
liquidsoap: liquidsoap:
- harbor_ssl_certificate: - harbor_ssl_certificate:
- harbor_ssl_private_key: - harbor_ssl_private_key:
+ harbor_ssl_certificate: /etc/letsencrypt/live/libretime.example.com/fullchain.pem + harbor_ssl_certificate: /etc/letsencrypt/live/libretime.example.org/fullchain.pem
+ harbor_ssl_private_key: /etc/letsencrypt/live/libretime.example.com/privkey.pem + harbor_ssl_private_key: /etc/letsencrypt/live/libretime.example.org/privkey.pem
``` ```
```git title="/etc/libretime/config.yml" ```git title="/etc/libretime/config.yml"

4
docs/developer-manual/legacy-api.md
View File

@ -15,7 +15,7 @@ If you intend to use the LibreTime API across a public network, for security rea
The format of API requests is: The format of API requests is:
``` ```
https://libretime.example.com/api/api-action/format/json/api_key/XXXXXX https://libretime.example.org/api/api-action/format/json/api_key/XXXXXX
``` ```
where api-action is the type of request and XXXXXX is the secret API key. Available actions include: where api-action is the type of request and XXXXXX is the secret API key. Available actions include:
@ -55,7 +55,7 @@ Some API requests require the directory ID number to be specified as _dir_id_ in
For example, using a request such as: For example, using a request such as:
``` ```
http://libretime.example.com/api/list-all-files/format/json/api_key/XXXXXX/dir_id/1/ http://libretime.example.org/api/list-all-files/format/json/api_key/XXXXXX/dir_id/1/
``` ```
returns the full path to each media file in the LibreTime storage directory: returns the full path to each media file in the LibreTime storage directory:

14
docs/user-manual/playout-history.md
View File

@ -42,10 +42,10 @@ Instead, your public-facing web server can retrieve the schedule information fro
There are two kinds of information that can be retrieved remotely from the LibreTime API without authentication; the metadata for the current show plus the following show (live-info), or the schedule for the current week and the week ahead (week-info). The week-info metadata includes show names, times, and individual show URLs on your public website. That way, the audience for your station can click through from the schedule information to find out more about a particular show, or download a previous show recording that you might have made available. There are two kinds of information that can be retrieved remotely from the LibreTime API without authentication; the metadata for the current show plus the following show (live-info), or the schedule for the current week and the week ahead (week-info). The week-info metadata includes show names, times, and individual show URLs on your public website. That way, the audience for your station can click through from the schedule information to find out more about a particular show, or download a previous show recording that you might have made available.
If your LibreTime server was accessible at https://libretime.example.com the live show information could be retrieved by your web server using this URL: If your LibreTime server was accessible at https://libretime.example.org the live show information could be retrieved by your web server using this URL:
``` ```
https://libretime.example.com/api/live-info/?callback https://libretime.example.org/api/live-info/?callback
``` ```
The comma-separated text metadata returned to your web server might be something like this: The comma-separated text metadata returned to your web server might be something like this:
@ -130,7 +130,7 @@ The comma-separated text metadata returned to your web server might be something
The information for the current week's schedule could be retrieved using the URL: The information for the current week's schedule could be retrieved using the URL:
``` ```
https://libretime.example.com/api/week-info/?callback https://libretime.example.org/api/week-info/?callback
``` ```
In this case, the metadata returned would be in a different format from the above example, something like the following. To keep the example short, this particular schedule export only contains four shows on a Monday. A full weekly schedule export would contain a great deal more text. In this case, the metadata returned would be in a different format from the above example, something like the following. To keep the example short, this particular schedule export only contains four shows on a Monday. A full weekly schedule export would contain a great deal more text.
@ -205,20 +205,20 @@ If the LibreTime server is behind a firewall, or you want to protect the LibreTi
Your system administrator can set up schedule caching on a standard Apache and PHP enabled web server with the _curl_ program installed, using the following steps: Your system administrator can set up schedule caching on a standard Apache and PHP enabled web server with the _curl_ program installed, using the following steps:
1. Create a shell script on the schedule server (schedule.example.com) that polls the remote LibreTime server (libretime.example.com), and writes the metadata returned into a pair of local temporary files: 1. Create a shell script on the schedule server (schedule.example.com) that polls the remote LibreTime server (libretime.example.org), and writes the metadata returned into a pair of local temporary files:
``` ```
sudo nano /usr/local/bin/libretime-schedule.sh sudo nano /usr/local/bin/libretime-schedule.sh
``` ```
The content of this file should be like the following script, replacing libretime.example.com with the name of your LibreTime server: The content of this file should be like the following script, replacing libretime.example.org with the name of your LibreTime server:
```bash ```bash
#!/bin/sh #!/bin/sh
curl -s "https://libretime.example.com/api/live-info/?callback=***" > /tmp/live-info curl -s "https://libretime.example.org/api/live-info/?callback=***" > /tmp/live-info
curl -s "https://libretime.example.com/api/week-info/?callback=***" > /tmp/week-info curl -s "https://libretime.example.org/api/week-info/?callback=***" > /tmp/week-info
``` ```
2. Make the script executable: 2. Make the script executable:

4
shared/tests/config/base_test.py
View File

@ -36,7 +36,7 @@ class FixtureConfig(BaseConfig):
FIXTURE_CONFIG_RAW = """ FIXTURE_CONFIG_RAW = """
public_url: http://libretime.example.com/ public_url: http://libretime.example.org/
api_key: "f3bf04fc" api_key: "f3bf04fc"
allowed_hosts: allowed_hosts:
- example.com - example.com
@ -81,7 +81,7 @@ def test_base_config(tmp_path: Path):
): ):
config = FixtureConfig(config_filepath) config = FixtureConfig(config_filepath)
assert config.public_url == "http://libretime.example.com" assert config.public_url == "http://libretime.example.org"
assert config.api_key == "f3bf04fc" assert config.api_key == "f3bf04fc"
assert config.allowed_hosts == ["example.com", "sub.example.com"] assert config.allowed_hosts == ["example.com", "sub.example.com"]
assert config.database.host == "localhost" assert config.database.host == "localhost"