diff --git a/docs/404.md b/docs/404.md index 68a35f70c..4a5320fc4 100644 --- a/docs/404.md +++ b/docs/404.md @@ -2,10 +2,10 @@ layout: 404 linkto: /search linktext: Search -img: /img/radio-unsplash.jpg -photocredit: Photo by Leo Wieling on Unsplash +img: /img/car-radio-unsplash.jpg +photocredit: Photo by Frank Albrecht on Unsplash --- -# Oops +# DEAD AIR -There's nothing there... \ No newline at end of file +Sorry... there's nothing there. \ No newline at end of file diff --git a/docs/README b/docs/README new file mode 100644 index 000000000..181ed94d8 --- /dev/null +++ b/docs/README @@ -0,0 +1,8 @@ +# Contributing to the docs + +## Running Jekyll + +``` +bundler install +jekyll serve +``` \ No newline at end of file diff --git a/docs/_config.yml b/docs/_config.yml index eef39fb01..de5c6663b 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -9,6 +9,8 @@ includes_dir: _includes favicon: favicon.ico +exclude: ['README'] + # Collections Settings collections: docs: diff --git a/docs/_docs/contribute.md b/docs/_docs/contribute.md index 69cf72709..df805eef5 100644 --- a/docs/_docs/contribute.md +++ b/docs/_docs/contribute.md @@ -17,25 +17,25 @@ improvements and new features for LibreTime on that site. ## Feature requests -Have an idea that would make LibreTime even better than it is right now? Start a **Feature request** on our +Have an idea that would make Libretime even better than it is right now? Start a **Feature request** on our [Github issues page](https://github.com/LibreTime/libretime/issues/new/choose). -## Help translate LibreTime +## Translation LibreTime can run in over 15 different languages due to the gracious help of our volunteers. Is your language not supported? Follow [this guide](/docs/interface-localization) to add your language to LibreTime! -## Help write documentation for LibreTime +## Write documentation Our site is now built by Jekyll, which has an installation guide [here](https://jekyllrb.com/docs/installation/) to help get you started. - After cloning our repo locally, enter the `/docs` directory and run + After cloning our repo locally, enter the `docs/` directory and run ``` bundle install jekyll serve ``` -## Help write code for LibreTime +## Code Are you familar with coding in PHP? Have you made projects in Liquidsoap and some of the other services we use? Take a look at the [list of bugs and feature requests](https://github.com/LibreTime/libretime/issues), and then @@ -44,7 +44,7 @@ your desktop, open up a favorite editor and make some changes, and then commit, Knowledge on how to use [Github](https://guides.github.com/activities/hello-world/) and [Git](https://git-scm.com/docs/gittutorial) will suit you well, use the links for a quick 101. -## Testing LibreTime +## Testing and CI/CD Before submitting code to the project, it's a good idea to test it first. To do this, it's easiest to install LibreTime in a virtural machine on your local system or in a cloud VM. We have instructions for setting up a virtural diff --git a/docs/_docs/host-configuration.md b/docs/_docs/host-configuration.md index 06ca885ac..e1e086813 100644 --- a/docs/_docs/host-configuration.md +++ b/docs/_docs/host-configuration.md @@ -6,7 +6,7 @@ category: install The streaming host configuration for LibreTime is shown in the file */etc/airtime/liquidsoap.cfg* which is automatically generated by the **Streams** page, found on the **System** menu of the LibreTime administration interface. For this reason, you would not normally edit the streaming configuration manually, as any changes are likely to be overwritten by the administration interface. -### Database and RabbitMQ hosts {#database} +## Database and RabbitMQ hosts {#database} Optionally, you may wish to edit the file */etc/airtime/airtime.conf* to set the PostgreSQL database host, and the username and password to connect to the database with: @@ -55,7 +55,7 @@ used by the various components of LibreTime, run the following commands sudo systemctl restart libretime-celery sudo systemctl restart libretime-analyzer -### API client configuration {#api} +## API client configuration {#api} The LibreTime API enables many types of information about the broadcast schedule and configuration to be retrieved from the LibreTime server. Other than the live-info and week-info data fetched by website widgets (see the chapter *Exporting the schedule*), all API requests must be authenticated using the secret API key stored in the file */etc/airtime/api\_client.cfg* on the LibreTime server. This key is autogenerated during LibreTime installation and should be unique for each server. @@ -70,7 +70,7 @@ 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 {#apache} +## Apache max file size configuration {#apache} By default, the maximum upload file size is 40 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: @@ -88,7 +88,7 @@ For quick reference, 1024 MB = 1 GB and 2048 MB = 2 GB, but most will be okay wi sudo systemctl restart apache2 ``` -### Playout settings {#playout} +## Playout settings {#playout} Settings for pypo, the playout engine used by LibreTime, are found in the file */etc/airtime/airtime.conf*. After making changes to this file, you will have to issue the command: @@ -164,4 +164,38 @@ for the changes to take effect. # while 'otf' (on the fly) cues while loading into ls # (needs the post_processor patch) cue_style = pre - \ No newline at end of file + +## RabbitMQ hostname changes + +If the Airtime logs indicate failures to connect to the RabbitMQ server, such as: + +``` +2013-10-31 08:21:11,255 ERROR - [pypomessagehandler.py : main() : line +99] - Error connecting to RabbitMQ Server. Trying again in few seconds + +2013-10-31 08:21:11,255 ERROR - \[pypomessagehandler.py : main() : line 99\] - Error connecting to RabbitMQ Server. Trying again in few seconds - See more at: http://forum.sourcefabric.org/discussion/16050/\#sthash.W8OJrNFm.dpuf +``` +but the RabbitMQ server is running normally, this error might be due to a change in the server's hostname since Libretime installation. Directory names under */var/lib/rabbitmq/mnesia/* indicate that RabbitMQ's database files are organised according to the hostname of the server (ex. `rabbit@airtime`) where the hostname is *airtime.example.com*. If the hostname has changed, it may be necessary to reconfigure RabbitMQ manually, as follows: + +1. Delete the files in */var/lib/rabbitmq/mnesia/* + +``` +sudo rm -r /var/lib/rabbitmq/mnesia/* +``` + +2. Restart RabbitMQ: + +``` +sudo systemctl restart rabbitmq-server +``` + +3. Enter the following commands to set up authentication and grant permissions. The *rabbitmqctl add\_user* command requires the RabbitMQ password from the /etc/airtime/airtime.conf file as an argument. The *rabbitmqctl set\_permissions* command should be entered on one line, with the list of Airtime services repeated three times: + +``` +rabbitmqctl add_vhost /airtime +rabbitmqctl add_user airtime XXXXXXXXXXXXXXXXXXXX +rabbitmqctl set_permissions -p /airtime airtime + "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" +  "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" +  "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" +``` \ No newline at end of file diff --git a/docs/_docs/troubleshooting.md b/docs/_docs/troubleshooting.md index 5028a100f..cf263a8e9 100644 --- a/docs/_docs/troubleshooting.md +++ b/docs/_docs/troubleshooting.md @@ -4,66 +4,53 @@ title: Troubleshooting category: admin --- -## Test tones {#tones} +Is something not working for your Libretime installation? Here's a quick guide to help you +troubleshoot most issues you'll run into. -If you need to test your computer's soundcard, you can use `speaker-test`, a tone generator for ALSA. -This does not come installed with LibreTime but can be installed with `sudo apt install speaker-test`. +## 1. Let's check the basics + +Is your server on? (We hate to ask.) Is it connected to the internet? Is it connected to your +broadcast console or mixer if being used for soundcard output? If you're using a cloud host, +does your cloud provider's status page indicate any system outages? + +Once you know your physical (or virtual) system is functional, was a show scheduled for the +current time with tracks or an autoplaylist scheduled? + +## 2. Are all services working? + +If you can log in to Libretime, go to **Settings** > **Status** to see the service indicators. +A fully working server should have green checkmarks next to all services. + +![](/img/Screenshot521-System_status_240.png) + +If one of the services isn't working, text will display with a terminal command to restart the service +or get status information for a particular service. For example (for Ubuntu 18.04), the following +commands would restart or check the status of Libretime's Liquidsoap instance, respectively. ``` -speaker-test [-D] [-f] - -Where: - -D device name - -f frequency of test tone +sudo systemctl restart libretime-liquidsoap +sudo systemctl status libretime-liquidsoap ``` -The **airtime-test-stream** command enables you to send a test tone to a local or remote streaming media server. Press **Ctrl+C** on your keyboard to stop the tone being streamed. -``` -airtime-test-stream [-v] - [-o icecast | shoutcast ] [-H hostname] [-P port] - [-u username] [-p password] [-m mount] - [-h] -Where: - -v verbose mode - -o stream server type (default: icecast) - -H hostname (default: localhost) - -P port (default: 8000) - -u user (default: source) - -p password (default: hackme) - -m mount (default: test) - -h show help menu -``` +If the service isn't wanting to restart, look at its status for clues as to why it stopped working. -## RabbitMQ hostname changes +## 3. Basic troubleshooting -If the Airtime logs indicate failures to connect to the RabbitMQ server, such as: -``` -2013-10-31 08:21:11,255 ERROR - [pypomessagehandler.py : main() : line -99] - Error connecting to RabbitMQ Server. Trying again in few seconds +If you have one of these issues, please try to resolve it with the instructions below before moving on in the +troubleshooting checklist. -2013-10-31 08:21:11,255 ERROR - \[pypomessagehandler.py : main() : line 99\] - Error connecting to RabbitMQ Server. Trying again in few seconds - See more at: http://forum.sourcefabric.org/discussion/16050/\#sthash.W8OJrNFm.dpuf -``` -but the RabbitMQ server is running normally, this error might be due to a change in the server's hostname since Libretime installation. Directory names under */var/lib/rabbitmq/mnesia/* indicate that RabbitMQ's database files are organised according to the hostname of the server (ex. `rabbit@airtime`) where the hostname is *airtime.example.com*. If the hostname has changed, it may be necessary to reconfigure RabbitMQ manually, as follows: +- **File not importing successfully?** Libretime has been known to work with MP3 and WAV files, encoded using 41,100 Hz. Variable Bit Rate (VBR) files are currently hit or miss with the importer. Please convert your file to an MP3 or WAV at 41,100 Hz. and try uploading again. +- **Podcast hosted by Anchor.fm not importing?** There is no known work-around at this time. Please ask your producers to provide their show files manually or check with the show's distributer? +- **Tracks won't publish?** We know the Publish screen is broken and we're working on it. A potential work-around is to use an external podcast host like [Anchor.fm](https://www.anchor.fm) or [Blubrry](https://blubrry.com/). +- **Can't hear any sound coming from your soundcard (for analog audio output)?** If you are using ALSA as your audio driver, use `alsamixer` to see the current volume your system is set to. If stil nothing, go to **Settings** > **Streams** and make sure **Hardware Audio Output** is checked. If you need to play a tone to help you troubleshoot, you can use `speaker-test` (does not come installed with Libretime). -1. Delete the files in */var/lib/rabbitmq/mnesia/* +## 4. Read the docs -``` -sudo rm -r /var/lib/rabbitmq/mnesia/* -``` +Our main documentation listing is [here](/docs) and can be searched [here](/search). -2. Restart RabbitMQ: +## 5. Reach out to the developers -``` -sudo systemctl restart rabbitmq-server -``` - -3. Enter the following commands to set up authentication and grant permissions. The *rabbitmqctl add\_user* command requires the RabbitMQ password from the /etc/airtime/airtime.conf file as an argument. The *rabbitmqctl set\_permissions* command should be entered on one line, with the list of Airtime services repeated three times: - -``` -rabbitmqctl add_vhost /airtime -rabbitmqctl add_user airtime XXXXXXXXXXXXXXXXXXXX -rabbitmqctl set_permissions -p /airtime airtime - "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" -  "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" -  "airtime-pypo|pypo-fetch|airtime-analyzer|media-monitor" -``` \ No newline at end of file +Libretime is still in active development, meaning bugs and issues are expected to pop up every so often. +See if an issue is still open by looking at our [Issues page](https://github.com/LibreTime/libretime/issues). +If you don't get the help you need, please [open an issue](https://github.com/LibreTime/libretime/issues/new/choose) +so we can take a look at it. diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index e6086ac3b..90e94a215 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -23,7 +23,7 @@ diff --git a/docs/_layouts/404.html b/docs/_layouts/404.html index 2a25c5e9f..fab28952d 100644 --- a/docs/_layouts/404.html +++ b/docs/_layouts/404.html @@ -25,6 +25,6 @@ layout: default {{ page.linktext }} -
{{page.photocredit}}
+
{{page.photocredit}}
\ No newline at end of file diff --git a/docs/_layouts/home.html b/docs/_layouts/home.html index 7b85abc1e..054040c9d 100644 --- a/docs/_layouts/home.html +++ b/docs/_layouts/home.html @@ -25,7 +25,7 @@ layout: default {{ page.linktext }} -
{{page.photocredit}}
+
{{page.photocredit}}
@@ -181,7 +181,7 @@ layout: default
-
+

Get started with Libretime


diff --git a/docs/docs.html b/docs/docs.html index c983cd66f..a69cdce1a 100644 --- a/docs/docs.html +++ b/docs/docs.html @@ -16,7 +16,7 @@ title: Docs
-

Install

+

Install

Get Libretime up and running in just 10 minutes.

@@ -64,10 +64,10 @@ title: Docs
-
+
-

FAQs

-

Have questions?
We have answers.

+

Troubleshooting

+

Something not working? Here's a quick guide to fixing Libretime.

diff --git a/docs/faq.html b/docs/faq.html deleted file mode 100644 index fd21ba92a..000000000 --- a/docs/faq.html +++ /dev/null @@ -1,163 +0,0 @@ ---- -layout: default -title: FAQ ---- - - -
-
-
-
-

Frequently Asked Questions

- - -
-
-
- - - - - - - -
- - -

-

-
-
-
-
- - - -
-
- -

Stay up to date with updates and contributions!

-
-
- - - - - - - - - -
-
- -
-
-
-
- -
-
-
What is Docs UI Kit?
- -
- -
-
Docs UI Kit is beautiful Open Source Bootstrap 4 UI Kit under MIT license. The UI Kit comes with more than 10 beautiful complete pages and includes a lot of reusable and customizable UI Blocks. Furthermore, Docs UI Kit includes 4 different Documentation Layouts.
-
-
- -
- -
-
Airtime stores log files under the directory path /var/log/airtime/. Copies of these log files may be requested by LibreTime developers while they are providing technical support for your Libretime deployment.
-
-
- -
- -
-
On Ubuntu, LibreTime services are controlled by the system service daemon systemctl. To restart a service, use the command sudo systemctl restart servicename. Some of Libretime's services include libretime-liquidsoap, libretime-playout, libretime-celery, libretime-analyzer, apache2, and rabbitmq-server.
-
-
- -
-
-
Is LibreTime free?
- -
- -
-
Absolutely, but "free as in freedom" free. While there is no cost to use the Libretime software at your radio station or in the cloud, please consider supporting the project financially or with your many talents. Our supporters allow the Libretime project to keep growing and improving.
-
-
- -
- -
-
Currently, Libretime comes with community support and you can open an issue on the product github page. We will do our best to answers your questions.
-
-
- -
- -
-
Sure! Please feel free to contribute - we appreciate any community help! You can pull request on github page.
-
-
- -
- -
-
You can check out our documenttion for detailed examples.
-
-
- -
- -
-
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 bash uninstall. - If allowed, the installer will permanently delete all databases and media uploaded to LibreTime. -

If it was something we did, please open an issue request on our Github. -

-
-
-
-
-
-
-
-
- -
-
- -

Can't find what you're looking for?

-
Open an issue on our Github!
- Submit a Request -
-
-
diff --git a/docs/img/car-radio-unsplash.jpg b/docs/img/car-radio-unsplash.jpg new file mode 100644 index 000000000..b52edd5fd Binary files /dev/null and b/docs/img/car-radio-unsplash.jpg differ diff --git a/docs/index.md b/docs/index.md index fd66d5734..68dc2c7f1 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ --- layout: home title: Home -linkto: /install +linkto: index#get-started linktext: Get Libretime img: /img/radio-unsplash.jpg photocredit: Photo by Leo Wieling on Unsplash @@ -16,10 +16,10 @@ actions: linktext: Install from Git --- -# RADIO AUTOMATION FOR THE MASSES +# BROADCAST WITHOUT LIMITS -Get broadcasting without the hassle +Libretime is an open source radio automation and broadcasting solution helping communities get on-air with ease. -LibreTime is Open Source radio automation and broadcasting solution helping communities both modernize their broadcasting stack, and get up and on-the-air with ease. +The platform can be easily deployed on dedicated hardware and VMs, on-prem or in the cloud, "free as in freedom" free. -The platform consists of several open-source components that can be easily and rapidly deployed on both dedicated hardware, virtual machines, and Cloud native infrastructure - allowing your station to truly underwrite it's own destiny. \ No newline at end of file +Let your station underwrite its own destiny. \ No newline at end of file