Reorganizing docs
This commit is contained in:
Zachary Klosko
parent
41caa14bff
commit
798241c13d
34 changed files with 15 additions and 2 deletions
|
|
@ -1,30 +0,0 @@
|
|||
The first entry on LibreTime's **Help** menu offers a **Getting Started** guide
|
||||
for new users. Further down, there is also a link to the online version of this
|
||||
**User Manual**.
|
||||
|
||||
|
||||
|
||||
You can visit the LibreTime online support forum at
|
||||
<https://discourse.libretime.org/c/get-help> to ask for help from the community
|
||||
regarding your LibreTime setup.
|
||||
|
||||
|
||||
Bug reporting
|
||||
-------------
|
||||
|
||||
LibreTime needs your input to improve. If you think you've found a bug, please
|
||||
visit <https://github.com/LibreTime/libretime>. Create a bug report by selecting
|
||||
**Issues**, then **New Issue**. That way, the LibreTime team can keep track of
|
||||
your problem and notify you when it has been fixed. You can also suggest
|
||||
improvements and new features for LibreTime on that site.
|
||||
|
||||
|
||||
|
||||
Other help
|
||||
----------
|
||||
|
||||
The UNESCO publication [*Community Radio - A user's guide to the technology*](static/CommunityRadioUserGuide.pdf)
|
||||
features a very comprehensive guide to setting up a community radio station.
|
||||
This guide is aimed at people thinking about setting up a radio station in
|
||||
India, but includes lots of practical advice that would be useful in any
|
||||
country.
|
||||
Binary file not shown.
Binary file not shown.
|
Before Width: | Height: | Size: 67 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 48 KiB |
Binary file not shown.
|
|
@ -1 +0,0 @@
|
|||
**TBD**
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
History
|
||||
=======
|
||||
|
||||
On the History menu, the **Playout History** page enables you to view a list of files played within a specific date and time range. This page is designed to help your station prepare reports for music royalty collection societies and regulatory agencies.
|
||||
|
||||
Search results can be copied to the clipboard using the **Copy** button, exported as data in **CSV** format (comma separated values), exported as a document in **PDF** format, or displayed in a printer-friendly format using the **Print** button. (Your web browser must have an Adobe Flash plugin installed for these buttons to appear). Press the **Esc** key to return to the LibreTime interface once the print job is complete.
|
||||
|
||||
This page has three tabs: **Log Sheet**, **File Summary** and **Show Summary**. On any of these tabs, you can select a date and time range by clicking the calendar and clock icons in the upper left corner of the page. Then click the search button, which has a magnifying glass icon, to the right. A list of files played during that date and time range will appear further down the page.
|
||||
|
||||
In the **Log Sheet** tab, the playout history is sorted by **Start Time** and **End Time** by default.
|
||||
|
||||
<img src="static/Screenshot533-Playout_history_250.png" width="595" height="385" />
|
||||
|
||||
The number of times each file was played and the length of the files are shown in the **File Summary** tab. To make optimal use of this feature for royalty reporting purposes, music files must be tagged with **Composer** and **Copyright** metadata. The artist performing a piece of music may not be the original composer of the work, or the copyright holder of the sound recording.
|
||||
|
||||
<img src="static/Screenshot534-File_summary_250.png" width="595" height="415" />
|
||||
|
||||
On the **Show Summary** tab, click the name of a show within the search range to expand its row and see its playout details.
|
||||
|
||||
<img src="static/Screenshot535-Show_summary_250.png" width="595" height="480" />
|
||||
|
||||
Manual logging
|
||||
--------------
|
||||
|
||||
If your station features playout from analogue sources such as turntables or microphones, there is no automatic metadata for LibreTime to collect from these inputs. To ensure that the playout history is complete, you can add log entries manually by clicking the **+ Create Entry** button. This action opens a pop-up window with default fields of Start Time, End Time, Title and Creator. Click the **Find** button to automatically fill the **Choose Show Instance** menu with the names of shows that took place within the specified time range. Then click the **Save** button to enter the new item into the playout history.
|
||||
|
||||
<img src="static/Screenshot536-Manual_login_250.png" width="530" height="575" />
|
||||
|
||||
Log entries can also be manually deleted, using the button with the trashcan icon, to the right of the **+ Create Entry** button. Pages of entries can be selected for deletion using the **Select** drop-down menu.
|
||||
|
||||
History Templates
|
||||
-----------------
|
||||
|
||||
The **History Templates** page on the History menu enables you to prepare reports with the exact content required by regulatory agencies in the territories that you are broadcasting to. You can begin creating a custom template by clicking the button **New Log Sheet Template** or the button **New File Summary Template**.
|
||||
|
||||
<img src="static/Screenshot537-History_templates.png" width="221" height="277" />
|
||||
|
||||
Either of these actions opens a page in which you can name the new template, and add or remove elements from the list on the left. To add a new element from the list on the right, click the plus icon for the item you require. If the element you require is not listed, you can use the **Add New Field** box at the lower end of the right side column. Select *string*, *boolean*, *integer*, or *float*, depending on the type of data that you wish to log, and then click the **+ Add** button.
|
||||
|
||||
<img src="static/Screenshot538-Log_sheet_template_250.png" width="595" height="517" />
|
||||
|
||||
When the template is in the format you require, click the **Save** button, and **Set Default Template** if you wish. The new template will now be listed on the History Templates page. If you have set a new default template, any changes will be visible on the tabs of the Playout History page.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 37 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 42 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 41 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 35 KiB |
|
|
@ -1,53 +0,0 @@
|
|||
Modifying the LibreTime interface
|
||||
----------------------------------
|
||||
|
||||
The LibreTime administration interface, as a web application, is fully customizable using the same methods that you might use to modify a website. For instance, you may wish to increase certain font sizes or change the colours in the LibreTime interface to better suit staff users with impaired vision. To do this, open one of the CSS files in the */public/css/* directory under the LibreTime *DocumentRoot* directory in an editor such as **nano**:
|
||||
|
||||
sudo nano /usr/share/airtime/public/css/styles.css
|
||||
|
||||
To change the background colour of the administration interface from dark gray to white, the *background:* property of the body tag could be changed to *\#ffffff* as follows:
|
||||
|
||||
body {
|
||||
font-size: 62.5%;
|
||||
font-family:Arial, Helvetica, sans-serif;
|
||||
background: #ffffff;
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
Save the file with **Ctrl+O**, then refresh your browser to see the change to the interface background colour.
|
||||
|
||||
Any custom changes that you make to the administration interface should be backed up before upgrading LibreTime to a newer version, otherwise they could be overwritten. If you have made improvements that you think might be useful to other LibreTime users, please contact LibreTime and tell us about them.
|
||||
|
||||
Modifying the LibreTime Radio Page
|
||||
-----------------------------------
|
||||
|
||||
The background of the mini-site that appears when you visit the server's domain in your web browser can be changed by modifying the page's CSS file, located at */usr/share/airtime/php/airtime_mvc/public/css/radio-page/radio-page.css*.
|
||||
|
||||
```
|
||||
html {
|
||||
background: url("img/background-testing-3.jpg") no-repeat center center fixed;
|
||||
-webkit-background-size: cover;
|
||||
-moz-background-size: cover;
|
||||
-o-background-size: cover;
|
||||
background-size: cover;
|
||||
overflow-y: auto;
|
||||
}
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
Modifying the Icecast interface
|
||||
-------------------------------
|
||||
|
||||
If you have installed Icecast, in the directory */etc/icecast2/web/* you will find several XSLT and other files which are used to generate the Icecast web interface. If you are familiar with HTML you should be able to modify these pages, as they are well commented. You do have to be careful with syntax, because something as simple as a missing bracket can cause the Icecast web interface to break down.
|
||||
|
||||
For example, you could change the *status.xsl* page:
|
||||
|
||||
sudo nano /etc/icecast2/web/status.xsl
|
||||
|
||||
Modifying the *status.xsl* page is a good place to start, because this is the default page that site visitors see when they browse port 8000 on your Icecast server. The most obvious change to make in the XSLT pages is the content of the *<title>* and *<h2>* tags, to announce the name of your station. You can also modify the *style.css* file in this directory to change colour and layout options.
|
||||
|
||||
After saving the file with Ctrl+O, refresh your web browser, and the new look should now be visible.
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 56 KiB |
|
|
@ -1,57 +0,0 @@
|
|||
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.
|
||||
|
||||
|
||||
|
||||
First, you should check if a localization is already under way for your locale of choice. The best way to do this is to take a look at the 'master' branch in the GitHub repository for LibreTime at <https://github.com/LibreTime/libretime>. You can also ask in the LibreTime development forum at <https://discourse.libretime.org/>, where you might find community members who can help you with the translation.
|
||||
|
||||
GNU **gettext** means using a .po file for each language or dialect, a specially formatted plain text file with groups of three or more lines, like this example from LibreTime's Korean localization:
|
||||
|
||||
#: airtime_mvc/application/configs/navigation.php:57
|
||||
msgid "Media Folders"
|
||||
msgstr "미디어 폴더"
|
||||
|
||||
The first of these three lines starts with the hash symbol, and references where this string of text is found in the source code by its file name and line number. If this string is found more than once in the source code, you will see other reference lines here. The second line contains the **msgid**, which is the original version of the string. The third line contains the **msgstr**, which is the translation of that string for the localization that this particular .po file relates to.
|
||||
|
||||
If you use the cross-platform program **Poedit** (<http://www.poedit.net/>) to edit the .po file, this formatting of the text is hidden by an easy-to-use GUI. The *poedit* package can be installed on most GNU/Linux distributions using the standard software installer. Versions of Poedit for Mac and Windows are available for free download from the project's homepage.
|
||||
|
||||
Before manually translating strings in Poedit from scratch, you should take a look at the online translation services available, such as Lingohub (<https://lingohub.com>) or Google's Translator Toolkit (<http://translate.google.com/toolkit/>), which both support gettext .po files. If using automatic translation, you can then use Poedit to fine-tune the localization and fix any formatting errors.
|
||||
|
||||
If you don't already have a GitHub account, you can sign up at <https://github.com/signup/free>. Once you have a GitHub account, you can fork a copy (<https://help.github.com/articles/fork-a-repo>) of the LibreTime project. Work for the next major version of the software is done in the **master** branch of each project, so that's the branch to **checkout** after you have made the initial **git clone**.
|
||||
|
||||
In the locale code *de\_CH*, for example, *de* represents the German language and the suffix *\_CH* indicates the dialect spoken in Switzerland. Some languages have a wide variety of dialect localizations, which can be differentiated with a suffix in this way. You should update the header information in the .po file, which includes the language code and a country code, using one of the existing .po files as a guide.
|
||||
|
||||
After forking the LibreTime git repository, make sure you're in the **master** branch:
|
||||
|
||||
git branch
|
||||
devel
|
||||
* master
|
||||
|
||||
Create a new locale directory (e.g. *airtime\_mvc/locale/de\_CH/LC\_MESSAGES/* for German as spoken in Switzerland):
|
||||
|
||||
mkdir -p airtime_mvc/locale/de_CH/LC_MESSAGES/
|
||||
|
||||
Copy the template *airtime.po* file into the directory you just created:
|
||||
|
||||
cp airtime_mvc_locale/template/airtime.po airtime_mvc/locale/de_CH/LC_MESSAGES
|
||||
|
||||
and update the header information in the new copy of the *airtime.po* file using the **nano** editor:
|
||||
|
||||
nano airtime_mvc/locale/de_CH/LC_MESSAGES/airtime.po
|
||||
|
||||
For the example of Swiss German, the header of the file should now look like this:
|
||||
|
||||
# SWISS GERMAN (de_CH) translation for LibreTime.
|
||||
# Copyright (C) 2013 Sourcefabric
|
||||
# This file is distributed under the same license as the LibreTime package.
|
||||
# Sourcefabric <contact@sourcefabric.org>, 2013.
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: LibreTime 3.0-Alpha\n"
|
||||
"Report-Msgid-Bugs-To: https://discourse.libretime.org/\n"
|
||||
|
||||
After using an online translation tool to begin a new localization, you can load the exported .po file into Poedit and complete your translation there. Enter the localization team's contact information and language into Poedit's **Edit -> Preferences** and **Catalog -> Settings** dialogs, which will be added to the .po file. When you save a .po file in Poedit, the corresponding binary .mo file will be compiled automatically.
|
||||
|
||||
Finally, **git add**, **git commit** and **git push** these new .mo and .po files to your GitHub fork of the project, and send a git pull request (<https://help.github.com/articles/using-pull-requests>) to the LibreTime developers. The localization can then be added to a forthcoming LibreTime release.
|
||||
|
||||
If you don't want to work with git, that's no problem - download a copy of the .po template file, edit the header, run it through an automatic translator and check it with Poedit. Then email your contribution to the LibreTime team as an attachment - it will be very welcome! However, learning to use git is a good idea, because it means you can work directly on the current source code, share the localization work with the LibreTime community, and avoid duplicated effort.
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 41 KiB |
|
|
@ -1,17 +0,0 @@
|
|||
In the Master Panel, beneath the **ON AIR** indicator, you will find the **LISTEN** button.
|
||||
|
||||
|
||||
|
||||
This button opens a pop-up **Live stream** window, which enables you to monitor the streams that have been configured previously in the **Streams** page on the **System** menu. In the **Live stream** window, a drop-down menu enables you to switch between the streams which are currently available. Both the streaming server and name of the stream are shown. Your station logo is shown in the top left corner of the window, if you have uploaded one via the **Preferences** page on the **System** menu.
|
||||
|
||||
|
||||
|
||||
Beneath the drop-down menu for stream selection is an orange volume control bar. This volume control only adjusts the output level of the pop-up **Live Stream** window, not the output level of the LibreTime server itself. To adjust output level between muted and maximum, click on the corresponding place in the orange bar, with maximum level on the right side. Click on the left side speaker icon to mute the output.
|
||||
|
||||
|
||||
|
||||
To display the URL of the stream you are monitoring, so that you can copy and paste it into an email or web page, click the **Share** button. Click the **X** icon to the right of the URL to return to the drop-down menu of available streams.
|
||||
|
||||
|
||||
|
||||
When you have finished monitoring the streams, you can close the pop-up window in the normal way, depending on the browser you are using. In Firefox, you can close the window by clicking the **X** button in the top right corner. This action will not shut down the output from the LibreTime server, only the stream monitoring on your desktop computer or laptop.
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 22 KiB |
|
|
@ -1,13 +0,0 @@
|
|||
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.
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3.4 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 7.9 KiB |
|
|
@ -1,102 +0,0 @@
|
|||
To increase the security of your server, you can enable encrypted access to the LibreTime administration interface, and direct your users towards this more secure login page. The main advantage of using this encryption is that your remote users' login names and passwords are not sent in plain text across the public Internet or untrusted local networks, such as shared Wi-Fi access points.
|
||||
|
||||
The padlock icon in a web browser's address bar depends on the browser's recognition of an encryption certificate. Because the users of your LibreTime server will often be known to you personally, it is feasible to use a self-signed certificate for this purpose. Alternatively, you can pay a Certificate Authority to sign the certificate for you. LibreTime Pro servers are pre-configured with a certificate signed by a Certificate Authority which is automatically recognised by all popular browsers.
|
||||
|
||||
Deploying a self-signed certificate
|
||||
-----------------------------------
|
||||
|
||||
The Debian/Ubuntu package *ssl-cert* creates a *snakeoil* certificate and key based on your server's hostname. This gratis certificate and key pair created under the */etc/ssl/certs*/ and */etc/ssl/private/* directories will not be recognised by users' browsers without manual intervention. You can install the *ssl-cert* package with the command:
|
||||
|
||||
sudo apt-get install ssl-cert
|
||||
|
||||
If the hostname of your server does not match the domain name you intend to use with the LibreTime virtual host, the user's browser will present an additional security warning. You can set the domain name of the certificate by editing the file */usr/share/ssl-cert/ssleay.cnf* to replace the *@HostName@* variable:
|
||||
|
||||
commonName = @HostName@
|
||||
|
||||
with the domain name used by LibreTime:
|
||||
|
||||
commonName = airtime.example.com
|
||||
|
||||
Then save the file and regenerate the certificate with the command:
|
||||
|
||||
sudo make-ssl-cert generate-default-snakeoil --force-overwrite
|
||||
|
||||
You should enable additional Apache modules for page redirections, custom headers and secure access:
|
||||
|
||||
sudo a2enmod alias headers ssl
|
||||
|
||||
Next, edit the virtual host configuration for your LibreTime server to include a stanza for the https:// interface on port 443 and a redirect for logins from port 80:
|
||||
|
||||
sudo nano /etc/apache2/sites-available/airtime-vhost.conf
|
||||
|
||||
Using the following configuration for Apache 2.2 as a guide, replace *airtime.example.com* with the name of your server and *admin@example.com* with your email address. The older SSLv2 and SSLv3 protocols and SSL compression should be disabled, as they are generally believed to be insecure. You may wish to create a *ServerAlias* for users to access the administration interface over https:// if required.
|
||||
|
||||
On port 80, Apache's *alias* module is used to set a *Redirect permanent* for the login page. Optionally, access could be denied to all sites except *localhost* and any other LibreTime servers on your network, so that unencrypted communication between LibreTime components can continue.
|
||||
|
||||
<VirtualHost *:443>
|
||||
SSLEngine on
|
||||
SSLProtocol All -SSLv2 -SSLv3
|
||||
SSLCompression off
|
||||
SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem
|
||||
SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
|
||||
Header always set Strict-Transport-Security "max-age=31536000"
|
||||
|
||||
ServerName airtime.example.com
|
||||
#ServerAlias www.example.com
|
||||
|
||||
ServerAdmin admin@example.com
|
||||
|
||||
DocumentRoot /usr/share/airtime/php/airtime_mvc/public
|
||||
DirectoryIndex index.php
|
||||
|
||||
<Directory /usr/share/airtime/php/airtime_mvc/public>
|
||||
Options -Indexes FollowSymLinks MultiViews
|
||||
AllowOverride all
|
||||
Order allow,deny
|
||||
Allow from all
|
||||
</Directory>
|
||||
</VirtualHost>
|
||||
|
||||
<VirtualHost *:80>
|
||||
ServerName airtime.example.com
|
||||
|
||||
ServerAdmin admin@example.com
|
||||
|
||||
DocumentRoot /usr/share/airtime/php/airtime_mvc/public
|
||||
Redirect permanent /login https://airtime.example.com/login
|
||||
|
||||
SetEnv APPLICATION_ENV "production"
|
||||
|
||||
<Directory /usr/share/airtime/php/airtime_mvc/public>
|
||||
Options -Indexes FollowSymLinks MultiViews
|
||||
AllowOverride All
|
||||
Order allow,deny
|
||||
Allow from all
|
||||
</Directory>
|
||||
</VirtualHost>
|
||||
|
||||
Save the file with **Ctrl+O** and exit the **nano** editor with **Ctrl+X**. Then restart Apache with the command:
|
||||
|
||||
sudo service apache restart
|
||||
|
||||
When attempting to log into your server via http:// in future, you should be redirected to https:// automatically.
|
||||
|
||||
Importing a self-signed certificate into the browser
|
||||
----------------------------------------------------
|
||||
|
||||
The first time you access an LibreTime server with a self-signed certificate over https:// your browser will block the login page and display a security warning. In **Mozilla Firefox**, you can click **Technical Details** to confirm that the warning is due to the certificate being self-signed before clicking the **Add Exception** button. In **Google Chrome**, the button to click on the security warning page is **Proceed Anyway**.
|
||||
|
||||
|
||||
|
||||
On the next page in Firefox, click the **Get Certificate** button to inspect the details of the self-signed certificate. If all is well, click the **Confirm Security Exception** button. You should now be able to proceed to the https:// login page.
|
||||
|
||||
|
||||
|
||||
If the users of your LibreTime server wish to avoid going through these steps, or they do not trust the remote LibreTime server to be what it claims to be, it is also possible to import a trusted local copy of a certificate file into the browser. For example, in Firefox version 30 preferences, you can go into the **Advanced** section, click the **Certificates** tab, then click the **View Certificates** button. On the **Servers** tab of the **Certificate Manager**, there is an **Import** button which enables you to load a certificate file from the local computer.
|
||||
|
||||
Mixed encrypted and unencrypted content
|
||||
---------------------------------------
|
||||
|
||||
Whether your certificate is self-signed or not, you will see browser security warnings whenever a https:// page is delivering unencrypted content, such as the stream from an Icecast server. In Firefox, an exclamation mark icon is displayed in the address bar of the **Listen** pop-up.
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 70 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 40 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 23 KiB |
Loading…
Add table
Add a link
Reference in a new issue