diff --git a/docs/index.md b/docs/index.md index 4f3866d3a..f2da86c6a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -11,8 +11,13 @@ LibreTime is Free/Libre and Open Source Software (FLOSS). Among other things, th LibreTime is a fork of AirTime due to stalled development of the FLOSS version. For background on this, see this [open letter to the Airtime community](https://gist.github.com/hairmare/8c03b69c9accc90cfe31fd7e77c3b07d). +If you are end-user of an already installed LibreTime instance we have a number of [tutorials](manual/tutorials/index.md) that can help you learn how to use the software. -Getting Started +We also have [how-to guides](manual/howtos) that contain step-by-step instructions for various common tasks. + +There are currently no companies offering turn-key LibreTime hosting so if you are interested in running it you will need to have some familiarity with running a linux server. You can always reach out to help from the community at our [forum](http://discourse.libretime.org) + +Getting Started (for Developers and Admins) --------------- The easiest way to check out LibreTime for yourself is to run a local instance in a virtual machine. Assuming you already have Git, Vagrant and Virtualbox installed, just run: @@ -20,10 +25,9 @@ The easiest way to check out LibreTime for yourself is to run a local instance i ```bash git clone https://github.com/libretime/libretime.git cd libretime -vagrant up ubuntu-trusty +vagrant up ubuntu-bionic ``` If everything works out, you will find LibreTime on [port 8080](http://localhost:8080), icecast on [port 8000](http://localhost:8000) and the docs on [port 8888](http://localhost:8888). Of course, this setup isn't appropriate for production use. For that, check out our [installation instructions](install.md). More information on the vagrant setup are in [the docs](vagrant.md). - diff --git a/docs/manual/howtos/index.md b/docs/manual/howtos/index.md new file mode 100644 index 000000000..7d1ba343c --- /dev/null +++ b/docs/manual/howtos/index.md @@ -0,0 +1 @@ +How-To diff --git a/docs/manual/tutorials/autodj.md b/docs/manual/tutorials/autodj.md new file mode 100644 index 000000000..4eb9ba7dd --- /dev/null +++ b/docs/manual/tutorials/autodj.md @@ -0,0 +1,2 @@ +How to Setup Genre based AutoDJ - Youtube Video +[![How to Setup Genre based AutoDJ](http://img.youtube.com/vi/XNVIDnczrOk/0.jpg)](https://www.youtube-nocookie.com/embed/XNVIDnczrOk "How to Setup Genre based AutoDJ") diff --git a/docs/manual/tutorials/autoloading-podcast.md b/docs/manual/tutorials/autoloading-podcast.md new file mode 100644 index 000000000..271f88914 --- /dev/null +++ b/docs/manual/tutorials/autoloading-podcast.md @@ -0,0 +1,2 @@ +How to Set Up an Podcast to Play with Autoloading Playlist - Youtube Video +[![How to Set Up an Podcast to Play with Autoloading Playlist](http://img.youtube.com/vi/g-4UcD8qvR8/0.jpg)](https://www.youtube-nocookie.com/embed/g-4UcD8qvR8 "How to Set Up an Podcast to Play with Autoloading Playlist") diff --git a/docs/manual/tutorials/build-schedule.md b/docs/manual/tutorials/build-schedule.md new file mode 100644 index 000000000..651b09ea6 --- /dev/null +++ b/docs/manual/tutorials/build-schedule.md @@ -0,0 +1,2 @@ +How to Build Your Schedule - Youtube Video +[![Build Station Schedule](http://img.youtube.com/vi/EfNhl-yQcn8/0.jpg)](https://www.youtube-nocookie.com/embed/EfNhl-yQcn8 "How to build your schedule") diff --git a/docs/manual/tutorials/filler.md b/docs/manual/tutorials/filler.md new file mode 100644 index 000000000..b2bc748e5 --- /dev/null +++ b/docs/manual/tutorials/filler.md @@ -0,0 +1,2 @@ +How to Upload use Smartblocks to Fill Time Between Shows - Youtube Video +[![How to Upload use Smartblocks to Fill Time Between Shows](http://img.youtube.com/vi/kNT9R80Q42I/0.jpg)](https://www.youtube-nocookie.com/embed/kNT9R80Q42I "How to Upload use Smartblocks to Fill Time Between Shows ") diff --git a/docs/manual/tutorials/index.md b/docs/manual/tutorials/index.md new file mode 100644 index 000000000..116081652 --- /dev/null +++ b/docs/manual/tutorials/index.md @@ -0,0 +1,22 @@ +##Tutorials## + +This page contains links to number of screencast tutorials. +Please provide any feedback on this [discourse forum post](https://discourse.libretime.org/t/new-tutorials-available-on-libretime-wiki/270/2). +There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/user90812787) + +## DJ tutorials +* [How to upload and schedule tracks on your show](upload-tracks) +* [How to upload a promo](upload-promo) +* [How to livestream with butt](livestream.md) +## Program Manager tutorials +* [Building a schedule](build-schedule.md) +* [How to set up an automatic top of the hour ID with intro playlist feature](top-of-hour-id.md) +* [How to schedule a podcast to play the newest episode on an automatic basis](autoloading-podcast.md) +* [How to setup a Auto DJ to play music from certain genres for unscheduled shows](autodj.md) +* [Preventing dead air between shows without cutting off tracks](filler.md) +* [How to schedule automatic underwriting/advertising announcements](underwriting.md) +* [How to schedule a repeating webstream with a linked show](webstream-link.md) +## Admin tutorials +* [Installing LibreTime from Git on a stand-alone VPS](install-vps.md) +* [Securing icecast and customizing stream settings ](stream-settings.md) +* [How to install player and calendar widgets on your website](widgets.md) diff --git a/docs/manual/tutorials/install-vps.md b/docs/manual/tutorials/install-vps.md new file mode 100644 index 000000000..5808b0e8b --- /dev/null +++ b/docs/manual/tutorials/install-vps.md @@ -0,0 +1,2 @@ +How to Install LibreTime on a VPS- Youtube Video +[![How to Install LibreTime on a VPS](http://img.youtube.com/vi/Djo_55LgjXE/0.jpg)](https://www.youtube-nocookie.com/embed/Djo_55LgjXE "How to Install LibreTime on a VPS") diff --git a/docs/manual/tutorials/livestream.md b/docs/manual/tutorials/livestream.md new file mode 100644 index 000000000..8be7f89b8 --- /dev/null +++ b/docs/manual/tutorials/livestream.md @@ -0,0 +1,2 @@ +How to Livestream Your Show - Youtube Video +[![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") diff --git a/docs/manual/tutorials/stream-settings.md b/docs/manual/tutorials/stream-settings.md new file mode 100644 index 000000000..94b55ccc4 --- /dev/null +++ b/docs/manual/tutorials/stream-settings.md @@ -0,0 +1,2 @@ +How to Customize the Stream Settings - YouTube link +[![Upload a promo to LibreTime](http://img.youtube.com/vi/QPNo52Fc0ck/0.jpg)](https://www.youtube-nocookie.com/embed/QPNo52Fc0ck "How to upload a promo") diff --git a/docs/manual/tutorials/top-of-hour-id.md b/docs/manual/tutorials/top-of-hour-id.md new file mode 100644 index 000000000..5448d5ac9 --- /dev/null +++ b/docs/manual/tutorials/top-of-hour-id.md @@ -0,0 +1,2 @@ +How to set up an automatic top of the hour ID with intro playlist feature - Youtube Video +[![How to set up an automatic top of the hour ID with intro playlist feature](http://img.youtube.com/vi/IXHmiqri4PI/0.jpg)](https://www.youtube-nocookie.com/embed/IXHmiqri4PI "How to set up an automatic top of the hour ID with intro playlist feature") diff --git a/docs/manual/tutorials/underwriting.md b/docs/manual/tutorials/underwriting.md new file mode 100644 index 000000000..6cbdd5942 --- /dev/null +++ b/docs/manual/tutorials/underwriting.md @@ -0,0 +1,2 @@ +How to schedule underwriting announcements or ad spots - Youtube Video +[![How to schedule underwriting announcements](http://img.youtube.com/vi/F7rMut7Trb4/0.jpg)](https://www.youtube-nocookie.com/embed/F7rMut7Trb4 "How to schedule underwriting announcements") diff --git a/docs/manual/tutorials/upload-promo.md b/docs/manual/tutorials/upload-promo.md new file mode 100644 index 000000000..01adc3543 --- /dev/null +++ b/docs/manual/tutorials/upload-promo.md @@ -0,0 +1,2 @@ +How to Upload a Promo - Youtube Video +[![Upload a promo to LibreTime](http://img.youtube.com/vi/IC0cn3LaAXs/0.jpg)](https://www.youtube-nocookie.com/embed/IC0cn3LaAXs "How to upload a promo") diff --git a/docs/manual/tutorials/upload-tracks.md b/docs/manual/tutorials/upload-tracks.md new file mode 100644 index 000000000..cf2db239e --- /dev/null +++ b/docs/manual/tutorials/upload-tracks.md @@ -0,0 +1,2 @@ +How to Upload Tracks and Schedule Your Show - Youtube Video +[![Upload Tracks](http://img.youtube.com/vi/TJtWUzAlP08/0.jpg)](https://www.youtube-nocookie.com/embed/TJtWUzAlP08 "How to upload tracks") diff --git a/docs/manual/tutorials/webstream-link.md b/docs/manual/tutorials/webstream-link.md new file mode 100644 index 000000000..75336a5de --- /dev/null +++ b/docs/manual/tutorials/webstream-link.md @@ -0,0 +1,2 @@ +How to schedule a webstream with linked calendar - Youtube Video +[![How to schedule a webstream with linked calendar](http://img.youtube.com/vi/Ha3X6aYdY04/0.jpg)](https://www.youtube-nocookie.com/embed/Ha3X6aYdY04 "How to schedule a webstream with linked calendar") diff --git a/docs/manual/tutorials/widgets.md b/docs/manual/tutorials/widgets.md new file mode 100644 index 000000000..01adc3543 --- /dev/null +++ b/docs/manual/tutorials/widgets.md @@ -0,0 +1,2 @@ +How to Upload a Promo - Youtube Video +[![Upload a promo to LibreTime](http://img.youtube.com/vi/IC0cn3LaAXs/0.jpg)](https://www.youtube-nocookie.com/embed/IC0cn3LaAXs "How to upload a promo") diff --git a/mkdocs.yml b/mkdocs.yml index 7c311766e..24eeef947 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,6 +17,8 @@ pages: - 'Home': index.md - 'What is LibreTime?': manual/index.md - 'Features': features.md + - 'Tutorials' : manual/tutorials/index.md + - 'How-Tos' : manual/howtos/index.md - 'F.A.Q.': faq.md - 'Rights and Royalties': manual/rights-and-royalties/index.md - 'Using LibreTime':