Congegni/sintonia
7
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

docs: rework docs into the new website

Browse source 
- multipass docs moved to local-dev.md
- add documentation to website
- rework fogotten files
- disable fogotten files

Co-authored-by: Zachary Klosko <zklosko@users.noreply.github.com>
This commit is contained in:
jo 2022-02-09 09:37:52 +01:00 • committed by Jonas L
parent 2fa10793ec
commit 6d9e7a6765
39 changed files with 698 additions and 721 deletions
Download patch file Download diff file Expand all files Collapse all files

16
docs/appendix/widgets.md
View file

@ -1,7 +1,5 @@
---
title: Widgets
category: interface
layout: article
---
Bring your Libretime broadcast to your website with embeddable widgets! Libretime comes with two widgets: a streaming player and a schedule. Both widgets use iframes to display and can be placed wherever embeddable code can on a website.
@ -10,9 +8,13 @@ Bring your Libretime broadcast to your website with embeddable widgets! Libretim
Before using the widgets, make sure Libretime's Public API is enabled in **Settings** > **General**.
![](/img/widgets_settings.png)
![](./widgets-widgets_settings.png)
> **Note:** Your Libretime instance needs to be accessible to the public _without the use of a VPN or SSH tunneling_ in order for the widgets to work.
:::tip Note
Libretime widgets cannot function through VPNs or SSH tunneling. The instance must be accessible from the internet for the widgets to work.
:::
## Streaming Player Widget
@ -20,12 +22,12 @@ The streaming player widget inserts your Libretime stream into your website. One
<iframe frameborder="0" width="400" height="235" src="http://broadcast.wcrsfm.org/embed/player?stream=auto&title=Now Playing"></iframe>
![](/img/widgets_player.png)
![](./widgets-widgets_player.png)
From **Widgets** > **Player**, enter a title for your streaming widget and select what stream you'd like to use. All selectible streams must first be configured in **Settings** > **Streams** (see [Settings](/docs/settings)). **Auto detect** should be fine for most.
From **Widgets** > **Player**, enter a title for your streaming widget and select what stream you'd like to use. All selectible streams must first be configured in **Settings** > **Streams** (see [Settings](/docs/guides/settings)). **Auto detect** should be fine for most.
## Show Schedule Widget
![](/img/widgets_schedule.png)
![](./widgets-widgets_schedule.png)
The show schedule widget displays the upcoming shows for the next seven days. There are no customizable settings for this widget.