Merge pull request #36 from radiorabe/feature/merge-manual
Merge Airtime manuals from Booktime.pro
7
docs/README.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
# LibreTime Documentation
|
||||
|
||||
The LibreTime documentation is created from this directory using `mkdocs`. You may read
|
||||
it at [libretime.org](http://libretime.org).
|
||||
|
||||
The canonical source of this documentation is in the [LibreTime repo](https://github.com/LibreTime/libretime)
|
||||
in the [`docs/` subdir](https://github.com/LibreTime/libretime/tree/master/docs).
|
|
@ -1,30 +0,0 @@
|
|||
README
|
||||
======
|
||||
|
||||
This directory should be used to place project specfic documentation including
|
||||
but not limited to project notes, generated API/phpdoc documentation, or
|
||||
manual files generated or hand written. Ideally, this directory would remain
|
||||
in your development environment only and should not be deployed with your
|
||||
application to it's final production location.
|
||||
|
||||
|
||||
Setting Up Your VHOST
|
||||
=====================
|
||||
|
||||
The following is a sample VHOST you might want to consider for your project.
|
||||
|
||||
<VirtualHost *:80>
|
||||
DocumentRoot "/home/naomiaro/airtime/public"
|
||||
ServerName airtime.local
|
||||
|
||||
# This should be omitted in the production environment
|
||||
SetEnv APPLICATION_ENV development
|
||||
|
||||
<Directory "/home/naomiaro/airtime/public">
|
||||
Options Indexes MultiViews FollowSymLinks
|
||||
AllowOverride All
|
||||
Order allow,deny
|
||||
Allow from all
|
||||
</Directory>
|
||||
|
||||
</VirtualHost>
|
|
@ -1,7 +1,7 @@
|
|||
Welcome to LibreTime
|
||||
====================
|
||||
|
||||
LibreTime makes it easy to run your own online radio station. Check out some [features](features.md) and [screenshots](features.md#screenshots), then [install it](install.md) and start broadcasting!
|
||||
LibreTime makes it easy to run your own online or terrestrial radio station. Check out some [features](features.md) and [screenshots](features.md#screenshots), then [install it](install.md) and start broadcasting!
|
||||
|
||||
LibreTime is Free/Libre and Open Source Software (FLOSS). Among other things, this means that you have the freedom to:
|
||||
|
||||
|
|
233
docs/manual/about-this-manual/index.md
Normal file
|
@ -0,0 +1,233 @@
|
|||
About this manual
|
||||
=================
|
||||
|
||||
**Copyright © 2011-2015 Sourcefabric z.ú.
|
||||
**
|
||||
|
||||
This manual was written for Sourcefabric by Daniel James, using Booktype Pro. Please add your comments and contributions at: [http://sourcefabric.booktype.pro/airtime-pro-for-broadcasters/](../index.html "Airtime Pro for Broadcasters")
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
All chapters in this manual are licensed with the **GNU General Public License version 3**.
|
||||
|
||||
This documentation is free documentation; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3.
|
||||
|
||||
This documentation is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along with this documentation; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### GNU GENERAL PUBLIC LICENSE
|
||||
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright © 2007 Free Software Foundation, Inc. <<http://fsf.org/>>
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
|
||||
|
||||
### <span id="preamble"></span>Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains that there is no warranty for this free software. For both users' and authors' sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users' freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and modification follow.
|
||||
|
||||
### <span id="terms"></span>TERMS AND CONDITIONS
|
||||
|
||||
#### <span id="section0"></span>0. Definitions.
|
||||
|
||||
“This License” refers to version 3 of the GNU General Public License.
|
||||
|
||||
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
|
||||
|
||||
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
|
||||
|
||||
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
|
||||
|
||||
A “covered work” means either the unmodified Program or a work based on the Program.
|
||||
|
||||
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
|
||||
|
||||
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
|
||||
|
||||
#### <span id="section1"></span>1. Source Code.
|
||||
|
||||
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
|
||||
|
||||
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
|
||||
|
||||
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same work.
|
||||
|
||||
#### <span id="section2"></span>2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
|
||||
|
||||
#### <span id="section3"></span>3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures.
|
||||
|
||||
#### <span id="section4"></span>4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
|
||||
|
||||
#### <span id="section5"></span>5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
- a) The work must carry prominent notices stating that you modified it, and giving a relevant date.
|
||||
- b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to “keep intact all notices”.
|
||||
- c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it.
|
||||
- d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
|
||||
|
||||
#### <span id="section6"></span>6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
|
||||
|
||||
- a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange.
|
||||
- b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge.
|
||||
- c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b.
|
||||
- d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements.
|
||||
- e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
|
||||
|
||||
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
|
||||
|
||||
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
|
||||
|
||||
#### <span id="section7"></span>7. Additional Terms.
|
||||
|
||||
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
|
||||
|
||||
- a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or
|
||||
- b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or
|
||||
- c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or
|
||||
- d) Limiting the use for publicity purposes of names of licensors or authors of the material; or
|
||||
- e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or
|
||||
- f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
|
||||
|
||||
#### <span id="section8"></span>8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
|
||||
|
||||
#### <span id="section9"></span>9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
#### <span id="section10"></span>10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
|
||||
|
||||
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
|
||||
|
||||
#### <span id="section11"></span>11. Patents.
|
||||
|
||||
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's “contributor version”.
|
||||
|
||||
A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
|
||||
|
||||
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
|
||||
|
||||
#### <span id="section12"></span>12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
|
||||
|
||||
#### <span id="section13"></span>13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
|
||||
|
||||
#### <span id="section14"></span>14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
|
||||
|
||||
#### <span id="section15"></span>15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
#### <span id="section16"></span>16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
#### <span id="section17"></span>17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
23
docs/manual/add-media/index.md
Normal file
|
@ -0,0 +1,23 @@
|
|||
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.
|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
The row of the file currently being uploaded is highlighted in pale green. At the bottom of the upload queue, a progress bar and percentage indicates how much of the upload has taken place so far. The upload speed will depend on the network connection between your computer and the Airtime server.
|
||||
|
||||

|
||||
|
||||
Once it has been uploaded successfully, each file row displays a white check mark in a green circle icon.
|
||||
|
||||

|
||||
|
||||
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/Screenshot143-File_upload.png
Normal file
After Width: | Height: | Size: 85 KiB |
BIN
docs/manual/add-media/static/Screenshot144-Start_upload_1.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
docs/manual/add-media/static/Screenshot145-Upload_status_1.png
Normal file
After Width: | Height: | Size: 17 KiB |
BIN
docs/manual/add-media/static/Screenshot146-Upload_done_1.png
Normal file
After Width: | Height: | Size: 6.8 KiB |
BIN
docs/manual/add-media/static/Screenshot383-Add_media.png
Normal file
After Width: | Height: | Size: 49 KiB |
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
|
@ -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.
|
After Width: | Height: | Size: 26 KiB |
224
docs/manual/automated-installation/index.md
Normal file
|
@ -0,0 +1,224 @@
|
|||
***Beware, here be dragons!***
|
||||
|
||||
These Airtime instructions are outdated, see [install.md](../../install.md) for LibreTime instructions.
|
||||
|
||||
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.
|
||||
|
After Width: | Height: | Size: 24 KiB |
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 13 KiB |
After Width: | Height: | Size: 19 KiB |
After Width: | Height: | Size: 18 KiB |
After Width: | Height: | Size: 33 KiB |
After Width: | Height: | Size: 19 KiB |
After Width: | Height: | Size: 37 KiB |
After Width: | Height: | Size: 23 KiB |
After Width: | Height: | Size: 19 KiB |
After Width: | Height: | Size: 9.5 KiB |
After Width: | Height: | Size: 17 KiB |
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 34 KiB |
After Width: | Height: | Size: 32 KiB |
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.
|
140
docs/manual/calendar/index.md
Normal file
|
@ -0,0 +1,140 @@
|
|||
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.
|
||||
|
||||

|
||||
|
||||
In the top left corner of the page, you can go back or forward through the **Calendar** by clicking on the buttons which have a small grey triangle in a white circle. Click the **today** button to jump to today's date in the current view. (The **today** button will be greyed out if you are already viewing that date). In the **day** or **week** views, there is also a drop-down menu which allows you to set the resolution displayed for the calendar, ranging from one minute per row to sixty minutes per row.
|
||||
|
||||

|
||||
|
||||
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 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
|
||||
----
|
||||
|
||||
In the **What** box, enter the **Name**, public website **URL**, **Genre** and **Description** for the show that you are creating.
|
||||
|
||||

|
||||
|
||||
When
|
||||
----
|
||||
|
||||
Next, in the **When** section, if you clicked on a date in the **Calendar** this should already be entered in the **Date/Time Start** field. To set another date for the show, click on the date in the **Date/Time Start** field and select the date that you require from the small pop-up calendar which will appear. Click on the adjacent time field to set the start time for the show, with the pop-up **Hour** and **Minute** box. The Minute values in the pop-up time boxes are rounded to the nearest five minutes. You can also adjust the times manually by clicking into the fields and typing. Repeat the process to set the **Date/Time End** fields. The **Duration** of the show will be displayed automatically, based on the start and end times you have set.
|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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).
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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 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.
|
||||
|
||||

|
||||
|
||||
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
|
||||
---
|
||||
|
||||
In the **Who** section, type the first few letters of the name of the show's DJ (presenter) in the **Search Users** field to select a name from the Airtime database, or check one of the **DJs** boxes in the vertical list below. This association of a DJ name with a particular show enables that presenter to add playout media to the show, and also to connect a live Show Source input stream (if that has been enabled), so it is important to get the DJ's name right.
|
||||
|
||||

|
||||
|
||||
Style
|
||||
-----
|
||||
|
||||
Show colours in the Calendar are set automatically, based on the **Name** of the show, so that individual shows can be easily identified in the **Calendar**. If you wish, you can select a **Background Colour** and **Text Colour** manually by clicking the boxes in the **Style** section. Click the coloured circle icon in the lower right corner to close this pop-up window.
|
||||
|
||||

|
||||
|
||||
Optionally, you can upload a Show Logo by clicking the **Browse** button.
|
||||
|
||||

|
||||
|
||||
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, 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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||
Adding content to a show
|
||||
------------------------
|
||||
|
||||
To add content to a show, click the show in any view on the Calendar, and select **Add/Remove Content** from the pop-up menu. Shows that do not yet contain any scheduled content are marked with a red exclamation mark icon, to the right of the show start and end times in the top bar. Shows partially filled with content have a yellow exclamation mark icon. During playout of the show, a green play icon will also be shown in the top bar.
|
||||
|
||||

|
||||
|
||||
The **Add/Remove Content** action opens a window with the name of the show. Like when using the **Now Playing** page, you can search for content items and add them to the show schedule on the right side of the page. Refer to the *Now Playing* chapter for details.
|
||||
|
||||
When your show has all the required content, click the **OK** button in the bottom right corner to close the window. Back in the **Calendar**, click the show and select **Show content** from the pop-up menu to view a list of content now included in the show.
|
||||
|
||||

|
||||
|
||||
The **Contents of Show** window is a read-only interface featuring an orange bar which indicates how much media has been added to the show. Click the **OK** button in the bottom right corner, or the white **x** icon in the top right corner, to close the window.
|
||||
|
||||

|
||||
|
||||
Removing content from a show
|
||||
----------------------------
|
||||
|
||||
To remove an individual item from a show, click on the show in the **Calendar**, and select **Add/Remove Content** from the pop-up menu. In the window which opens, click any item you wish to remove from the show, then click **Delete** on the pop-up menu, or check the box in the item's row then click the **Trashcan** icon at the top of the table. To remove all files and playlists from a show, click on the show in the **Calendar**, and select **Remove All Content** from the pop-up menu.
|
||||
|
||||
Deleting a forthcoming show
|
||||
---------------------------
|
||||
|
||||
To delete one forthcoming instance of a repeating show, click on the show in the **Calendar**, and select **Delete**, then **Delete This Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete This Instance and All Following** from the pop-up menu.
|
||||
|
||||

|
||||
|
||||
You cannot delete or remove content from shows that have already played out. These shows have only one option on the pop-up menu, which is **Show Content**.
|
||||
|
||||
Cancelling playout
|
||||
------------------
|
||||
|
||||
If you wish to cancel playout of a show while it is running, click on the show in the **Calendar** and select **Cancel Current Show** from the pop-up menu. Airtime will ask you if you are sure about this action, as it cannot be undone.
|
||||
|
||||

|
||||
|
BIN
docs/manual/calendar/static/Screenshot161-Show_users.png
Normal file
After Width: | Height: | Size: 8.4 KiB |
BIN
docs/manual/calendar/static/Screenshot162-Show_colours.png
Normal file
After Width: | Height: | Size: 24 KiB |
BIN
docs/manual/calendar/static/Screenshot353-Contents_of_show.png
Normal file
After Width: | Height: | Size: 23 KiB |
After Width: | Height: | Size: 7.9 KiB |
BIN
docs/manual/calendar/static/Screenshot451-Calendar.png
Normal file
After Width: | Height: | Size: 20 KiB |
After Width: | Height: | Size: 29 KiB |
BIN
docs/manual/calendar/static/Screenshot453-Show_what.png
Normal file
After Width: | Height: | Size: 27 KiB |
BIN
docs/manual/calendar/static/Screenshot457-Live_stream_input.png
Normal file
After Width: | Height: | Size: 16 KiB |
After Width: | Height: | Size: 19 KiB |
BIN
docs/manual/calendar/static/Screenshot459-Update_show.png
Normal file
After Width: | Height: | Size: 16 KiB |
BIN
docs/manual/calendar/static/Screenshot488-Add_remove_content.png
Normal file
After Width: | Height: | Size: 20 KiB |
BIN
docs/manual/calendar/static/Screenshot489-Show_Content.png
Normal file
After Width: | Height: | Size: 9.8 KiB |
After Width: | Height: | Size: 16 KiB |
BIN
docs/manual/calendar/static/Screenshot526-Add_show_when_250.png
Normal file
After Width: | Height: | Size: 37 KiB |
BIN
docs/manual/calendar/static/Screenshot527-negative_time250.png
Normal file
After Width: | Height: | Size: 15 KiB |
BIN
docs/manual/calendar/static/Screenshot528-Link_shows_250.png
Normal file
After Width: | Height: | Size: 26 KiB |
After Width: | Height: | Size: 25 KiB |
BIN
docs/manual/calendar/static/Screenshot530-show_end_date_250.png
Normal file
After Width: | Height: | Size: 44 KiB |
After Width: | Height: | Size: 18 KiB |
BIN
docs/manual/calendar/static/Screenshot584-Show_logo.png
Normal file
After Width: | Height: | Size: 109 KiB |
BIN
docs/manual/calendar/static/Screenshot587-Live_stream_input.png
Normal file
After Width: | Height: | Size: 27 KiB |
After Width: | Height: | Size: 15 KiB |
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
|
54
docs/manual/easy-setup/index.md
Normal file
|
@ -0,0 +1,54 @@
|
|||
***Beware, here be dragons!***
|
||||
|
||||
These Airtime instructions are outdated, see [install.md](../../install.md) for LibreTime instructions.
|
||||
|
||||
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.
|
After Width: | Height: | Size: 33 KiB |
After Width: | Height: | Size: 54 KiB |
After Width: | Height: | Size: 49 KiB |
After Width: | Height: | Size: 29 KiB |
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
|
@ -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.
|
After Width: | Height: | Size: 6.2 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 38 KiB |
After Width: | Height: | Size: 42 KiB |
78
docs/manual/getting-started/index.md
Normal file
|
@ -0,0 +1,78 @@
|
|||
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:
|
||||
|
||||
http://localhost/
|
||||
|
||||
If you have set up Airtime so that it can be accessed from other computers, you would use a domain name instead. For example:
|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
If you enter the password incorrectly three times, you will be presented with a reCAPTCHA challenge to prove that you are a human, and not a password-guessing robot. This feature helps protect your Airtime installation against brute force attacks.
|
||||
|
||||

|
||||
|
||||
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
|
||||
----------------
|
||||
|
||||
After you have logged in as *admin* for the first time, a pop-up window will ask if you wish to send technical support data about your server to Sourcefabric.
|
||||
|
||||

|
||||
|
||||
These details can be viewed by clicking on the **Show me what I am sending** link, which expands a scrolling window. The data helps Sourcefabric engineers resolve any problems with your Airtime installation, as well as count the number of installations worldwide.
|
||||
|
||||
<img src="static/Screenshot546-Remind_me_never_250.png" width="535" height="275" />
|
||||
|
||||
Sourcefabric has a privacy policy regarding data collection, which you can read by clicking the link to <http://www.sourcefabric.org/en/about/policy/> further down. After checking the **Send support feedback** and **privacy policy** boxes, you can submit the data by clicking the **Yes, help Airtime** button.
|
||||
|
||||
This window also offers the opportunity to **Promote my station on Sourcefabric.org** (on the page <http://www.sourcefabric.org/en/airtime/whosusing/>) by checking the box. Fill in the form which will appear with some details about your station. The contact details are only requested for verification purposes, and will not be made available to the public. Click the **Browse** button to select a **Station Logo** image from the file manager on your computer.
|
||||
|
||||

|
||||
|
||||
The Master Panel
|
||||
----------------
|
||||
|
||||
After the pop-up window is closed, you should now see the **Master Panel**, which is present at the top of every page of the Airtime interface. On the left hand side, the Master Panel displays the details of the **Previous** file played out, the current file playing (with an orange progress bar and time elapsed/time remaining), and the details of the **Next** file due to play. It also displays the name and scheduled time of the current show, with a blue progress bar.
|
||||
|
||||
Beneath this side of the Master Panel is the main navigation menu, with sub-menus labelled **Now Playing**, **Add Media**, **Library**, **Calendar**, **System**, **History** and **Help**. We'll be looking at the contents of these menus in the following chapters of this book.
|
||||
|
||||
<img src="static/Screenshot542-Main_menus_250.png" width="595" height="145" />
|
||||
|
||||
On the right hand side of the Master Panel are the switches for the **Source Streams**, which enable you to switch from scheduled play to remote live sources, and back. (See the chapter *Stream settings* for details of this feature). The **On Air** indicator turns from dark grey to red whenever audio is being played out. Underneath this indicator is a **Listen** button, which opens a pop-up player that can be used to audition the available playout streams.
|
||||
|
||||
There is also a clock indicating the **Station time** and time zone. Beneath the clock and just to the left, the name of the user currently logged in is displayed, and there is the link for you to **Logout**.
|
||||
|
||||

|
||||
|
||||
Clicking the username link opens a page in which you can update your Airtime password, contact details, language and time zone preferences. Click the **Save** button once you have made the changes that you require.
|
||||
|
||||

|
||||
|
||||
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
|
||||
--------------------------
|
||||
|
||||
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://localhost:8000
|
||||
|
||||
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.
|
||||
|
||||

|
After Width: | Height: | Size: 75 KiB |
After Width: | Height: | Size: 45 KiB |
After Width: | Height: | Size: 49 KiB |
After Width: | Height: | Size: 60 KiB |
After Width: | Height: | Size: 40 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 24 KiB |
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 35 KiB |
After Width: | Height: | Size: 20 KiB |
After Width: | Height: | Size: 30 KiB |
After Width: | Height: | Size: 32 KiB |
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)
|
24
docs/manual/help/index.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
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.
|
||||
|
||||

|
||||
|
||||
You can visit the Airtime online support forum, and sign up for the mailing list, at <http://forum.sourcefabric.org/categories/airtime-support>
|
||||
|
||||
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>
|
||||
|
||||
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/Screenshot460-Help_page.png
Normal file
After Width: | Height: | Size: 46 KiB |
BIN
docs/manual/help/static/Screenshot578-Help_page.png
Normal file
After Width: | Height: | Size: 48 KiB |
BIN
docs/manual/help/static/jPlayer_demo4.zip
Normal file
43
docs/manual/history/index.md
Normal file
|
@ -0,0 +1,43 @@
|
|||
History
|
||||
=======
|
||||
|
||||
On the History menu, the **Playout History** page enables you to view a list of files played within a specific date and time range. This page is designed to help your station prepare reports for music royalty collection societies and regulatory agencies.
|
||||
|
||||
Search results can be copied to the clipboard using the **Copy** button, exported as data in **CSV** format (comma separated values), exported as a document in **PDF** format, or displayed in a printer-friendly format using the **Print** button. (Your web browser must have an Adobe Flash plugin installed for these buttons to appear). Press the **Esc** key to return to the Airtime interface once the print job is complete.
|
||||
|
||||
This page has three tabs: **Log Sheet**, **File Summary** and **Show Summary**. On any of these tabs, you can select a date and time range by clicking the calendar and clock icons in the upper left corner of the page. Then click the search button, which has a magnifying glass icon, to the right. A list of files played during that date and time range will appear further down the page.
|
||||
|
||||
In the **Log Sheet** tab, the playout history is sorted by **Start Time** and **End Time** by default.
|
||||
|
||||
<img src="static/Screenshot533-Playout_history_250.png" width="595" height="385" />
|
||||
|
||||
The number of times each file was played and the length of the files are shown in the **File Summary** tab. To make optimal use of this feature for royalty reporting purposes, music files must be tagged with **Composer** and **Copyright** metadata. The artist performing a piece of music may not be the original composer of the work, or the copyright holder of the sound recording.
|
||||
|
||||
<img src="static/Screenshot534-File_summary_250.png" width="595" height="415" />
|
||||
|
||||
On the **Show Summary** tab, click the name of a show within the search range to expand its row and see its playout details.
|
||||
|
||||
<img src="static/Screenshot535-Show_summary_250.png" width="595" height="480" />
|
||||
|
||||
Manual logging
|
||||
--------------
|
||||
|
||||
If your station features playout from analogue sources such as turntables or microphones, there is no automatic metadata for Airtime to collect from these inputs. To ensure that the playout history is complete, you can add log entries manually by clicking the **+ Create Entry** button. This action opens a pop-up window with default fields of Start Time, End Time, Title and Creator. Click the **Find** button to automatically fill the **Choose Show Instance** menu with the names of shows that took place within the specified time range. Then click the **Save** button to enter the new item into the playout history.
|
||||
|
||||
<img src="static/Screenshot536-Manual_login_250.png" width="530" height="575" />
|
||||
|
||||
Log entries can also be manually deleted, using the button with the trashcan icon, to the right of the **+ Create Entry** button. Pages of entries can be selected for deletion using the **Select** drop-down menu.
|
||||
|
||||
History Templates
|
||||
-----------------
|
||||
|
||||
The **History Templates** page on the History menu enables you to prepare reports with the exact content required by regulatory agencies in the territories that you are broadcasting to. You can begin creating a custom template by clicking the button **New Log Sheet Template** or the button **New File Summary Template**.
|
||||
|
||||
<img src="static/Screenshot537-History_templates.png" width="221" height="277" />
|
||||
|
||||
Either of these actions opens a page in which you can name the new template, and add or remove elements from the list on the left. To add a new element from the list on the right, click the plus icon for the item you require. If the element you require is not listed, you can use the **Add New Field** box at the lower end of the right side column. Select *string*, *boolean*, *integer*, or *float*, depending on the type of data that you wish to log, and then click the **+ Add** button.
|
||||
|
||||
<img src="static/Screenshot538-Log_sheet_template_250.png" width="595" height="517" />
|
||||
|
||||
When the template is in the format you require, click the **Save** button, and **Set Default Template** if you wish. The new template will now be listed on the History Templates page. If you have set a new default template, any changes will be visible on the tabs of the Playout History page.
|
||||
|
BIN
docs/manual/history/static/Screenshot533-Playout_history_250.png
Normal file
After Width: | Height: | Size: 37 KiB |
BIN
docs/manual/history/static/Screenshot534-File_summary_250.png
Normal file
After Width: | Height: | Size: 33 KiB |
BIN
docs/manual/history/static/Screenshot535-Show_summary_250.png
Normal file
After Width: | Height: | Size: 42 KiB |
BIN
docs/manual/history/static/Screenshot536-Manual_login_250.png
Normal file
After Width: | Height: | Size: 41 KiB |
BIN
docs/manual/history/static/Screenshot537-History_templates.png
Normal file
After Width: | Height: | Size: 15 KiB |
After Width: | Height: | Size: 35 KiB |
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
|
@ -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.
|
After Width: | Height: | Size: 74 KiB |
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.
|
After Width: | Height: | Size: 44 KiB |
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*.
|
||||
|
||||

|
After Width: | Height: | Size: 54 KiB |
After Width: | Height: | Size: 75 KiB |
80
docs/manual/index.md
Normal file
|
@ -0,0 +1,80 @@
|
|||
[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.
|
||||
|
||||

|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||

|
||||
|
||||
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).
|
||||
|
||||
LibreTime workflow
|
||||
----------------
|
||||
|
||||
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). This storage server might be accessed directly via studio workstations on the local network.
|
||||
|
||||
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. 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 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. 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. 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
|
||||
|
||||
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
|
||||
|
||||
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) 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) manage presenter, staff and guest access to LibreTime, and contact details, via the **Manage Users** page
|
||||
|
||||
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) upload media files from LibreTime to a third-party hosting service, such as SoundCloud
|
||||
|
||||
j) audition available output streams from the server using the **Listen** button
|
||||
|
||||
k) check the status and resource usage of system components on the **Status** page
|
||||
|
||||
l) export the broadcast schedule to external sites via the Schedule API
|
||||
|
||||
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.
|
||||
|
||||

|