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

More changes as per @paddatrapper

This commit is contained in:
Zachary Klosko 2020-05-16 10:17:31 -04:00
parent fea6a91b81
commit 2b27850f29
14 changed files with 81 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/calendar.md
View File

@ -124,10 +124,10 @@ Removing content from a show
To remove an individual item from a show, click on the show in the **Calendar**, and select **Schedule Tracks** from the pop-up menu. In the window which opens, click any item you wish to remove from the show, then click **Delete** on the pop-up menu, or check the box in the item's row then click the **Remove** icon at the top of the table. To remove all files and playlists from a show, click on the show in the **Calendar**, and select **Clear Show** from the pop-up menu. 
Deleting a forthcoming show
Deleting a upcoming show
---------------------------
To delete one forthcoming instance of a repeating show, click on the show in the **Calendar**, and select **Delete**, then **Delete Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete Instance and All Following** from the pop-up menu.
To delete an upcoming instance of a repeating show, click on the show in the **Calendar**, and select **Delete**, then **Delete Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete Instance and All Following** from the pop-up menu.
![](img/Screenshot490-Delete_this_instance.png)

18
docs/features.md
View File

@ -3,13 +3,13 @@
[LibreTime](http://libretime.org/ "LibreTime homepage") is the open broadcast
software for scheduling and remote station management. Web browser access to
the station's media library, multi-file upload and automatic metadata import
features are coupled with a collaborative on-line scheduling calendar and
features are coupled with a collaborative online scheduling calendar and
playlist management. The scheduling calendar is managed through an easy-to-use
interface and triggers playout with sub-second precision.
![](img/Screenshot540-Now_playing_250.png)
LibreTime has been intended to provide a solution for a wide range of broadcast
LibreTime is intended to provide a solution for a wide range of broadcast
projects, from community to public and commercial stations. The scalability of
LibreTime allows implementation in a number of scenarios, ranging from an
unmanned broadcast unit accessed remotely through the Internet, to a local
@ -30,8 +30,8 @@ line input. News editors, DJs and station controllers can use LibreTime to
build playlists or smart blocks and manage media files (upload, edit metadata,
manage advertisements) at the station or via the Internet.
The scheduler in LibreTime has a calendar view, organized by months, weeks and
days. Here the program editors can schedule playlists and shows for their
The scheduler in LibreTime has a calendar view, organized by months, weeks or
days. Program editors can schedule playlists and shows here for their
broadcast station. In some scenarios, the transmitter is situated outside the
reach of the broadcaster and all program management has to be maintained
through the web interface. Possible reasons for this scenario might be of a
@ -44,12 +44,12 @@ LibreTime services
| Service | Description |
|---------|-------------|
| `media-monitor` | Keeps track of files being added, renamed, moved or removed from storage, and reads their metadata using the Mutagen library. |
| `airtime-analyzer` | Keeps track of files being added, renamed, moved or removed from storage, and reads their metadata using the Mutagen library. |
| [PostgreSQL](https://www.postgresql.org/) | Contains the location of those media files and their metadata. This means you can search for and playlist a set of media files according to the specific metadata that you require, or use a 'smart block' to select the files for you. The database also contains details of specified remote input streams. |
| Pypo | (Python Playout engine) Downloads media from the storage up to 24 hours ahead of playout and checks it for average level (with ReplayGain tools) and leading or trailing silence (with Silan). At playout time, the media to be broadcast is sent to Liquidsoap. |
| [Liquidsoap](https://www.liquidsoap.info/) | Takes individual media files and remote input streams, and assembles them into a continuous output stream. This stream can be sent to a sound card (e.g. for a broadcast mixer, on the way to an FM or DAB transmitter) or to a streaming server for IP network distribution, over the LAN, local WiFi or the Internet. You can stream to a sound card and up to three different stream distribution servers with the same LibreTime server, if you wish. |
| [Icecast](https://www.icecast.org/) or [Shoutcast](https://shoutcast.com/) | Audio streaming server, used for creating an internet radio stream from LibreTime. Icecast is included in the LibreTime installation by default. Note: If a suitable Liquidsoap output is not available for your streaming service of choice, you can send audio from Liquidsoap to a separate encoding or streaming machine via a sound card or relay stream. |
| [Monit](https://mmonit.com/monit/) | Monitors the health of pypo, media-monitor and Liquidsoap, and reports the status of these services to LibreTime. |
| [Monit](https://mmonit.com/monit/) | Monitors the health of pypo, airtime-analyzer and Liquidsoap, and reports the status of these services to LibreTime. |
| [RabbitMQ](https://www.rabbitmq.com/) | Pushes messages from LibreTime to media-monitor and pypo about changes to media files and the playout schedule. |
Types of user accounts
@ -67,7 +67,7 @@ Create different accounts for your staff by role, to give them only the permissi
- Preview uploaded media _without_ affecting the live playout
- Create Playlists, Smart Blocks, and connect Podcasts and Webstreams to LibreTime
- Publish media items to LibreTime's built-in My Podcast function or 3rd party sources such as Soundcloud
* Program Directors
* Program Managers
- Everything DJs can do, plus
- Manage other users' libraries in addition to their own
- Create, edit, and delete color-coded shows on the Calender and assign them to DJs (if needed)
@ -75,10 +75,10 @@ Create different accounts for your staff by role, to give them only the permissi
- View listener statistics
- Export playout logs for analysis or reporting for music royalties
* Administrators
- Everything Program Directors can do, plus
- Everything Program Managers can do, plus
- Manage all user accounts, including the ability to reset passwords
- Configure Track Types for easy sorting of uploaded content
- Change system and system settings, in addition to monitoring the system status
- Change system settings
Example studio broadcast system
-------------------------------

2
docs/general-settings.md
View File

@ -48,7 +48,7 @@ default.
You can enable live, read-only access to the LibreTime schedule calendar for
your station's public website with the **Public LibreTime API** option, if you
wish. (There is more about this feature in the
[*Exporting the schedule*](../exporting-the-schedule/index.md) chapter, in the
[*Exporting the schedule*](exporting-the-schedule) chapter, in the
*Advanced Configuration* section of this book).
The **Allowed CORS URLs** is intended to deal with situations where you want a

0
docs/hd-audio-moduels.md → docs/hd-audio-modules.md
View File

8
docs/install.md
View File

@ -5,10 +5,6 @@
[Quick Install](quickstart). Please complete the [Preparing the server](preparing-the-server) and
[Setting the server time](manual/setting-the-server-time/index) guides before proceeding.
## Reverse proxy connections
Instuctions for setting up a reverse proxy can be found [here](reverse-proxy).
## Ubuntu Package
LibreTime maintains amd64 .deb packages for Ubuntu 16.04 (Xenial) and 18.04
(Bionic). These can be downloaded using their PPA in apt or your favorite package manager.
@ -36,6 +32,10 @@ If you would like to try LibreTime in a Docker image,
Odclive has instructions [here](https://github.com/kessibi/libretime-docker) for setting up a test image
and a more persistant install.
## Reverse proxy connections
Instuctions for setting up a reverse proxy can be found [here](reverse-proxy).
## Manual configuration
If you need to manually configure dependencies or services for LibreTime, below is a list of the options

9
docs/manual.md
View File

@ -1,4 +1,5 @@
# Tutorials
Manual
------
This page contains links to number of tutorials.
Please provide any feedback on this [discourse forum post](https://discourse.libretime.org/t/new-tutorials-available-on-libretime-wiki/270/2).
@ -12,10 +13,8 @@ There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/use
* [Smart Blocks](smartblocks)
* [Webstreams](webstreams)
* [Podcasts](podcasts)
* My Podcast (coming soon)
* [Radio Page](radio-page)
* [Calendar](calendar)
* Widgets (coming soon)
* Settings
* [General](general-settings)
* [Users](users)
@ -38,8 +37,8 @@ There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/use
* [How to set up an automatic top of the hour ID with intro playlist feature](intro-playlist)
* [How to setup a Auto DJ to play music from certain genres for unscheduled shows](autodj)
* [Preventing dead air between shows without cutting off tracks](outro-playlist)
* [How to schedule automatic underwriting/advertising announcements](https://www.youtube.com/watch?v=F7rMut7Trb4)
* [How to schedule a repeating webstream with a linked show](https://www.youtube.com/watch?v=Ha3X6aYdY04)
* [How to schedule automatic underwriting/advertising announcements (YouTube)](https://www.youtube.com/watch?v=F7rMut7Trb4)
* [How to schedule a repeating webstream with a linked show (YouTube)](https://www.youtube.com/watch?v=Ha3X6aYdY04)
* [How to export a schedule of played tracks](exporting-the-schedule)
## For Server Administrators

15
docs/multipass.md
View File

@ -1,11 +1,7 @@
# Testing LibreTime with Canonical's Multipass
Ever wanted to test out LibreTime but didn't want to tango with
Virturalbox, Vagrent, or Docker?
![](https://thumbs.gfycat.com/HauntingDirtyDragon-size_restricted.gif)
Canonical released [Multipass](https://multipass.run), a tool for setting up Ubuntu VMs with cloud-init files in a snap.
Virturalbox, Vagrent, or Docker? Canonical released [Multipass](https://multipass.run), a tool for setting up Ubuntu VMs with cloud-init files in a snap.
Multipass is available for Windows and macOS, as well as Linux OSes that support snaps.
Similar to Docker, Multipass works through a CLI. To use, clone this repo and then open a Terminal
@ -15,16 +11,11 @@ multipass launch bionic -n ltTEST --cloud-init libretimeTest.yaml # to launch V
multipass shell ltTEST # to enter VM's shell
```
And that's it! At the moment, Multipass isn't patient enough for an automated install,
so after you enter the shell for the first time, you will still need to run the install script for LibreTime.
Due to a known bug, Multipass is not able to perform the entire install using the cloud-init file.
Run the LibreTime installer and follow the welcome wizard in your web browser.
```
sudo ./libretime/install -fiap
sudo service airtime-liquidsoap start
sudo service airtime-playout start
sudo service airtime-celery start
sudo service airtime_analyzer start
```
The IP address of your new VM can be found by running `multipass list`.

7
docs/podcasts.md
View File

@ -4,7 +4,7 @@ The Podcasts page allows you add subscriptions to podcasts which are often used
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 to 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.
The podcast interfaces provides you with the ability to 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.
### Video Tutorials
- [How to schedule a podcast to play the latest episode automatically](https://www.youtube.com/watch?v=g-4UcD8qvR8)
@ -15,8 +15,7 @@ Dashboard
![](img/Podcasts_Dashboard.png)
The podcasts dashboard is similar to the tracks view, allowing you to add, edit, and remove
podcasts by the toolbar, in addition to sorting by columns. Podcast feeds themselves cannot be searched (ie. to
search for _Background Briefing_, as per the screenshot).
podcasts by the toolbar, in addition to sorting by columns.
To add a podcast, click on the **+ Add** button on the toolbar and provide the podcast's RSS feed, which usually ends in *.xml*.
Once the podcast's feed is recognized, the editor pane opens for the podcast.
@ -31,4 +30,4 @@ A search box is available to search for episodes within the feed.
- To import an episode directly into LibreTime, double-click on an episode or select it and click **+ Import**. The podcast will appear under tracks with the Podcast Name as the Album.
- To delete an episode from LibreTime, select the episode and click on the red trash can on the toolbar.
- If you would like LibreTime to automatically download the latest episodes of a podcast, make sure *Download latest episodes* is checked. This can be used in conjunction with Smartblocks and Playlists to automate downloading and scheduling shows that are received via. podcast feed.
- If you would like LibreTime to automatically download the latest episodes of a podcast, make sure *Download latest episodes* is checked. This can be used in conjunction with Smartblocks and Playlists to automate downloading and scheduling shows that are received via podcast feed.

32
docs/quickstart.md
View File

@ -13,6 +13,7 @@ to full internet radio station in 10 minutes!
## Preparing the server
Configure the server to have a static IP address by modifying the Netplan configuration.
If you're using a cloud VM, you likely already have a static IP address. Check with your provider to confirm this.
```
cd /etc/netplan && ls # find the netplan filename
@ -33,7 +34,6 @@ network:
addresses: [192.168.88.8/24]
gateway4: 192.168.88.1
nameservers:
search: [lan]
addresses: 192.168.88.1
```
@ -45,13 +45,21 @@ sudo ufw allow 80/tcp
sudo ufw allow 8000/tcp
```
If you plan on broadcasting live with Libretime, also unblock ports 8001 and 8002.
```
sudo ufw enable 8001/tcp
sudo ufw enable 8002/tcp
```
## Installing LibreTime
Installing LibreTime consists of running two commands in the terminal:
Installing LibreTime consists of running these commands in the terminal:
```
git clone https://github.com/LibreTime/libretime.git
sudo ./libretime/install -fiap
cd libretime
sudo ./install -fiap
```
After the install is completed, head to the IP address of the server LibreTime was just installed on
@ -96,17 +104,27 @@ into the playlist.
![](img/Screenshot562-Drag_show_content.png)
Keep in mind the bar at the end of your show's playlist. It will show the amount of time your show is under- or
overscheduled. Shows that are underscheduled will have dead air at the end and shows that are overscheduled
The bar at the end of the show's playlist will show the amount of time the show is underscheduled or overscheduled.
Shows that are underscheduled will have dead air at the end and shows that are overscheduled
will fade out exactly when the show is over (the orange colored entry), meaning tracks scheduled to start
after this point will not play (dark red colored entries). Click the **Ok** button in the bottom right to save.
Show playback will start and end as per each show's start and end times, allowing you to rely completely on
LibreTime for running your station or using LibreTime as a part of your live setup to cover when DJs are not present.
When media is playing back, the **On Air** indicator at the top will turn red.
When media is playing, the **On Air** indicator at the top will turn red.
![](img/on-air-status.png)
You can listen to your stream by going to `yourserverIP:8000` or by clicking the **Listen** button under the On Air
indicator. Congratulations! You've successfully set up LibreTime! We're so proud of you. :)
indicator.
Congratulations! You've successfully set up LibreTime!
## Next Steps
Now that the install is complete, use these guides to help you continue to set up your LibreTime server
- [Host Configuration](host-configuration)
- [Setting the Server Time](setting-the-server-time)
- [Configuring Track Types](track-types)
- [Setting up SSL](ssl-config)

2
docs/radio-page.md
View File

@ -23,4 +23,4 @@ Tracks published wind up here, and can be played back on-demand. This is a great
![](img/radio-altbkgnd.png)
The background of the radio page can be changed; see instructions [here](../interface-customization/index.md). Image comes from [CATS ON SYNTHESIZERS IN SPACE](https://www.catsonsynthesizersinspace.com/).
The background of the radio page can be changed; see instructions [here](interface-customization). Image comes from [CATS ON SYNTHESIZERS IN SPACE](https://www.catsonsynthesizersinspace.com/).

4
docs/reverse-proxy.md
View File

@ -6,7 +6,7 @@ makes extensive use of its API for some site functionality, which causes
[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
to occur. By default, CORS requests are blocked by your browser and the origins
need to be added to the **Allowed CORS URLs** block in
[**General Settings**](/manual/general/index). These origins should include any
[**General Settings**](general-settings). These origins should include any
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
@ -38,7 +38,7 @@ Nginx set up on `proxy` and LibreTime will be installed on `libretime`. You will
access on both. `libretime` also needs to be able to be accessed from `proxy`
(`ping libretime` on `proxy`).
On `libretime`, install LibreTime as described in the [install guide](../install). In short
On `libretime`, install LibreTime as described in the [install guide](install). In short
this means run the following commands:
```

14
docs/status.md
View File

@ -1,9 +1,17 @@
# The Status page
On the **Settings** menu, the **Status** page provides an overview of the health and resource usage of the various services that make up a LibreTime system. If all is well, you will only see green check mark icons in the **Status** column. This page also shows how much **Disk Space** you have used on the disk partition containing the main Import folder, as well as any disks or partitions with watched folders.
On the **Settings** menu, the **Status** page provides an overview of the health and resource usage of the various
services that make up a LibreTime system. If all is well, you will only see green check mark icons in the
**Status** column. This page also shows how much **Disk Space** you have used on the disk partition containing
the main Import folder, as well as any disks or partitions with watched folders.
![](img/Screenshot521-System_status_240.png)
If any of the check mark icons in the **Status** column have changed to a red warning sign, contact your system administrator for assistance. (The chapter [Troubleshooting](../troubleshooting/index.md) contains some tips). LibreTime will do its best to restart any failing services, but sometimes manual intervention may be required; for example, in the case of hardware failure.
If any of the check mark icons in the **Status** column have changed to a red warning sign, contact your system
administrator for assistance. (The chapter [Troubleshooting](troubleshooting) contains some tips). LibreTime will
do its best to restart any failing services, but sometimes manual intervention may be required; for example, in
the case of hardware failure.
If you have run out of storage space, a LibreTime user with *admin* privileges could log in and delete media files that are no longer required from the **Library**. Alternatively, you could move some files to a watched folder on another disk, or ask your system administrator to install additional storage capacity.
If you have run out of storage space, a LibreTime user with *admin* privileges could log in and delete media files
that are no longer required from the **Library**. Alternatively, you could move some files to a watched folder on
another disk, or ask your system administrator to install additional storage capacity.

6
docs/upload.md
View File

@ -9,7 +9,7 @@ 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` (see [here](../host-configuration/index.md)).
`/etc/apache2/sites-available/airtime.conf` (see [here](host-configuration)).
Airtime previously supported import via SFTP but this functionality is still under
development for LibreTime.
@ -37,9 +37,9 @@ again or contact your Admin to have them consult the logs and open up a bug
report. It sometimes takes a few minutes for files to be processed but if they
are all stuck at **Pending Import** then it is possible that the
*airtime_analyzer* process has crashed and the admin will need to restart it.
See [Troubleshooting](../troubleshooting) for more information. You can look
See [Troubleshooting](troubleshooting) for more information. You can look
specifically at any failed imports by clicking the radio button next to Failed.
Once they are done procesing your files ready to be included in your broadcast
playlists, smart blocks and shows and can be viewed in the [Tracks](../Tracks)
playlists, smart blocks and shows and can be viewed in the [Tracks](tracks)
section of the Library.

17
docs/users.md
View File

@ -19,10 +19,19 @@ Adding user accounts
To add further user accounts to the system, one for each of your station staff that need access to Airtime, click the **New User** button with the plus icon. Enter a user name, password and contact details, and then select the **User Type** from the drop down menu, which can be *Admin*, *Program Manager*, *DJ*, or *Guest*. The difference between these user types is:
- An *Admin* (station manager) has read and write access to all the features of Airtime. This role should be reserved for trusted staff members only. If you give the *Admin* role to too many people, there could be arguments at the station!
- A *Program Manager* has write access to the entire broadcast schedule, but cannot see the **System** menu and therefore cannot adjust Airtime preferences, manage user accounts, change media folder or stream settings, check the server status, or see the Listener Stats. A *Program Manager* can view the **History** menu and the Playout History page, but cannot edit History Templates. **
- A *DJ* (presenter) only has write access to features related to the specific shows assigned to them by an *Admin* or *Program Manager*. The *DJ* can read data for other shows in the **Calendar**, but not write to them. This read access to other shows helps staff plan their own shows, for instance avoiding the scenario where two DJs play the same music by coincidence. Like a *Program Manager*, a *DJ* cannot see the **System** menu when they log in, and cannot edit History Templates.
- A *Guest* can log in to read the forthcoming schedule or playlists, but has no write permission for any feature. *Guest* users cannot see the **Add Media**, **Library**, **System** or **History** menus when they log in. The group of guest users might include the station accountant, or the show assistants.
- An *Admin* (station manager) has read and write access to all the features of Airtime. This role should be
reserved for trusted staff members only. If you give the *Admin* role to too many people, there could be arguments
at the station!
- A *Program Manager* has write access to the entire broadcast schedule, but cannot see the **System** menu and therefore cannot adjust Airtime preferences, manage user accounts, change media folder or stream settings, check the server status, or see the Listener Stats. A
*Program Manager* can view the **History** menu and the Playout History page, but cannot edit History Templates.
- A *DJ* (presenter) only has write access to features related to the specific shows assigned to them by an
*Admin* or *Program Manager*. The *DJ* can read data for other shows in the **Calendar**, but not write to them.
This read access to other shows helps staff plan their own shows, for instance avoiding the scenario where two DJs
play the same music by coincidence. Like a *Program Manager*, a *DJ* cannot see the **System** menu when they log
in, and cannot edit History Templates.
- A *Guest* can log in to read the forthcoming schedule or playlists, but has no write permission for any
feature. *Guest* users cannot see the **Add Media**, **Library**, **System** or **History** menus when they log in.
The group of guest users might include the station accountant, or the show assistants.
Editing or deleting user accounts
---------------------------------