Filling out FAQ and small revisions
This commit is contained in:
Zachary Klosko
parent
2931d3755b
commit
b8c02a3b57
|
|
@ -1,7 +1,7 @@
|
|||
title: LibreTime
|
||||
description: An open source radio automation server made for (and by) low-power FM stations and the rest of us.
|
||||
logo: 144px.png
|
||||
baseurl: "/libretime" # The subpath of your site, e.g. /blog
|
||||
baseurl: "/" # The subpath of your site, e.g. /blog
|
||||
url: "https://libretime.org" # The base hostname & protocol for your site, e.g. http://example.com
|
||||
|
||||
layouts_dir: _layouts
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: article
|
||||
title: LibreTime API Usage
|
||||
git: api.md
|
||||
category: dev
|
||||
---
|
||||
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -23,21 +23,24 @@ Have an idea that would make LibreTime even better than it is right now? Start a
|
|||
## Help translate LibreTime
|
||||
|
||||
LibreTime can run in over 15 different languages due to the gracious help of our volunteers. Is your language not
|
||||
supported? Follow [this guide](interface-localization) to add your language to LibreTime!
|
||||
supported? Follow [this guide](/docs/interface-localization) to add your language to LibreTime!
|
||||
|
||||
## Help write documentation for LibreTime
|
||||
|
||||
Our site is now run by Jekyll. After cloning our repo locally, enter the `/docs` directory and run
|
||||
Our site is now run by Jekyll, who 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
|
||||
|
||||
```
|
||||
bundle install
|
||||
jekyll serve
|
||||
```
|
||||
|
||||
If you get an error, try running `bundle exec jekyll serve`. The site should start running on `http://127.0.0.1:4000/`.
|
||||
|
||||
## Help write code for LibreTime
|
||||
|
||||
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 bugs and feature requests [here](https://github.com/LibreTime/libretime/issues), and then
|
||||
Take a look at the [list of bugs and feature requests](https://github.com/LibreTime/libretime/issues), and then
|
||||
fork our repo and have a go! Just use the **Fork** button at the top of our **Code** page, clone the forked repo to
|
||||
your desktop, open up a favorite editor and make some changes, and then commit, push, and open a pull request.
|
||||
Knowledge on how to use [Github](https://guides.github.com/activities/hello-world/) and [Git](https://git-scm.com/docs/gittutorial)
|
||||
|
|
@ -47,7 +50,7 @@ will suit you well, use the links for a quick 101.
|
|||
|
||||
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. Instructions on how to set up a virtural
|
||||
instance of LibreTime with Vagrant are located [here](vagrant).
|
||||
instance of LibreTime with Vagrant are located [here](/docs/vagrant).
|
||||
|
||||
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
|
||||
|
|
|
|||
|
|
@ -211,15 +211,12 @@ for the changes to take effect.
|
|||
|
||||
## Setting the server time
|
||||
|
||||
Accurate time keeping on your server is vital for LibreTime performance. You can confirm that the date and time of your server are set correctly with the **date** command:
|
||||
|
||||
date
|
||||
|
||||
Accurate time keeping on your server is vital for LibreTime performance. You can confirm that the date and time of your server are set correctly with the `date` command.
|
||||
The server should respond with the date, time, time zone and year in a format similar to the following example:
|
||||
|
||||
Tue Jul 2 15:08:57 BST 2013
|
||||
|
||||
If the time on your server is wrong, it is recommended that you take LibreTime off-air until the problem is fixed.
|
||||
If the time on your server is wrong, it is strongly recommended that you take LibreTime off-air until the problem is fixed.
|
||||
|
||||
### Configuring NTP
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: article
|
||||
title: Interface Localization
|
||||
git: interface-localization.md
|
||||
category: admin
|
||||
---
|
||||
|
||||
The LibreTime administration interface can be localized using the standard GNU **gettext** method. Using GitHub for this task means you don't have to tackle the whole of a localization yourself; just as much as you can manage.
|
||||
|
|
|
|||
|
|
@ -6,10 +6,10 @@ category: manager
|
|||
|
||||
The Listener Stats page on the Analytics menu shows graphs of listener connections to the configured streaming servers for the selected date and time range. On the right side, a green **Status** indicator shows **OK** if the connection to the streaming server is active.
|
||||
|
||||
|
||||
|
||||
|
||||
If the status indicator is red, check that the **Admin User** and **Admin Password** settings are correct under **Additional Options** for the named mount point, such as *libretime\_128*, on the **Streams** page of the **Settings** menu.
|
||||
|
||||
By default, statistics for the last 24 hours of streaming are shown. To change this date and time range, click the calendar and clock icons in the lower left corner of the page, then click the magnifying glass icon.
|
||||
To choose which particular streams should have statistics displayed, click the check boxes for the individual colour-coded mount points, just below the graph.
|
||||
|
||||
> To choose which particular streams should have statistics displayed, click the check boxes for the individual colour-coded mount points, just below the graph.
|
||||
By default, statistics for the last 24 hours of streaming are shown. To change this date and time range, click the calendar and clock icons in the lower left corner of the page, then click the magnifying glass icon.
|
||||
|
|
@ -6,10 +6,9 @@ category: admin
|
|||
|
||||
|
||||
|
||||
LibreTime includes a mini-site, which can be accessed at _serverIP_ (for local installations), or
|
||||
_libretime.yourdomain.com_ or _cloudvmIP_ (for installations to a server on a domain). The site includes your
|
||||
LibreTime includes a microsite, which can be accessed at _serverIP_ or a domain you've set up for your server. The site includes your
|
||||
logo and station description (set under Settings > General), the login button to the LibreTime interface, the schedule for the next seven days,
|
||||
podcast tabs, and a live feed of your station with the currently playing artist and track displayed.
|
||||
podcast tabs, and a live feed of your station with information on the the currently playing artist and track.
|
||||
|
||||
## Modifying the LibreTime Radio Page
|
||||
|
||||
|
|
@ -26,4 +25,4 @@ html {
|
|||
}
|
||||
```
|
||||
|
||||
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.
|
||||
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.
|
||||
|
|
|
|||
|
|
@ -44,7 +44,7 @@ Fill out the smart block's **Name**, **Search Criteria**, and **Limit to** secti
|
|||
|
||||
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.
|
||||
|
||||
> Note: Smart Blocks by default will not overflow the length of a scheduled show.
|
||||
> **Note:** Smart Blocks by default will not overflow the length of a scheduled show.
|
||||
> 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"**
|
||||
> (helpful for avoiding dead air on autoscheduled shows).
|
||||
|
|
|
|||
|
|
@ -8,7 +8,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](library#smartblocks) that can be used in conjunction with autoloading playlists to schedule the newest episode of a podcast without human intervention.
|
||||
The podcast interfaces provides you with the ability to generate [Smartblocks](/docs/playlists) that can be used in conjunction with autoloading playlists to schedule the newest episode of a podcast without human intervention.
|
||||
|
||||
<html>
|
||||
<iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/g-4UcD8qvR8" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
|
||||
|
|
|
|||
|
|
@ -4,29 +4,6 @@ title: Troubleshooting
|
|||
git: troubleshooting.md
|
||||
---
|
||||
|
||||
## Restarting services
|
||||
|
||||
LibreTime is effectively a web site running on a LAPP stack, so individual components of the system can be started, stopped, restarted or checked in the server console using the **systemctl** command:
|
||||
|
||||
```
|
||||
sudo systemctl start|stop|restart|status libretime-liquidsoap
|
||||
sudo systemctl start|stop|restart|status libretime-playout
|
||||
sudo systemctl start|stop|restart|status libretime-celery
|
||||
sudo systemctl start|stop|restart|status libretime-analyzer
|
||||
sudo systemctl start|stop|restart|status apache2
|
||||
sudo systemctl start|stop|restart|status rabbitmq-server
|
||||
```
|
||||
|
||||
For example, to restart the Airtime playout engine, you could enter the command:
|
||||
|
||||
```
|
||||
sudo systemctl restart libretime-playout
|
||||
```
|
||||
|
||||
## Log files {#logs}
|
||||
|
||||
Airtime stores log files under the directory path */var/log/airtime/* which can be useful for diagnosing the cause of any problems. Copies of these log files may be requested by LibreTime developers while they are providing technical support for your Airtime deployment.
|
||||
|
||||
## Test tones {#tones}
|
||||
|
||||
If you need to test your computer's soundcard, you can use `speaker-test`, a tone generator for ALSA.
|
||||
|
|
@ -89,22 +66,4 @@ 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"
|
||||
```
|
||||
|
||||
## Uninstall LibreTime {#uninstall}
|
||||
|
||||
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 ./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 page, located
|
||||
[here](https://github.com/LibreTime/libretime/issues).
|
||||
|
||||
Until we meet again, best of luck.
|
||||
|
||||
<3 The LibreTime team
|
||||
```
|
||||
|
|
@ -1,7 +1,7 @@
|
|||
---
|
||||
layout: article
|
||||
title: Upgrading LibreTime
|
||||
git: upgrading.md
|
||||
category: admin
|
||||
---
|
||||
|
||||
## LibreTime versioning
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ layout: default
|
|||
<div class="d-md-flex align-items-center">
|
||||
<div class="w-100 mb-3 mb-md-0 pr-md-5">
|
||||
<h2 class="h4 font-weight-light mb-0">Can't find what you're looking for?</h2>
|
||||
<p class="font-weight-light mb-0">Let us help you!</p>
|
||||
<p class="font-weight-light mb-0">Ask for help on our Github repo!</p>
|
||||
</div>
|
||||
|
||||
<div class="text-md-right w-100">
|
||||
|
|
@ -129,7 +129,7 @@ layout: default
|
|||
<ul class="list-unstyled">
|
||||
{% for doc in site.docs %}
|
||||
{% if doc.category == "admin" %}
|
||||
<li class="mb-3"><a class="link-muted" href="{{doc.url}}">{{doc.title}}</a></li>
|
||||
<li class="mb-2"><a class="link-muted" href="{{doc.url}}">{{doc.title}}</a></li>
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
</ul>
|
||||
|
|
|
|||
|
|
@ -40,7 +40,7 @@ layout: default
|
|||
<div class="card-body z-index-1">
|
||||
<div class="d-flex align-items-center">
|
||||
<i class="fab fa-github fa-3x mr-4"></i>
|
||||
<p class="mb-0">Stay up to date for any abouts and contributions!</p>
|
||||
<p class="mb-0">Stay up to date with updates and contributions!</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -73,21 +73,21 @@ layout: default
|
|||
|
||||
<div class="card border-bottom mb-3">
|
||||
<div class="card-header accordion-header d-flex align-items-center collapsed" id="headingTwo-001" data-toggle="collapse" data-target="#collapseTwo-001" aria-expanded="false" aria-controls="collapseTwo-001" role="region">
|
||||
<h6 class="mb-0">Is it really free and under MIT license?</h6>
|
||||
<h6 class="mb-0">Where do I find the log files?</h6>
|
||||
<i class="fas fa-angle-down accordion-control ml-auto text-primary"></i>
|
||||
</div>
|
||||
<div id="collapseTwo-001" class="collapse" aria-labelledby="headingTwo-001" data-parent="#accordionExample-001">
|
||||
<div class="card-body">Yes! It's just absolutely FREE and comes with a simple license! If you have any questions or doubts, please feel free to reach us <a href="#">here</a>.</div>
|
||||
<div class="card-body">Airtime stores log files under the directory path <code>/var/log/airtime/</code>. Copies of these log files may be requested by LibreTime developers while they are providing technical support for your Libretime deployment.</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="card border-bottom mb-3">
|
||||
<div class="card-header accordion-header d-flex align-items-center collapsed" id="headingThree-001" data-toggle="collapse" data-target="#collapseThree-001" aria-expanded="false" aria-controls="collapseThree-001" role="region">
|
||||
<h6 class="mb-0">Can I use Docs UI Kit in commercial project?</h6>
|
||||
<h6 class="mb-0">One of the Libretime services stopped working. How do I restart it?</h6>
|
||||
<i class="fas fa-angle-down accordion-control ml-auto text-primary"></i>
|
||||
</div>
|
||||
<div id="collapseThree-001" class="collapse" aria-labelledby="headingThree-001" data-parent="#accordionExample-001">
|
||||
<div class="card-body">Yes! Docs UI Kit is absolutely Free and you can use in both personal and commercial projects without any attribution. However, we would much appreciate for any attribution.</div>
|
||||
<div class="card-body">On Ubuntu, LibreTime services are controlled by the system service daemon <i>systemctl</i>. To restart a service, use the command <code>sudo systemctl restart servicename</code>. Some of Libretime's services include libretime-liquidsoap, libretime-playout, libretime-celery, libretime-analyzer, apache2, and rabbitmq-server.</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
|
@ -138,8 +138,8 @@ layout: default
|
|||
<i class="fas fa-angle-down accordion-control ml-auto text-primary"></i>
|
||||
</div>
|
||||
<div id="collapseEight-001" class="collapse" aria-labelledby="headingEight-001" data-parent="#accordionExample-001">
|
||||
<div class="card-body">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 <code>sudo ./uninstall</code>.
|
||||
If allowed, the installer will **permanently** delete all databases and media uploaded to LibreTime.
|
||||
<div class="card-body">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 <code>sudo bash uninstall</code>.
|
||||
If allowed, the installer will <i>permanently</i> delete all databases and media uploaded to LibreTime.
|
||||
<p>If it was something we did, please <a href="https://github.com/LibreTime/libretime/issues" target="_blank">open an issue request</a> on our Github.
|
||||
</div>
|
||||
</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue