Merge pull request #1012 from zklosko/master

Updating Assorted Documentation

docs/database.md

@@ -21,14 +21,15 @@ Here are some brief instructions for how to get starting using it as a developer
 1. Download and install release from their [github page](https://github.com/workflowproducts/postage/releases/) - Additional instructions [here](https://github.com/workflowproducts/postage/) 
 2. Setup port-forwarding for the vagrant VM - check the VirtualBox Settings for the VM -> Network -> Advanced -> Port Forwarding -> Forward HostPort 5550 to GuestPort 5432
 3. Modify PostgreSQL to accept connections from outside localhost -> edit /etc/postgresql/VERSION#/main/postgresql.conf - uncomment and modify the listen_address to be `listen_addresses = '*' `you may also need to edit pg_hba.conf in the same directory and allow Ipv4 connections from your localhost. I modified it to all as security wasn't a concern.
-4. Setup a Postgres username/password for super user in Ubuntu etc use ```
+4. Setup a Postgres username/password for super user in Ubuntu etc use
 
+```
 sudo -u postgres psql postgres
 
 # \password postgres
-
-Enter new password: 
 ```
+Enter new password: 
+ 
 5. Startup Postage by running `postage` and edit the postage-connections.conf and set the port to 5550 and save it. Then type in the username postgres and password you set above.
 6. Launch and select the airtime database to view the copy running on your vagrant box. To see the data/schema in a particular table click Schemas->Tables->table_name and then DesignTable or EditData
 

docs/install.md

@@ -13,13 +13,15 @@ Recommendations:
 - Please review the release notes of the version you are planning on installing.
 
 Once you have downloaded and extracted LibreTime, run the installation script by navigating into the
-folder containing the LibreTime codebase, and run it's install script from the command line:
+folder containing the LibreTime codebase, and run its install script from the command line:
 
 ```
-sudo ./install
+sudo ./install -fiap
 ```
 
-By default, the installer will install and configure all dependencies.
+The installer will install and configure all dependencies only if the `-fiap` flag is added. If you would prefer to configure dependencies manually, omit the flag.
+
+A great tutorial video on how to install LibreTime is [here](https://www.youtube.com/watch?v=Djo_55LgjXE).
 
 ## Ubuntu Package
 LibreTime maintains amd64 .deb packages for Ubuntu 16.04 (Xenial) and 18.04
@@ -41,7 +43,7 @@ Installation in Debian 9 and other Linux distributions is possible, but these
 are less tested. Installation on Ubuntu 14.04.5 LTS (Trusty Tahr) is also working, but deprecated due to the
 fact that this version will reach its official end of life in April 2019.
 
-Plans are in the works for `.rpm` packages, as well as Docker and AWS images.
+Plans are in the works for `.rpm` packages, as well as Docker and AWS images. If you would like to try LibreTime in a Docker image, [odclive's (unofficial) image](https://hub.docker.com/r/odclive/libretime-docker) is a great place to start.
 
 Please note that the install script does not take care to ensure that any
 packages installed are set up in a secure manner. Please see the chapter on

docs/manual/dashboard/index.md

@@ -7,7 +7,7 @@ interface. Check the links to see information about the other sections which
 provide the content that can be scheduled.
 
 The **Scheduled Shows** page provides a view of the content your station is will
-playout, or has already played out, which defaults to showing the 24 hours
+playout, or has already played out, which defaults to showing the 3 hours
 ahead. This page also enables you to make last-minute changes to running shows.
 
 If you've only just installed LibreTime, there might not be any content shown

docs/manual/getting-started/index.md

@@ -68,14 +68,6 @@ password, contact details, language and time zone preferences. Click the
 
 ![](static/Screenshot470-User_settings.png)
 
-On the right of the Logout link, clicking the green check mark opens a pop-up
-window with information about the version of LibreTime installed. If your
-LibreTime installation is not the latest version available, the green check
-mark changes to a green upgrade arrow. Should your LibreTime installation get
-too far out of date, this arrow will change to a red exclamation mark.
-
-![](static/Screenshot543-Running_latest_version_250.png)
-
 Checking an Icecast server
 --------------------------
 

docs/manual/host-configuration/index.md

@@ -62,6 +62,21 @@ If you have changed the *base\_url*, *base\_port* or *base\_dir* setting in */et
     base_port = 80
     base_dir = /
 
+Apache max file size configuration
+----------------------------------
+
+By default, the maximum upload file size is 500 MB, which may not be large enough for some stations, especially if they are uploading prerecorded shows. The setting for this is located in */etc/apache2/sites-available/airtime.config*. Search for and update the following in megabytes:
+
+```
+; Maximum allowed size for uploaded files.
+upload_max_filesize = 40M
+
+; Must be greater than or equal to upload_max_filesize
+post_max_size = 40M
+```
+
+For quick reference, 1024 MB = 1 GB and 2048 MB = 2 GB, but most will be okay with rounding to the nearest thousand. After updating the config file, restart Apache by `sudo systemctl apache restart`.
+
 
 Playout and recorder settings
 -----------------------------

docs/manual/interface-customization/index.md

@@ -1,3 +1,6 @@
+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**:
 
     sudo nano /usr/share/airtime/public/css/styles.css
@@ -16,6 +19,24 @@ Save the file with **Ctrl+O**, then refresh your browser to see the change to th
 
 Any custom changes that you make to the administration interface should be backed up before upgrading LibreTime to a newer version, otherwise they could be overwritten. If you have made improvements that you think might be useful to other LibreTime users, please contact LibreTime and tell us about them.
 
+Modifying the LibreTime Radio Page
+-----------------------------------
+
+The background of the mini-site that appears when you visit the server's domain in your web browser can be changed by modifying the page's CSS file, located at */usr/share/airtime/php/airtime_mvc/public/css/radio-page/radio-page.css*.
+
+```
+html {
+    background: url("img/background-testing-3.jpg") no-repeat center center fixed;
+    -webkit-background-size: cover;
+    -moz-background-size: cover;
+    -o-background-size: cover;
+    background-size: cover;
+    overflow-y: auto;
+}
+```
+
+Place the new background image in the */usr/share/airtime/public/css/radio-page/img/* folder and change the `background:` entry's URL to point to the new image. The new image should be at least 1280 x 720 in pixel size to avoid being blurry.
+
 Modifying the Icecast interface
 -------------------------------
 

docs/manual/playlists/index.md

@@ -1,13 +1,7 @@
 Creating a new playlist
 -----------------------
 
-Once you have found the media that you require using the search tools, you can create a new playlist on the right hand side of the **Library** page. If it is not already open, click the **Open Media Builder** button to begin.
+You can create a new playlist on the toolbar of the **Playlists** page.
-
-![](static/Screenshot500-Open_media_builder_240.png)
-
-Then click the **New** button and select **New Playlist** from the pop-up menu.
-
-![](static/Screenshot434-New_playlist.png)
 
 At first, the new playlist will be shown as *Untitled Playlist*. Click the pencil icon on the right to give the playlist a name.
 
@@ -34,7 +28,7 @@ You can also select or deselect a whole page of search results using the **Selec
 
 After adding files to the playlist, the total playlist time is displayed in the top right corner. The duration of an individual file is shown in each row of the playlist in a white font, and beneath this figure the time since the beginning of the playlist is displayed in a smaller light grey font. This elapsed time figure can be used as a time check for voice tracks, although this option may limit the re-usability of the voice track.
 
-To audition a playlist file in your web browser, click the white triangle**** button on the left side of its row. (If the format of the file is not supported by your browser, the triangle in this button will be greyed out). If audition of the file format is supported, a pop-up window will open, with the playlist starting at the file you clicked.
+To audition a playlist file in your web browser, click the white triangle button on the left side of its row. (If the format of the file is not supported by your browser, the triangle in this button will be greyed out). If audition of the file format is supported, a pop-up window will open, with the playlist starting at the file you clicked.
 
 Click the small white **x** icon on the right hand side of each row to remove a file from the playlist. You can also drag and drop files to re-order them, or click the **Shuffle** button to re-order files automatically. Click the **Clear** button to remove all content from the playlist, or click the **Delete** button to remove the playlist from the LibreTime library altogether.
 
@@ -44,24 +38,6 @@ To adjust start and end fades, click the playlist **Fade** button (two horizonta
 
 ![](static/Screenshot507-Fade_in_out_240.png)
 
-Click any one of the smaller **Fade** buttons between file rows to open another beige bar, which enables you to set **Fade out** and **Fade in** durations between two adjacent files in the playlist. The fade buttons for adjacent files change to an orange background when you click them.
-
-![](static/Screenshot508-Adjacent_fade_out_in_240.png)
-
-If your web browser supports the Web Audio API, you will see a **Show Waveform** button which enables you to view the waveforms of the adjacent items, adjust the fades and audition them. Click the **Fade Out** or **Fade In** button to change the fade curves by clicking in the waveforms, then click the **Play** button to audition the effect of any adjustment you have made. To audition just one part of the item, use the **Cursor** button to move the play cursor, which appears as a thin red line, on the waveform. The playback progress is shown by an orange colour on the waveform.
-
-![](static/Screenshot509-fade_editor_240.png)
-
-Each file in the playlist also has a button with two square brackets, which enables you to adjust **Cue In** and **Cue Out** times for that particular file. Like the fade button, the cue button changes to an orange background when you click it.
-
-**Cue In** and **Cue Out** points are set in hours, minutes, seconds and tenths of a second, relative to the start of the item. If a file has leading or trailing silence, corresponding cue points will be set automatically. The duration of the file in the playlist is updated automatically when you adjust a cue point, but the **Original Length** of the file is also displayed for your reference.
-
-![](static/Screenshot510-Cue_in_out_240.png)
-
-If a **Fade In** and **Cue In** are set on the same item in the playlist, the fade in begins at the **Cue In** point. If a **Fade Out** and **Cue Out** are set on the same item, the fade out ends at the **Cue Out** point. If your web browser supports the Web Audio API, you can click the **Show Waveform** button to adjust and audition cue points.
-
-![](static/Screenshot511-Visual_cue_editor_240.png)
-
 When your playlist is complete, click the **New** button in the top left corner to create another playlist, click the close icon (a white cross in a black circle) in the top right corner, or browse to another page of the LibreTime interface.
 
 If you want to edit the playlist content or metadata later, you can find it by **Title**, **Creator**, **Last Modified** date, **Length**, **Owner** or **Year** using one of the search tools on the Library page. Click the playlist in the search results list, and then click **Edit** from the pop-up menu. You can also **Preview** the entire playlist in a pop-up audition window, **Duplicate** or **Delete** one of your playlists from this menu.

docs/manual/podcasts/index.md

@@ -1,6 +1,6 @@
 The Podcasts page allows you add subscriptions to podcasts which are often used to syndicated audio files using a URL called a RSS feed. This allows your LibreTime instance to automatically download new shows from the web.
 
-In order to add a podcast you need to get the RSS feed. All podcasts available on iTunes have a RSS feed but it is sometimes hidden. See this issue on our github page[#510](https://github.com/LibreTime/libretime/issues/510)for more information.
+In order to add a podcast you need to get the RSS feed. All podcasts available on iTunes have a RSS feed but it is sometimes hidden. See this issue on our github page [#510](https://github.com/LibreTime/libretime/issues/510) for more information. RSS feeds that do not end in *.xml* may be accepted by LibreTime but might fail to download episodes; in that case, download the episode using a podcast client such as [gpodder](https://gpodder.github.io/) and then manually upload and schedule the episode. Podcast feeds coming from Anchor.fm have been known to have this issue.
 
 The podcast interfaces provides you with the ability generate [Smartblocks](../smartblocks) that can be used in conjunction with [Autoloading Playlists](../calendar/#autoloading-playlist) to schedule the newest episode of a podcast without human intervention.
 

docs/manual/smartblocks/index.md

@@ -2,9 +2,9 @@
 Creating a smart block
 ----------------------
 
-Smart blocks are automatically filled with media files from the LibreTime library, according to the criteria that you specify. This feature is intended to save staff time, compared to selecting items for a playlist manually.
+Smart blocks are automatically filled with media files from the LibreTime library, according to the criteria that you specify. This feature is intended to save staff time, compared to selecting items for a playlist manually, and can be used to schedule shows that operate in a consistent format.
 
-To create a smart block, click the **New** button on the right side of the Library page, and select **New Smart Block** from the pop-up menu. Like a playlist, smart blocks can have a title and **Description**, which you can edit. This helps you find relevant smart blocks in searches.
+To create a smart block, click the **Smartblocks** button on the left sidebar, and select **New** from the toolbar. Like a playlist, smart blocks can have a title and description, which you can edit. This helps you find relevant smart blocks in searches.
 
 ![](static/Screenshot512-Example_smart_block_240.png)
 
@@ -30,7 +30,7 @@ By default, a smart block will not contain repeated items, which will limit the
 
 In addition Smart Blocks by default will never overflow the Time Limit. For instance if you set a time limit of 1 hour. It will add tracks to the schedule until it can't add any more tracks without exceeding the hour. This is to prevent tracks from being cut-off because they exceed the time limit of a show. 
 
-If you want a smartblock to schedule tracks until it is longer than the Time Limit you can check "Allow last track to exceed time limit". This will make LibreTime add tracks that meet the criteria until it equals or is longer than the time limit. The was the default behaviour with the LibreTime software.
+If you want a smartblock to schedule tracks until it is longer than the Time Limit you can check "Allow last track to exceed time limit". This will make LibreTime add tracks that meet the criteria until it equals or is longer than the time limit. This is helpful for avoiding dead air on shows that are being autoscheduled.
 
 If you have a large number of files which meet the criteria that you specify, you may wish to limit the duration of the smart block using the **Limit to** field, so that it fits within the show you have in mind. Select **hours**, **minutes** or **items** from the drop-down menu, and click the **Generate** button again, if it is a static smart block. Then click the **Save** button.
 
@@ -38,5 +38,4 @@ Smart blocks can be added to shows in the same way as a manually created playlis
 
 ![](static/Screenshot515-Expand_static_smart_block.png)
 
-Once created, smart blocks can be found in Library searches and refined at any time. They can be re-opened by clicking on the smart block and selecting **Edit** from the pop-up menu.
+Once created, smart blocks can be found under the Smartblocks tab and refined at any time. They can be re-opened by right-clicking on the smart block and selecting **Edit** from the pop-up menu.
-

docs/manual/stream-settings/index.md

@@ -1,5 +1,9 @@
 *Note* LibreTime installed via the install script does not currently change the default Icecast password and is insecure without intervention by the system admin. There is a [tutorial](https://github.com/LibreTime/libretime/wiki/Securing-icecast-and-customizing-stream-settings) on our wiki that walks you through the steps of how to fix this and an open issue [#86](https://github.com/LibreTime/libretime/issues/86) to track resolution of this. 
 
+
+Global settings
+------------------------
+
 You can configure direct Icecast and SHOUTcast streams and sound card output by clicking **Streams** on the **System** menu.
 
 At the top left of the **Stream Settings** page are global settings including **Hardware Audio Output**, which enables playout from the default sound card on the server, if one is fitted. The default **Output Type** of *ALSA* on the drop-down menu will be suitable for most servers with a sound card. If not, you have the option to choose from other Liquidsoap interfaces available, such as *OSS* or *PortAudio*.

docs/manual/upload/index.md

@@ -9,8 +9,9 @@ Some web browsers may set an upload limit for a single file, between 200MB and
 2GB. In addition the default LibreTime webserver configuration limits file size
 to 500M.  If you need to upload files larger than 500MB to the LibreTime server
 on a regular basis, you will need to have your admin update the configuration at
-`/etc/apache2/sites-available/airtime.conf `. Airtime previously supported
+`/etc/apache2/sites-available/airtime.conf` (see [here](../host-configuration/index.md)). 
-import via SFTP but this functionality is still under development for LibreTime.
+Airtime previously supported import via SFTP but this functionality is still under
+development for LibreTime.
 
 ![](static/upload-files-dialog.png)
 

docs/manual/webstreams/index.md

@@ -8,3 +8,5 @@ To add a web stream, click the **New** button on the right side of the Library p
 ![](static/Screenshot516-New_remote_webstream.png)
 
 The **Stream URL** setting must include the *port number* (such as 8000) and *mount point* (such as remote\_stream) of the remote stream, in addition to the streaming server name. A **Default Length** for the remote stream can also be set. If the stream is added at the end of a show which becomes overbooked as a result, it will be faded out when the show ends.
+
+Note: LibreTime checks the remote webstream's status upon editing stream settings, so an offline stream will result in an error. There are many tools such as [BUTT](https://danielnoethen.de/butt/) and [MIXXX](https://www.mixxx.org) that can be used to send a test stream to LibreTime can save it; read more [here](../live-shows-with-mixxx/index.md).