From 22e57e2a8b9d371202c55e60221be8199582c79c Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 27 May 2020 09:39:33 -0400 Subject: [PATCH] @paddatrapper changes --- docs/_data/nav.yml | 6 +----- docs/contribute.md | 7 +++++++ docs/dashboard.md | 2 -- docs/hd-audio-modules.md | 5 ++--- docs/icecast-shoutcast.md | 5 ++++- docs/interface-customization.md | 7 +++++-- docs/live-broadcast.md | 6 +++++- docs/quickstart.md | 28 ++++++++++++++++++++++++++-- docs/ssl-config.md | 3 ++- docs/uninstall.md | 6 ++++-- 10 files changed, 56 insertions(+), 19 deletions(-) diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index 7743deff1..1c11b746a 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -1,8 +1,6 @@ topnav: -- page: Install - url: quickstart - page: Docs - url: preparing-the-server + url: quickstart - page: Contribute url: contribute - page: Sponsor @@ -11,8 +9,6 @@ topnav: docsnav: - section: Install contents: - - page: 0. Preparing the Server - url: preparing-the-server - page: 1. Quick Install url: quickstart - page: 2. Host Configuration diff --git a/docs/contribute.md b/docs/contribute.md index da3bcd2a7..bf499eacf 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -24,6 +24,13 @@ Have an idea that would make LibreTime even better than it is right now? Start a LibreTime can run in over 15 different languages due to the gracious help of our volunteers. Is your language not supported? Follow [this guide](interface-localization) to add your language to LibreTime! +## Help write documentation for LibreTime + +Our site is now run by Jekyll. After cloning our repo locally, enter the `/docs` directory and run +``` +jekyll serve +``` + ## Help write code for LibreTime Are you familar with coding in PHP? Have you made projects in Liquidsoap and some of the other services we use? diff --git a/docs/dashboard.md b/docs/dashboard.md index a227dff9c..08f6e5597 100644 --- a/docs/dashboard.md +++ b/docs/dashboard.md @@ -80,8 +80,6 @@ To cancel the current show completely, click the red button to the right again. A pop-up window will ask you to confirm the cancellation, as this action cannot be undone. -![](img/cancel-show.png) - Items which are no longer available have an exclamation mark icon in the second column. This may happen for media files which were part of previous shows, and were removed from LibreTime's library (main storage or watched folders) diff --git a/docs/hd-audio-modules.md b/docs/hd-audio-modules.md index 68214f18f..dd6fdf7e5 100644 --- a/docs/hd-audio-modules.md +++ b/docs/hd-audio-modules.md @@ -1,9 +1,8 @@ --- -sidebar: appendix +layout: docs +title: HD Audio Modules --- -# HD Audio Modules - This listing is provided to help ensure that the correct model parameter is passed to the ALSA kernel module for an Intel HDA soundcard, if one is fitted to your LibreTime server. See the chapter *Preparing the server* in this book for more details. Model name Description diff --git a/docs/icecast-shoutcast.md b/docs/icecast-shoutcast.md index f1d88cc29..341c24261 100644 --- a/docs/icecast-shoutcast.md +++ b/docs/icecast-shoutcast.md @@ -1,4 +1,7 @@ -# Icecast and Shoutcast stream configuration +--- +layout: docs +title: Icecast and Shoutcast Stream Configuration +--- LibreTime supports direct connection to two popular streaming media servers, the open source **Icecast** () and the proprietary **SHOUTcast** (). Apart from the software license, the main difference between these two servers is that Icecast supports simultaneous MP3, AAC, Ogg Vorbis or Ogg Opus streaming from LibreTime, whereas SHOUTcast supports MP3 and AAC streams but not Ogg Vorbis or Opus. The royalty-free Ogg Vorbis format has the advantage of better sound quality than MP3 at lower bitrates, which has a direct impact on the amount of bandwidth that your station will require to serve the same number of listeners. Ogg Opus also benefits from good sound quality at low bitrates, with the added advantage of lower latency than other streaming formats. Opus is now an IETF standard () and requires Icecast 2.4 or later to be installed on the streaming server. diff --git a/docs/interface-customization.md b/docs/interface-customization.md index 9f1ecce56..6dc1c09a1 100644 --- a/docs/interface-customization.md +++ b/docs/interface-customization.md @@ -1,5 +1,8 @@ -Modifying the LibreTime interface ----------------------------------- +--- +layout: docs +title: Modifying the LibreTime interface +--- + The LibreTime administration interface, as a web application, is fully customizable using the same methods that you might use to modify a website. For instance, you may wish to increase certain font sizes or change the colours in the LibreTime interface to better suit staff users with impaired vision. To do this, open one of the CSS files in the */public/css/* directory under the LibreTime *DocumentRoot* directory in an editor such as **nano**: diff --git a/docs/live-broadcast.md b/docs/live-broadcast.md index 388bb2f62..c3ccdebb1 100644 --- a/docs/live-broadcast.md +++ b/docs/live-broadcast.md @@ -7,7 +7,11 @@ title: Broadcasting live with MIXXX or B.U.T.T. - [MIXXX](#mixxx) - [BUTT](#butt) -[![How to Livestream Your Show](http://img.youtube.com/vi/4GLsU9hPTtM/0.jpg)](https://www.youtube-nocookie.com/embed/4GLsU9hPTtM "How to Livestream Your Show") +# Video Tutorial + + + + This how to is intended for DJs using BUTT or MIXXX to stream to their LibreTime server with an external USB audio card setup to route a mixer and sound. diff --git a/docs/quickstart.md b/docs/quickstart.md index 31cf4e22f..eda555d77 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -81,10 +81,32 @@ After the install is completed, head to the IP address of the server LibreTime w to complete the welcome wizard. While not strictly necessary, it is recommended that you change the passwords prompted in the welcome wizard if you intend on accessing the server from the Internet. The welcome wizard will walk you through the rest of the installation process. -Congratulations! You've successfully set up LibreTime! - ## Post-install +### Services + +Once all of the services needed to run LibreTime are installed and configured, +it is important that the server starts them during the boot process, to cut down on downtime, especially in live enviornments. +Ubuntu 18.04 uses the `systemctl` command to manage services, so run the following commands to enable all +LibreTime-needed services to run at boot: + +``` +sudo systemctl enable libretime-liquidsoap +sudo systemctl enable libretime-playout +sudo systemctl enable libretime-celery +sudo systemctl enable libretime-analyzer +sudo systemctl enable apache2 +sudo systemctl enable rabbitmq-server +``` + +If an error is returned, try adding `.service` to the end of each command. For example: + +``` +sudo systemctl enable apache2.service +``` + +### User Permissions + If you plan to have LibreTime output analog audio directly from its server to a mixing console or transmitter, the `www-data` user needs to be added to the `audio` user group using the command below. @@ -92,6 +114,8 @@ the `www-data` user needs to be added to the `audio` user group using the comman sudo adduser www-data audio ``` +Congratulations! You've successfully installed LibreTime! + Now that the install is complete, use these guides to help you continue to set up your LibreTime server - [Host Configuration](host-configuration) diff --git a/docs/ssl-config.md b/docs/ssl-config.md index b2fd2dff8..4bcc74ca0 100644 --- a/docs/ssl-config.md +++ b/docs/ssl-config.md @@ -72,6 +72,7 @@ Using the following configuration for Apache 2.2 as a guide, replace *airtime.ex 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. +``` SSLEngine on SSLProtocol All -SSLv2 -SSLv3 @@ -113,6 +114,7 @@ On port 80, Apache's *alias* module is used to set a *Redirect permanent* for th Allow from all +``` Save the file with **Ctrl+O** and exit the **nano** editor with **Ctrl+X**. Then restart Apache with the command: @@ -136,4 +138,3 @@ If the users of your LibreTime server wish to avoid going through these steps, o Whether your certificate is self-signed or not, you will see browser security warnings whenever a https:// page is delivering unencrypted content, such as the stream from an Icecast server. In Firefox, an exclamation mark icon is displayed in the address bar of the **Listen** pop-up. -![](img/Screenshot549-unencrypted_warning.png) diff --git a/docs/uninstall.md b/docs/uninstall.md index 8bbb74307..904a604b0 100644 --- a/docs/uninstall.md +++ b/docs/uninstall.md @@ -1,5 +1,7 @@ -Uninstall LibreTime -------------------- +--- +layout: docs +title: Uninstall LibreTime +--- Hopefully it wasn't something that we did, but if you need to uninstall LibreTime for any reason, cd to the directory of the installer and run `sudo ./uninstall` and follow the prompts.