Add converted 2.5.x manual on top of pro manual
I tried to only merge what makes sense for us, there is still quite some cleanup needed, this commit tries to preserve the 2.5 manual as much as possible while still keeping the rare new stuff from pro.
This commit is contained in:
Lucas Bickel
parent
7f02761e8d
commit
187afcb206
159 changed files with 3148 additions and 230 deletions
|
|
@ -1,15 +1,12 @@
|
|||
Add media
|
||||
=========
|
||||
If you do not have direct access to the Airtime server, you can add files to the Airtime library using the **Add Media** page of the administration interface. (The **Add Media** page is not visible to *Guest* users). This page includes an upload queue for media files, which supports drag and drop from your computer's file manager if you are using a recent web browser, such as *Mozilla Firefox 16* or later.
|
||||
|
||||
You can add files to the Airtime library using the **Add Media** page of the administration interface. (The **Add Media** page is not visible to *Guest* users). This page includes an upload queue for media files, which supports drag and drop from your computer's file manager if you are using a recent web browser, such as the current version of *Mozilla Firefox* or *Google Chrome*.
|
||||
Some web browsers may set an upload limit for a single file, between 200MB and 2GB. If you need to upload files larger than 200MB to the Airtime server on a regular basis, you may find it more convenient to perform the upload using SFTP, rather than through the browser. See the chapter *Automated file import* for more details.
|
||||
|
||||
Some web browsers may set an upload limit for a single file, between 200MB and 2GB. If you need to upload files larger than 200MB to the Airtime server on a regular basis, you may find it more convenient to perform the upload using FTP, rather than through the browser. You can obtain FTP login details from the Sourcefabric support team.
|
||||
|
||||
<img src="static/Screenshot557-Select_files_a7GflUi.png" alt="Select files" width="740" height="610" />
|
||||
|
||||
|
||||
If your web browser does not support drag and drop, you can use the **Add files** button, which has a white plus sign in a green circle icon, to open a file selection window on your computer.
|
||||
|
||||
<img src="static/Screenshot143-File_upload.png" width="595" height="500" />
|
||||
|
||||
|
||||
After you have added all the files that you require to the upload queue, click the **Start upload** button, which has a green arrow icon.
|
||||
|
||||
|
|
@ -24,4 +21,3 @@ Once it has been uploaded successfully, each file row displays a white check mar
|
|||
|
||||
|
||||
Your files are now imported into the Airtime library, ready to be included in your broadcast playlists, smart blocks and shows.
|
||||
|
||||
|
|
|
|||
BIN
docs/manual/add-media/static/Screenshot383-Add_media.png
Normal file
BIN
docs/manual/add-media/static/Screenshot383-Add_media.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 85 KiB |
51
docs/manual/airtime-api-authentication/index.md
Normal file
51
docs/manual/airtime-api-authentication/index.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
The Airtime API enables many types of information about the broadcast schedule and configuration to be retrieved from the Airtime 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 Airtime server. This key is autogenerated during Airtime installation and should be unique for each server.
|
||||
|
||||
If you intend to use the Airtime API across a public network, for security reasons it is highly recommended that all API requests are sent over encrypted https: and that the web server is configured to accept requests to the api/ directory from specific host names or IP addresses only.
|
||||
|
||||
The format of API requests is:
|
||||
|
||||
https://airtime.example.com/api/api-action/format/json/api_key/XXXXXX
|
||||
|
||||
where api-action is the type of request and XXXXXX is the secret API key. Available actions include:
|
||||
|
||||
- on-air-light - return true if the station is on air
|
||||
- status - get the status of Airtime components and resource usage
|
||||
- version - returns the version of Airtime installed
|
||||
- get-files-without-silan-value - list files for which silence detection has not yet been performed
|
||||
- get-stream-setting - gets the settings of Airtime output streams
|
||||
- get-stream-parameters - gets the parameters of Airtime output streams
|
||||
|
||||
For example, using the action *get-stream-setting* returns the following output for the first configured stream:
|
||||
|
||||
{"keyname":"s1_type","value":"ogg","type":"string"},
|
||||
|
||||
{"keyname":"s1_host","value":"streaming.example.com","type":"string"},
|
||||
|
||||
{"keyname":"s1_port","value":"8000","type":"integer"},
|
||||
|
||||
{"keyname":"s1_mount","value":"airtime_128","type":"string"},
|
||||
|
||||
{"keyname":"s1_url","value":"http:\/\/airtime.sourcefabric.org","type":"string"},
|
||||
|
||||
{"keyname":"s1_description","value":"Airtime Radio! Stream
|
||||
#1","type":"string"},
|
||||
|
||||
{"keyname":"s1_genre","value":"Screamo","type":"string"},
|
||||
|
||||
which is enough information to construct a player widget dynamically. (s1\_url is the station's homepage, not the stream URL). The same information is provided with an s2\_ prefix for the second stream, and s3\_ prefix for the third stream.
|
||||
|
||||
Some API requests require the directory ID number to be specified as *dir\_id* including:
|
||||
|
||||
- list-all-files - list files in the specified directory
|
||||
- get-files-without-replay-gain - list files in the specified directory for which ReplayGain has not been calculated yet
|
||||
|
||||
For example, using a request such as:
|
||||
|
||||
http://airtime.example.com/api/list-all-files/format/json/api_key/XXXXXX/dir_id/1/
|
||||
|
||||
returns the full path to each media file in the Airtime storage directory:
|
||||
|
||||
{"files":[
|
||||
"imported\/1\/Mark Ronson feat. Saigon\/Here Comes the Fuzz\/7-Diduntdidunt-unknown.flac",
|
||||
"imported\/1\/Jimi Tenor & Tony Allen\/Inspiration Information\/3-Selfish Gene-128kbps.mp3",
|
||||
"]}
|
||||
63
docs/manual/automated-file-import/index.md
Normal file
63
docs/manual/automated-file-import/index.md
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
The *airtime-import* script can be combined with the standard *SFTP* (secure FTP) program and *cron* daemon on a GNU/Linux server to enable automated file import from multiple remote computers. This could save time for your station staff when using distributed production methods, or content syndication.
|
||||
|
||||
Traditional FTP servers use plain text passwords (without encryption) and are therefore not recommended for upload accounts on Airtime servers accessible from the public Internet. SFTP is a cross-platform protocol which works with many desktop programs including **gFTP** for GNU/Linux (<http://www.gftp.org/>). This program can be installed on Debian or Ubuntu desktop computers with the command:
|
||||
|
||||
sudo apt-get install gftp
|
||||
|
||||
Other popular SFTP clients include **FileZilla** for Windows (<http://filezilla-project.org/>) and **Cyberduck** for Mac and Windows (<http://cyberduck.ch/>).
|
||||
|
||||
To enable SFTP uploads, first invoke the **adduser** command to create the *uploads* account on the server. For security reasons this user account is restricted to using SFTP only; it cannot be used for executing other commands in a login shell.
|
||||
|
||||
sudo adduser --home /srv/airtime/uploads --shell /usr/lib/sftp-server uploads
|
||||
|
||||
The server will then invite you to type in the password for the new *uploads* user, and once again for confirmation. The security of your Airtime server depends on the strength of the password that you set, so be sure to use a long and complex password with upper case, lower case and numerical characters. It is not necessary to set a full name or other details for this account.
|
||||
|
||||
Adding user `uploads' ...
|
||||
Adding new group `uploads' (1003) ...
|
||||
Adding new user `uploads' (1002) with group `uploads' ...
|
||||
Creating home directory `/srv/airtime/uploads' ...
|
||||
Copying files from `/etc/skel' ...
|
||||
Enter new UNIX password:
|
||||
Retype new UNIX password:
|
||||
passwd: password updated successfully
|
||||
Changing the user information for uploads
|
||||
Enter the new value, or press ENTER for the default
|
||||
Full Name []:
|
||||
Room Number []:
|
||||
Work Phone []:
|
||||
Home Phone []:
|
||||
Other []:
|
||||
Is the information correct? [Y/n] Y
|
||||
|
||||
Next, create a folder to contain the incoming files:
|
||||
|
||||
sudo mkdir /srv/airtime/uploads/incoming/
|
||||
|
||||
Then create a script to run once per hour:
|
||||
|
||||
sudo nano /etc/cron.hourly/airtime-upload
|
||||
|
||||
The script should import the newly uploaded files from the incoming folder specified, using the *copy* option, and then remove the original uploaded files. This step, rather than simply using the *watch* option on the */srv/airtime/uploads/incoming/* folder, ensures that the *uploads* SFTP account does not have direct write access to the Airtime storage archive. That could be a security risk if the password was compromised.
|
||||
|
||||
#!/bin/sh
|
||||
|
||||
# Run the import script on fresh uploads
|
||||
|
||||
airtime-import copy /srv/airtime/uploads/incoming/
|
||||
|
||||
# Clean the incoming directory to save disk space
|
||||
|
||||
rm -r /srv/airtime/uploads/incoming/*
|
||||
|
||||
Finally, the script should be made executable so that the cron daemon can run it.
|
||||
|
||||
sudo chmod +x /etc/cron.hourly/airtime-upload
|
||||
|
||||
By default, Debian and Ubuntu GNU/Linux run *cron.hourly* tasks at 17 minutes past each hour. This value can be adjusted in the file */etc/crontab* on the server, if required.
|
||||
|
||||
Remote users should connect to the Airtime server using their client software of choice, making sure that they specify an SFTP rather than FTP connection. The remote directory for the clients to use would be */srv/airtime/uploads/incoming/* as configured above.*
|
||||
*
|
||||
|
||||
|
||||
|
||||
For additional security, you could configure your Airtime server to use an encryption key pair for the *uploads* account, instead of a password. See <https://help.ubuntu.com/community/SSH/OpenSSH/Keys> for details of how to do this on an Ubuntu server.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
220
docs/manual/automated-installation/index.md
Normal file
220
docs/manual/automated-installation/index.md
Normal file
|
|
@ -0,0 +1,220 @@
|
|||
This installation method is intended for computers running Ubuntu or Debian GNU/Linux, and is the recommended method for production Airtime systems. If you have previously performed a manual installation of Airtime on the server, you should run the *airtime-uninstall* script to remove it before setting up the server for automated installation.
|
||||
|
||||
Set up repositories for Ubuntu
|
||||
------------------------------
|
||||
|
||||
When installing on an Ubuntu server, a few of the packages that Airtime relies on are in the Ubuntu *universe* or *multiverse* repositories. If either of these repositories is disabled, you can enable them in the */etc/apt/sources.list* file, by opening the *nano* editor in your server's console. The *nano* editor should be installed by default, but if not, you can install it with the command:
|
||||
|
||||
sudo apt-get install nano
|
||||
|
||||
Then open the *sources.list* file with the command:
|
||||
|
||||
sudo nano /etc/apt/sources.list
|
||||
|
||||
For an Ubuntu 10.04 Lucid server, find the lines which begin *deb* and end with *lucid universe* or *lucid-updates universe*, adding *multiverse* to the end of these lines, if it is not there already. Other versions of Ubuntu will have similar lines. The *multiverse* repository is required for the *libmp3lame0* library, which is an MP3 encoder. Later versions of Ubuntu, such as 12.04 Precise, have *libmp3lame0* in the *universe* repository.
|
||||
|
||||
|
||||
|
||||
The exact repository mirror URLs in your *sources.list* file will differ from the above screenshot, depending on your location.
|
||||
|
||||
The Sourcefabric repository contains packages for Airtime, and any other packages which Airtime requires. To add the Sourcefabric repository to an Ubuntu Lucid server, scroll to the end of the *sources.list* file and add the following line:
|
||||
|
||||
deb http://apt.sourcefabric.org/ lucid main
|
||||
|
||||
For Ubuntu 12.04 Precise, 12.10 Quantal, 13.04 Raring or 13.10 Saucy substitute *precise*, *quantal*, *raring* or *saucy* in place of *lucid* in the line above.
|
||||
|
||||
|
||||
|
||||
Press Ctrl+O (the Ctrl key and the letter O together) to save the file, then Ctrl+X to exit the nano editor.
|
||||
|
||||
Set up repositories for Debian
|
||||
------------------------------
|
||||
|
||||
On a Debian squeeze or wheezy server, you can edit the */etc/apt/sources.list* file as root with the command:
|
||||
|
||||
nano /etc/apt/sources.list
|
||||
|
||||
Packages for MP3 encoding are not included in the Debian squeeze repositories. If your server runs squeeze, you can obtain the necessary *libmp3lame0* package by adding the following repository to the end of the file:
|
||||
|
||||
deb http://backports.debian.org/debian-backports squeeze-backports main
|
||||
|
||||
To add the Sourcefabric repository to a Debian squeeze server, add the following line to the end of the file:
|
||||
|
||||
deb http://apt.sourcefabric.org/ squeeze main
|
||||
|
||||
or for Debian wheezy:
|
||||
|
||||
deb http://apt.sourcefabric.org/ wheezy main
|
||||
|
||||
Press Ctrl+O (the Ctrl key and the letter O together) to save the file, then Ctrl+X to exit the *nano* editor.
|
||||
|
||||
Install the Sourcefabric signing key
|
||||
-------------------------------------
|
||||
|
||||
Reload the system's package list with:
|
||||
|
||||
sudo apt-get update
|
||||
|
||||
You will see an error message about a missing public key.
|
||||
|
||||
|
||||
|
||||
To fix this system error, you need to install the *sourcefabric-keyring* package, which contains the package signing key. This encryption key is a security measure which helps ensure that the Airtime packages you will be downloading in future have not been tampered with by a third party. You can install the key with the command:
|
||||
|
||||
sudo apt-get install sourcefabric-keyring
|
||||
|
||||
When prompted, press the *y* key on your keyboard to install the *sourcefabric-keyring* package without verification. If you wish to verify the authenticity of the package signing key, please contact Sourcefabric for assistance.
|
||||
|
||||
|
||||
|
||||
Update your computer's software sources again, to confirm that you are now using a trusted software repository:
|
||||
|
||||
sudo apt-get update
|
||||
|
||||
You should no longer see the error message about the missing public key.
|
||||
|
||||
Install the database management system
|
||||
--------------------------------------
|
||||
|
||||
Airtime uses a PostgreSQL database to keep track of media assets and associated metadata in its storage server. Depending on the scale of your Airtime installation and the hardware available, you may wish to install PostgreSQL on a separate server. If you only have one server, you can install the *postgresql* package on the same machine as Airtime with the command:
|
||||
|
||||
sudo apt-get install postgresql
|
||||
|
||||
Install a streaming server
|
||||
--------------------------
|
||||
|
||||
Optionally, you may wish to stream directly from Airtime to an **Icecast** media distribution server, without requiring a soundcard or mixer in the broadcast chain. This option is particularly suitable for fully automated stations, in which all shows are played out using Airtime. You can install the **icecast2** package on your server with the command:
|
||||
|
||||
sudo apt-get install icecast2
|
||||
|
||||
In some scenarios, you may wish to stream from Airtime to a remote Icecast server, for example when Icecast is installed on a server in a data center with greater bandwidth available than an Airtime server located at your broadcast studio has. This separation may become necessary if your stream becomes popular, because each additional listener which connects to the Icecast stream uses additional bandwidth. In this case, you do not need to install the **icecast2** package on the same server as Airtime.
|
||||
|
||||
Before running Icecast on a remote server for the first time, you should change the default *<source-password>*, *<relay-password>* and *<admin-password>* values from *hackme* to something more secure. On more recent GNU/Linux distributions, such as Ubuntu 12.04 'Precise Pangolin' or later, you may be prompted for these settings during the installation of Icecast. If not, you can edit the Icecast configuration manually, with the command:
|
||||
|
||||
sudo nano /etc/icecast2/icecast.xml
|
||||
|
||||
|
||||
|
||||
You should also set the value of *<hostname>* to the domain name of the Icecast server, for example:
|
||||
|
||||
<hostname>icecast.example.com</hostname>
|
||||
|
||||
This step ensures that stream URLs are generated correctly by the Icecast server.
|
||||
|
||||
Save and close the *icecast.xml* file with Ctrl+O and Ctrl+X. Then check the Icecast server is set to start automatically when the server boots in the */etc/default/icecast2* file:
|
||||
|
||||
sudo nano /etc/default/icecast2
|
||||
|
||||
The value of *ENABLE* should be set to *true* on the last line of that file:
|
||||
|
||||
ENABLE=true
|
||||
|
||||
Save and close this file with Ctrl+O and Ctrl+X, then start Icecast:
|
||||
|
||||
sudo service icecast2 start
|
||||
|
||||
The server should respond:
|
||||
|
||||
Starting icecast2: Starting icecast2
|
||||
Detaching from the console
|
||||
icecast2.
|
||||
|
||||
Install Airtime
|
||||
---------------
|
||||
|
||||
You can now install the Airtime package with:
|
||||
|
||||
sudo apt-get install airtime
|
||||
|
||||
This command will install all of the Airtime components, plus any other packages that Airtime requires in order to run.
|
||||
|
||||
Reading package lists... Done
|
||||
Building dependency tree
|
||||
Reading state information... Done
|
||||
Suggested packages:
|
||||
airtime-audio-samples
|
||||
The following NEW packages will be installed
|
||||
airtime
|
||||
0 upgraded, 1 newly installed, 0 to remove and 2 not upgraded.
|
||||
Need to get 8,446kB of archives.
|
||||
After this operation, 33.3MB of additional disk space will be used.
|
||||
Get: 1 http://apt.sourcefabric.org/ precise/main airtime 2.5.0-1 [8,446kB]
|
||||
Fetched 8,446kB in 8s (1,015kB/s)
|
||||
Preconfiguring packages ...
|
||||
Selecting previously deselected package airtime.
|
||||
(Reading database ... 657254 files and directories currently installed.)
|
||||
Unpacking airtime (from .../airtime_2.5.0-1_all.deb) ...
|
||||
|
||||
Once all the packages have been downloaded and installed, you will be asked a few questions about the configuration of the Airtime system. You can accept the default settings by pressing the **Enter** key, or use the **Tab** key to change your selection.
|
||||
|
||||
Firstly, you will asked if you wish to create an **Apache** virtual host web server configuration automatically.
|
||||
|
||||
|
||||
|
||||
If so, you will need to enter the domain name that your station staff will use to access Airtime. This would normally be a fully qualified domain name (FQDN) which is already set up in DNS, or dynamic DNS, to point to the IP address of the Airtime server. For a test server that will only be accessed directly from the same machine, you can use the default setting of *localhost* here.
|
||||
|
||||
|
||||
|
||||
Next, set the contact email address of the server administrator, which is good practice in case of any server problems. For a test server, using an address at the *localhost* is acceptable.
|
||||
|
||||
|
||||
|
||||
Debian and Ubuntu servers are set up with a default Apache configuration, which might block station staff from accessing Airtime. If you wish, this default configuration can be removed automatically for you.
|
||||
|
||||
|
||||
|
||||
If you are installing Airtime and Icecast on the same machine, you can set the hostname and passwords for the Icecast server during the Airtime installation.
|
||||
|
||||
|
||||
|
||||
First, set the hostname of the Icecast server. For test installs in which you have Icecast installed on the same machine as Airtime, you can use *localhost* here.
|
||||
|
||||
|
||||
|
||||
The security of your streaming server depends on the strength of the passwords that you choose. You should set strong passwords for *source*, *relay* and *admin* access.
|
||||
|
||||
|
||||
|
||||
By default, Airtime stores media files under the path */srv/airtime/stor/* but you can specify an alternative path if you wish. If you change this setting, the new path must end with a slash. This main storage path is separate from the *watched folders* which are configured after installation, in the Airtime administration interface. See the chapter *Media Folders* for details of how to add watched folders.
|
||||
|
||||
|
||||
|
||||
Finally, you have the option to set a more secure password for Airtime's *admin* user than the default of *admin*. You could change the password for the *admin* user later, in the Airtime administration interface, but this would mean that your installation would be insecure until you carried out that task.
|
||||
|
||||
|
||||
|
||||
On some GNU/Linux distributions, you may be warned about upgrading the **rabbitmq-server** package, even if you have never installed this package before. If RabbitMQ is only being used by Airtime on your server, it is safe to press the **Enter** key to continue.
|
||||
|
||||
|
||||
|
||||
The Airtime installer will then run a script to check that your server environment is set up correctly.
|
||||
|
||||
*** Verifying your system environment, running airtime-check-system ***
|
||||
AIRTIME_STATUS_URL = http://airtime.example.com:80/api/status/format/json/api_key/%%api_key%%
|
||||
AIRTIME_SERVER_RESPONDING = OK
|
||||
KERNEL_VERSION = 3.2.0-4-amd64
|
||||
MACHINE_ARCHITECTURE = x86_64
|
||||
TOTAL_MEMORY_MBYTES = 2963688
|
||||
TOTAL_SWAP_MBYTES = 7812092
|
||||
AIRTIME_VERSION = 2.5.1
|
||||
OS = Debian GNU/Linux 7.1 (wheezy) x86_64
|
||||
CPU = AMD Turion(tm) II Neo N40L Dual-Core Processor
|
||||
WEB_SERVER = Apache/2.2.22 (Debian)
|
||||
PLAYOUT_ENGINE_PROCESS_ID = 4446
|
||||
PLAYOUT_ENGINE_RUNNING_SECONDS = 55
|
||||
PLAYOUT_ENGINE_MEM_PERC = 0.5%
|
||||
PLAYOUT_ENGINE_CPU_PERC = 0.4%
|
||||
LIQUIDSOAP_PROCESS_ID = 4685
|
||||
LIQUIDSOAP_RUNNING_SECONDS = 49
|
||||
LIQUIDSOAP_MEM_PERC = 0.7%
|
||||
LIQUIDSOAP_CPU_PERC = 7.4%
|
||||
MEDIA_MONITOR_PROCESS_ID = 4410
|
||||
MEDIA_MONITOR_RUNNING_SECONDS = 55
|
||||
MEDIA_MONITOR_MEM_PERC = 0.5%
|
||||
MEDIA_MONITOR_CPU_PERC = 0.0%
|
||||
-- Your installation of Airtime looks OK!
|
||||
|
||||
************ Install Complete ************
|
||||
|
||||
You should now be able to log in to the Airtime administration interface, as shown in the *Getting started* chapter. See the *Host configuration* chapter for advanced settings.
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 13 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 23 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.5 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 32 KiB |
31
docs/manual/backing-up-the-server/index.md
Normal file
31
docs/manual/backing-up-the-server/index.md
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
The following shell commands can be used for database backup and restore on a running *PostgreSQL* server in an Airtime system.
|
||||
|
||||
You can dump the entire database to a zipped file with the combination of the **pg\_dumpall** command and **gzip**. The **pg\_dumpall** command is executed as the user *postgres*, by using the **sudo** command and the **-u** switch. It is separated from the **gzip** command with the pipe symbol.
|
||||
|
||||
sudo -u postgres pg_dumpall | gzip -c > airtime-backup.gz
|
||||
|
||||
This command can be automated to run on a regular basis using the standard **cron** tool on your server.
|
||||
|
||||
When restoring a production database on a cleanly installed Airtime system, it may be necessary to drop the empty database that was created during the new installation, by using the **dropdb** command. Again, this command is executed with **sudo** as the user *postgres*:
|
||||
|
||||
sudo -u postgres dropdb airtime
|
||||
|
||||
This **dropdb** command above is necessary to avoid 'already exists' errors on table creation when overwriting an empty Airtime database in the next step. These errors might prevent some data from being restored, such as user account data.
|
||||
|
||||
To restore, first unzip the backup file with **gunzip**, then use the **psql** command as the *postgres* user:
|
||||
|
||||
gunzip airtime-backup.gz
|
||||
sudo -u postgres psql -f airtime-backup
|
||||
|
||||
You should now be able to log in to the Airtime web interface in the usual way.
|
||||
|
||||
For safety reasons, your regular database backups should be kept in a directory which is backed up by your storage backup tool of choice; for example, the */srv/airtime/database\_backups* directory. This should ensure that a storage restore can be made along with a matching and complete version of the Airtime database from the day that the storage backup was made.
|
||||
|
||||
Storage backup
|
||||
--------------
|
||||
|
||||
Backing up the Airtime database with **pg\_dumpall** will not back up the Airtime media storage server, which is likely to need a great deal more backup space. Creating a compressed file from hundreds of gigabytes of storage server contents is likely to take a very long time, and may have little benefit for the amount of CPU power used, if the media files are already stored in a highly compressed format. It is also impractical to copy very large backup files across the network on a daily basis.
|
||||
|
||||
Instead, it is preferable to use an incremental backup technique to synchronize the production Airtime server storage with a backup server each day or night. If the backup server also contains an Airtime installation, it should be possible to switch playout to this second machine relatively quickly, in case of a hardware failure or other emergency on the production server.
|
||||
|
||||
A standard incremental backup tool on GNU/Linux servers is *rsync* [(http://rsync.samba.org/)](http://rsync.samba.org/)) which can be installed using the package manager of your GNU/Linux distribution. However, incremental backup alone cannot help in the scenario where a file which later proves to be important has been deleted by an administrator. For backups that can be rolled back to restore from an earlier date than the current backup, the tool *rdiff-backup* [(http://www.nongnu.org/rdiff-backup/](http://www.nongnu.org/rdiff-backup/)) can be deployed.
|
||||
|
|
@ -1,6 +1,3 @@
|
|||
Calendar
|
||||
========
|
||||
|
||||
The Calendar page of the Airtime administration interface has three views: **day**, **week** and **month**, which can be switched using the grey buttons in the top right corner. By default, the **month** view is shown, with today's date highlighted by a pale green background.
|
||||
|
||||
|
||||
|
|
@ -12,7 +9,7 @@ In the top left corner of the page, you can go back or forward through the **Cal
|
|||
Adding a show
|
||||
-------------
|
||||
|
||||
Only *Admins* and *Program Managers* can use this feature. To add a new show to the Calendar, click the **+ Show** button in the top left corner of the page, or click on any future row or box in the Calendar which is empty. Either of these actions opens the **Add this show** box, which has five sections, arranged vertically: **What**, **When**, **Live Stream Input**, **Who**, and **Style**. Click the small black triangle to the left of the section name if you wish to minimize or maximize it.
|
||||
Only *Admins* and *Program Managers* can use this feature. To add a new show to the Calendar, click the **+ Show** button in the top left corner of the page, or click on any future row or box in the Calendar which is empty. Either of these actions opens the **Add this show** box, which has six sections, arranged vertically: **What**, **When**, **Live Stream Input**, **Record & Rebroadcast**, **Who**, and **Style**. Click the small black triangle to the left of the section name if you wish to minimize or maximize it.
|
||||
|
||||
What
|
||||
----
|
||||
|
|
@ -28,34 +25,47 @@ Next, in the **When** section, if you clicked on a date in the **Calendar** this
|
|||
|
||||
By default, the **Timezone** of the show start and end times will be the timezone of the station, as set on the Preferences page on the System menu. You can specify an alternative time zone using the drop-down menu, if you wish. The time zone displayed in the Calendar when you log in depends on your personal settings. See 'Updating your own account' in the chapter *Users* for more details.
|
||||
|
||||
<img src="static/Screenshot526-Add_show_when_250.png" width="595" height="350" />
|
||||
|
||||
|
||||
Airtime will only allow you to enter valid times for shows. If you attempt to schedule show times which would be impossible, by ending the show before it begins, Airtime will highlight the error with a pink background.
|
||||
|
||||
<img src="static/Screenshot527-negative_time250.png" width="340" height="220" />
|
||||
|
||||
|
||||
To schedule a regular show, check the **Repeats?** box, which will make a new section of the dialog appear. Optionally, click the **Link:** box to automatically schedule the same content in the repeated shows as in the original show.
|
||||
|
||||
<img src="static/Screenshot528-Link_shows_250.png" width="340" height="455" />
|
||||
|
||||
|
||||
Then select either **weekly**, **every 2 weeks**, **every 3 weeks**, **every 4 weeks** or **monthly** from the **Repeat Type** drop-down menu. If you have selected a weekly option, check the boxes for the days of the week that you want to schedule the regular show on. If you have selected **monthly**, you have the option to **Repeat By: day of the month** (for example the 9th of each month) or **day of the week** (for example the second Wednesday of each month).
|
||||
|
||||
<img src="static/Screenshot529-repeat_type_monthly_250.png" width="340" height="410" />
|
||||
|
||||
|
||||
Uncheck the **No End?** box and set the **Date End** for the regular show to finish, or leave the **No End?** box checked to schedule the show indefinitely.
|
||||
|
||||
<img src="static/Screenshot530-show_end_date_250.png" width="355" height="575" />
|
||||
|
||||
|
||||
Live Stream Input
|
||||
-----------------
|
||||
|
||||
The **Live Stream Input** section can be used to enable live input streams during the show, and also to configure authentication for them. If you check the **Use Airtime Authentication** box, the DJs (presenters) of the show will be able to connect a live stream to Airtime's **Show Source Mount** using their login name and password. See the chapter *Stream Settings* for details.
|
||||
The **Live Stream Input** section can be used to enable live input streams during the show, and also to configure authentication for them. If you check the **Use Airtime Authentication** box, the DJs (presenters) of the show will be able to connect a live stream to Airtime's **Show Source Mount Point** using their login name and password. See the chapter *Stream Settings* for details.
|
||||
|
||||
If you check the **Use Custom Authentication** box instead, you can set a one-time username and password pair for live stream input to the show. For example, you may wish to create an authenticated live stream input for a particular remote news reporter, without providing any further access to your Airtime server for that person.
|
||||
|
||||
<img src="static/Screenshot587-Live_stream_input.png" alt="Live stream input" width="354" height="539" />
|
||||
|
||||
|
||||
A reminder of the **Host**, **Port** and **Mount** point for the live input stream to use is shown at the end of the **Live Stream Input** section.
|
||||
A reminder of the **Connection URL** for the live input stream to use is shown at the end of the **Live Stream Input** section.
|
||||
|
||||
Record & Rebroadcast
|
||||
--------------------
|
||||
|
||||
In the **Record & Rebroadcast** section, checking the **Record from Line In?** box enables automatic recording of the soundcard line input, if your Airtime server has one, at the time of the show. Shows set for line-in recording should not also contain files or playlists. The default audio format for live recordings is 256kbps Ogg Vorbis, and the files are saved in the *recorded* folder, under the **Import Folder** path set in the **Media Folders** page on the **System** menu. See the chapter *Host configuration* for details of recorder settings.
|
||||
|
||||
If you wish the recording to be played out at a later time, check the **Rebroadcast?** box, and then select up to ten date and time slots in the **Choose Days** box.
|
||||
|
||||
|
||||
|
||||
Shows set for recording have a small red dot icon in the calendar, while rebroadcast shows have a white loop icon.
|
||||
|
||||
|
||||
|
||||
Who
|
||||
---
|
||||
|
|
@ -73,20 +83,20 @@ Show colours in the Calendar are set automatically, based on the **Name** of the
|
|||
|
||||
Optionally, you can upload a Show Logo by clicking the **Browse** button.
|
||||
|
||||
<img src="static/Screenshot584-Show_logo.png" alt="Show logo" width="335" />
|
||||
|
||||
|
||||
Finally, click the **+ Add this show** button at the top or bottom of the box. The new show will now be displayed in the **Calendar**, with a regular slot if you have chosen to schedule one.
|
||||
Finally, click the **Add this show** button at the top or bottom of the box. The new show will now be displayed in the **Calendar**, with a regular slot if you have chosen to schedule one.
|
||||
|
||||
Editing a show
|
||||
--------------
|
||||
|
||||
Show configuration and metadata can be changed at any time before the end of a show, except for **Date/Time Start**, which is fixed after broadcast of that show commences. Click the show in the Calendar, and select either **Edit Show** for a one-off show, **Edit** then **Edit This Show** for all episodes of a repeating show or ****Edit**** then **Edit This Instance** for just one episode of a repeating show, from the pop-up context menu. Any of these actions opens the **Update Show** box, which is almost exactly the same as the **Add this Show** box. Click the **+ Update show** button at the top or bottom of the box when you are done.
|
||||
Show configuration and metadata can be changed at any time, except for **Date/Time Start** and **Record from Line In?** options, which are fixed after broadcast of that show commences. Click the show in the Calendar, and select **Edit Show** from the pop-up context menu. This opens the **Update Show** box, which is almost exactly the same as the **Add this Show** box. Click the **+ Update show** button at the top or bottom of the box when you are done.
|
||||
|
||||
|
||||
|
||||
Episodes of repeating shows also have an **Instance Description** field in which you can add details for that particular episode. Click the episode in the Calendar, click **Edit** on the pop-up menu, then click **Edit this instance**. After entering an Instance Description, click the **+ Update show** button.
|
||||
|
||||
<img src="static/Screenshot583-Show_instance_description_vC9ooiT.png" alt="Show instance description" width="340" height="443" />
|
||||
|
||||
|
||||
Alternatively, individual shows can be clicked on and dragged to new days and times in the calendar. However, Airtime will not allow you to drag a future show into the past, or drag and drop instances of a repeated show. In the **Day** and **Week** views, show length can be adjusted by clicking on the lower edge of the show box, and dragging the edge of the box upwards or downwards. The new show length is calculated automatically.
|
||||
|
||||
|
|
|
|||
BIN
docs/manual/calendar/static/Screenshot457-Live_stream_input.png
Normal file
BIN
docs/manual/calendar/static/Screenshot457-Live_stream_input.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 19 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
16
docs/manual/convert.sh
Executable file
16
docs/manual/convert.sh
Executable file
|
|
@ -0,0 +1,16 @@
|
|||
#!/bin/bash
|
||||
|
||||
book="booktype-25"
|
||||
base_path=`pwd`
|
||||
pandoc_cmd="docker run --rm -ti -v ${base_path}:${base_path} jagregory/pandoc"
|
||||
|
||||
for html in `find ${book} -name 'index.html'`; do
|
||||
pushd `dirname $html`
|
||||
mkdir -p ${base_path}/`dirname ${html#*/}`
|
||||
$pandoc_cmd -o - -f html -t markdown_github ${base_path}/${html} > `echo "${base_path}/${html#*/}" | sed 's/html$/md/'`
|
||||
popd
|
||||
done
|
||||
|
||||
for static in `find ${book} -name 'static'`; do
|
||||
cp -rp ${static} ${static#*/}
|
||||
done
|
||||
50
docs/manual/easy-setup/index.md
Normal file
50
docs/manual/easy-setup/index.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
The **airtime-easy-setup** package sets up a typical Airtime configuration without prompting you for any settings. You can then install the latest Airtime package from the Sourcefabric repository with a few clicks.
|
||||
|
||||
After that, the Airtime administration interface can be accessed at the default domain name of the computer (such as *http://airtime.example.com*). If you have not yet set a fully qualified domain name for the computer, you can use a URL such as *http://ubuntu/* on the localhost for testing purposes. Whichever domain name you use, the Icecast administration interface will be at port 8000 of the same URL (such as *http://airtime.example.com:8000*).
|
||||
|
||||
You can download the **airtime-easy-setup** package from <http://apt.sourcefabric.org/misc/airtime-easy-setup.deb> which is a link to the latest version of the package. You should stay connected to the Internet throughout the installation, as a number of dependency packages have to be installed from online repositories.
|
||||
|
||||
On Ubuntu 10.04 'lucid', Debian 6.0 'squeeze' or Debian 7.2 'wheezy', you can run the **airtime-easy-setup** ** package from your browser using the program **GDebi**.
|
||||
|
||||
|
||||
|
||||
If you have chosen to save the package to your computer instead, in the desktop file manager, right-click on the **airtime-easy-setup** ** package and select **Open with GDebi Package Installer**:
|
||||
|
||||
|
||||
|
||||
Or for an Ubuntu Lucid or Debian server without a desktop, you can use <span style="font-weight: bold;">gdebi</span> on the command line:
|
||||
|
||||
sudo apt-get update
|
||||
sudo gdebi airtime-easy-setup.deb
|
||||
|
||||
If gdebi is not installed, you can run this command first:
|
||||
|
||||
sudo apt-get install gdebi
|
||||
|
||||
Later versions of Ubuntu have replaced GDebi with the program **software-center**. On a desktop installation, right-click on the package and select **Open with Ubuntu Software Centre**. This desktop program can also be run from the command line, for example:
|
||||
|
||||
software-center airtime-easy-setup.deb
|
||||
|
||||
|
||||
|
||||
Any of the methods above should resolve package dependencies automatically.
|
||||
|
||||
Install Airtime
|
||||
---------------
|
||||
|
||||
Once the installation of **airtime-easy-setup** has completed, you can install the latest Airtime package on a desktop system using your usual package manager, such as **Ubuntu Software Centre**, or **Synaptic** on Debian.
|
||||
|
||||
|
||||
|
||||
On a server, you can use the command:
|
||||
|
||||
sudo airtime-easy-setup
|
||||
|
||||
Configure for production
|
||||
------------------------
|
||||
|
||||
To convert a test installation into a production installation, you can run the command:
|
||||
|
||||
sudo dpkg-reconfigure airtime
|
||||
|
||||
The **dkpg-reconfigure** command will run through the configuration steps shown in the *Automated installation* chapter, so that you can set the correct hostnames and passwords for your production Airtime server.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 49 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 29 KiB |
45
docs/manual/expert-install/index.md
Normal file
45
docs/manual/expert-install/index.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
These quick install steps are suitable for experienced GNU/Linux system administrators who have already followed the steps shown in the chapter *Preparing the server* earlier in this book. For a more detailed explanation of the steps below, please read the chapter *Automated installation*.
|
||||
|
||||
1. Edit the repositories file for your server:
|
||||
|
||||
sudo nano /etc/apt/sources.list
|
||||
|
||||
For Ubuntu Precise \[or Quantal, Raring, Saucy\] servers, use the Sourcefabric repository:
|
||||
|
||||
deb http://apt.sourcefabric.org/ precise main
|
||||
|
||||
substituting *precise* if appropriate. Make sure you have enabled the multiverse repository for MP3 encoding support:
|
||||
|
||||
deb http://archive.ubuntu.com/ubuntu/ precise multiverse
|
||||
|
||||
For Debian wheezy \[or squeeze\] servers, use the Sourcefabric repository:
|
||||
|
||||
deb http://apt.sourcefabric.org/ wheezy main
|
||||
|
||||
If using Debian squeeze, also enable the backports repository for MP3 encoding support:
|
||||
|
||||
deb http://backports.debian.org/debian-backports squeeze-backports main
|
||||
|
||||
2. Install the Sourcefabric package signing key, then update again:
|
||||
|
||||
sudo apt-get update
|
||||
sudo apt-get install sourcefabric-keyring
|
||||
sudo apt-get update
|
||||
|
||||
3. Install the database management system (for a single server configuration):
|
||||
|
||||
sudo apt-get install postgresql
|
||||
|
||||
4. Install the streaming media server (optional, it may be remote):
|
||||
|
||||
sudo apt-get install icecast2
|
||||
|
||||
5. Remove PulseAudio, if installed:
|
||||
|
||||
sudo apt-get purge pulseaudio
|
||||
|
||||
6. Install Airtime:
|
||||
|
||||
sudo apt-get install airtime
|
||||
|
||||
Refer to the *Configuration* chapter for configuration options. Now you should be able to log in to the Airtime administration interface, as shown in the *Getting started* chapter.
|
||||
375
docs/manual/exporting-the-schedule/index.md
Normal file
375
docs/manual/exporting-the-schedule/index.md
Normal file
|
|
@ -0,0 +1,375 @@
|
|||
Airtime has a feature which enables your station's show and schedule information to be displayed on remote websites. This feature is included in Airtime because you would not usually invite the general public to access your Airtime server directly. If you had very large numbers of people requesting data from the Airtime server at once, the burst of network traffic might overload the server, potentially disrupting your broadcasts. If carried out maliciously, this network overload is known as a *denial of service attack*.
|
||||
|
||||
Instead, your public-facing web server can retrieve the schedule information from the Airtime API. This information can then be displayed on your broadcast station or affiliate websites by a content management system, such as Sourcefabric's **Newscoop** (<http://newscoop.sourcefabric.org/>). It can be presented using Javascript widgets and styled with CSS, in any format that you require. The **Broadcaster** theme for Newscoop (<https://github.com/newscoop/theme-Broadcaster>) integrates these widgets with ready-to-use styles.
|
||||
|
||||
There are two kinds of information that can be retrieved remotely from the Airtime API without authentication; the metadata for the current show plus the following show (live-info), or the schedule for the current week and the week ahead (week-info). The week-info metadata includes show names, times, and individual show URLs on your public website. That way, the audience for your station can click through from the schedule information to find out more about a particular show, or download a previous show recording that you might have made available.
|
||||
|
||||
If your Airtime server was accessible at https://airtime.example.com the live show information could be retrieved by your web server using this URL:
|
||||
|
||||
https://airtime.example.com/api/live-info/?callback
|
||||
|
||||
The comma-separated text metadata returned to your web server might be something like this:
|
||||
|
||||
({"env":"production",
|
||||
"schedulerTime":"2013-07-03 14:07:31",
|
||||
|
||||
"previous":{"name":"Earth, Wind & Fire - Boogie Wonderland",
|
||||
"starts":"2013-07-01 22:53:00",
|
||||
"ends":"2013-07-01 22:55:00",
|
||||
"type":"track"},
|
||||
"current":{"name":"Deodato - Also Sprach Zarathustra",
|
||||
"starts":"2013-07-03 13:07:06",
|
||||
"ends":"2013-07-03 13:16:05",
|
||||
"media_item_played":true,
|
||||
"record":0,
|
||||
"type":"track"},
|
||||
|
||||
"next":{"id":8,
|
||||
"instance_id":10,
|
||||
"name":"Rock Show",
|
||||
"url":"https:\/\/rock.example.com\/",
|
||||
"start_timestamp":"2013-07-03 14:00:00",
|
||||
"end_timestamp":"2013-07-03 15:00:00",
|
||||
"starts":"2013-07-03 14:00:00",
|
||||
"ends":"2013-07-03 15:00:00",
|
||||
"record":0,
|
||||
"type":"show"},
|
||||
|
||||
"currentShow":[{"start_timestamp":"2013-07-03 14:07:00",
|
||||
"0":"2013-07-03 13:07:00",
|
||||
"end_timestamp":"2013-07-03 15:00:00",
|
||||
"1":"2013-07-03 14:00:00",
|
||||
"name":"Funk Show",
|
||||
"2":"Funk Show",
|
||||
"id":7,
|
||||
"3":7,
|
||||
"instance_id":9,"4":9,
|
||||
"record":0,
|
||||
"5":0,
|
||||
"url":"https:\/\/funk.example.com\/",
|
||||
"6":"",
|
||||
"starts":"2013-07-03 14:07:00",
|
||||
"7":"2013-07-03 13:07:00",
|
||||
"ends":"2013-07-03 15:00:00",
|
||||
"8":"2013-07-03 14:00:00"}],
|
||||
|
||||
"nextShow":[{"id":8,
|
||||
"instance_id":10,
|
||||
"name":"Rock Show",
|
||||
"url":"https:\/\/rock.example.com\/",
|
||||
"start_timestamp":"2013-07-03 15:00:00",
|
||||
"end_timestamp":"2013-07-03 16:00:00",
|
||||
"starts":"2013-07-03 15:00:00",
|
||||
"ends":"2013-07-03 16:00:00",
|
||||
"record":0,
|
||||
"type":"show"}],
|
||||
|
||||
"timezone":"BST",
|
||||
"timezoneOffset":"3600",
|
||||
"AIRTIME_API_VERSION":"1.1"})
|
||||
|
||||
The information for the current week's schedule could be retrieved using the URL:
|
||||
|
||||
https://airtime.example.com/api/week-info/?callback
|
||||
|
||||
In this case, the metadata returned would be in a different format from the above example, something like the following. To keep the example short, this particular schedule export only contains four shows on a Monday. A full weekly schedule export would contain a great deal more text.
|
||||
|
||||
({"monday":[
|
||||
|
||||
{"start_timestamp":"2013-07-01 12:05:00",
|
||||
"end_timestamp":"2013-07-01 13:00:00",
|
||||
"name":"Elvis Show",
|
||||
"id":2,
|
||||
"instance_id":2,
|
||||
"record":0,
|
||||
"url":"https:\/\/elvis.example.com\/",
|
||||
"starts":"2013-07-01 12:05:00",
|
||||
"ends":"2013-07-01 13:00:00"},
|
||||
|
||||
{"start_timestamp":"2013-07-01 13:00:00",
|
||||
"end_timestamp":"2013-07-01 14:00:00",
|
||||
"name":"News",
|
||||
"id":3,
|
||||
"instance_id":4,
|
||||
"record":0,
|
||||
"url":"https:\/\/news.example.com\/",
|
||||
"starts":"2013-07-01 13:00:00",
|
||||
"ends":"2013-07-01 14:00:00"},
|
||||
|
||||
{"start_timestamp":"2013-07-01 14:00:00",
|
||||
"end_timestamp":"2013-07-01 15:00:00",
|
||||
"name":"Funk Show",
|
||||
"id":4,
|
||||
"instance_id":6,
|
||||
"record":0,
|
||||
"url":"https:\/\/funk.example.com\/",
|
||||
"starts":"2013-07-01 14:00:00",
|
||||
"ends":"2013-07-01 15:00:00"},
|
||||
|
||||
{"start_timestamp":"2013-07-01 15:00:00",
|
||||
"end_timestamp":"2013-07-01 17:30:00",
|
||||
"name":"Rock Show",
|
||||
"id":5,
|
||||
"instance_id":7,
|
||||
"record":0,
|
||||
"url":"https:\/\/rock.example.com\/",
|
||||
"starts":"2013-07-01 15:00:00",
|
||||
"ends":"2013-07-01 17:30:00"},
|
||||
|
||||
],
|
||||
|
||||
"tuesday":[],
|
||||
"wednesday":[],
|
||||
"thursday":[],
|
||||
"friday":[],
|
||||
"saturday":[],
|
||||
"sunday":[],
|
||||
"AIRTIME_API_VERSION":"1.1"})
|
||||
|
||||
If you see the message *You are not allowed to access this resource* when attempting to display schedule information in your web browser, log in to the Airtime administration interface, click *System* in the main menu, then *Preferences*. Set **Allow Remote Websites To Access "Schedule" Info?** to **Enabled**, click the **Save** button, then refresh the browser window opened on the schedule export URL. If you do not wish to make schedule information available to the public, set this option to **Disabled** instead.
|
||||
|
||||
|
||||
|
||||
Caching schedule information
|
||||
----------------------------
|
||||
|
||||
If the Airtime server is behind a firewall, or you want to protect the Airtime server from large numbers of schedule requests, you may wish to cache the schedule information on a public-facing or intermediate server. You can then create a firewall rule that only allows the schedule server to connect to the Airtime server, in addition to any remote users of the Airtime web interface.
|
||||
|
||||
Your system administrator can set up schedule caching on a standard Apache and PHP enabled web server with the *curl* program installed, using the following steps:
|
||||
|
||||
1. Create a shell script on the schedule server (schedule.example.com) that polls the remote Airtime server (airtime.example.com), and writes the metadata returned into a pair of local temporary files:
|
||||
|
||||
sudo nano /usr/local/bin/airtime-schedule.sh
|
||||
|
||||
The content of this file should be like the following script, replacing airtime.example.com with the name of your Airtime server:
|
||||
|
||||
#!/bin/sh
|
||||
|
||||
curl -s "https://airtime.example.com/api/live-info/?callback=***" > /tmp/live-info
|
||||
|
||||
curl -s "https://airtime.example.com/api/week-info/?callback=***" > /tmp/week-info
|
||||
|
||||
2. Make the script executable:
|
||||
|
||||
sudo chmod +x /usr/local/bin/airtime-schedule.sh
|
||||
|
||||
3. Create an Apache VirtualHost configuration for the schedule server:
|
||||
|
||||
sudo nano /etc/apache2/sites-available/schedule
|
||||
|
||||
containing a definition like the following, replacing *schedule.example.com* with the name of your schedule server:
|
||||
|
||||
<VirtualHost *:80>
|
||||
ServerName schedule.example.com
|
||||
DocumentRoot /var/www/schedule/
|
||||
</VirtualHost>
|
||||
|
||||
4. In the schedule server's DocumentRoot folder, create the folders *api/live-info/* and *api/week-info/*
|
||||
|
||||
sudo mkdir -p /var/www/schedule/api/live-info/
|
||||
sudo mkdir -p /var/www/schedule/api/week-info/
|
||||
|
||||
5. Create an index.php file in the *api/live-info/* folder:
|
||||
|
||||
sudo nano /var/www/schedule/api/live-info/index.php
|
||||
|
||||
containing the following code:
|
||||
|
||||
<?php
|
||||
$filename = '/tmp/live-info'; // define here the path and name of uploaded live-info file
|
||||
|
||||
header('Content-Type: text/javascript');
|
||||
header("Expires: Thu, 01 Jan 1970 00:00:00 GMT");
|
||||
header("Cache-Control: no-store, no-cache, must-revalidate");
|
||||
|
||||
$callback = empty($_GET['callback']) ? null : $_GET['callback'];
|
||||
$content = file_get_contents($filename);
|
||||
$content = str_replace('***', $callback, $content);
|
||||
echo $content;
|
||||
?>
|
||||
|
||||
6. Create an index.php file in the *api/week-info/* folder:
|
||||
|
||||
sudo nano /var/www/schedule/api/week-info/index.php
|
||||
|
||||
containing the following code:
|
||||
|
||||
<?php
|
||||
$filename = '/tmp/week-info'; // define here the path and name of uploaded week-info file
|
||||
|
||||
header('Content-Type: text/javascript');
|
||||
header("Expires: Thu, 01 Jan 1970 00:00:00 GMT");
|
||||
header("Cache-Control: no-store, no-cache, must-revalidate");
|
||||
|
||||
$callback = empty($_GET['callback']) ? null : $_GET['callback'];
|
||||
$content = file_get_contents($filename);
|
||||
$content = str_replace('***', $callback, $content);
|
||||
echo $content;
|
||||
?>
|
||||
|
||||
7. Enable the new configuration and reload the Apache web server:
|
||||
|
||||
sudo a2ensite schedule
|
||||
sudo /etc/init.d/apache2 reload
|
||||
|
||||
8. Create a cron job to run the shell script each minute:
|
||||
|
||||
sudo nano /etc/cron.d/airtime-schedule
|
||||
|
||||
containing the line:
|
||||
|
||||
* * * * * www-data /usr/local/bin/airtime-schedule.sh
|
||||
|
||||
The schedule server will now be serving the same show information as the Airtime server, with a cache lifetime of one minute. You can adjust the cache lifetime by altering the frequency of the cron job that polls the Airtime server.
|
||||
|
||||
Pushing schedule information via FTP or SSH
|
||||
-------------------------------------------
|
||||
|
||||
If there is no inbound access to the Airtime server at all, an FTP script can be used to push cached schedule data from Airtime to an external web server. The standard ftp command should be available on the Airtime server and the external web server should have a suitably restricted FTP account set up. After following steps 1 and 2 above to export schedule data to a pair of temporary files on the Airtime server, create a new script on the Airtime server to automatically make the upload:
|
||||
|
||||
sudo nano /usr/local/bin/upload-schedule-data.sh
|
||||
|
||||
Replace host, user and password values with appropriate values for your external web server:
|
||||
|
||||
#!/bin/sh
|
||||
HOST='website.example.com'
|
||||
USER='ftp_user'
|
||||
PASSWD='ftp_password'
|
||||
|
||||
ftp -n -v $HOST << EOT
|
||||
user $USER $PASSWD
|
||||
ascii
|
||||
prompt
|
||||
put /tmp/airtime-week-info
|
||||
put /tmp/airtime-live-info
|
||||
bye
|
||||
EOT
|
||||
|
||||
Then make the new script executable and create a cron job to launch it every minute, as in step 8 above. Steps 3 to 7 above should be carried out on the external web server so that it can convert the two temporary files uploaded via FTP into public schedule data.
|
||||
|
||||
If you have secure shell access (SSH) to the remote web server, you could write a script to use the secure copy command (scp) instead of ftp.
|
||||
|
||||
Website widgets
|
||||
---------------
|
||||
|
||||
Example HTML, Javascript and CSS code for your public website are provided in the *widgets* folder of the Airtime installation tarball, or on GitHub: <https://github.com/sourcefabric/Airtime/tree/master/widgets>
|
||||
|
||||
If you have performed an automated installation on Debian or Ubuntu, the widgets can be found in the */usr/share/doc/airtime/examples/* directory.
|
||||
|
||||
For the widgets to work on a typical web server, links to the Javascript and CSS code have to be included in the HTML page <head> element, like the following example:
|
||||
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
||||
<title>Airtime widgets</title>
|
||||
<script src="js/jquery-1.6.1.min.js" type="text/javascript">
|
||||
</script>
|
||||
<script src="js/jquery-ui-1.8.10.custom.min.js" type="text/javascript">
|
||||
</script>
|
||||
<script src="js/jquery.showinfo.js" type="text/javascript">
|
||||
</script>
|
||||
<link href="css/airtime-widgets.css" rel="stylesheet" type="text/css" />
|
||||
</head>
|
||||
|
||||
A full example is shown in the *widgets/sample\_page.html* file in the Airtime installation tarball, on GitHub, or in the */usr/share/doc/airtime/examples/* directory if you have installed the Debian/Ubuntu package of Airtime.
|
||||
|
||||
The following code is for a small *airtimeLiveInfo* widget that displays information about the current show (show time elapsed, and show time remaining), as well as some information about the next show (start time and end time). In this example, the label text for *onAirNow* is translated into French for local language support:
|
||||
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$("#headerLiveHolder").airtimeLiveInfo({
|
||||
sourceDomain: "https://schedule.example.com/",
|
||||
text: {onAirNow:"Sur Les Antennes", offline:"Offline", current:"Current", next:"Next"},
|
||||
updatePeriod: 20 //seconds
|
||||
});
|
||||
});
|
||||
</script>
|
||||
|
||||
The <script> element above would typically be added to the page's <head> element. You would then add a <div> element to the <body> element of the page to hold the widget, such as:
|
||||
|
||||
<div id="headerLiveHolder" style="border: 1px solid #999999; padding: 10px;"></div>
|
||||
|
||||
On the public website, this widget can be made to look like the following screenshot:
|
||||
|
||||
|
||||
|
||||
The CSS properties *color:* and *text-transform:uppercase* have been used to style the *onAirNow* label. There is a full example CSS file *widgets/css/airtime-widgets.css* in the Airtime installation tarball, GitHub repository, or */usr/share/doc/airtime/examples/* directory on Debian/Ubuntu.
|
||||
|
||||
A variation on this widget displays the item being played out, rather than the show names:
|
||||
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$("#headerLiveTrackHolder").airtimeLiveTrackInfo({
|
||||
sourceDomain: "https://schedule.example.com/",
|
||||
text: {onAirNow:"On Air Now", offline:"Offline", current:"Current", next:"Next"},
|
||||
updatePeriod: 20 //seconds
|
||||
});
|
||||
});
|
||||
</script>
|
||||
|
||||
The id of the <div> element in the page body would have to be updated to match:
|
||||
|
||||
<div id="headerLiveTrackHolder" style="border: 1px solid #999999; padding: 10px;"></div>
|
||||
|
||||
The next widget *airtimeShowSchedule* is medium sized, and displays the upcoming show schedule for that day.
|
||||
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
$("#onAirToday").airtimeShowSchedule({
|
||||
sourceDomain: "https://schedule.example.com/",
|
||||
text: {onAirToday:"On air today"},
|
||||
updatePeriod: 60 //seconds
|
||||
});
|
||||
});
|
||||
</script>
|
||||
|
||||
Again, the id of the <div> element has to match the script for the widget to appear:
|
||||
|
||||
<div id="onAirToday"></div>
|
||||
|
||||
The output from the widget script above can be styled to look like this screen shot:
|
||||
|
||||
|
||||
|
||||
Finally, the following code creates a large widget *airtimeWeekSchedule* that enables site visitors to browse through the show schedule for that week. In this example, all widget labels have been translated into French:
|
||||
|
||||
<script>
|
||||
$(document).ready(function() {
|
||||
|
||||
$("#scheduleTabs").airtimeWeekSchedule({
|
||||
sourceDomain:"https://schedule.example.com/",
|
||||
dowText:{monday:"Lundi", tuesday:"Mardi", wednesday:"Mercredi", thursday:"Jeudi", friday:"Vendredi", saturday:"Samedi", sunday:"Dimanche"},
|
||||
miscText:{time:"Temps", programName:"Nom du Programme", details:"Détails", readMore:"Lire La Suite"},
|
||||
updatePeriod: 600 //seconds
|
||||
});
|
||||
|
||||
var d = new Date().getDay();
|
||||
$('#scheduleTabs').tabs({selected: d === 0 ? 6 : d-1, fx: { opacity: 'toggle' }});
|
||||
|
||||
});
|
||||
</script>
|
||||
|
||||
The <div> element for this widget would be:
|
||||
|
||||
<div id="scheduleTabs"></div>
|
||||
|
||||
Using the code above and the CSS and image files provided with Airtime, the weekly schedule can be styled to look like this:
|
||||
|
||||
|
||||
|
||||
Optionally, you can display the schedule for the week ahead, as well as the current week. This requires the Javascript file *jquery.showinfo.js* supplied with Airtime 2.5.0 or later, where the value of the variable *dow* (for days of the week) includes fourteen rather than seven days:
|
||||
|
||||
var dow = ["monday", "tuesday", "wednesday", "thursday", "friday",
|
||||
"saturday", "sunday", "nextmonday", "nexttuesday",
|
||||
"nextwednesday","nextthursday", "nextfriday",
|
||||
"nextsaturday", "nextsunday"];
|
||||
|
||||
In that case, the labels for the days of the week could be configured as follows:
|
||||
|
||||
dowText: {monday:"Monday", tuesday:"Tuesday", wednesday:"Wednesday",
|
||||
thursday:"Thursday", friday:"Friday", saturday:"Saturday",
|
||||
sunday:"Sunday", nextmonday:"Next Monday",
|
||||
nexttuesday:"Next Tuesday", nextwednesday:"Next Wednesday",
|
||||
nextthursday:"Next Thursday",nextfriday:"Next Friday",
|
||||
nextsaturday:"Next Saturday", nextsunday:"Next Sunday"},
|
||||
|
||||
The value of **sourceDomain** in the code examples above should match the URL that you wish to serve schedule information to the public from. If you have used the *Caching schedule information* method detailed above, this would be the URL of your schedule server, not the Airtime server directly.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 6.2 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 42 KiB |
|
|
@ -1,11 +1,12 @@
|
|||
Getting started
|
||||
===============
|
||||
If the server is only being used for Airtime and has a web browser installed, you can access the administration interface directly on that server by opening the address:
|
||||
|
||||
You can access the Airtime administration interface by opening your *airtime.pro* domain name in your web browser, for example:
|
||||
http://localhost/
|
||||
|
||||
https://example.airtime.pro/
|
||||
If you have set up Airtime so that it can be accessed from other computers, you would use a domain name instead. For example:
|
||||
|
||||
If you are the station administrator, log in with the user name *admin* and the password given to you. Your browser should automatically focus on the **Username** field.
|
||||
https://airtime.example.com/
|
||||
|
||||
You can log in for the first time with the user name *admin* and the password set during installation. Your browser should automatically focus on the **Username** field.
|
||||
|
||||
|
||||
|
||||
|
|
@ -13,6 +14,14 @@ If you enter the password incorrectly three times, you will be presented with a
|
|||
|
||||
|
||||
|
||||
If activated, you will see a link **Reset password** below the password field, which enables users to obtain a password reminder by email. See the chapter *Preferences* for configuration details.
|
||||
|
||||
|
||||
|
||||
The **E-mail** address you enter must match the address stored in the database for your **Username**.
|
||||
|
||||
|
||||
|
||||
Register Airtime
|
||||
----------------
|
||||
|
||||
|
|
@ -49,14 +58,21 @@ Clicking the username link opens a page in which you can update your Airtime pas
|
|||
|
||||
|
||||
|
||||
On the right of the Logout link, clicking the green check mark opens a pop-up window with information about the version of Airtime installed. If your Airtime installation is not the latest version available, the green check mark changes to a green upgrade arrow. Should your Airtime installation get too far out of date, this arrow will change to a red exclamation mark.
|
||||
|
||||
<img src="static/Screenshot543-Running_latest_version_250.png" width="595" height="230" />
|
||||
|
||||
Checking an Icecast server
|
||||
--------------------------
|
||||
|
||||
You can check that Icecast is running by opening its default server port of 8000 in your web browser. For example, using the domain name of the Icecast server found on the **Stream Settings** page:
|
||||
If you have installed an Icecast streaming media server, you can check that Icecast is running by opening its default server port of 8000 in your web browser. For example, on the server itself, you can use:
|
||||
|
||||
http://example.out.airtime.pro:8000/
|
||||
http://localhost:8000
|
||||
|
||||
You should see the Icecast status page, with details of any connections that your Airtime server has made to this Icecast server. If you have only just started with Airtime, there may not be any media playing out yet.
|
||||
or from another machine, using the domain name of the Icecast server:
|
||||
|
||||
http://streaming.example.com:8000
|
||||
|
||||
You should see the Icecast status page, with details of any connections that your Airtime server has made to this Icecast server. If you have only just installed Airtime, there may not be any media playing out yet.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
310
docs/manual/hd-audio-models/index.md
Normal file
310
docs/manual/hd-audio-models/index.md
Normal file
|
|
@ -0,0 +1,310 @@
|
|||
This listing is provided to help ensure that the correct model parameter is passed to the ALSA kernel module for an Intel HDA soundcard, if one is fitted to your Airtime server. See the chapter *Preparing the server* in this book for more details.
|
||||
|
||||
Model name Description
|
||||
---------- -----------
|
||||
ALC880
|
||||
======
|
||||
3stack 3-jack in back and a headphone out
|
||||
3stack-digout 3-jack in back, a HP out and a SPDIF out
|
||||
5stack 5-jack in back, 2-jack in front
|
||||
5stack-digout 5-jack in back, 2-jack in front, a SPDIF out
|
||||
6stack 6-jack in back, 2-jack in front
|
||||
6stack-digout 6-jack with a SPDIF out
|
||||
|
||||
ALC260
|
||||
======
|
||||
N/A
|
||||
|
||||
ALC262
|
||||
======
|
||||
inv-dmic Inverted internal mic workaround
|
||||
|
||||
ALC267/268
|
||||
==========
|
||||
inv-dmic Inverted internal mic workaround
|
||||
|
||||
ALC269/270/275/276/28x/29x
|
||||
======
|
||||
laptop-amic Laptops with analog-mic input
|
||||
laptop-dmic Laptops with digital-mic input
|
||||
alc269-dmic Enable ALC269(VA) digital mic workaround
|
||||
alc271-dmic Enable ALC271X digital mic workaround
|
||||
inv-dmic Inverted internal mic workaround
|
||||
headset-mic Indicates a combined headset (headphone+mic) jack
|
||||
lenovo-dock Enables docking station I/O for some Lenovos
|
||||
dell-headset-multi Headset jack, which can also be used as mic-in
|
||||
dell-headset-dock Headset jack (without mic-in), and also dock I/O
|
||||
|
||||
ALC66x/67x/892
|
||||
==============
|
||||
mario Chromebook mario model fixup
|
||||
asus-mode1 ASUS
|
||||
asus-mode2 ASUS
|
||||
asus-mode3 ASUS
|
||||
asus-mode4 ASUS
|
||||
asus-mode5 ASUS
|
||||
asus-mode6 ASUS
|
||||
asus-mode7 ASUS
|
||||
asus-mode8 ASUS
|
||||
inv-dmic Inverted internal mic workaround
|
||||
dell-headset-multi Headset jack, which can also be used as mic-in
|
||||
|
||||
ALC680
|
||||
======
|
||||
N/A
|
||||
|
||||
ALC88x/898/1150
|
||||
======================
|
||||
acer-aspire-4930g Acer Aspire 4930G/5930G/6530G/6930G/7730G
|
||||
acer-aspire-8930g Acer Aspire 8330G/6935G
|
||||
acer-aspire Acer Aspire others
|
||||
inv-dmic Inverted internal mic workaround
|
||||
no-primary-hp VAIO Z/VGC-LN51JGB workaround (for fixed speaker DAC)
|
||||
|
||||
ALC861/660
|
||||
==========
|
||||
N/A
|
||||
|
||||
ALC861VD/660VD
|
||||
==============
|
||||
N/A
|
||||
|
||||
CMI9880
|
||||
=======
|
||||
minimal 3-jack in back
|
||||
min_fp 3-jack in back, 2-jack in front
|
||||
full 6-jack in back, 2-jack in front
|
||||
full_dig 6-jack in back, 2-jack in front, SPDIF I/O
|
||||
allout 5-jack in back, 2-jack in front, SPDIF out
|
||||
auto auto-config reading BIOS (default)
|
||||
|
||||
AD1882 / AD1882A
|
||||
================
|
||||
3stack 3-stack mode
|
||||
3stack-automute 3-stack with automute front HP (default)
|
||||
6stack 6-stack mode
|
||||
|
||||
AD1884A / AD1883 / AD1984A / AD1984B
|
||||
====================================
|
||||
desktop 3-stack desktop (default)
|
||||
laptop laptop with HP jack sensing
|
||||
mobile mobile devices with HP jack sensing
|
||||
thinkpad Lenovo Thinkpad X300
|
||||
touchsmart HP Touchsmart
|
||||
|
||||
AD1884
|
||||
======
|
||||
N/A
|
||||
|
||||
AD1981
|
||||
======
|
||||
basic 3-jack (default)
|
||||
hp HP nx6320
|
||||
thinkpad Lenovo Thinkpad T60/X60/Z60
|
||||
toshiba Toshiba U205
|
||||
|
||||
AD1983
|
||||
======
|
||||
N/A
|
||||
|
||||
AD1984
|
||||
======
|
||||
basic default configuration
|
||||
thinkpad Lenovo Thinkpad T61/X61
|
||||
dell_desktop Dell T3400
|
||||
|
||||
AD1986A
|
||||
=======
|
||||
6stack 6-jack, separate surrounds (default)
|
||||
3stack 3-stack, shared surrounds
|
||||
laptop 2-channel only (FSC V2060, Samsung M50)
|
||||
laptop-eapd 2-channel with EAPD (ASUS A6J)
|
||||
laptop-automute 2-channel with EAPD and HP-automute (Lenovo N100)
|
||||
ultra 2-channel with EAPD (Samsung Ultra tablet PC)
|
||||
samsung 2-channel with EAPD (Samsung R65)
|
||||
samsung-p50 2-channel with HP-automute (Samsung P50)
|
||||
|
||||
AD1988/AD1988B/AD1989A/AD1989B
|
||||
==============================
|
||||
6stack 6-jack
|
||||
6stack-dig ditto with SPDIF
|
||||
3stack 3-jack
|
||||
3stack-dig ditto with SPDIF
|
||||
laptop 3-jack with hp-jack automute
|
||||
laptop-dig ditto with SPDIF
|
||||
auto auto-config reading BIOS (default)
|
||||
|
||||
Conexant 5045
|
||||
=============
|
||||
laptop-hpsense Laptop with HP sense (old model laptop)
|
||||
laptop-micsense Laptop with Mic sense (old model fujitsu)
|
||||
laptop-hpmicsense Laptop with HP and Mic senses
|
||||
benq Benq R55E
|
||||
laptop-hp530 HP 530 laptop
|
||||
test for testing/debugging purpose, almost all controls
|
||||
can be adjusted. Appearing only when compiled with
|
||||
$CONFIG_SND_DEBUG=y
|
||||
|
||||
Conexant 5047
|
||||
=============
|
||||
laptop Basic Laptop config
|
||||
laptop-hp Laptop config for some HP models (subdevice 30A5)
|
||||
laptop-eapd Laptop config with EAPD support
|
||||
test for testing/debugging purpose, almost all controls
|
||||
can be adjusted. Appearing only when compiled with
|
||||
$CONFIG_SND_DEBUG=y
|
||||
|
||||
Conexant 5051
|
||||
=============
|
||||
laptop Basic Laptop config (default)
|
||||
hp HP Spartan laptop
|
||||
hp-dv6736 HP dv6736
|
||||
hp-f700 HP Compaq Presario F700
|
||||
ideapad Lenovo IdeaPad laptop
|
||||
toshiba Toshiba Satellite M300
|
||||
|
||||
Conexant 5066
|
||||
=============
|
||||
laptop Basic Laptop config (default)
|
||||
hp-laptop HP laptops, e g G60
|
||||
asus Asus K52JU, Lenovo G560
|
||||
dell-laptop Dell laptops
|
||||
dell-vostro Dell Vostro
|
||||
olpc-xo-1_5 OLPC XO 1.5
|
||||
ideapad Lenovo IdeaPad U150
|
||||
thinkpad Lenovo Thinkpad
|
||||
|
||||
STAC9200
|
||||
========
|
||||
ref Reference board
|
||||
oqo OQO Model 2
|
||||
dell-d21 Dell (unknown)
|
||||
dell-d22 Dell (unknown)
|
||||
dell-d23 Dell (unknown)
|
||||
dell-m21 Dell Inspiron 630m, Dell Inspiron 640m
|
||||
dell-m22 Dell Latitude D620, Dell Latitude D820
|
||||
dell-m23 Dell XPS M1710, Dell Precision M90
|
||||
dell-m24 Dell Latitude 120L
|
||||
dell-m25 Dell Inspiron E1505n
|
||||
dell-m26 Dell Inspiron 1501
|
||||
dell-m27 Dell Inspiron E1705/9400
|
||||
gateway-m4 Gateway laptops with EAPD control
|
||||
gateway-m4-2 Gateway laptops with EAPD control
|
||||
panasonic Panasonic CF-74
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC9205/9254
|
||||
=============
|
||||
ref Reference board
|
||||
dell-m42 Dell (unknown)
|
||||
dell-m43 Dell Precision
|
||||
dell-m44 Dell Inspiron
|
||||
eapd Keep EAPD on (e.g. Gateway T1616)
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC9220/9221
|
||||
=============
|
||||
ref Reference board
|
||||
3stack D945 3stack
|
||||
5stack D945 5stack + SPDIF
|
||||
intel-mac-v1 Intel Mac Type 1
|
||||
intel-mac-v2 Intel Mac Type 2
|
||||
intel-mac-v3 Intel Mac Type 3
|
||||
intel-mac-v4 Intel Mac Type 4
|
||||
intel-mac-v5 Intel Mac Type 5
|
||||
intel-mac-auto Intel Mac (detect type according to subsystem id)
|
||||
macmini Intel Mac Mini (equivalent with type 3)
|
||||
macbook Intel Mac Book (eq. type 5)
|
||||
macbook-pro-v1 Intel Mac Book Pro 1st generation (eq. type 3)
|
||||
macbook-pro Intel Mac Book Pro 2nd generation (eq. type 3)
|
||||
imac-intel Intel iMac (eq. type 2)
|
||||
imac-intel-20 Intel iMac (newer version) (eq. type 3)
|
||||
ecs202 ECS/PC chips
|
||||
dell-d81 Dell (unknown)
|
||||
dell-d82 Dell (unknown)
|
||||
dell-m81 Dell (unknown)
|
||||
dell-m82 Dell XPS M1210
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC9202/9250/9251
|
||||
==================
|
||||
ref Reference board, base config
|
||||
m1 Some Gateway MX series laptops (NX560XL)
|
||||
m1-2 Some Gateway MX series laptops (MX6453)
|
||||
m2 Some Gateway MX series laptops (M255)
|
||||
m2-2 Some Gateway MX series laptops
|
||||
m3 Some Gateway MX series laptops
|
||||
m5 Some Gateway MX series laptops (MP6954)
|
||||
m6 Some Gateway NX series laptops
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC9227/9228/9229/927x
|
||||
=======================
|
||||
ref Reference board
|
||||
ref-no-jd Reference board without HP/Mic jack detection
|
||||
3stack D965 3stack
|
||||
5stack D965 5stack + SPDIF
|
||||
5stack-no-fp D965 5stack without front panel
|
||||
dell-3stack Dell Dimension E520
|
||||
dell-bios Fixes with Dell BIOS setup
|
||||
dell-bios-amic Fixes with Dell BIOS setup including analog mic
|
||||
volknob Fixes with volume-knob widget 0x24
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC92HD71B*
|
||||
============
|
||||
ref Reference board
|
||||
dell-m4-1 Dell desktops
|
||||
dell-m4-2 Dell desktops
|
||||
dell-m4-3 Dell desktops
|
||||
hp-m4 HP mini 1000
|
||||
hp-dv5 HP dv series
|
||||
hp-hdx HP HDX series
|
||||
hp-dv4-1222nr HP dv4-1222nr (with LED support)
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC92HD73*
|
||||
===========
|
||||
ref Reference board
|
||||
no-jd BIOS setup but without jack-detection
|
||||
intel Intel DG45* mobos
|
||||
dell-m6-amic Dell desktops/laptops with analog mics
|
||||
dell-m6-dmic Dell desktops/laptops with digital mics
|
||||
dell-m6 Dell desktops/laptops with both type of mics
|
||||
dell-eq Dell desktops/laptops
|
||||
alienware Alienware M17x
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC92HD83*
|
||||
===========
|
||||
ref Reference board
|
||||
mic-ref Reference board with power management for ports
|
||||
dell-s14 Dell laptop
|
||||
dell-vostro-3500 Dell Vostro 3500 laptop
|
||||
hp-dv7-4000 HP dv-7 4000
|
||||
hp_cNB11_intquad HP CNB models with 4 speakers
|
||||
hp-zephyr HP Zephyr
|
||||
hp-led HP with broken BIOS for mute LED
|
||||
hp-inv-led HP with broken BIOS for inverted mute LED
|
||||
auto BIOS setup (default)
|
||||
|
||||
STAC9872
|
||||
========
|
||||
vaio VAIO laptop without SPDIF
|
||||
auto BIOS setup (default)
|
||||
|
||||
Cirrus Logic CS4206/4207
|
||||
========================
|
||||
mbp55 MacBook Pro 5,5
|
||||
imac27 IMac 27 Inch
|
||||
auto BIOS setup (default)
|
||||
|
||||
Cirrus Logic CS4208
|
||||
===================
|
||||
mba6 MacBook Air 6,1 and 6,2
|
||||
gpio0 Enable GPIO 0 amp
|
||||
auto BIOS setup (default)
|
||||
|
||||
VIA VT17xx/VT18xx/VT20xx
|
||||
========================
|
||||
auto BIOS setup (default)
|
||||
|
|
@ -1,11 +1,24 @@
|
|||
Help
|
||||
====
|
||||
The first entry on Airtime'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** and an **About** page, which displays version and licensing information.
|
||||
|
||||
The first entry on Airtime's **Help** menu is for the **Help Center**, which is the official support channel for Airtime Pro. The next link offers a quick **Getting Started** guide for new users. There is also a link to the online version of this **User Manual** and an **About** page, which displays version and licensing information.
|
||||
|
||||
|
||||
<img src="static/Screenshot578-Help_page.png" alt="Help page" width="740" height="360" />
|
||||
You can visit the Airtime online support forum, and sign up for the mailing list, at <http://forum.sourcefabric.org/categories/airtime-support>
|
||||
|
||||
The Live Chat window for support is in the lower right corner of the page.
|
||||
This forum is mirrored by the mailing list, so posts on the forum appear on the mailing list and vice versa. You can therefore also post a message there by emailing <airtime-support@lists.sourcefabric.org>
|
||||
|
||||
When all other avenues have been exhausted, email us directly at <contact@sourcefabric.org> and we'll try to help!
|
||||
To subscribe to forum updates via email, please register or login to the forum by clicking the appropriate link. Then visit your profile page at <http://forum.sourcefabric.org/profile/> and click the link **My Email Subscriptions** on the left side menu. In the pop-up window that opens, check the boxes for the mailing lists you wish to subscribe to, then click the **Save** button.
|
||||
|
||||
Bug reporting
|
||||
-------------
|
||||
|
||||
Airtime needs your input to improve. If you think you've found a bug, please visit <http://dev.sourcefabric.org/> and sign in, using the same login and password that you registered for the Airtime forum. Create a bug report by selecting **Create Issue**, then **Airtime**, and then **Bug**. That way, the Airtime team can keep track of your problem and notify you when it has been fixed. You can also suggest improvements and new features for Airtime on that site.
|
||||
|
||||
Contact
|
||||
-------
|
||||
|
||||
Finally, when all other avenues have been exhausted, email us directly at <contact@sourcefabric.org> and we'll try to help!
|
||||
|
||||
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.
|
||||
|
|
|
|||
BIN
docs/manual/help/static/CommunityRadioUserGuide.pdf
Normal file
BIN
docs/manual/help/static/CommunityRadioUserGuide.pdf
Normal file
Binary file not shown.
BIN
docs/manual/help/static/Screenshot460-Help_page.png
Normal file
BIN
docs/manual/help/static/Screenshot460-Help_page.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
BIN
docs/manual/help/static/jPlayer_demo4.zip
Normal file
BIN
docs/manual/help/static/jPlayer_demo4.zip
Normal file
Binary file not shown.
198
docs/manual/host-configuration/index.md
Normal file
198
docs/manual/host-configuration/index.md
Normal file
|
|
@ -0,0 +1,198 @@
|
|||
The streaming host configuration for Airtime is shown in the file */etc/airtime/liquidsoap.cfg* which is automatically generated by the **Streams** page, found on the **System** menu of the Airtime 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
|
||||
---------------------------
|
||||
|
||||
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:
|
||||
|
||||
sudo nano /etc/airtime/airtime.conf
|
||||
|
||||
You can also set options for RabbitMQ messaging, the Airtime server and SoundCloud uploads in this file, although you should not normally need to adjust the defaults unless you are running a large Airtime system distributed across multiple servers. To run the Airtime server in demo mode, which changes the greeting on the login page and prevents user accounts from being created or modified, set the value of *demo* to 1.
|
||||
|
||||
[database]
|
||||
host = localhost
|
||||
dbname = airtime
|
||||
dbuser = airtime
|
||||
dbpass = airtime
|
||||
|
||||
[rabbitmq]
|
||||
host = 127.0.0.1
|
||||
port = 5672
|
||||
user = airtime
|
||||
password = XXXXXXXXXXXXXXXXXXXX
|
||||
vhost = /airtime
|
||||
|
||||
[general]
|
||||
api_key = XXXXXXXXXXXXXXXXXXXXX
|
||||
web_server_user = www-data
|
||||
airtime_dir = /usr/share/airtime
|
||||
base_url = airtime.example.com
|
||||
base_port = 80
|
||||
base_dir = /
|
||||
cache_ahead_hours = 1
|
||||
|
||||
[monit]
|
||||
monit_user = guest
|
||||
monit_password = airtime
|
||||
|
||||
[soundcloud]
|
||||
connection_retries = 3
|
||||
time_between_retries = 60
|
||||
|
||||
[demo]
|
||||
demo = 0
|
||||
|
||||
Save and close the file with **Ctrl+O** and **Ctrl+X**. If you have changed the database settings, you should now run the command:
|
||||
|
||||
sudo airtime-update-db-settings
|
||||
|
||||
to make sure all of Airtime's database configuration files are updated. This command should output the following text to the server console:
|
||||
|
||||
Airtime root folder found at /usr/share/airtime
|
||||
Updating /usr/share/airtime/application/configs/application.ini
|
||||
Updating /usr/share/airtime/build/build.properties
|
||||
Updating /usr/share/airtime/build/runtime-conf.xml
|
||||
Success!
|
||||
|
||||
API client configuration
|
||||
------------------------
|
||||
|
||||
If you have changed the *base\_url*, *base\_port* or *base\_dir* setting in */etc/airtime/airtime.conf* from the defaults, you will probably also have to update the *Hostname* settings in the file */etc/airtime/api\_client.cfg* accordingly.**
|
||||
|
||||
bin_dir = /usr/lib/airtime/api_clients
|
||||
api_key = 'XXXXXXXXXXXXXXXXXXXX'
|
||||
api_base = api
|
||||
host = airtime.example.com
|
||||
base_port = 80
|
||||
base_dir = /
|
||||
|
||||
Media monitor settings
|
||||
----------------------
|
||||
|
||||
Airtime's media monitor has its own configuration file in */etc/airtime/media-monitor.cfg* which contains RabbitMQ settings and other preferences.
|
||||
|
||||
api_client = airtime
|
||||
|
||||
# where the binary files live
|
||||
bin_dir = /usr/lib/airtime/media-monitor
|
||||
|
||||
# where the logging files live
|
||||
log_dir = /var/log/airtime/media-monitor
|
||||
|
||||
############################################
|
||||
# RabbitMQ settings #
|
||||
############################################
|
||||
rabbitmq_host = localhost
|
||||
rabbitmq_user = airtime
|
||||
rabbitmq_password = XXXXXXXXXXXXXXXXXXXX
|
||||
rabbitmq_vhost = /airtime
|
||||
|
||||
############################################
|
||||
# Media-Monitor preferences #
|
||||
############################################
|
||||
|
||||
#how long to queue up events performed on the files themselves.
|
||||
check_filesystem_events = 5
|
||||
|
||||
#how long to queue metadata input from airtime.
|
||||
check_airtime_events = 30
|
||||
|
||||
# MM2 only:
|
||||
touch_interval = 5
|
||||
chunking_number = 450
|
||||
request_max_wait = 3.0
|
||||
rmq_event_wait = 0.1
|
||||
logpath = /var/log/airtime/media-monitor/media-monitor.log
|
||||
index_path = /var/tmp/airtime/media-monitor/last_index
|
||||
|
||||
Playout and recorder settings
|
||||
-----------------------------
|
||||
|
||||
Settings for pypo, the playout and recording engine used by Airtime, are found in the file */etc/airtime/pypo.cfg*. After making changes to this file, you will have to issue the command:
|
||||
|
||||
sudo /etc/init.d/airtime-playout restart
|
||||
|
||||
for the changes to take effect.
|
||||
|
||||
############################################
|
||||
# pypo - configuration #
|
||||
############################################
|
||||
# Set the type of client you are using.
|
||||
# Currently supported types:
|
||||
# 1) "obp" = Open Broadcast Platform
|
||||
# 2) "airtime"
|
||||
#
|
||||
api_client = airtime
|
||||
|
||||
############################################
|
||||
# Cache Directories #
|
||||
# *include* trailing slash !! #
|
||||
############################################
|
||||
cache_dir = /var/tmp/airtime/pypo/cache/
|
||||
file_dir = /var/tmp/airtime/pypo/files/
|
||||
tmp_dir = /var/tmp/airtime/pypo/tmp/
|
||||
|
||||
############################################
|
||||
# Setup Directories #
|
||||
# Do *not* include trailing slash !! #
|
||||
############################################
|
||||
cache_base_dir = /var/tmp/airtime/pypo
|
||||
bin_dir = /usr/lib/airtime/pypo
|
||||
log_base_dir = /var/log/airtime
|
||||
pypo_log_dir = /var/log/airtime/pypo
|
||||
liquidsoap_log_dir = /var/log/airtime/pypo-liquidsoap
|
||||
|
||||
############################################
|
||||
# Liquidsoap settings #
|
||||
############################################
|
||||
ls_host = 127.0.0.1
|
||||
ls_port = 1234
|
||||
|
||||
############################################
|
||||
# RabbitMQ settings #
|
||||
############################################
|
||||
rabbitmq_host = localhost
|
||||
rabbitmq_user = airtime
|
||||
rabbitmq_password = XXXXXXXXXXXXXXXXXXXX
|
||||
rabbitmq_vhost = /airtime
|
||||
|
||||
############################################
|
||||
# pypo preferences #
|
||||
############################################
|
||||
# Poll interval in seconds.
|
||||
#
|
||||
# This will rarely need to be changed because any schedule changes are
|
||||
# automatically sent to pypo immediately.
|
||||
#
|
||||
# This is how often the poll script downloads new schedules and files from the
|
||||
# server in the event that no changes are made to the schedule.
|
||||
#
|
||||
poll_interval = 3600# in seconds.
|
||||
|
||||
# Push interval in seconds.
|
||||
#
|
||||
# This is how often the push script checks whether it has something new to
|
||||
# push to liquidsoap.
|
||||
#
|
||||
# It's hard to imagine a situation where this should be more than 1 second.
|
||||
#
|
||||
push_interval = 1# in seconds
|
||||
|
||||
# 'pre' or 'otf'. 'pre' cues while playlist preparation
|
||||
# while 'otf' (on the fly) cues while loading into ls
|
||||
# (needs the post_processor patch)
|
||||
cue_style = pre
|
||||
|
||||
############################################
|
||||
# Recorded Audio settings #
|
||||
############################################
|
||||
record_bitrate = 256
|
||||
record_samplerate = 44100
|
||||
record_channels = 2
|
||||
record_sample_size = 16
|
||||
|
||||
#can be either ogg|mp3, mp3 recording requires installation of the package "lame"
|
||||
record_file_type = ogg
|
||||
|
||||
# base path to store recorded shows at
|
||||
base_recorded_files = /var/tmp/airtime/show-recorder/
|
||||
30
docs/manual/icecast-and-shoutcast/index.md
Normal file
30
docs/manual/icecast-and-shoutcast/index.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
Airtime supports direct connection to two popular streaming media servers, the open source **Icecast** (<http://www.icecast.org>) and the proprietary **SHOUTcast** (<http://www.shoutcast.com>). Apart from the software license, the main difference between these two servers is that Icecast supports simultaneous MP3, AAC, Ogg Vorbis or Ogg Opus streaming from Airtime, whereas SHOUTcast supports MP3 and AAC streams but not Ogg Vorbis or Opus. The royalty-free Ogg Vorbis format has the advantage of better sound quality than MP3 at lower bitrates, which has a direct impact on the amount of bandwidth that your station will require to serve the same number of listeners. Ogg Opus also benefits from good sound quality at low bitrates, with the added advantage of lower latency than other streaming formats. Opus is now an IETF standard (<http://tools.ietf.org/html/rfc6716>) and requires Icecast 2.4 or later to be installed on the streaming server.
|
||||
|
||||
Ogg Vorbis playback is supported in **Mozilla Firefox**, **Google Chrome** and **Opera** browsers, via **jPlayer** (<http://jplayer.org/>), and is also supported in several popular media players, including VideoLAN Client, also known as VLC (<http://www.videolan.org/vlc/>). (See the chapter *Stream player for your website* on how to deliver **jPlayer** to your audience). Ogg Opus is relatively new and is supported natively in the very latest browsers, such as Mozilla Firefox 25.0, and media players including VLC 2.0.4 or later.
|
||||
|
||||
Streaming MP3 below a bitrate of 128kbps is not recommended for music, because of a perceptible loss of high audio frequencies in the broadcast playout. A 96kbps or 64kbps MP3 stream may be acceptable for voice broadcasts if there is a requirement for compatibility with legacy hardware playback devices which do not support Ogg Vorbis or Opus streams.
|
||||
|
||||
Because Airtime supports simultaneous streaming in multiple formats, it is possible to offer one or more streams via your website, and another independent stream for direct connection from hardware players. You can test whether Ogg streams sound better at low bitrates for yourself, by using the **LISTEN** button in Airtime's **Master Panel** to switch between streaming formats.
|
||||
|
||||
Conversely, you may have a music station which wants to stream at 160kbps or 192kbps to offer a quality advantage over stations streaming at 128kbps or less. Since Ogg, AAC and MP3 formats use lossy compression, listeners will only hear the benefit of higher streaming bitrates if the media files in the Airtime storage server are encoded at an equivalent bitrate, or higher.
|
||||
|
||||
UTF-8 metadata in Icecast MP3 streams
|
||||
-------------------------------------
|
||||
|
||||
When sending metadata about your stream to an Icecast server in non-Latin alphabets, you may find that Icecast does not display the characters correctly for an MP3 stream, even though they are displayed correctly for an Ogg Vorbis stream. In the following screenshot, Russian characters are being displayed incorrectly in the *Current Song* field for the MP3 stream:
|
||||
|
||||
|
||||
|
||||
The solution is to specify that the metadata for the MP3 mount point you are using should be interpreted using UTF-8 encoding. You can do this by adding the following stanza to the */etc/icecast2/icecast.xml* file, where *airtime.mp3* is the name of your mount point:
|
||||
|
||||
<mount>
|
||||
<mount-name>/airtime.mp3</mount-name>
|
||||
<charset>UTF-8</charset>
|
||||
</mount>
|
||||
|
||||
After saving the */etc/icecast2/icecast.xml* file, you should restart the Icecast server:
|
||||
|
||||
sudo invoke-rc.d icecast2 restart
|
||||
Restarting icecast2: Starting icecast2
|
||||
Detaching from the console
|
||||
icecast2.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 74 KiB |
45
docs/manual/icecast-handover/index.md
Normal file
45
docs/manual/icecast-handover/index.md
Normal file
|
|
@ -0,0 +1,45 @@
|
|||
In a typical radio station configuration, the live output from the broadcast studio and the scheduled output from Airtime are mixed together before being sent further along the broadcast chain, to a transmitter or streaming media server on the Internet. (This may not be the case if your Airtime server is remote from the studio, and you are using the **Show Source Mount Point** or **Master Source Mount Point** to mix live and scheduled content. See the *Stream Settings* chapter for details).
|
||||
|
||||
If your **Icecast** server is hosted in a remote data centre, you may not have the option to handover the streaming media source manually, because you have no physical access to connect a broadcast mixer to the server. Disconnecting the stream and beginning another is less than ideal, because the audience's media players will also be disconnected when that happens.
|
||||
|
||||
The **Icecast** server has a *fallback-mount* feature which can be used to move clients (media players used by listeners or viewers) from one source to another, as new sources become available. This makes it possible to handover from Airtime output to a show from another source, and handover to Airtime again once the other show has ended.
|
||||
|
||||
To enable fallback mounts, edit the main Icecast configuration file to define the mount points you will use, and the relationship between them.
|
||||
|
||||
sudo nano /etc/icecast2/icecast.xml
|
||||
|
||||
The example *<mount>* section provided in the *icecast.xml* file is commented out by default. Before or after the commented section, add three mount point definitions. The default mount point used by Airtime is */airtime\_128* which is shown in the */etc/airtime/liquidsoap.cfg* file. You must also define a mount point for the live source (called */live.ogg* in this example) and a mount point for the public to connect to (called */stream.ogg* in this example).
|
||||
|
||||
<mount>
|
||||
<mount-name>/airtime_128</mount-name>
|
||||
<hidden>0</hidden>
|
||||
</mount>
|
||||
|
||||
<mount>
|
||||
<mount-name>/live.ogg</mount-name>
|
||||
<fallback-mount>/airtime_128</fallback-mount>
|
||||
<fallback-override>1</fallback-override>
|
||||
<hidden>0</hidden>
|
||||
</mount>
|
||||
|
||||
<mount>
|
||||
<mount-name>/stream.ogg</mount-name>
|
||||
<fallback-mount>/live.ogg</fallback-mount>
|
||||
<fallback-override>1</fallback-override>
|
||||
<hidden>0</hidden>
|
||||
</mount>
|
||||
|
||||
These mount point definitions mean that a client connecting to a URL such as *http://icecast.example.com:8000/stream.ogg* will first fall back to the */live.ogg* mount point if it is available. If not, the client will fall back in turn to the */airtime\_128* mount point for Airtime playout.
|
||||
|
||||
Setting the value of *<fallback-override>* to 1 (enabled) means that when the */live.ogg* mount point becomes available again, the client will be re-connected to it. If you wish to hide the */airtime\_128* and */live.ogg* mount points from the public Icecast web interface, set the value of *<hidden>* in each of these definitions to 1.
|
||||
|
||||
Source configuration
|
||||
--------------------
|
||||
|
||||
Connect the other source to the Icecast server with the same parameters defined in the */etc/airtime/liquidsoap.cfg* file, except for the mount point. This should one of the mount points you have defined in the */etc/icecast2/icecast.xml* file, such as */live.ogg* in the example above.
|
||||
|
||||
To configure **Mixxx** for streaming to Icecast, click *Options*, *Preferences*, then *Live Broadcasting*. For server *Type*, select the default of *Icecast 2* when streaming to Debian or Ubuntu servers, as this is the current version of Icecast supplied with those GNU/Linux distributions.
|
||||
|
||||
|
||||
|
||||
By default, Icecast streams are buffered to guard against network problems, which causes latency for remote listeners. When monitoring the stream from a remote location, you may have to begin the live stream a few seconds before the previous stream ends to enable a smooth transition.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
129
docs/manual/icecast-statistics-with-piwik/index.md
Normal file
129
docs/manual/icecast-statistics-with-piwik/index.md
Normal file
|
|
@ -0,0 +1,129 @@
|
|||
Piwik (<http://piwik.org/>) is an open source web analytics platform which supports Icecast's log format, in Piwik version 2.0 or later. For your convenience, packages of Piwik for Debian and Ubuntu are provided in the <http://apt.sourcefabric.org> repository. If you have already configured your Airtime server for this repository, you can install the **piwik** package and its dependencies with the command:
|
||||
|
||||
sudo apt-get install piwik php5-geoip php5-cli mysql-server
|
||||
|
||||
For security reasons, you should set a strong root password for the MySQL server. If you have not set a MySQL root password already, you should be promoted to do this during the installation of the **mysql-server** package.
|
||||
|
||||
Database and web server configuration
|
||||
-------------------------------------
|
||||
|
||||
Piwik uses a MySQL database which must be created manually before you can use the Piwik web interface.
|
||||
|
||||
1. Log into the database management system with the root password that you set for the MySQL server:
|
||||
|
||||
mysql -uroot -p
|
||||
Enter password:
|
||||
|
||||
The server should respond with:
|
||||
|
||||
Welcome to the MySQL monitor. Commands end with ; or \g.
|
||||
|
||||
Type 'help;' or '\h' for help. Type '\c' to clear the current input statement.
|
||||
|
||||
mysql>
|
||||
|
||||
2. At the mysql command prompt, create a database named *piwik* with the command:
|
||||
|
||||
CREATE DATABASE `piwik` /*!40100 DEFAULT CHARACTER SET utf8 */;
|
||||
|
||||
3. Create a MySQL user and a strong password with access to the database previously created:
|
||||
|
||||
CREATE USER piwik@localhost IDENTIFIED BY 'my-strong-password';
|
||||
GRANT ALL PRIVILEGES ON piwik.* to piwik@localhost;
|
||||
GRANT FILE ON *.* TO piwik@localhost;
|
||||
QUIT
|
||||
|
||||
4. Create a virtual host for the piwik web interface in */etc/apache2/sites-available/piwik-vhost.conf* setting the *ServerName* as appropriate for your server:
|
||||
|
||||
<VirtualHost *:80>
|
||||
ServerName stats.example.com
|
||||
DocumentRoot /usr/share/piwik
|
||||
Include "conf.d/piwik.conf"
|
||||
</VirtualHost>
|
||||
|
||||
5. Enable the virtual host and reload the web server:
|
||||
|
||||
sudo a2ensite pwiki-vhost.conf
|
||||
sudo invoke-rc.d apache2 reload
|
||||
|
||||
6. Open the *ServerName* that you set for Piwik in your browser. You should see the Piwik setup pages. Provide the MySQL database and Piwik *Super User* details when requested. If you intended to use Piwik for Icecast statistics only, you can skip the step *JavaScript Tracking Code*.
|
||||
|
||||
|
||||
|
||||
7. Uncomment the last line in the crontab file */etc/cron.d/piwik* and set your Piwik *ServerName* to enable automatic archiving every five minutes:
|
||||
|
||||
5 * * * * www-data [ -e /usr/share/piwik/misc/cron/archive.php ]
|
||||
&& [ -x /usr/bin/php ]
|
||||
&& /usr/bin/php /usr/share/piwik/misc/cron/archive.php
|
||||
-- "url=http://stats.example.com/" >/dev/null 2>&1
|
||||
|
||||
See <http://piwik.org/docs/> for more details of Piwik installation and configuration.
|
||||
|
||||
Configure Piwik for geolocation
|
||||
-------------------------------
|
||||
|
||||
By default, Piwik uses browser language settings to guess the countries in which your station's audience is physically located. In order to satisfy broadcast regulators and music royalty collection societies, a more accurate method is required, based on the location of individual IP addresses.
|
||||
|
||||
1. Edit the file */etc/php5/apache2/conf.d/20-geoip.ini* to set the path to your Piwik installation:
|
||||
|
||||
extension=geoip.so
|
||||
geoip.custom_directory=/usr/share/piwik/misc
|
||||
|
||||
Then restart the web server for the change to take effect:
|
||||
|
||||
sudo invoke-rc.d apache2 restart
|
||||
|
||||
2. Download GeoLite data from MaxMind's website <http://dev.maxmind.com/geoip/legacy/geolite/> under the [Creative Commons Attribution-ShareAlike 3.0 Unported License](http://creativecommons.org/licenses/by-sa/3.0/), for example:
|
||||
|
||||
wget http://geolite.maxmind.com/download/geoip/database/GeoLiteCity.dat.gz
|
||||
|
||||
2. Unzip and set permissions on the data file, then move it to the *misc* directory under the Piwik install directory and rename it to *GeoIPCity.dat* :
|
||||
|
||||
gunzip GeoLiteCity.dat.gz
|
||||
chmod 644 GeoLiteCity.dat
|
||||
sudo mv GeoLiteCity.dat /usr/share/piwik/misc/GeoIPCity.dat
|
||||
|
||||
4. In the Piwik web interface click **Settings** in the top right corner, then **Geolocation** in the left side menu. Change the setting from *Default* to *GeoIP (PECL)* .
|
||||
|
||||
5. Optionally, configure *Setup automatic updates of GeoIP databases* at the end of the Geolocation page.
|
||||
|
||||
Importing an Icecast log file
|
||||
-----------------------------
|
||||
|
||||
In addition to the JavaScript tracking code used for web analytics, Piwik includes a Python script which can import a server log file directly. This script accepts the parameter *--log-format-name=icecast2* which enables support for the connection duration field logged by Icecast when a client disconnects. It is this field which enables stations to track the duration of individual audience connections, and calculate both the average connection duration and the 'aggregate tuning hours' figure required by some broadcast regulators.
|
||||
|
||||
For an Icecast log file at */var/log/icecast2/access.log* you can run the script as follows:
|
||||
|
||||
python /usr/share/piwik/misc/log-analytics/import_logs.py --show-progress
|
||||
--url=http://stats.example.com --idsite=1 --recorders=8 --enable-http-errors
|
||||
--log-format-name=icecast2 --strip-query-string /var/log/icecast2/access.log
|
||||
|
||||
where the parameters are:
|
||||
|
||||
--url=http://stats.example.com
|
||||
|
||||
*The ServerName of your Piwik installation.*
|
||||
|
||||
--idsite=1
|
||||
|
||||
*Number of the default site configured in Piwik.*
|
||||
|
||||
--recorders=8
|
||||
|
||||
*How many threads to use while parsing the log file. To begin with, set this value to the number of CPU cores you can spare on the Piwik server.*
|
||||
|
||||
--enable-http-errors
|
||||
|
||||
*Collect statistics for errors, such as stream links not found.*
|
||||
|
||||
--strip-query-string
|
||||
|
||||
*Used because any characters requested by the client after the Icecast mounpoint URL can confuse the statistics.*
|
||||
|
||||
If the Piwik server is remote, you can use an additional parameter *--token\_auth=* to authenticate the request. You can find the token to use for your installation by logging in to Piwik and clicking **API** in the main navigation menu at the top of the page. Further details of the import script are shown at <a href="http://piwik.org/docs/log-analytics-tool-how-to/" class="uri" class="moz-txt-link-freetext" title="http://apt.sourcefabric.org">http://piwik.org/docs/log-analytics-tool-how-to/</a>
|
||||
|
||||
The script will report the number of records processed and the time that has been required to parse the Icecast log file. If the import script is taking too long to execute, there are performance and configuration tips in the <a href="https://github.com/piwik/piwik/blob/master/misc/log-analytics/README.md" class="uri" class="moz-txt-link-freetext">https://github.com/piwik/piwik/blob/master/misc/log-analytics/README.md</a> file.
|
||||
|
||||
Open the Piwik dashboard in your browser, and you should now see a summary of the imported data, including the most popular streams (listed under *Entry Pages*), *Visits by Server Time*, *Referrer Websites* and a *Visitor Map*.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 54 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 75 KiB |
|
|
@ -1,42 +1,41 @@
|
|||
What is Airtime Pro?
|
||||
====================
|
||||
[LibreTime](http://libretime.org/ "LibreTime homepage") is the open broadcast software for scheduling and remote station management. Web browser access to the station's media library, multi-file upload and automatic metadata import features are coupled with a collaborative on-line scheduling calendar and playlist management. The scheduling calendar is managed through an easy-to-use interface and triggers playout with sub-second precision.
|
||||
|
||||
[Airtime](http://airtime.sourcefabric.org/ "Airtime homepage") is the open broadcast software for scheduling and remote station management. Web browser access to the station's media library, multi-file upload and automatic metadata import features are coupled with a collaborative on-line scheduling calendar and playlist management. The scheduling calendar is managed through an easy-to-use interface and triggers playout with sub-second precision.
|
||||
|
||||
|
||||
<img src="what-is-airtime/static/Screenshot540-Now_playing_250.png" width="595" height="455" />
|
||||
LibreTime has been intended to provide a solution for a wide range of broadcast projects, from community to public and commercial stations. The scalability of LibreTime allows implementation in a number of scenarios, ranging from an unmanned broadcast unit accessed remotely through the Internet, to a local network of machines accessing a central LibreTime storage system. LibreTime supports the playout of lossy compressed audio files in both MP3 and AAC formats and the open, royalty-free equivalent [Ogg Vorbis](http://www.vorbis.com/ "Ogg Vorbis homepage"). It also supports playout of lossless FLAC and WAV format audio files.
|
||||
|
||||
A fully managed [Airtime Pro](https://www.airtime.pro/ "Airtime Pro") service is available from Sourcefabric. Airtime source code is also available for download, under the GNU Affero General Public License version 3. If you're an [Airtime Pro](https://www.airtime.pro/ "Airtime Pro") user, you can go straight to the *Getting started* chapter of this book and log in. Alternatively, a demonstration server is available for public use at:
|
||||
LibreTime manages the [Liquidsoap](http://savonet.sourceforge.net/) stream generator at the heart of the system. Liquidsoap generates streams from files in the LibreTime library and any remote input streams that you specify. Available stream output formats include Ogg Vorbis, Ogg Opus, MP3, and AAC. The library is indexed in a [PostgreSQL](http://www.postgresql.org/) database to enable searching. Live shows can be recorded automatically with [Ecasound](http://eca.cx/ecasound/ "Ecasound homepage"), using the sound card line input. News editors, DJs and station controllers can use LibreTime to build playlists or smart blocks and manage media files (upload, edit metadata, manage advertisements) at the station or via the Internet.
|
||||
|
||||
<http://airtime-demo.sourcefabric.org/>
|
||||
The LibreTime administration interface is designed to work with any web browser, on any desktop or mobile platform with a minimum display size of 1280x768 pixels. LibreTime looks its best on a high definition display of 1920x1080 pixels. The recommended web browsers are **Mozilla Firefox 25** or **Google Chrome 30** (or later versions). **Apple Safari 6** (or later) is also supported.
|
||||
|
||||
Airtime has been intended to provide a solution for a wide range of broadcast projects, from community to public and commercial stations. Airtime supports the playout of lossy compressed audio files in both MP3 and AAC formats and the open, royalty-free equivalent [Ogg Vorbis](http://www.vorbis.com/ "Ogg Vorbis homepage"). It also supports playout of lossless FLAC and WAV format audio files.
|
||||
International UTF-8 metadata in media files is supported throughout, and the LibreTime interface can be localized into any language or dialect using the standard GNU gettext utility. Localizations that are installed by default include Austrian, Brazilian, British, Canadian, Chinese, Czech, French, German, Greek, Hungarian, Italian, Korean, Polish, Russian, Spanish and USA. See the chapter *Interface localization* for details of how to update a translation or add a new localization.
|
||||
|
||||
Available stream output formats include Ogg Vorbis, Ogg Opus, MP3, and AAC. The Airtime library is indexed in a database to enable searching. News editors, DJs and station controllers can use Airtime to build playlists or smart blocks and manage media files (upload, edit metadata, manage advertisements) at the station or via the Internet.
|
||||
|
||||
|
||||
The Airtime administration interface is designed to work with any web browser, on any desktop or mobile platform with a minimum display size of 1280x768 pixels. Airtime looks best on a high definition display of 1920x1080 pixels. The recommended web browsers are **Mozilla Firefox 37** or **Google Chrome 42** (or later versions). **Apple Safari 6** (or later) is also supported.
|
||||
The scheduler in LibreTime has a calendar view, organized by months, weeks and days. Here the program editors can schedule playlists and shows for their broadcast station. In some scenarios, the transmitter is situated outside the reach of the broadcaster and all program management has to be maintained through the web interface. Possible reasons for this scenario might be of a pragmatic nature (running many stations from one central office due to limited human resources) or an emergency (running a transmitter in a crisis area without putting staff at risk).
|
||||
|
||||
International UTF-8 metadata in media files is supported throughout, and the Airtime interface can be localized into any language or dialect. Localizations that are installed by default include Austrian, Brazilian, British, Canadian, Chinese, Czech, French, German, Greek, Hungarian, Italian, Korean, Polish, Russian, Spanish and USA.
|
||||
|
||||
<img src="what-is-airtime/static/Screenshot541-Chinese_localization_250.png" width="595" height="405" />
|
||||
|
||||
Airtime workflow
|
||||
LibreTime workflow
|
||||
----------------
|
||||
|
||||
This typical workflow is intended to clarify the difference between the various components that make up a complete Airtime system.
|
||||
This typical workflow is intended to clarify the difference between the various components that make up a complete LibreTime system.
|
||||
|
||||
1. There are media files on a storage server, which include metadata in their tags (title, creator, genre and so on).
|
||||
1. There are media files on a storage server, which include metadata in their tags (title, creator, genre and so on). This storage server might be accessed directly via studio workstations on the local network.
|
||||
|
||||
2. The Airtime media-monitor keeps track of files being added, renamed, moved or removed from storage, and reads their metadata using the Mutagen library.
|
||||
2. The LibreTime media-monitor keeps track of files being added, renamed, moved or removed from storage, and reads their metadata using the Mutagen library.
|
||||
|
||||
3. A PostgreSQL database contains the location of those media files and their metadata. The database also contains details of specified remote input streams.
|
||||
3. A PostgreSQL database contains the location of those media files and their metadata. This means you can search for and playlist a set of media files according to the specific metadata that you require, or use a 'smart block' to select the files for you. The database also contains details of specified remote input streams.
|
||||
|
||||
4. Pypo, the Python Playout engine, downloads media from the storage up to 24 hours ahead of playout and checks it for average level (with ReplayGain tools) and leading or trailing silence (with Silan). At playout time, the media to be broadcast is sent to Liquidsoap.
|
||||
|
||||
5. Liquidsoap takes individual media files and remote input streams, and assembles them into a continuous output stream. This output stream can be sent to an Icecast streaming server for distribution over the Internet. You can stream to up to three different distribution servers with the same Airtime server, if you wish.
|
||||
5. Liquidsoap takes individual media files and remote input streams, and assembles them into a continuous output stream. This stream can be sent to a sound card (e.g. for a broadcast mixer, on the way to an FM or DAB transmitter) or to a streaming server for IP network distribution, over the LAN, local WiFi or the Internet. You can stream to a sound card and up to three different stream distribution servers with the same LibreTime server, if you wish.
|
||||
|
||||
6. RabbitMQ pushes messages from Airtime to media-monitor and pypo about changes to media files and the playout schedule.
|
||||
6. Icecast (<http://www.icecast.org/>) is the default stream distribution server, and there is also support for SHOUTcast ([http://www.shoutcast.com](http://www.shoutcast.com/ "Shoutcast homepage")), but in theory you could stream from Liquidsoap to any online service. If a suitable Liquidsoap output is not available for your streaming service of choice, you can send audio from Liquidsoap to a separate encoding or streaming machine via a sound card or relay stream.
|
||||
|
||||
7. Airtime manages all of these components, and provides an easy, multi-user web interface to the system. It enables your station staff, depending on the permissions you have granted them, to:
|
||||
7. Monit monitors the health of pypo, media-monitor and Liquidsoap, and reports the status of these services to LibreTime.
|
||||
|
||||
8. RabbitMQ pushes messages from LibreTime to media-monitor and pypo about changes to media files and the playout schedule.
|
||||
|
||||
9. LibreTime manages all of these components, and provides an easy, multi-user web interface to the system. It enables your station staff, depending on the permissions you have granted them, to:
|
||||
|
||||
a) upload media files to the storage server via the **Add Media** page
|
||||
|
||||
|
|
@ -44,23 +43,38 @@ b) automatically import file metadata into the PostgreSQL database
|
|||
|
||||
c) search for and download media files, and edit the metadata of individual files, if required, on the **Library** page
|
||||
|
||||
d) create and edit playlists of media files or create smart blocks of content based on metadata, edit cue points and fades, and audition them. Playlists and smart blocks are also saved in the database, and can be searched for on the **Library** page
|
||||
d) create and edit playlists of media files or create smart blocks of content based on metadata, edit cue points and fades, and audition them. Playlists and smart blocks are also saved in the database, and can be searched for
|
||||
|
||||
e) schedule colour-coded broadcast shows (which can contain playlists, smart blocks, pre-recorded complete shows, timed remote input streams, or be live) for specific dates and times on the **Calendar** page. Regular shows can be scheduled by the day of the week or month, and can be linked to share content
|
||||
|
||||
f) manage presenter, staff and guest access to Airtime, and contact details, via the **Manage Users** page
|
||||
f) automatically record live shows at specific times and dates (in 256 kbps Ogg Vorbis format by default) from the sound card input with Ecasound, upload them to the storage server and import them into the database
|
||||
|
||||
g) see what is about to be played by Liquidsoap on the **Now Playing** page, with support for last-minute changes to the content
|
||||
g) manage presenter, staff and guest access to LibreTime, and contact details, via the **Manage Users** page
|
||||
|
||||
h) audition available output streams from the server using the **Listen** button
|
||||
h) see what is about to be played by Liquidsoap on the **Now Playing** page, with support for last-minute changes to the content
|
||||
|
||||
i) check the status and resource usage of system components on the **Status** page
|
||||
i) upload media files from LibreTime to a third-party hosting service, such as SoundCloud
|
||||
|
||||
j) export the broadcast schedule to external sites via the Public Airtime API on the **Preferences** page
|
||||
j) audition available output streams from the server using the **Listen** button
|
||||
|
||||
k) see logs on the **Playout History** page and view graphs on the **Listener Stats** page
|
||||
k) check the status and resource usage of system components on the **Status** page
|
||||
|
||||
l) configure the Airtime system on the **Preferences** and **Streams** pages
|
||||
l) export the broadcast schedule to external sites via the Schedule API
|
||||
|
||||
m) copy and paste code into a third-party website from the **Embeddable Player** page
|
||||
m) see logs on the **Playout History** page and view graphs on the **Listener Stats** page
|
||||
|
||||
n) configure the LibreTime system on the **Preferences**, **Media Folders** and **Streams** pages.
|
||||
|
||||
Example studio broadcast system
|
||||
-------------------------------
|
||||
|
||||
In the diagram of an FM radio station below, LibreTime is hosted on a server connected to the local network, with direct soundcard access. Liquidsoap outputs streams to both the transmitter, via the main studio mixer, and streaming media servers. The machine running LibreTime is behind a firewall because it is also connected to the Internet for remote access by media contributors. This enables LibreTime to offer password-protected access to the media library and scheduling from both inside and outside the studio building.
|
||||
|
||||
|
||||
|
||||
Example web broadcast system
|
||||
----------------------------
|
||||
|
||||
In the diagram below, LibreTime is hosted on a remote web server, and has no soundcard. There does not need to be a centralised studio, although LibreTime can enable remote studios to stream in to Liquidsoap at authorised times. Optionally, the outgoing Icecast stream can be relayed to a transmitter.
|
||||
|
||||
|
||||
|
|
|
|||
32
docs/manual/interface-customization/index.md
Normal file
32
docs/manual/interface-customization/index.md
Normal file
|
|
@ -0,0 +1,32 @@
|
|||
The Airtime 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 Airtime 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 Airtime *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 Airtime to a newer version, otherwise they could be overwritten. If you have made improvements that you think might be useful to other Airtime users, please contact Sourcefabric and tell us about them.
|
||||
|
||||
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.
|
After Width: | Height: | Size: 56 KiB |
57
docs/manual/interface-localization/index.md
Normal file
57
docs/manual/interface-localization/index.md
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
The Airtime 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 Airtime at <https://github.com/sourcefabric/Airtime/tree/master>. You can also ask in the Airtime development forum at <http://forum.sourcefabric.org/categories/airtime-development>, 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 Airtime'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 Airtime 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 Airtime 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 Airtime.
|
||||
# Copyright (C) 2013 Sourcefabric
|
||||
# This file is distributed under the same license as the Airtime package.
|
||||
# Sourcefabric <contact@sourcefabric.org>, 2013.
|
||||
#
|
||||
msgid ""
|
||||
msgstr ""
|
||||
"Project-Id-Version: Airtime 2.5\n"
|
||||
"Report-Msgid-Bugs-To: http://forum.sourcefabric.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 Airtime developers. The localization can then be added to a forthcoming Airtime 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 Airtime 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 Airtime community, and avoid duplicated effort.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
|
|
@ -1,6 +1,3 @@
|
|||
Library
|
||||
=======
|
||||
|
||||
This page of the Airtime interface enables you to search the media library, sort and display the search results by the criteria that you choose, audition library items, and drag and drop those items into a playlist. You can also adjust fade and cue points, create smart blocks (automatically generated playlists), or add incoming web streams to the library. The **Library** page is not visible to *Guest* users.
|
||||
|
||||
Searching the library
|
||||
|
|
@ -13,7 +10,7 @@ Creating a new playlist
|
|||
|
||||
Once you have found the media that you require using the search tools, you can create a new playlist on the right hand side of the **Library** page. If it is not already open, click the **Open Media Builder** button to begin.
|
||||
|
||||
<img src="static/Screenshot500-Open_media_builder_240.png" width="595" height="310" />
|
||||
|
||||
|
||||
Then click the **New** button and select **New Playlist** from the pop-up menu.
|
||||
|
||||
|
|
@ -21,22 +18,22 @@ Then click the **New** button and select **New Playlist** from the pop-up menu.
|
|||
|
||||
At first, the new playlist will be shown as *Untitled Playlist*. Click the pencil icon on the right to give the playlist a name.
|
||||
|
||||
<img src="static/Screenshot502-Untitled_playlist_240.png" width="585" height="295" />
|
||||
|
||||
|
||||
Type the name you have chosen, then press the **Enter** key on your keyboard to save the new name. You can edit the name of the playlist later, by clicking on the pencil icon again.
|
||||
|
||||
<img src="static/Screenshot503-My_playlist_240.png" width="585" height="285" />
|
||||
|
||||
|
||||
Click the link **View / edit description** to expand a box where you can enter a **Description** for the playlist, then click the **Save** button. Setting good quality metadata here will help you find the playlist using the search box later, so you should be as descriptive as possible.
|
||||
|
||||
<img src="static/Screenshot504-Example_playlist_240.png" width="585" height="310" />
|
||||
|
||||
|
||||
Adding content to a playlist
|
||||
----------------------------
|
||||
|
||||
With a playlist open, click on an item in the search results and then click **Add to Playlist** on the pop-up menu. Or drag and drop items from the search results on the left into the playlist on the right. Jingles and voice tracks can be added before, after or between music items.
|
||||
|
||||
<img src="static/Screenshot505-Add_item_to_playlist_240.png" width="585" height="325" />
|
||||
|
||||
|
||||
You can also select or deselect a whole page of search results using the **Select** button, just below the simple search field. Alternatively, use the checkboxes in the first column of the search results table to select individual items, then click the **Add to current playlist** button. Items that you own which you no longer require can be deleted from Airtime's library using the **Trashcan** button.
|
||||
|
||||
|
|
@ -48,60 +45,60 @@ To audition a playlist file in your web browser, click the white triangle**** bu
|
|||
|
||||
Click the small white **x** icon on the right hand side of each row to remove a file from the playlist. You can also drag and drop files to re-order them, or click the **Shuffle** button to re-order files automatically. Click the **Clear** button to remove all content from the playlist, or click the **Delete** button to remove the playlist from the Airtime library altogether.
|
||||
|
||||
<img src="static/Screenshot506-Drag_drop_playlist_240.png" width="585" height="325" />
|
||||
|
||||
|
||||
To adjust start and end fades, click the playlist **Fade** button (two horizontal white arrows crossing in a grey rectangle), to the left of the **Delete** and **Save** buttons. This action opens a beige bar in which you can set the **Fade in** duration for the first item in this playlist, and the **Fade out** duration for the last item. This duration figure represents the length of the fade, in seconds and tenths of a second, not the time at which the fade takes place. The default fade duration is set in the **Preferences** page on the **System** menu.
|
||||
|
||||
<img src="static/Screenshot507-Fade_in_out_240.png" width="585" height="380" />
|
||||
|
||||
|
||||
Click any one of the smaller **Fade** buttons between file rows to open another beige bar, which enables you to set **Fade out** and **Fade in** durations between two adjacent files in the playlist. The fade buttons for adjacent files change to an orange background when you click them.
|
||||
|
||||
<img src="static/Screenshot508-Adjacent_fade_out_in_240.png" width="585" height="480" />
|
||||
|
||||
|
||||
If your web browser supports the Web Audio API, you will see a **Show Waveform** button which enables you to view the waveforms of the adjacent items, adjust the fades and audition them. Click the **Fade Out** or **Fade In** button to change the fade curves by clicking in the waveforms, then click the **Play** button to audition the effect of any adjustment you have made. To audition just one part of the item, use the **Cursor** button to move the play cursor, which appears as a thin red line, on the waveform. The playback progress is shown by an orange colour on the waveform.
|
||||
|
||||
<img src="static/Screenshot509-fade_editor_240.png" width="585" height="550" />
|
||||
|
||||
|
||||
Each file in the playlist also has a button with two square brackets, which enables you to adjust **Cue In** and **Cue Out** times for that particular file. Like the fade button, the cue button changes to an orange background when you click it.
|
||||
|
||||
**Cue In** and **Cue Out** points are set in hours, minutes, seconds and tenths of a second, relative to the start of the item. If a file has leading or trailing silence, corresponding cue points will be set automatically. The duration of the file in the playlist is updated automatically when you adjust a cue point, but the **Original Length** of the file is also displayed for your reference.
|
||||
|
||||
<img src="static/Screenshot510-Cue_in_out_240.png" width="585" height="430" />
|
||||
|
||||
|
||||
If a **Fade In** and **Cue In** are set on the same item in the playlist, the fade in begins at the **Cue In** point. If a **Fade Out** and **Cue Out** are set on the same item, the fade out ends at the **Cue Out** point. If your web browser supports the Web Audio API, you can click the **Show Waveform** button to adjust and audition cue points.
|
||||
|
||||
<img src="static/Screenshot511-Visual_cue_editor_240.png" width="585" height="485" />
|
||||
|
||||
|
||||
When your playlist is complete, click the **New** button in the top left corner to create another playlist, click the close icon (a white cross in a black circle) in the top right corner, or browse to another page of the Airtime interface.
|
||||
|
||||
If you want to edit the playlist content or metadata later, you can find it by **Title**, **Creator**, **Last Modified** date, **Length**, **Owner** or **Year** using one of the search tools on the Library page. Click the playlist in the search results list, and then click **Edit** from the pop-up menu. You can also **Preview** the entire playlist in a pop-up audition window, **Duplicate** or **Delete** one of your playlists from this menu.
|
||||
|
||||
<img src="static/Screenshot501-Edit_playlist_240.png" width="595" height="290" />
|
||||
|
||||
|
||||
Creating a smart block
|
||||
----------------------
|
||||
|
||||
Smart blocks are automatically filled with media files from the Airtime library, according to the criteria that you specify. This feature is intended to save time, compared to selecting items for a playlist manually.
|
||||
Smart blocks are automatically filled with media files from the Airtime library, according to the criteria that you specify. This feature is intended to save staff time, compared to selecting items for a playlist manually.
|
||||
|
||||
To create a smart block, click the **New** button on the right side of the Library page, and select **New Smart Block** from the pop-up menu. Like a playlist, smart blocks can have a title and **Description**, which you can edit. This helps you find relevant smart blocks in searches.
|
||||
|
||||
<img src="static/Screenshot512-Example_smart_block_240.png" width="585" height="340" />
|
||||
|
||||
|
||||
Click the link **Smart Block Options** to display the criteria and modifiers for the smart block. The criteria can be any one of Airtime's metadata categories, such as **Title**, **Creator** or **Genre**. The modifier depends on whether the metadata in question contains letters or numbers. For example, **Title** has modifiers including *contains* and *starts with*, whereas the modifiers for **BPM** include *is greater than* and *is in the range*.
|
||||
|
||||
You can also set the **smart block type**. A **Static** smart block will save the criteria and generate the block content immediately. This enables you to edit the contents of the block in the **Library** page before adding it to a show. A **Dynamic** smart block will only save the criteria, and the specific content will be generated at the time the block is added to a show. After that, the content of the show can be changed or re-ordered in the **Now Playing** page.
|
||||
|
||||
<img src="static/Screenshot579-Creator_contains.png" alt="Smart block creator contains" width="585" height="250" />
|
||||
|
||||
|
||||
Click the **plus button** on the left to add OR criteria, such as **Creator** containing *beck* OR *jimi*. (The criteria are not case sensitive). For a static smart block, click the **Generate** button to see the results. Dynamic smart blocks do not display the **Generate** or **Shuffle** buttons.
|
||||
|
||||
<img src="static/Screenshot580-Contains_beck_or_jimi.png" alt="Smart block creator contains or" width="585" height="275" />
|
||||
|
||||
|
||||
If you don't like the ordering which is generated, click the **Shuffle** button, or drag and drop the smart block contents into the order that you prefer. You can also remove items or add new items manually from the Library. Changes to static smart block contents are saved automatically when you add items, remove or re-order them, or click the **Generate** button. Click the **Save** button in the upper right corner to save any changes to smart block criteria.
|
||||
|
||||
To add an AND criteria, such as **Creator** containing *jimi* AND BPM in the range *120* to *130*, click the **plus button** on the right. If you see the message **0 files meet the criteria** in this case, it might mean that the files in the Library have not been tagged with BPM metadata. See the chapter *Preparing media for ingest* for tips on tagging content.
|
||||
|
||||
<img src="static/Screenshot581-Smart_block_and_criteria.png" alt="Smart block and criteria" width="575" height="160" />
|
||||
|
||||
|
||||
By default, a smart block will not contain repeated items, which will limit the duration of the block if you do not have sufficient items meeting the specified criteria in your **Library**. To override the default behaviour, check the **Allow Repeat Tracks** box. The **Sort tracks by** menu offers the options of **random**, **newest** or **oldest** items first.
|
||||
|
||||
|
|
@ -111,7 +108,7 @@ If you have a large number of files which meet the criteria that you specify, yo
|
|||
|
||||
Smart blocks can be added to shows in the same way as a manually created playlist is added. Smart blocks can also be added to one or more playlists. In the case of a playlist containing a static smart block, click **Expand Static Block** to view the contents. For a dynamic smart block, you can review the criteria and duration limit by clicking **Expand Dynamic Block**.
|
||||
|
||||
<img src="static/Screenshot515-Expand_static_smart_block.png" width="585" height="405" />
|
||||
|
||||
|
||||
Once created, smart blocks can be found in Library searches and refined at any time. They can be re-opened by clicking on the smart block and selecting **Edit** from the pop-up menu.
|
||||
|
||||
|
|
@ -122,7 +119,6 @@ A web stream URL and metadata can be added to the Airtime library, so that a rem
|
|||
|
||||
To add a web stream, click the **New** button on the right side of the Library page, and select **New Webstream** from the pop-up menu. Like a playlist, web streams in the Library can have a title and **Description**, which may help you find them in searches later.
|
||||
|
||||
<img src="static/Screenshot516-New_remote_webstream.png" width="585" height="400" />
|
||||
|
||||
|
||||
The **Stream URL** setting must include the *port number* (such as 8000) and *mount point* (such as remote\_stream) of the remote stream, in addition to the streaming server name. A **Default Length** for the remote stream can also be set. If the stream is added at the end of a show which becomes overbooked as a result, it will be faded out when the show ends.
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 59 KiB |
|
|
@ -1,6 +1,3 @@
|
|||
Listen
|
||||
======
|
||||
|
||||
In the Master Panel, beneath the **ON AIR** indicator, you will find the **LISTEN** button.
|
||||
|
||||
|
||||
|
|
@ -18,4 +15,3 @@ To display the URL of the stream you are monitoring, so that you can copy and pa
|
|||
|
||||
|
||||
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 Airtime server, only the stream monitoring on your desktop computer or laptop.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,4 @@
|
|||
Listener stats
|
||||
==============
|
||||
|
||||
The **Listener Stats** page on the System 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.
|
||||
The Listener Stats page on the System 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.
|
||||
|
||||
|
||||
|
||||
|
|
@ -13,5 +10,4 @@ By default, statistics for the last 24 hours of streaming are shown. To change t
|
|||
|
||||
To choose which particular streams should have statistics displayed, click the check boxes for the individual colour-coded mount points, just below the graph.
|
||||
|
||||
<img src="static/Screenshot522-Select_stream_stats_240.png" width="545" height="175" />
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,3 @@
|
|||
Live shows with Mixxx
|
||||
=====================
|
||||
|
||||
Mixxx is a cross-platform Open Source application for DJs, available from <http://www.mixxx.org/>
|
||||
|
||||
Installed on a desktop or laptop computer, Mixxx complements your Airtime server to provide a complete system for both live and scheduled broadcasting. Although Mixxx has many features designed for dance music DJs that require beat matching and pitch independent time stretching, the program can be used for any kind of manually triggered broadcast playout, including live speech shows such as news or current affairs.
|
||||
|
|
@ -10,13 +7,32 @@ Mixxx supports a wide variety of popular hardware control surfaces, which can be
|
|||
Sound cards
|
||||
-----------
|
||||
|
||||
If your computer does not have a four-channel audio interface to provide a cue output or separate mixer outputs, you can configure Mixxx to use additional stereo sound cards or USB devices by clicking **Options**, **Preferences**, then **Sound Hardware** in the main Mixxx menu. Select a device other than the default ** for the **Headphones** output, or select separate devices for **Deck** outputs. Then click the **OK** button.
|
||||
If you wish to use Airtime and Mixxx on the same machine, you will need two or more sound cards, as each program requires exclusive access to the sound hardware. Otherwise, you may see an error message that Mixxx cannot access the sound device.
|
||||
|
||||
|
||||
|
||||
The solution is to configure Mixxx to use additional sound cards by clicking **Options**, **Preferences**, then **Sound Hardware** in the main Mixxx menu. Select devices other than the ALSA default of *hw:0,0* for at least the **Master** and **Headphones** outputs. Then click the **OK** button.
|
||||
|
||||
|
||||
|
||||
For performance and redundancy reasons it is advisable to cache files required for a particular show on the client machine where Mixxx is installed. For example, a nightly**** download of new media in the archive would guard against network problems at playout time potentially disrupting a broadcast at a remote studio.
|
||||
Sharing storage
|
||||
---------------
|
||||
|
||||
Mixxx users can also record a show, and then upload it through the Airtime web interface for collaborative or user-generated broadcasts.
|
||||
If you make the Airtime server's storage directory */srv/airtime/stor/* accessible to a desktop machine as a read-only location, Mixxx will accept that location as its default music library when starting up for the first time. (This location can also be configured after installation by clicking **Options**, **Preferences**, then **Library** in the main Mixxx menu).
|
||||
|
||||
|
||||
|
||||
You may need to adjust file and directory permissions so that the storage directory has read access from the desktop user account. Enabling write access directly to the storage server is not recommended, as this would allow desktop users to delete files which might be needed for playout later.
|
||||
|
||||
If the filesystem path has been configured correctly, the metadata for the files in the Airtime storage server will be displayed in the main window of the Mixxx interface. Individual files from the Airtime storage server can then be added to either of Mixxx's live players with a right-click on the filename, or by using the appropriate hardware buttons on a control surface. Therefore it is possible to manage the station's storage archive remotely and collaboratively through Airtime, while using Mixxx as the live playout client in multiple, remote studios.
|
||||
|
||||
|
||||
|
||||
The Airtime storage archive can be exported like any other file server share. The method that you implement would depend on the operating system of your desktop client machines, and whether they were on the same local network as the Airtime server, or remote.
|
||||
|
||||
For performance and redundancy reasons it is advisable to cache files required for a particular show on the client machine where Mixxx is installed. For example, for a GNU/Linux client machine, a nightly **rsync** download of new media in the archive would guard against network problems at playout time potentially disrupting a broadcast at a remote studio.
|
||||
|
||||
Mixxx users can also record a show, and then upload it through the Airtime web interface on a local or remote server for collaborative or user-generated broadcasts.
|
||||
|
||||
Streaming from Mixxx into Airtime
|
||||
---------------------------------
|
||||
|
|
@ -44,4 +60,3 @@ After downloading one of the skins, extract the zip file and copy it to the *ski
|
|||
Then, start Mixxx and select the Airtime skin by clicking **Options**, **Preferences**, then **Interface** in the Mixxx main menu.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 44 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 34 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
235
docs/manual/manual-installation/index.md
Normal file
235
docs/manual/manual-installation/index.md
Normal file
|
|
@ -0,0 +1,235 @@
|
|||
You do not normally need to install Airtime manually, unless you are testing a development version of the software. Versions of Airtime recommended for production use are available for download and upgrade via *secure apt*, as shown in the *Automated installation* chapter.
|
||||
|
||||
Dependencies provided by Sourcefabric
|
||||
-------------------------------------
|
||||
|
||||
The <http://apt.sourcefabric.org/> repository contains up-to-date Debian and Ubuntu packages of Airtime dependencies such as **liquidsoap** and **silan** which you may find convenient to install, even if you are installing Airtime manually. Refer to the chapter *Automated installation* for repository setup details.
|
||||
|
||||
Airtime requires a version of **python-virtualenv** later than 1.4.8, but Ubuntu Lucid includes the older version 1.4.5 of this package. Before performing a manual installation on Lucid, you should update **python-virtualenv** using the backported package available from the <http://apt.sourcefabric.org/> repository. This step is not necessary when performing an automated installation, in which dependencies are resolved automatically.
|
||||
|
||||
Full install
|
||||
------------
|
||||
|
||||
The **airtime-full-install** script is designed to configure your server for you, using typical default settings.
|
||||
|
||||
1. In the server terminal or console, download Airtime from <https://github.com/sourcefabric/Airtime/releases> with **wget**. For example, to download version 2.5.1, you could use the command:
|
||||
|
||||
wget https://github.com/sourcefabric/Airtime/archive/airtime-2.5.1-ga.tar.gz
|
||||
|
||||
Then unzip the downloaded file in your home directory. This action will create a subdirectory called *airtime-2.5.1*:
|
||||
|
||||
tar -xvzf airtime-2.5.1-ga.tar.gz -C ~/
|
||||
|
||||
Alternatively, clone the git repository if you wish to work on the latest Airtime source code:
|
||||
|
||||
git clone https://github.com/sourcefabric/Airtime.git
|
||||
|
||||
In order to return your code improvements to Airtime, you will need to create your own fork of the Airtime git repository and send pull requests. See the GitHub help page <https://help.github.com/articles/fork-a-repo> for details.
|
||||
|
||||
2. Run the **airtime-full-install** script, for example on Ubuntu:
|
||||
|
||||
sudo ~/airtime-2.5.1/install_full/ubuntu/airtime-full-install
|
||||
|
||||
The installation script will indicate which files are being installed on your system, and the directories they are being unpacked into. Finally, it will run the **airtime-check-system** script to confirm that your server environment is set up correctly.
|
||||
|
||||
*** Verifying your system environment, running airtime-check-system ***
|
||||
AIRTIME_STATUS_URL = http://airtime.example.com:80/api/status/format/json/api_key/%%api_key%%
|
||||
AIRTIME_SERVER_RESPONDING = OK
|
||||
KERNEL_VERSION = 3.2.0-4-amd64
|
||||
MACHINE_ARCHITECTURE = x86_64
|
||||
TOTAL_MEMORY_MBYTES = 2963688
|
||||
TOTAL_SWAP_MBYTES = 7812092
|
||||
AIRTIME_VERSION = 2.5.1
|
||||
OS = Debian GNU/Linux 7.1 (wheezy) x86_64
|
||||
CPU = AMD Turion(tm) II Neo N40L Dual-Core Processor
|
||||
WEB_SERVER = Apache/2.2.22 (Debian)
|
||||
PLAYOUT_ENGINE_PROCESS_ID = 4446
|
||||
PLAYOUT_ENGINE_RUNNING_SECONDS = 55
|
||||
PLAYOUT_ENGINE_MEM_PERC = 0.5%
|
||||
PLAYOUT_ENGINE_CPU_PERC = 0.4%
|
||||
LIQUIDSOAP_PROCESS_ID = 4685
|
||||
LIQUIDSOAP_RUNNING_SECONDS = 49
|
||||
LIQUIDSOAP_MEM_PERC = 0.7%
|
||||
LIQUIDSOAP_CPU_PERC = 7.4%
|
||||
MEDIA_MONITOR_PROCESS_ID = 4410
|
||||
MEDIA_MONITOR_RUNNING_SECONDS = 55
|
||||
MEDIA_MONITOR_MEM_PERC = 0.5%
|
||||
MEDIA_MONITOR_CPU_PERC = 0.0%
|
||||
-- Your installation of Airtime looks OK!
|
||||
|
||||
************ Install Complete ************
|
||||
|
||||
You are now ready to proceed to the *Configuration* chapter.
|
||||
|
||||
Minimal install
|
||||
---------------
|
||||
|
||||
The alternative **airtime-install** script does not attempt to configure your server, an option which you may find more suitable if you have special requirements.
|
||||
|
||||
1. In the server terminal or console, install the list of dependencies. For example, on Ubuntu you could enter the command:
|
||||
|
||||
sudo apt-get install postgresql python-virtualenv apache2 coreutils \
|
||||
curl ecasound flac gzip libapache2-mod-php5 libcamomile-ocaml-data \
|
||||
liquidsoap locales lsof monit mp3gain multitail patch php5-cli \
|
||||
php5-curl php5-gd php5-json php5-pgsql php-apc php-pear pwgen \
|
||||
python rabbitmq-server silan sudo sysv-rc tar unzip \
|
||||
vorbisgain vorbis-tools libzend-framework-php
|
||||
|
||||
On Debian, install *zendframework* instead of the *libzend-framework-php* package.
|
||||
|
||||
2. Check that the Apache web server modules that Airtime requires are enabled:
|
||||
|
||||
sudo a2enmod php5 rewrite
|
||||
|
||||
The server should respond:
|
||||
|
||||
Module php5 already enabled
|
||||
Module rewrite already enabled
|
||||
|
||||
3. Create a directory to contain the Airtime web interface:
|
||||
|
||||
sudo mkdir -p /usr/share/airtime/public
|
||||
|
||||
4. Next, create the Airtime virtual host configuration file for Apache:
|
||||
|
||||
sudo nano /etc/apache2/sites-available/airtime.conf
|
||||
|
||||
and enter the information below, substituting your server's hostname for *airtime.example.com* and your system administrator's email address for *admin@example.com*. Make sure you set the *DocumentRoot* and *Directory* paths correctly. This should normally match the *public* directory that the installer will unpack the web interface into, which by default is the */usr/share/airtime/public/* directory. From Airtime 2.3.0 onwards, the web interface can be installed in a subdirectory of the *DocumentRoot* if you require it to be.
|
||||
|
||||
For Apache 2.2, you can use the following syntax:
|
||||
|
||||
<VirtualHost *:80>
|
||||
ServerName airtime.example.com
|
||||
ServerAdmin admin@example.com
|
||||
DocumentRoot /usr/share/airtime/public
|
||||
php_admin_value upload_tmp_dir /tmp
|
||||
|
||||
<Directory /usr/share/airtime/public>
|
||||
DirectoryIndex index.php
|
||||
AllowOverride all
|
||||
Order allow,deny
|
||||
Allow from all
|
||||
</Directory>
|
||||
</VirtualHost>
|
||||
|
||||
Apache 2.4 uses a different access control syntax in the Directory stanza:
|
||||
|
||||
<VirtualHost *:80>
|
||||
ServerName airtime.example.com
|
||||
ServerAdmin admin@example.com
|
||||
DocumentRoot /usr/share/airtime/public
|
||||
php_admin_value upload_tmp_dir /tmp
|
||||
|
||||
<Directory /usr/share/airtime/public>
|
||||
DirectoryIndex index.php
|
||||
AllowOverride all
|
||||
Require all granted
|
||||
</Directory>
|
||||
</VirtualHost>
|
||||
|
||||
Press Ctrl+O to save the file, then Ctrl+X to exit the **nano** editor.
|
||||
|
||||
5. Create the PHP configuration file */etc/airtime/airtime.ini* in nano:
|
||||
|
||||
sudo nano /etc/airtime/airtime.ini
|
||||
|
||||
with the following contents:
|
||||
|
||||
[PHP]
|
||||
memory_limit = 512M
|
||||
magic_quotes_gpc = Off
|
||||
file_uploads = On
|
||||
upload_tmp_dir = /tmp
|
||||
apc.write_lock = 1
|
||||
apc.slam_defense = 0
|
||||
|
||||
Save and exit nano, then link this file to the system's PHP configuration with the command:
|
||||
|
||||
sudo ln -s /etc/airtime/airtime.ini /etc/php5/conf.d/airtime.ini
|
||||
|
||||
6. Enable the new configuration by entering the command:
|
||||
|
||||
sudo a2ensite airtime
|
||||
|
||||
The server should respond:
|
||||
|
||||
Enabling site airtime.
|
||||
Run '/etc/init.d/apache2 reload' to activate new configuration!
|
||||
|
||||
You may also need to disable the default site configuration, which may otherwise interfere with your Airtime installation:
|
||||
|
||||
sudo a2dissite default
|
||||
|
||||
As suggested by the output of the command above, reload the web server configuration.
|
||||
|
||||
sudo /etc/init.d/apache2 reload
|
||||
|
||||
The server should respond:
|
||||
|
||||
* Reloading web server config apache2
|
||||
|
||||
7. Download Airtime from <https://github.com/sourcefabric/Airtime/releases> with **wget**, and unzip the downloaded file in your home directory. This action will create a subdirectory called *airtime-2.5.1*:
|
||||
|
||||
wget https://github.com/sourcefabric/Airtime/archive/airtime-2.5.1-ga.tar.gz
|
||||
tar -xvzf airtime-2.5.1-ga.tar.gz -C ~/
|
||||
|
||||
Alternatively, clone the Airtime git repository as shown above.
|
||||
|
||||
8. Monit is a utility which Airtime uses to make sure that the system runs smoothly. Enable it by opening the */etc/default/monit* file in the **nano** editor:
|
||||
|
||||
sudo nano /etc/default/monit
|
||||
|
||||
Find the line that begins with *START* and change the value to *yes*:
|
||||
|
||||
START=yes
|
||||
|
||||
Save the file with Ctrl+O and close nano with Ctrl+X. Now copy the Monit configuration from the Airtime install directory to the */etc/monit/conf.d/* directory:
|
||||
|
||||
sudo cp ~/airtime-2.5.1/python_apps/monit/airtime-monit.cfg /etc/monit/conf.d/
|
||||
|
||||
Open the */etc/monit/monitrc* file in **nano**:
|
||||
|
||||
sudo nano /etc/monit/monitrc
|
||||
|
||||
At the end of the file, add the line:
|
||||
|
||||
include /etc/monit/conf.d/*
|
||||
|
||||
Save the file with Ctrl+O and close nano with Ctrl+X. Then start Monit with:
|
||||
|
||||
sudo invoke-rc.d monit start
|
||||
|
||||
More information about monit is available in the chapter *Using Monit*.
|
||||
|
||||
9. On Debian squeeze, make sure the rabbitmq-server daemon has started:
|
||||
|
||||
sudo invoke-rc.d rabbitmq-server start
|
||||
|
||||
10. Finally, run the minimal **airtime-install** script:
|
||||
|
||||
sudo ~/airtime-2.5.1/install_minimal/airtime-install
|
||||
|
||||
Once the **airtime-check-system** script confirms that the install has been successful, you should now be able to log in to the Airtime administration interface, as shown in the *Getting started* chapter, with the username *admin* and the password *admin*. See the *Configuration* chapter for advanced settings.
|
||||
|
||||
Install script options
|
||||
----------------------
|
||||
|
||||
By default, the **airtime-install** script preserves any existing configuration or installation that it finds on the server. However, it is also possible to dictate the behaviour of the script with a command line option, as follows:
|
||||
|
||||
--help|-h Displays usage information.
|
||||
--overwrite|-o Overwrite any existing config files.
|
||||
--preserve|-p Keep any existing config files.
|
||||
--no-db|-n Turn off database install.
|
||||
--reinstall|-r Force a fresh install of this Airtime version.
|
||||
|
||||
Manual uninstall
|
||||
----------------
|
||||
|
||||
To manually uninstall Airtime from the server, run the **airtime-uninstall** script from the minimal installation directory, for example:
|
||||
|
||||
sudo ~/airtime-2.5.1/install_minimal/airtime-uninstall
|
||||
|
||||
Optionally, you can also delete the Airtime storage and configuration folders, if you have backups and are not going to need the data on this particular server again. The **rm** command should be used with caution, because it has no undo feature.
|
||||
|
||||
sudo rm -r /srv/airtime
|
||||
sudo rm -r /etc/airtime
|
||||
51
docs/manual/media-folders/index.md
Normal file
51
docs/manual/media-folders/index.md
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
Airtime's media library is inside the */srv/airtime/stor/* folder on your server, by default. In **Media folders** on the **System** menu, you can change this default location, or add extra folders to be watched by Airtime.
|
||||
|
||||
|
||||
|
||||
If you specify a network drive as a media folder and that network becomes disconnected for any reason, Airtime's **media monitor** will flag the files as 'missing' in its database until the drive is reconnected. If those files are still missing at the time of the show, the broadcast output could be silenced.
|
||||
|
||||
For the same reason, if a removable drive (such as a USB memory stick or MP3 player) is specified as a watched folder, that drive has to be present and powered on until the corresponding show time, so that the Airtime playout engine can download the files needed for the show. If your station staff use removable drives to store media files, it is safer to use the **Add media** page of the Airtime administration interface or the **airtime-import copy** command to copy the files to the main storage server. See the chapters *Add media* and *Using the airtime-import script* for more details.
|
||||
|
||||
The metadata for new media files you add to the *organize* folder or a watched folder will be automatically imported into the Airtime database. The *organize* or watched folders can be exported to computers on the local network. This would enable dragging and dropping of media uploads using the file managers on the desktop computers at your studio.
|
||||
|
||||
|
||||
|
||||
A file dropped into the *organize* folder will appear to vanish as the metadata is read, and the file is moved to the correct location under the *imported* directory, according to its creator and title. This means you can find files for download and editing using a file browser connected to your server, as well as in the **Search** table in the **Library**. This location could be under a filesystem path such as */srv/airtime/stor/imported/Beck/Midnite Vultures/* in the screenshot below.
|
||||
|
||||
|
||||
|
||||
If a media file is corrupted and cannot be played by Liquidsoap, Airtime will move the file to the *problem\_files* folder in the storage archive, and its metadata will not be added to the database. This feature ensures that all files are tested for encoding errors or upload corruption before playout time.
|
||||
|
||||
Files in watched folders are not moved into the main Airtime storage folder. However, just like in the main storage, files deleted from a watched folder will be automatically flagged as missing in any show that they are part of.
|
||||
|
||||
Edits to your stored and watched media files are noticed by Airtime. If you edit any file known to the database and change its duration, Airtime will automatically adjust the duration of playlists, smart blocks and shows that the file is included in. If you edit the metadata tags of a file, Airtime will automatically update the database with the new information. This may invalidate existing playlists or smart blocks that the file is part of. For example, if you use 'genre' as a search criteria to create a playlist or smart block and then edit the 'genre' tag for a file, that file may no longer match the original search criteria. A playlist or static smart block would still have an entry for the original file if either of these items was created before you modified the tag of the file in question.
|
||||
|
||||
Changing the storage folder
|
||||
---------------------------
|
||||
|
||||
To change Airtime's storage folder, click the upper **choose folder** button. In the pop-up window that opens, double-click on the folder names to select the folder that you require. Then click the **Open** button to open that folder.
|
||||
|
||||
|
||||
|
||||
Back on the **Manage Media Folders** page, click the **Set** button to change the storage folder. Airtime will ask if you are sure about this action. Click the **OK** button to confirm your choice.
|
||||
|
||||
|
||||
|
||||
The **Manage Media Folders** page will now display the new storage location.
|
||||
|
||||
|
||||
|
||||
The storage folder cannot be changed while a file import is in progress. If you attempt to do this, an error message will be displayed.
|
||||
|
||||
|
||||
|
||||
Watching a folder
|
||||
-----------------
|
||||
|
||||
Under **Watched Folders**, click the lower **choose folder** button, open the folder you require, and then click the **Add** button. You can add as many watched folders as you require.
|
||||
|
||||
|
||||
|
||||
To remove a watched folder, click the small **x** on the right side of its row in the list. Again, you will be asked to confirm if you are sure about the action.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 47 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 33 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 15 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 18 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 16 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 9.9 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 8 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 21 KiB |
|
|
@ -1,9 +1,6 @@
|
|||
Now playing
|
||||
===========
|
||||
|
||||
The Now Playing page provides a view of the content your station will play out, or has already played out, which defaults to showing the 24 hours ahead. This page also enables you to make last-minute changes to running shows.
|
||||
|
||||
If you've only just logged in to Airtime, there might not be any content shown yet. Click the calendar and clock icons above the table to change the date and time range, then click the **Find Shows** button (with the magnifying glass icon) to the right.
|
||||
If you've only just installed Airtime, there might not be any content shown yet. Click the calendar and clock icons above the table to change the date and time range, then click the **Find Shows** button (with the magnifying glass icon) to the right.
|
||||
|
||||
|
||||
|
||||
|
|
@ -38,7 +35,7 @@ To cancel the current show completely, click the red button to the right again.
|
|||
|
||||
|
||||
|
||||
Items which are no longer available have an exclamation mark icon in the second column. This may happen for media files which were part of previous shows, and were removed from Airtime's library subsequently. Items which are included in forthcoming shows cannot be removed from the Library via the Airtime interface.
|
||||
Items which are no longer available have an exclamation mark icon in the second column. This may happen for media files which were part of previous shows, and were removed from Airtime's library (main storage or watched folders) subsequently. Items which are included in forthcoming shows cannot be removed from the Library via the Airtime interface.
|
||||
|
||||
|
||||
|
||||
|
|
@ -55,15 +52,13 @@ In the library table which opens, the upper section is for the **Advanced Search
|
|||
|
||||
At the bottom of the library table, click the **First**, **Previous**, **Next**, **Last** or individual page number buttons to browse the search results. Right-clicking an item in the search results will display the available metadata for that item in a pop-up window.
|
||||
|
||||
<img src="static/Screenshot575-Right_click_metadata.png" alt="Pop up metadata" width="740" />
|
||||
|
||||
|
||||
The columns displayed in the search results correspond to the fields available for advanced searches (except for **Scheduled** and **Playlist / Block**, which indicate if a particular item is in use). To change the fields which can be searched, click the **Show / hide columns** button on the right side of the table, just above the search results.
|
||||
|
||||
<img src="static/Screenshot499-Library_show_hide_columns_240.png" width="595" height="360" />
|
||||
|
||||
Click the metadata column headings such as **Title**, **Creator**, **Album**, or <span style="font-weight: bold;">Genre</span> to sort the entries in ascending or descending order. In the second column, audio files which can be auditioned in your browser are represented by a loudspeaker icon, while audio file types which cannot be auditioned in your browser have a padlock icon. Playlists are represented by a document and play button icon, smart blocks have a document and think bubble icon, and web streams have a globe and arrow icon.
|
||||
|
||||
<img src="static/Screenshot576-Library_file_type_icons.png" alt="Library file type icons" width="740" />
|
||||
Click the metadata column headings such as **Title**, **Creator**, **Album**, or <span style="font-weight: bold;">Genre</span> to sort the entries in ascending or descending order. In the second column, audio files are represented by a loudspeaker icon, while playlists are represented by a document icon. Smart blocks have a think bubble icon, and web streams have an arrow icon.
|
||||
|
||||
To find all files uploaded by yourself, or another specific member of the station staff, click the **Show / hide columns** checkbox which enables the **Owner** column. After you have made your search, you can click the header of the **Uploaded** column to find the items that person added to the server most recently.
|
||||
|
||||
|
|
@ -79,24 +74,37 @@ Click the Advanced Search Options link to collapse that area. Beneath the collap
|
|||
|
||||
If your jingles are tagged with *Jingle* in the **Genre** or other fields, you can very easily find them by entering *jingle* into the simple search field. The same technique can be used to find advertising and promotional files. (See the chapter *Preparing media for ingest* for tips on batch tagging files with metadata). Unlike advanced searches, simple searches use 'or' logic for multiple search terms, so a simple search for *jingle ident* will return items matching either keyword.
|
||||
|
||||
Clicking on an item in the library table opens a pop-up menu which enables you to audition the item, or remove it from the Airtime library. Audio file types which cannot be auditioned directly in a web browser can be downloaded to your local computer for audition instead. The **Delete** option should be used with caution, because this action cannot be undone. For media files, you can also **Edit Metadata** stored for the file using this menu.
|
||||
Clicking on an item in the library table opens a pop-up menu which enables you to audition the item, or remove it from the Airtime library. Media types which cannot be auditioned directly in a web browser, such as FLAC, have a lock icon instead of a loudspeaker icon, but these files can be downloaded to your local computer for audition instead. The **Delete** option should be used with caution, because this action cannot be undone. For media files, you can also **Edit Metadata** stored for the file using this menu.
|
||||
|
||||
|
||||
|
||||
If the **Enable SoundCloud Upload** box on the Preferences page is checked, there will be an additional option on the pop-up menu, **Upload to SoundCloud**. As mentioned previously, you should only upload audio files to SoundCloud with the permission of the copyright holder.
|
||||
|
||||
|
||||
|
||||
Adding content to a running show
|
||||
--------------------------------
|
||||
|
||||
After you have found the items that you want using the search tools, you can then drag and drop them from the library table on the left side of the page into the shows on the right side, including the current playing show.
|
||||
|
||||
If the current show has nothing playing out at the time, the new item will begin playing immediately. This manual triggering of playout can be used as a live assist technique. For instance, a live show's host may not wish to cut off a studio discussion in order to play music at a fixed time.
|
||||
If the current show has nothing playing out at the time, the new item will begin playing immediately. This manual triggering of playout can be used as a live assist technique, in which the Airtime server's soundcard output is mixed with other sources such as microphones or telephone hybrids on its way to a transmitter, or a separate stream encoder. For instance, a live show's host may not wish to cut off a studio discussion in order to play music at a fixed time.
|
||||
|
||||
<img src="static/Screenshot586-Add_to_current_show.png" alt="Add to current show" width="730" height="560" />
|
||||
|
||||
|
||||
You can also select multiple items using the **Select** menu button, just beneath the simple search field, which has the options to **Select this page** of search results, **Deselect this page** and **Deselect all**. Alternatively, use the checkboxes on the left side of the library table to select specific items. Then drag one of the items into the show to add all of the selected items, or click the **Add to current show** button, which has a plus icon. If you wish, you can also use the **Trashcan** button to permanently remove items from Airtime's library. Only *admin* users have permission to delete items owned by other users.
|
||||
You can also select multiple items using the **Select** menu button, just beneath the simple search field, which has the options to **Select this page** of search results, **Deselect this page** and **Deselect all**. Alternatively, use the checkboxes on the left side of the library table to select specific items. Then drag one of the items into the show to add all of the selected items, or click the **Add to selected show** button, which has a plus icon. If you wish, you can also use the **Trashcan** button to permanently remove items from Airtime's library. Only *admin* users have permission to delete all items.
|
||||
|
||||
To insert checkbox selected items from the library at specific times in the show schedule, click one or more of the checkboxes on the left side of the schedule table to create an insertion point. Then click the **Add before selected items** button in the library table. To add a single item at the insertion point, double-click on it in the library. There is no need to select or drag the item first.
|
||||
To insert checkbox selected items at a specific time in the show schedule, click one of the grey and white triangle icons on the left side of the schedule table, which will change to red and white. A red horizontal line will be shown at the insertion point. Then click the **Add to selected show** button in the library table.
|
||||
|
||||
<img src="static/Screenshot585-Insertion_point.png" alt="Insertion point" width="740" height="237" />
|
||||
To add a single item at the insertion point, double-click on it in the library. There is no need to select or drag the item first.
|
||||
|
||||
Multiple insertion points can be enabled by clicking on more than one of the checkboxes, so that the same item is inserted into the schedule at different times. For example, you may wish to play a news report every hour, or a station ident after every five music files.
|
||||
|
||||
|
||||
Another way to create an insertion point is to click an item in the show table, then click **Select cursor** on the small pop-up menu that will appear. This pop-up menu also enables you to audition the entire show in advance of playout, or remove the item that was clicked on from the show.
|
||||
|
||||
|
||||
|
||||
Multiple insertion points can be enabled, so that the same item is inserted into the schedule at different times. For example, you may wish to play a news report every hour, or a station ident after every five music files.
|
||||
|
||||
A live show set for recording from the Airtime server's sound card is displayed with a red dot icon in the first column. It would not contain any files or playlists, smart blocks or web streams.
|
||||
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 39 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 41 KiB |
BIN
docs/manual/now-playing/static/Screenshot430-Select_cursor.png
Normal file
BIN
docs/manual/now-playing/static/Screenshot430-Select_cursor.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 31 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 26 KiB |
BIN
docs/manual/now-playing/static/Screenshot433-Metadata_pop_up.png
Normal file
BIN
docs/manual/now-playing/static/Screenshot433-Metadata_pop_up.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
|
|
@ -1,7 +1,4 @@
|
|||
On air in 60 seconds!
|
||||
=====================
|
||||
|
||||
Here's how you can use Airtime Pro to manage your broadcasts. Chapter names in this book are shown in *italics*, to help you find the details of each step (if you need to read more).
|
||||
Here's how you can use Airtime to manage your broadcasts. Chapter names in this book are shown in *italics*, to help you find the details of each step (if you need to read more).
|
||||
|
||||
1. Log in to your Airtime server with your **Username** and **Password** (*Getting started*).
|
||||
|
||||
|
|
|
|||
|
|
@ -1,48 +1,34 @@
|
|||
General
|
||||
=======
|
||||
|
||||
Only users with the **User Type** of *Admin* can see the **Settings** menu when they log in.
|
||||
|
||||
On the <span style="font-weight: bold;">Settings</span> menu, click **General** to set your **Station Name**. This text is shown in your web browser's title bar when your station staff are logged into Airtime, and optionally in stream metadata. You can also set a **Station Description** and **Station Logo** here.
|
||||
You can enable live, read-only access to the Airtime schedule calendar for your station's public website with the **Allow Remote Websites to Access "Schedule" Info?** option, if you wish. (There is more about this feature in the *Exporting the schedule* chapter, in the *Advanced Configuration* section of this book).
|
||||
|
||||
<img src="static/Screenshot553-Station_preferences.png" alt="Station preferences" width="565" height="550" />
|
||||
Initially, the **Default Fade In** and **Default Fade Out** times for automated fades are set to half a second, and the **Default Crossfade Duration** is set to zero seconds. Custom fade and crossfade times can be set for adjacent items in a playlist or static smart block. See the chapter *Library* for details.
|
||||
|
||||
The **Default Language** drop-down menu sets the default localization for your Airtime instance, and the **Station Timezone** drop-down menu can be used to display local time at your station. Airtime stores show times internally in UTC format (similar to *Greenwich Mean Time*), but displays local time for the convenience of your station staff. You can also set the day of the week that your station's **Week starts on**, which defaults to Sunday.
|
||||
The **Default Interface Language** drop-down menu sets the default localization for your Airtime instance, and the **Station Timezone** drop-down menu can be used to display local time at your station. Airtime stores show times internally in UTC format (similar to *Greenwich Mean Time*), but displays local time for the convenience of your station staff. You can also set the day of the week that you wish to start your station's weekly schedule on, which defaults to Sunday. Then click the **Save** button.
|
||||
|
||||
<img src="static/Screenshot554-Default_language.png" alt="Default language" width="540" height="375" />
|
||||
|
||||
|
||||
Individual Airtime users can choose another interface localization when they log in, or set personal preferences for localization and time zone by clicking their username on the right side of the menu bar.
|
||||
|
||||
<img src="static/Screenshot556-Username_link.png" alt="User name link" width="200" height="150" />
|
||||
|
||||
|
||||
Initially, the **Default Fade In** and **Default Fade Out** times for automated fades are set to half a second, and the **Default Crossfade Duration** is set to zero seconds. Custom fade and crossfade times can be set for adjacent items in a playlist or static smart block. See the chapter *Library* for details.
|
||||
Email / Mail Server Settings
|
||||
----------------------------
|
||||
|
||||
You can enable live, read-only access to the Airtime schedule calendar for your station's public website by enabling the **Public Airtime API** option, if you wish. You can choose to reveal or hide the **login button** on your Radio Page by ticking on the **Display login button** option.
|
||||
The **Enable System Emails (Password Reset)** box is not checked by default, because although enabling staff users to retrieve their lost password for themselves may be convenient, this option does have security implications. If the email account of the staff user is compromised, an attacker could very easily gain access to your Airtime server by clicking the **Reset Password** link on the login page.
|
||||
|
||||
<img src="static/Login_Button_02.PNG" width="543" height="146" />
|
||||
If you wish to enable the password reset option, your Airtime server can have an SMTP mail program installed. (See the chapter *Preparing the server* for details). Alternatively, you can check the box **Configure Mail Server** and specify the details of an external SMTP server, which would usually require authentication if it is outside of your local network.
|
||||
|
||||
The **TuneIn Settings** enable the use of the [TuneIn broadcaster API](http://tunein.com/broadcasters/api/ "TuneIn broadcaster API"). <span>This feature is intended to push your Airtime station's stream metadata to your station's page on TuneIn. </span>
|
||||
Whether SMTP runs on the same server as Airtime or on another server, you should enter a valid email address into the **Reset Password 'From' Email** field to help ensure emails are delivered correctly. Then click the **Save** button.
|
||||
|
||||
<span><img src="static/TuneIn%20Settings.PNG" width="543" height="245" />
|
||||
</span>
|
||||
|
||||
|
||||
You will need to add the **Station ID **which you can find in your TuneIn station URL and is the letter '*s*' and the six digits that follow.
|
||||
SoundCloud Settings
|
||||
-------------------
|
||||
|
||||
The next fields to fill in are the **Partner Id **and **Partner Key**. You will have to contact <span class="il">TuneIn to request both the Id and Key. Send a email including your Station ID to</span><span> </span>[broadcaster-support@<span class="il">tunein</span>.com](mailto:broadcaster-support@tunein.com "TuneIn broadcaster API")<span> and let them know you are using Airtime Pro as your broadcasting software.</span>
|
||||
If your station has a SoundCloud account (on [http://soundcloud.com](http://soundcloud.com/ "SoundCloud")), you may wish to upload files and show recordings to this service, in order to broaden distribution and balance the bandwidth load with your own servers. Click the small black triangle next to **SoundCloud Settings** to show the options available. Check the **Enable Soundcloud Upload** box, then optionally check the **Automatically Upload Recorded Shows** box. You will also need to enter your SoundCloud login email address and password, and the tag metadata that SoundCloud will use to categorize your show recordings.
|
||||
|
||||
<span><img src="static/2015-06-29%2018_14_50-staging4%20-%20Airtime.png" alt="SoundCloud Settings" width="512" height="208" /></span>
|
||||
Check the box **Automatically Mark Files "Downloadable" on SoundCloud** if you wish to enable this option. **** You can also set a default genre, track type and copyright license here, including public domain, all rights reserved, or one of the *Creative Commons* licenses (see [http://creativecommons.org](http://creativecommons.org/ "Creative Commons")). Then click the **Save** button again.
|
||||
|
||||
<span>**SoundCloud Settings **enable you to upload tracks from your Airtime Pro instance to your SoundCloud account. <span>If you frequently broadcast full, pre-produced radio shows, this new feature can help you streamline your audio publishing workflow. Title, genre, and year metadata are passed along to SoundCloud to save you time, and you can set a default visibility for new uploads in the preferences.</span></span>
|
||||
|
||||
<span><img src="static/2015-06-29%2018_17_25-staging4%20-%20Airtime.png" alt="SoundCloud upload" width="494" height="261" /></span>
|
||||
|
||||
<span>Once you've connected your Airtime Pro account to your SoundCloud account you'll be able to upload your tracks. To do so you only need to <span>Left-click on a track in your library and select SoundCloud -> Upload track.</span></span>
|
||||
|
||||
<img src="static/Delete%20All%20Tracks.PNG" width="541" height="172" />
|
||||
|
||||
Under **Dangerous Options **there is the possibility to clear your entire library *permanently. *By clicking on this option you will clear all uploaded files from your library. This does not include playlists, smart blocks or webstreams, however all their contents will be deleted.
|
||||
|
||||
<img src="static/Save%20Preferences.PNG" width="540" height="136" />
|
||||
|
||||
Once you have updated the preferences, click the **Save** button.
|
||||
|
||||
|
||||
Please note that like most online distribution services, SoundCloud terms of service require you to have copyright in, or permission for Internet distribution from the copyright holder of, any media that you upload. Commercially released music files uploaded to SoundCloud are likely to be automatically removed from your station's SoundCloud page.
|
||||
|
|
|
|||
Binary file not shown.
|
After Width: | Height: | Size: 37 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 30 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.2 KiB |
BIN
docs/manual/preferences/static/Screenshot544-Preferences_250.png
Normal file
BIN
docs/manual/preferences/static/Screenshot544-Preferences_250.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 35 KiB |
|
|
@ -1,6 +1,3 @@
|
|||
Preparing media for ingest
|
||||
==========================
|
||||
|
||||
Before uploading media to an Airtime server, there are a number of factors which should be considered. Getting your ingest workflow right will save you a lot of time later.
|
||||
|
||||
Metadata quality
|
||||
|
|
@ -96,4 +93,3 @@ Before importing media, it is good practice to check for any silent sections in
|
|||
Very quiet introductions or over-long fades can also lead to apparent gaps in your broadcast playout. Some audio CDs feature a 'hidden track' at the end, which in fact uses a long period of silence within the final track, rather than an actual separate track on the disc. This means that CD encoding programs will often encode both the hidden material and the silence in the media file. For example, the track *Debra* from the CD *Midnite Vultures* by *Beck* includes hidden material preceded by seven minutes of silence, as shown in the screen shot from Audacity below.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
179
docs/manual/preparing-the-server/index.md
Normal file
179
docs/manual/preparing-the-server/index.md
Normal file
|
|
@ -0,0 +1,179 @@
|
|||
The following instructions assume that you have root access (**sudo** on Ubuntu) to a GNU/Linux server, and are familiar with basic command line tasks. Experienced system administrators may prefer to skip to the *Expert install* chapter in the appendix of this book after preparing the server as shown in the steps below.
|
||||
|
||||
The recommended Airtime server platform is Debian 7.2 'wheezy'. Ubuntu 12.04 LTS 'Precise Pangolin' is also supported. Users of other GNU/Linux distributions may be able to adapt these instructions to suit their needs.
|
||||
|
||||
The server should have at least a 1GHz processor and 512MB of RAM, preferably 1GB RAM or more. If you are using a desktop environment and web browser directly on the server you should install at least 2GB RAM, to avoid swapping to disk.
|
||||
|
||||
The Airtime installation does not use much disk space, but you should allow plenty of storage capacity for the Airtime library. A hot-swap RAID array is recommended for media storage, in case of disk failure. You should also consider a UPS or other battery-powered system to offer some protection against short-term power failures.
|
||||
|
||||
Sound cards
|
||||
-----------
|
||||
|
||||
If your Airtime machine will only be used to stream directly to an **Icecast** or **SHOUTcast** streaming media server, you do not require a sound card to be installed on the Airtime server side. This option is suitable for Airtime installations at your ISP's data centre, remote from any transmitter. However, you will not be able to take advantage of Airtime's live show recording feature (yet).
|
||||
|
||||
If you intend that your Airtime server will have a direct audio output to a broadcast transmitter or a separate stream encoder, your server machine must have a sound card supported by an **ALSA** driver. Almost all standard sound cards have ALSA drivers built into the Linux kernel, which do not need to be installed separately. If in doubt about driver support for your sound card, check the ALSA support matrix at: <http://www.alsa-project.org/main/index.php/Matrix:Main>
|
||||
|
||||
USB audio device index
|
||||
----------------------
|
||||
|
||||
Some server motherboards do not have a default ALSA device (index number zero, shown as hw:0,0 in ALSA notation), and a USB sound card is often prevented from getting index zero by the GNU/Linux distribution's configuration. This setting may be in a file such as */etc/modprobe.d/alsa-base.conf* in Ubuntu, which can be edited with **nano**:
|
||||
|
||||
sudo nano /etc/modprobe.d/alsa-base.conf
|
||||
|
||||
Comment out the lines beginning *options snd-usb-* to fix the problem:
|
||||
|
||||
# Prevent abnormal drivers from grabbing index 0
|
||||
|
||||
# options snd-usb-audio index=-2
|
||||
# options snd-usb-us122l index=-2
|
||||
# options snd-usb-usx2y index=-2
|
||||
# options snd-usb-caiaq index=-2
|
||||
|
||||
Save the file with **Ctrl+O** and close **nano** with **Ctrl+X**. Then remove and re-insert the cable connecting the USB sound card to the server (making sure any mixer or amplifier connected is faded down, to avoid a 'thump' on the output). The command **aplay -l** should now confirm that the *USB Audio* device has index 0 (shown as card 0, device 0):
|
||||
|
||||
aplay -l
|
||||
**** List of PLAYBACK Hardware Devices ****
|
||||
card 0: MobilePre [MobilePre], device 0: USB Audio [USB Audio]
|
||||
Subdevices: 1/1
|
||||
Subdevice #0: subdevice #0
|
||||
|
||||
When using a USB sound card with ALSA, some how-to documents advocate setting the *nrpacks=1* option, but this is not recommended for Airtime because it can increase CPU load significantly.
|
||||
|
||||
Intel HDA mixer labels
|
||||
----------------------
|
||||
|
||||
If you have an **Intel HDA** sound card, as built in to many contemporary motherboards, you may discover that the recording controls in **alsamixer** have incorrect labels. This problem can make it difficult to adjust mixer levels except by trial and error. To fix these labels, you can pass a specific *model=* parameter to the *snd-hda-intel* module of the Linux kernel. On Debian or Ubuntu GNU/Linux, you can do this by first identifying the model you have, with the command:
|
||||
|
||||
cat /proc/asound/card0/codec* | grep Codec
|
||||
|
||||
The server should respond with a line such as:
|
||||
|
||||
Codec: Realtek ALC882
|
||||
|
||||
Referring to the appendix *HD Audio Models* in this book, find the matching codec and model. In this example, the codec is *ALC882* and the motherboard has six analogue jacks and two S/PDIF sockets, so the model is *6stack-dig*.
|
||||
|
||||
ALC882/883/885/888/889
|
||||
======================
|
||||
3stack-dig 3-jack with SPDIF I/O
|
||||
6stack-dig 6-jack digital with SPDIF I/O
|
||||
|
||||
Edit the file */etc/modprobe.d/alsa-base.conf* with **nano** as follows:
|
||||
|
||||
sudo nano /etc/modprobe.d/alsa-base.conf
|
||||
|
||||
Add an appropriate line for your soundcard model to the end of the file, such as:
|
||||
|
||||
# Realtek ALC882
|
||||
options snd-hda-intel model=6stack-dig
|
||||
|
||||
Save the file with **Ctrl+O** and close **nano** with **Ctrl+X**. Then reboot the server. After the reboot, you should now see that the mixer controls are correctly labelled.
|
||||
|
||||
Disable desktop and other sounds
|
||||
--------------------------------
|
||||
|
||||
If you are installing Airtime on a desktop computer, make sure you disable or remove any programs that could send unintended audio to a sound card you are using for broadcast output. This includes alert sounds which play when the computer is ready for use, or when a user logs in. On Ubuntu, these sounds are configured using *System -> Preferences -> Sound* on the main desktop menu. (This configuration tool only works when the PulseAudio sound server is installed).
|
||||
|
||||
You may prefer to remove all system sound files from the computer, in case they could be played unintentionally via the sound card. For example, on Ubuntu you may wish to remove the **ubuntu-sounds** package, with the following command:
|
||||
|
||||
sudo apt-get purge ubuntu-sounds
|
||||
|
||||
PulseAudio
|
||||
----------
|
||||
|
||||
The PulseAudio sound server is not recommended for Airtime sound card output, but is installed by default on Ubuntu. To remove PulseAudio from an Ubuntu machine, type the following command:
|
||||
|
||||
sudo apt-get purge pulseaudio
|
||||
|
||||
Removing the **pulseaudio** package on a desktop Ubuntu machine may force the removal of the **ubuntu-desktop** metapackage. However, this metapackage is only installed on the system for managing upgrades; removing it does not remove the entire desktop.
|
||||
|
||||
After removing PulseAudio, if your Airtime machine has a desktop, you can install a mixer applet which can control the ALSA soundcard driver directly, such as **gnome-alsamixer**:
|
||||
|
||||
sudo apt-get install gnome-alsamixer
|
||||
|
||||
On a server with a sound card but without a desktop, you can control sound input and output levels using the command line program **alsamixer**:
|
||||
|
||||
|
||||
|
||||
This program should already be installed on an Ubuntu or Debian machine with a sound card. If not, you can install it with the command:
|
||||
|
||||
sudo apt-get install alsa-utils
|
||||
|
||||
The PHP cache
|
||||
-------------
|
||||
|
||||
This dependency, introduced in Airtime 2.5.0, can improve the responsiveness of the Airtime administration interface and reduce server load. Various PHP cache software is available, but the current cache software required by Airtime is **APC** (<http://pecl.php.net/package/APC>). You should uninstall or disable any other PHP cache that may be present on the server, such as **XCache**, before installing Airtime and APC. This is because having multiple caches enabled can cause problems for PHP.
|
||||
|
||||
You can remove the XCache package **php5-xcache** from a Debian or Ubuntu server with the command:
|
||||
|
||||
sudo apt-get remove php5-xcache
|
||||
|
||||
APC is available in Debian or Ubuntu as the **php-apc** package. If you already have Apache installed on the server you are going to use for Airtime, you can install APC and get it working with the following commands:
|
||||
|
||||
sudo apt-get install php-apc
|
||||
sudo invoke-rc.d apache2 restart
|
||||
|
||||
APC has an administration page, which is not installed by default. If you wish, you can install and configure it with the following commands:
|
||||
|
||||
sudo cp /usr/share/doc/php-apc/apc.php /usr/share/airtime/public/
|
||||
sudo nano /usr/share/airtime/public/apc.php
|
||||
|
||||
You should set an admin password for the *apc* user on line 42 of the file, such as *mynewpassword* in this example:
|
||||
|
||||
defaults('ADMIN_PASSWORD','mynewpassword');
|
||||
|
||||
Save the *apc.php* file with **Ctrl+O** and close it with **Ctrl+X**. Then open a web browser at the *apc.php* page of your Airtime server, such as:
|
||||
|
||||
http://airtime.example.com/apc.php
|
||||
|
||||
You will then be able to confirm that APC is working, and view some statistics for the cache.
|
||||
|
||||
|
||||
|
||||
Remove webmin, if installed
|
||||
---------------------------
|
||||
|
||||
The **webmin** control panel (<http://www.webmin.com>) has been known to remove Apache and PHP packages on Debian and Ubuntu systems, which can cause the Airtime package to be removed in turn. This problem is easily reversed by re-installation of the affected packages, but it has the potential to disrupt your broadcast playout from Airtime. Webmin is not likely to be installed on your server unless your system administrator has installed it manually. This is because webmin was removed from official Debian and Ubuntu package repositories some years ago.
|
||||
|
||||
RabbitMQ hostname
|
||||
-----------------
|
||||
|
||||
**RabbitMQ** requires a fixed and resolvable hostname (see<http://www.rabbitmq.com/ec2.html#issues-hostname>), which is normal for a server. For a desktop or laptop machine where the hostname changes frequently or is not resolvable, this issue may prevent RabbitMQ from starting. When using a desktop or laptop computer with a dynamic IP address, such as an address obtained from a wireless network, the **rabbitmq-server** daemon must not start up before the **NetworkManager** service.
|
||||
|
||||
RabbitMQ on Debian squeeze
|
||||
--------------------------
|
||||
|
||||
In Debian 6.0 'squeeze' the **rabbitmq-server** daemon does not start automatically after a reboot. This should be fixed before installing Airtime, to prevent problems at playout time. If the rabbitmq-server package was installed before the last reboot, you will need to run:
|
||||
|
||||
invoke-rc.d rabbitmq-server start
|
||||
|
||||
as the root user before the installation of Airtime. If it is not already installed, run the following command as root:
|
||||
|
||||
apt-get install rabbitmq-server
|
||||
|
||||
After a fresh installation, rabbitmq-server will start automatically, so there is no need to run the **invoke-rc.d** command mentioned above.
|
||||
|
||||
In either case, you should then edit lines 13 and 14 of the file */etc/init.d/rabbitmq-server* (as root) to show:
|
||||
|
||||
# Default-Start: 2 3 4 5
|
||||
# Default-Stop: 0 1 6
|
||||
|
||||
and then run the command (as root):
|
||||
|
||||
update-rc.d rabbitmq-server defaults
|
||||
|
||||
This should make sure that **rabbitmq-server** starts after the next reboot.
|
||||
|
||||
libav on Debian squeeze and .m4a files
|
||||
--------------------------------------
|
||||
|
||||
The version of libav shipped with Debian 6.0 'squeeze' is known to cause problems when Airtime analyses .m4a files containing the AAC codec for silence, using Silan (see <https://github.com/x42/silan/issues/2>). It is recommended that Debian servers are upgraded to the current stable 'wheezy' 7.2 release. As a short-term measure, updated libav packages from the squeeze-backports repository can be used to work around this problem. This work-around is only required if you do not wish to upgrade to 'wheezy' yet, but have AAC codec .m4a files in your Airtime library.
|
||||
|
||||
Mail server
|
||||
-----------
|
||||
|
||||
If you wish Airtime to be able to send password reminder emails to your staff users, the server can have an SMTP program installed, such as the **postfix** package in Debian or Ubuntu. For configuration options, refer to the documentation for your mail server of choice. Alternatively, you can specify an external SMTP server in the **Preferences** page on Airtime's **System** menu.
|
||||
|
||||
Proceed to installation
|
||||
-----------------------
|
||||
|
||||
Now your server should be ready for Airtime to be installed. Depending on your requirements, you should now proceed to either the chapter *Easy setup*, the chapter *Automated installation,* the chapter *Manual installation* or the *Expert install* appendix.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 57 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 6.4 KiB |
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue