Renaming

docs/manual/about-manual.md

@@ -0,0 +1,233 @@
+About this manual
+=================
+
+**Copyright © 2011-2017 Sourcefabric z.ú.**
+**Copyright © 2017 LibreTime Community**
+
+This manual was written for Sourcefabric by Daniel James, using Booktype Pro. It has been converted to markdown and updated by the LibreTime Community. Please add your comments and contributions at: [http://libretime.org/manual/](../index.md)
+
+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. &lt;<http://fsf.org/>&gt;
+
+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
+

docs/manual/api.md

@@ -0,0 +1,51 @@
+The LibreTime API enables many types of information about the broadcast schedule and configuration to be retrieved from the LibreTime server. Other than the live-info and week-info data fetched by website widgets (see the chapter *Exporting the schedule*), all API requests must be authenticated using the secret API key stored in the file */etc/airtime/api\_client.cfg* on the LibreTime server. This key is autogenerated during LibreTime installation and should be unique for each server.
+
+If you intend to use the LibreTime 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://libretime.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 LibreTime components and resource usage
+-   version - returns the version of LibreTime installed
+-   get-files-without-silan-value - list files for which silence detection has not yet been performed
+-   get-stream-setting - gets the settings of LibreTime output streams
+-   get-stream-parameters - gets the parameters of LibreTime 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://libretime.example.com/api/list-all-files/format/json/api_key/XXXXXX/dir_id/1/
+
+returns the full path to each media file in the LibreTime 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",
+    "]}

docs/manual/autodj.md

@@ -0,0 +1,106 @@
+# How to Setup Genre based AutoDJ
+* YouTube video
+
+[![How to Setup Genre based AutoDJ](http://img.youtube.com/vi/XNVIDnczrOk/0.jpg)](https://www.youtube-nocookie.com/embed/XNVIDnczrOk "How to Setup Genre based AutoDJ")
+
+## Text-based Step-by-step
+
+In this tutorial we will focus on how to build a traditional auto DJ system
+where we use a feature called smart blocks and auto loading playlists to play
+random music tracks of a certain genre during a show. This tutorial is
+primarily focused on program managers but users who are DJs can also benefit
+from smart blocks but will only be able to manually schedule them.
+
+So for the purposes of this tutorial we are going to assume that you
+have uploaded a number of files of music with the genre metadata all
+matching a specific genre, for instance, Alternative. This can be done
+ahead of time, but LibreTime has no way of automatically grouping sub
+genres and so it is important that you spend some time curating the
+track metadata before you upload it to LibreTime as there is not
+currently a way to bulk edit tracks from inside LibreTime. Also once
+tracks are uploaded the metadata of the track itself isn’t changed but
+just how it is represented in the LibreTime database. This might change
+in the future but would only affect you if you were downloading tracks
+and uploading them to another instance and hoped that the changes you
+made were saved.
+
+So we can bulk upload a number of creative commons licensed tracks that
+have their genre all set to specific genres as one way of getting tracks
+if you don’t have a mp3 collection of your own to draw from. See links
+below for some spots where you can procure tracks where the creators
+gave permission for everyone to redistribute play and share them.
+
+One the tracks are uploaded to the system and imported we can now create
+a smartblock that will select the tracks that match a certain genre. For
+this we will use Genre contains Jazz – this will match any track that
+has genre anywhere in its genre so ‘big band jazz’ and ‘swing jazz’
+would match as well as ‘acid jazz’. Any subgenre that doesn’t include
+jazz explicitly such as ‘be bop’ would need to be added as a new
+modifier.
+
+For the purposes of this smart block we want to select 4 random items.
+We also want to avoid really long tracks that are longer than 10
+minutes. So we will add the modifier Length is less than 00:10:00
+
+and now this smart block will pull 4 smart blocks. Be sure to preview it
+to make sure that you have some matches in your library. This will also
+save it.
+
+Now we are going to create a new smart block that plays one promo or
+station ID.
+
+Click smartblock and new and then type in the name promo OR ID and then
+change the criteria Genre to is promo and now click new modifier and
+then is TOTHID.
+
+And then change limit to 1 items.
+
+Now we are going to create a playlist that contains these two smart
+blocks.
+
+Click new and then type Jazz with promos
+
+and then click smartblocks and add the Jazz Songs followed by the Promo
+or ID smart block.
+
+Now this playlist can be dragged into a schedule show to add 3 random
+jazz songs followed by a promo. You can manually repeat the selection in
+the playlist to create a long auto DJ playlist. For instance lets add 3
+more Jazz Songs and then add 3 Jazz Songs again followed by a Promo or
+ID. Now lets save this playlist and go and add it to a scheduled show.
+
+This is a quick and easy way for you to manually schedule a large chunk
+of time. You can also use this as an autoloading playlist.
+
+Lets assign this to a new 3 hour show. Called lots of Jazz. Now lets go
+under Autoloading Playlist and enable that and in this spot we will
+check repeat until full. This will mean that the system will keep
+scheduling this playlist until the show is completely full. The only
+problem here is that at the end of the show it is almost assured that a
+track will be cut off. If you are a web station and you just want to
+schedule music for long lengths of time you can schedule shows that are
+up to 24 hours long.
+
+On the other hand if you are an FCC licensed station you are required to
+have top of the hour IDs as close as possible to the top of the hour. In
+this case the random selection of tracks might not suffice for
+compliance.
+
+If you have a station ID playlist smartblock in your intro playlist (see
+previous tutorial linked below) and you have your tracks broken up
+hourly this shouldn’t be an issue but it still might result in tracks
+being cut of in the middle.
+
+So the best option currently is to change the music tracks to fill the
+remaining show from the previous selection of 3 items. And then be sure
+to add a promos or musical sound bridges at the end that are also time
+remaining but allow overfill.
+
+It is possible that we could improve the way the autoloading playlists
+work in the future, please check out LibreTime.org for the latest
+release notes and feel free to ask any questions at our forum at
+[https://discourse.LibreTime.org](https://discourse.LibreTime.org/)
+
+Thanks for tuning in to another LibreTime tutorial. Our next tutorial
+will show you how to use autoloading playlists to add show specific
+underwriting or advertisements.

docs/manual/backing-up-the-server/index.md

@@ -0,0 +1,71 @@
+The following shell commands can be used for database backup and restore on a
+running *PostgreSQL* server in an LibreTime 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.
+
+```bash
+sudo -u postgres pg_dumpall | gzip -c > libretime-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 LibreTime 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*: 
+
+```bash
+sudo -u postgres dropdb airtime
+```
+
+This **dropdb** command above is necessary to avoid 'already exists' errors on
+table creation when overwriting an empty LibreTime 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:
+
+```bash
+gunzip libretime-backup.gz
+sudo -u postgres psql -f libretime-backup
+```
+
+You should now be able to log in to the LibreTime 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 LibreTime
+database from the day that the storage backup was made. 
+
+Storage backup
+--------------
+
+Backing up the LibreTime database with **pg\_dumpall** will not back up the
+LibreTime 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 LibreTime server storage with a backup server each day or night. If
+the backup server also contains an LibreTime 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.  

docs/manual/build-schedule.md

@@ -0,0 +1,39 @@
+# How to Build Your Schedule
+* YouTube video
+
+[![Build Station Schedule](http://img.youtube.com/vi/EfNhl-yQcn8/0.jpg)](https://www.youtube-nocookie.com/embed/EfNhl-yQcn8 "How to build your schedule")
+
+## Step-by-step Text Based 
+
+A description of the steps involved in adding a show to the LibreTime calendar
+schedule for future playback including repeating shows
+
+**Audience**: Program Managers and Admins
+
+1. Click on the Calendar menu item on the left side of the screen
+1. Click on the blue New Show button
+1. Under **What** - type in a Name to replace Untitled Show
+1. Optional – add URL, Genre and Description
+1. Under **When** click **In The Future**
+1. Select a date and time for the **Start Time** and **End Time**
+1. Time is entered as 00:00 where the first 2 digits are the hour in 24 hour
+time and the second 2 digits are the minutes. So 15:00 is 3PM. *Note: 24 hours
+is the maximum show time and Midnight is 00:00 of the next date.*
+1. Click **Repeats** if this show will air more than once.
+1. If it airs at the same time of the day on more than one day of the week then
+check the boxes next to the Days it should repeat on.
+1. If this is a limited engagement show uncheck **No End?** and select the date
+at which this show should no longer be on the schedule.
+* **Autoloading Playlist** is used if you will generate the content for this
+show using a playlist possibly containing smartblocks to dynamically generate
+it. Ihf this is checked and a playlist is selected, LibreTime will schedule it
+an hour before the show is set to air as well as any **Intro & Outro Playlist**
+configured in the Admin settings. See other How Tos for ideas about how to use Autoloading playlists.
+1. **Live Stream Input** contains the streaming information for DJs and if
+**Use LibreTime Authentication** is checked then DJs can login to stream live
+if they are added to the **Who** section.
+1. **Who** is where you can give DJ users permission to schedule tracks for
+this show and stream live during the show spot. You can check the box
+next to them or type their name and click the drop down.
+1. **Style** allows you to select a custom color and add a show Logo for this
+show.

docs/manual/calendar/index.md

@@ -0,0 +1,139 @@
+The Calendar page of the LibreTime 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 grey background.
+
+![](static/Screenshot451-Calendar.png)
+
+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.
+
+![](static/Screenshot452-Calendar_resolution.png)
+
+Adding a show
+-------------
+
+Only *Admins* and *Program Managers* can use this feature. To add a new show to the Calendar, click the **+ New 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 seven sections, arranged vertically: **What**, **Autoloading Playlist**, **When**, **Live Stream Input**, **Record & Rebroadcast**, **Who**, and **Style**. Click the small orange 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.
+
+![](static/Screenshot453-Show_what.png)
+
+Autoloading Playlist
+------------------
+
+In this section, you can select a playlist that will be used for this show. The playlist must already be defined in your library. **Auto Schedule Playlist** needs to be checked for **Select Playlist** and **Repeat AutoPlaylist Until Show is Full** to be visible.
+
+![](static/Screenshot454-Show_playlist.png)
+
+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 **Start Time** can be **Now** or **In the Future**. A show that starts now, will start at the time save is pressed, while a future show will start at the time set. 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.
+
+![](static/Screenshot526-Add_show_when_250.png)
+
+LibreTime 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, LibreTime will highlight the error with a pink background.
+
+![](static/Screenshot527-negative_time250.png)
+
+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.
+
+![](static/Screenshot528-Link_shows_250.png)
+
+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).
+
+![](static/Screenshot529-repeat_type_monthly_250.png)
+
+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.
+
+![](static/Screenshot530-show_end_date_250.png)
+
+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 LibreTime Authentication** box, the DJs (presenters) of the show will be able to connect a live stream to LibreTime'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 LibreTime server for that person.
+
+![](static/Screenshot457-Live_stream_input.png)
+
+A reminder of the connection **Host**, **Port** and **Mount** for the live input stream to use is shown at the end of the **Live Stream Input** section.
+
+Record & Rebroadcast
+--------------------
+
+The **Record & Rebroadcast** section is currently not working, and so has been removed from the web interface. If this feature is important to you, please search for relevant issues in the [LibreTime github repository](https://github.com/LibreTime/libretime/search?q=record&type=Issues) and help us make it happen!
+
+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 LibreTime 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.
+
+![](static/Screenshot161-Show_users.png)
+
+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.
+
+![](static/Screenshot162-Show_colours.png) 
+
+Optionally, you can upload a Show Logo by clicking the **Browse** button.
+
+![](static/Screenshot584-Show_logo.png)
+
+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.
+
+![](static/Screenshot459-Update_show.png)
+
+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.
+
+![](static/Screenshot583-Show_instance_description_vC9ooiT.png)
+
+Alternatively, individual shows can be clicked on and dragged to new days and times in the calendar. However, LibreTime 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 **Schedule Tracks** 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.
+
+![](static/Screenshot488-Add_remove_content.png)
+
+The **Schedule Tracks** 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 **View** from the pop-up menu to view a list of content now included in the show.
+
+![](static/Screenshot489-Show_Content.png)
+
+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.
+
+![](static/Screenshot353-Contents_of_show.png)
+
+Removing content from a show
+----------------------------
+
+To remove an individual item from a show, click on the show in the **Calendar**, and select **Schedule Tracks** 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 **Remove** 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 **Clear Show** 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 Instance** from the pop-up menu. If you wish to delete all future instances of a repeating show, select **Delete Instance and All Following** from the pop-up menu.
+
+![](static/Screenshot490-Delete_this_instance.png)
+
+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 **View**.
+
+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 Show** from the pop-up menu. LibreTime will ask you if you are sure about this action, as it cannot be undone.
+
+![](static/Screenshot357-Cancel_current_show.png)
+

docs/manual/dashboard/index.md

@@ -0,0 +1,121 @@
+# Dashboard
+The Dashboard is divided into two sections a Library section divided between
+[Tracks](../tracks), [Playlists](../playlists), [Smart Blocks](../smartblocks),
+[Webstreams](../webstreams), and [Podcasts](../podcasts), with the **Scheduled
+Shows** dialog on the right. This page provides an overview of the right-hand
+interface. Check the links to see information about the other sections which
+provide the content that can be scheduled.
+
+The **Scheduled Shows** page provides a view of the content your station is will
+playout, or has already played out, which defaults to showing the 3 hours
+ahead. This page also enables you to make last-minute changes to running shows.
+
+If you've only just installed LibreTime, there might not be any content shown
+yet. Click the calendar and clock icons above the table to change the date and
+time range, then click the **Find Shows** button (with the magnifying glass
+icon) to the right.
+
+![](static/now-playing.png)
+
+To display the content of a particular show, click **Filter by Show** and select
+the name of the show from the drop-down menu which will appear.
+
+![](static/filter.png)
+
+On the left side of the page, the **Start** and **End** times, **Duration**
+and **Title** of each content item are shown. On the right, **Creator**,
+**Album**, **Cue** or **Fade** times and **Mime** type (file format) can also be
+shown. This information can help you to prepare voice tracks for insertion into
+the show, including time checks if you wish. Putting current time information i
+to voice tracks describing specific content can, of course, limit the
+re-usability of those voice tracks, unless you always broadcast a particular
+item at the same time of day.
+
+Click the **Show/hide columns** button on the right to configure the metadata
+displayed, by checking the boxes in the pop-up window.
+
+![](static/columns.png)
+
+The row for the currently playing item is displayed with a bright green
+background. Any underbooked shows (shows with insufficient content to fill the
+time allowed) are displayed with a row indicating the length of the underbooking
+in minutes and seconds. These rows contain a red exclamation mark in the first
+column, and have a pink background.
+
+![](static/end-gap.png)
+
+Removing content from a running show
+------------------------------------
+
+If a show is overbooked, which means the total playout duration is longer than
+the time allowed for the show, a brown row indicates that the item will be faded
+out when the show ends. A red row indicates that the item will not be played at
+all. The length of the overbooking is shown in minutes and seconds in the last
+row of the show. To remove the extra items from the end of an overbooked show,
+click the **Scissors** button at the top left of the table.
+
+Alternatively, check the boxes for items which have not yet completed playout,
+and click the **Trashcan** button, to the right of the Scissors, to remove them
+from the schedule. If you remove the currently playing item, playout will skip
+to the next item in the show automatically, so you should make sure you have
+enough items remaining in the show to avoid dead air.
+
+![](static/delete-extra.png)
+
+If you have a long schedule displayed, and you wish to skip to the currently
+playing item, click the button with the end arrow icon, to the right of the
+**Trashcan**.
+
+To cancel the current show completely, click the red button to the right again.
+A pop-up window will ask you to confirm the cancellation, as this action cannot
+be undone.
+
+![](static/cancel-show.png)
+
+Items which are no longer available have an exclamation mark icon in the second
+column. This may happen for media files which were part of previous shows, and
+were removed from LibreTime's library (main storage or watched folders)
+subsequently. Items which are included in forthcoming shows cannot be removed
+from the Library via the LibreTime interface.
+
+Adding content to a running show
+--------------------------------
+
+After you have found the items that you want using the search tools, you can
+then drag and drop them from the library table on the left side of the page into
+the shows on the right side, including the current playing show.
+
+If the current show has nothing playing out at the time, the new item will begin
+playing immediately. This manual triggering of playout can be used as a live
+assist technique, in which the LibreTime server's soundcard output is mixed with
+other sources such as microphones or telephone hybrids on its way to a
+transmitter, or a separate stream encoder. For instance, a live show's host may
+not wish to cut off a studio discussion in order to play music at a fixed time.
+
+![](static/drag-and-drop.png)
+
+You can also select multiple items using the **Select** menu button, just
+beneath the simple search field, which has the options to **Select this page**
+of search results, **Deselect this page** and **Deselect all**. Alternatively,
+use the checkboxes on the left side of the library table to select specific
+items. Then drag one of the items into the show to add all of the selected
+items, or click the **Add to selected show** button, which has a plus icon. If
+you wish, you can also use the **Trashcan** button to permanently remove items
+from LibreTime's library. Only *admin* users have permission to delete all
+items.
+
+To insert checkbox selected items at a specific time in the show schedule, click
+one of the songs in the schedule table.  Then click the **Add to selected show**
+button in the library table. This will insert the library songs after the
+selected scheduled song.
+
+To add a single item at the insertion point, double-click on it in the library.
+There is no need to select or drag the item first.
+
+Right-clicking on a song in the schedule table will show a pop-up. This pop-up
+menu also enables you to audition the entire show in advance of playout, or
+remove the item that was clicked on from the show.
+
+Multiple insertion points can be enabled, so that the same item is inserted into
+the schedule at different times. For example, you may wish to play a news report
+every hour, or a station ident after every five music files.

docs/manual/embed-player/index.md

@@ -0,0 +1,68 @@
+If you are using Airtime with Icecast or SHOUTcast for web streaming, you can embed a player applet into your website. **jPlayer** is a player applet (available under the GNU GPL from <http://jplayer.org/>) which uses the *&lt;audio&gt;* tag feature of HTML5 to play your streams. If the listener's browser does not support HTML5, the applet falls back to using Adobe Flash for MP3 format streams.
+
+Proprietary browsers, such as Internet Explorer on Windows or Safari on Apple OS X, may not support Ogg Vorbis or Opus streams. Listeners who do not wish to install a browser with Ogg support (such as **Mozilla Firefox**, **Google Chrome** or **Opera**) can listen to these streams using a separate media player such as **VideoLAN Client**, also known as VLC (<http://www.videolan.org/vlc/>).
+
+Example code
+------------
+
+You can download the example code for this chapter from:
+
+[http://sourcefabric.booktype.pro/airtime-25-for-broadcasters/help/static/jPlayer\_demo4.zip](../help/static/jPlayer_demo4.zip "jPlayer demo files")
+
+Unzip this file on your computer, and then open the file *jplayer-demo.html* in your editor:
+
+    nano jplayer-demo.html
+
+We'll focus on the two areas that you need to concern yourself with. Firstly, in the *&lt;head&gt;* tag of the document, you'll see some code like this:
+
+      $("#jquery_jplayer_1").jPlayer({ 
+          ready: function (event) { 
+              $(this).jPlayer("setMedia", { 
+                  oga:"http://sourcefabric.out.airtime.pro:8000/sourcefabric_a" 
+              }); 
+          }, 
+          swfPath: "js", 
+          supplied: "oga", 
+          wmode: "window", 
+          smoothPlayBar: true, 
+          keyEnabled: true 
+      });
+
+This code loads jPlayer, and specifies the source of an Ogg Vorbis stream. When testing on your own server, you should change this setting to the IP address or domain name, port number and mount point of the Icecast server you are using, like so:
+
+    oga: "http://streaming.example.com:8000/airtime_128"
+
+If your stream is in MP3 format, you will need to prefix the stream setting with mp3, like this:
+
+    mp3: "http://streaming.example.com:8000/airtime_128"
+
+and change the *supplied* line from:
+
+        supplied: "oga"
+
+to:
+
+        supplied: "mp3"
+
+As soon as jPlayer has finished loading, it will automatically begin to play the stream. The parameters *ready*, *ended*, *swfPath* and *supplied* are arguments passed to jPlayer. A full list of constructor arguments is available in the *jPlayer Developer Guide* at <http://www.jplayer.org/latest/developer-guide/>
+
+jPlayer controls
+----------------
+
+Secondly, the *&lt;body&gt;* tag of the file *jplayer-demo.html* defines the controls displayed by jPlayer. These controls can be as simple as just one Play/Pause button, or a fully-fledged playback interface with a playlist, progress bar and volume control. This example code uses one of the simpler skins available for jPlayer, *Blue Monday*.
+
+A stop button or progress bar is not useful when we are streaming continuously from Icecast or SHOUTcast, so we can remove these tags from the demo code, along with the tags specifying the playback time and file duration. The simplified HTML creates a play/pause button and a mute button, and looks as follows:
+
+    <ul class="jp-controls"> 
+      <li><a href="javascript:;" class="jp-play" tabindex="1">play</a></li> 
+      <li><a href="javascript:;" class="jp-pause" tabindex="1">pause</a></li> 
+      <li><a href="javascript:;" class="jp-mute" tabindex="1" title="mute">mute</a></li> 
+      <li><a href="javascript:;" class="jp-unmute" tabindex="1" title="unmute">unmute</a></li> 
+      <li><a href="javascript:;" class="jp-volume-max" tabindex="1" title="max volume">max volume</a></li> 
+    </ul>
+
+When you open the HTML file *jplayer-demo.html* in a web browser, your player should appear as follows:
+
+![](static/Screenshot525-jplayer-demo_240.png)
+
+The original version of this demo code and skin are available from <http://jplayer.org/download/> for further experimentation.

docs/manual/exporting-the-schedule/index.md

@@ -0,0 +1,250 @@
+LibreTime has a feature which enables your station's show and schedule information to be displayed on remote websites. This feature is included in LibreTime because you would not usually invite the general public to access your LibreTime server directly. If you had very large numbers of people requesting data from the LibreTime 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 LibreTime 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 LibreTime 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 LibreTime server was accessible at https://libretime.example.com the live show information could be retrieved by your web server using this URL:
+
+    https://libretime.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 &amp; 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://libretime.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 LibreTime 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.
+
+![](static/Screenshot497-System_preferences_240.png)
+
+Caching schedule information
+----------------------------
+
+If the LibreTime server is behind a firewall, or you want to protect the LibreTime 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 LibreTime server, in addition to any remote users of the LibreTime 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 LibreTime server (libretime.example.com), and writes the metadata returned into a pair of local temporary files:
+
+    sudo nano /usr/local/bin/libretime-schedule.sh
+
+The content of this file should be like the following script, replacing libretime.example.com with the name of your LibreTime server:
+
+    #!/bin/sh
+
+    curl -s "https://libretime.example.com/api/live-info/?callback=***" > /tmp/live-info
+
+    curl -s "https://libretime.example.com/api/week-info/?callback=***" > /tmp/week-info
+
+2. Make the script executable:
+
+    sudo chmod +x /usr/local/bin/libretime-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/libretime-schedule
+
+containing the line:
+
+    * * * * * www-data /usr/local/bin/libretime-schedule.sh
+
+The schedule server will now be serving the same show information as the LibreTime 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 LibreTime server.
+
+Pushing schedule information via FTP or SSH
+-------------------------------------------
+
+If there is no inbound access to the LibreTime server at all, an FTP script can be used to push cached schedule data from LibreTime to an external web server. The standard ftp command should be available on the LibreTime 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 LibreTime server, create a new script on the LibreTime 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.

docs/manual/folders.md

@@ -0,0 +1,3 @@
+LibreTime's media library is inside the */srv/airtime/stor/* folder on your server, by default. Tracks are uploaded into the imported subdirectory and then a separate directory based upon the user ID # of the user who uploaded it and then into a folder based upon the artist. 
+
+LibreTime unlike Airtime does not currently monitor the files for changes after they are uploaded. The media library is not designed to be edited directly after files are uploaded. This was done as part of a move towards enabling cloud-based file hosting. There are currently two works in progress to support filesystem imports and sync but neither of them have been finished as of the time of this writing. See [#111](https://github.com/LibreTime/libretime/pull/111) and [#514](https://github.com/LibreTime/libretime/pull/514). In addition LibreTime does not write metadata changes back to the files. See [#621](https://github.com/LibreTime/libretime/issues/621)

docs/manual/freeipa.md

@@ -0,0 +1,102 @@
+You can configure LibreTime to delegate all authentication to a FreeIPA server.
+
+This allows you users to use their existing FreeIPA credentials. For this to
+work you need to configure Apache to use `mod_authnz_pam` and `mod_intercept_form_submit`.
+
+## Apache configuration
+
+After installing the needed modules you can set up Apache to intercept form logins and
+check them against pam.
+
+```apache
+<Location /login>
+    InterceptFormPAMService http-libretime
+    InterceptFormLogin username
+    InterceptFormPassword password
+    InterceptFormLoginSkip admin
+    InterceptFormPasswordRedact on
+    InterceptFormLoginRealms INT.RABE.CH
+    Require pam-account http-libretime
+</Location>
+
+<Location />
+    <RequireAny>
+       <RequireAny>
+           Require pam-account http-libretime
+           Require all granted
+       </RequireAny>
+       <RequireAll>
+           Require expr %{REQUEST_URI} =~  /(index.php|login|favicon.ico|js|css|locale)/
+           Require all granted
+       </RequireAll>
+    </RequireAny>
+</Location>
+```
+
+## PAM configuration
+
+The above configuration expects a PAM configuration for the `http-libretime` service.
+
+To confiure this you need to create the file `/etc/pam.d/http-libretime` with the following contents.
+
+```
+auth    required   pam_sss.so
+account required   pam_sss.so
+```
+
+## LDAP configuration
+
+LibreTime needs direct access to LDAP so it can fetch additional information. It does so with
+a [system account](https://www.freeipa.org/page/HowTo/LDAP#System_Accounts) that you need to
+set up beforehand.
+
+You can configure everything pertaining to how LibreTime accesses LDAP in 
+`/etc/airtime/airtime.conf`. The default file has the following values you need to change.
+
+```ini
+# 
+# ----------------------------------------------------------------------
+#                          L D A P
+# ----------------------------------------------------------------------
+#
+# hostname:       Hostname of LDAP server
+#
+# binddn:         Complete DN of user used to bind to LDAP
+#
+# password:       Password for binddn user
+#
+# account_domain: Domain part of username
+#
+# basedn:         base search DN
+#
+# filter_field:   Name of the uid field for searching
+#                 Usually uid, may be cn
+#
+# groupmap_*:     Map LibreTime user types to LDAP groups
+#                 Lets LibreTime assign user types based on the
+#                 group a given user is in.
+#
+[ldap]
+hostname = ldap.example.org
+binddn = 'uid=libretime,cn=sysaccounts,cn=etc,dc=int,dc=example,dc=org'
+password = hackme
+account_domain = INT.EXAMPLE.ORG
+basedn = 'cn=users,cn=accounts,dc=int,dc=example,dc=org'
+filter_field = uid
+groupmap_guest = 'cn=guest,cn=groups,cn=accounts,dc=int,dc=example,dc=org'
+groupmap_host = 'cn=host,cn=groups,cn=accounts,dc=int,dc=example,dc=org'
+groupmap_program_manager = 'cn=program_manager,cn=groups,cn=accounts,dc=int,dc=example,dc=org'
+groupmap_admin = 'cn=admins,cn=groups,cn=accounts,dc=int,dc=example,dc=org'
+groupmap_superadmin = 'cn=superadmin,cn=groups,cn=accounts,dc=int,dc=example,dc=org'
+```
+
+## Enable FreeIPA auth
+
+After everything is set up properly you can enable FreeIPA auth in `airtime.conf`:
+
+```
+[general]
+auth = LibreTime_Auth_Adaptor_FreeIpa
+```
+
+You should now be able to use your FreeIPA credentials to log in to LibreTime.

docs/manual/general/index.md

@@ -0,0 +1,81 @@
+# Settings
+
+![](static/station-info-settings.png)
+
+On the **Settings** menu, click **General** to set your **Station Name**. This
+text is shown in your web browser's title bar when your station staff are logged
+into LibreTime, and optionally in stream metadata. You can also set a **Station
+Description** and **Station Logo** here.
+
+![](static/general-playback-settings.png)
+
+The **Default Interface Language** drop-down menu sets the default localization
+for your LibreTime instance, and the **Station Timezone** drop-down menu can be
+used to display local time at your station. LibreTime stores show times
+internally in UTC format (similar to *Greenwich Mean Time*), but displays local
+time for the convenience of your station staff. You can also set the day of the
+week that you wish to start your station's weekly schedule on, which defaults
+to Sunday.
+
+The **Track Type Default** enables you to select a track type default for uploads.
+
+Initially, the **Default Fade In** and **Default Fade Out** times for automated
+fades are set to half a second, and the **Default Crossfade Duration** is set to
+zero seconds. Custom fade and crossfade times can be set for adjacent items in a
+playlist or static smart block. See the chapter *Library* for details.
+
+The **Intro Autoloading Playlist** enables you to select a playlist that will be
+scheduled at the beginning of every show that has enabled an autoloading
+playlist. This can be used for instance to insert a station ID or other
+announcements a the top of every show.
+
+The **Outro Autoloading Playlist** enables you to select a playlist that will be
+scheduled after the content of every show with an autoloading playlist.
+
+The **Overwrite Podcast Episode Metatags** option which is enabled by default
+causes LibreTime to override the Artist, Title & Album fields on any tracks
+downloaded from a podcast with information from the RSS feed.
+
+The **Generate a smartblock and a playlist upon creation of a new podcast**
+option when enabled will create a smartblock matching the newest episode of a
+podcast and a playlist containing that smartblock automatically upon adding a
+podcast to LibreTime. This can also be done manually by the generate smartblock
+and playlist button under a podcasts settings which is why it is disabled by
+default.
+
+![](static/api-settings.png)
+
+You can enable live, read-only access to the LibreTime schedule calendar for
+your station's public website with the **Public LibreTime API** option, if you
+wish. (There is more about this feature in the
+[*Exporting the schedule*](../exporting-the-schedule/index.md) chapter, in the
+*Advanced Configuration* section of this book).
+
+The **Allowed CORS URLs** is intended to deal with situations where you want a
+remote site with a different domain to access the API. This is relevant when
+there is a reverse proxy server in front of LibreTime. If you are using a
+reverse proxy, the URLs that will be used to access it should be added here.
+
+The **Display login button on your Radio Page?** will determine whether visitors
+to your site see a link to login. If this is disabled DJs and admins will need
+to goto http://SITEURL/login to be able to login.
+
+The **Tune-In Settings** section is intended for stations that have partnered
+with TuneIn to automatically push their now playing metadata to TuneIn. This
+hasn't been tested and also requires special credentials from TuneIn.
+
+![](static/dangerous-options.png)
+
+The **Dangerous Options** section provides an administrator the ability to erase
+the entire LibreTime library.
+
+When you are done remember click the **Save** button at the top or bottom of the
+form.
+
+![](static/save-button.png)
+
+Individual LibreTime users can choose another interface localization when they
+log in, or set personal preferences for localization and time zone by clicking
+their username on the right side of the menu bar.
+
+![](static/Screenshot475-Edit_own_user_account.png)

docs/manual/getting-started/index.md

@@ -0,0 +1,100 @@
+# Getting Started
+
+If the server is only being used for LibreTime 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 LibreTime so that it can be accessed from other computers,
+you would use a domain name instead. For example:
+
+    https://libretime.example.com/
+
+You can log in for the first time with the user name *admin* and the password
+*admin*. Your browser should automatically focus on the
+**Username** field.
+
+![](../on-air-in-60-seconds/static/Screenshot559-Log_in.png)
+
+You will see a link **Reset password** below the password field, which enables
+users to obtain a password reminder by email. You will need to have a
+mailserver configured to work with PHP for this to work. There is an issue open
+to add documentation for this
+([#724](https://github.com/LibreTime/libretime/issues/724)).
+
+![](static/Screenshot467-Reset_password_link.png) 
+
+The **E-mail** address you enter must match the address stored in the database
+for your **Username**.
+
+![](static/Screenshot468-Restore_password.png)
+
+
+The Master Panel
+----------------
+
+The **Master Panel** is present at the top of every page of the LibreTime
+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.
+
+![](static/Screenshot-MasterPanel.png)
+
+Beneath this side of the Master Panel is the main navigation menu. We'll be
+looking at the contents of these menus in the following chapters of this book.
+
+![](static/Screenshot-MainMenu.png)
+
+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**. 
+
+![](static/Screenshot469-On_Air_light.png)
+
+Clicking the username link opens a page in which you can update your LibreTime
+password, contact details, language and time zone preferences. Click the
+**Save** button once you have made the changes that you require.
+
+![](static/Screenshot470-User_settings.png)
+
+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 LibreTime server has made to this Icecast server. If you have only just
+installed LibreTime, there may not be any media playing out yet.
+
+![](static/Screenshot293-Icecast_status_page.png)
+
+Reverse Proxy Connections
+-------------------------
+In some deployments, the LibreTime server is deployed behind a reverse proxy,
+for example in containerization use-cases such as Docker and LXC. LibreTime
+makes extensive use of its API for some site functionality, which causes
+[Cross-Origin Resource Sharing (CORS)](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)
+to occur. By default, CORS requests are blocked by your browser and the origins
+need to be added to the **Allowed CORS URLs** block in
+[**General Settings**](/manual/general/). These origins should include any
+domains that will be used externally to connect to your reverse proxy that you
+want handled by LibreTime.

docs/manual/hd-audio-models.md

@@ -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 LibreTime 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)

docs/manual/help/index.md

@@ -0,0 +1,30 @@
+The first entry on LibreTime's **Help** menu offers a **Getting Started** guide
+for new users. Further down, there is also a link to the online version of this
+  **User Manual**.
+
+![](static/Screenshot460-Help_page.png)
+
+You can visit the LibreTime online support forum at
+<https://discourse.libretime.org/c/get-help> to ask for help from the community
+regarding your LibreTime setup.
+
+
+Bug reporting
+-------------
+
+LibreTime needs your input to improve. If you think you've found a bug, please
+visit <https://github.com/LibreTime/libretime>. Create a bug report by selecting
+**Issues**, then **New Issue**. That way, the LibreTime team can keep track of
+your problem and notify you when it has been fixed. You can also suggest
+improvements and new features for LibreTime on that site.
+
+
+
+Other help
+----------
+
+The UNESCO publication [*Community Radio - A user's guide to the technology*](static/CommunityRadioUserGuide.pdf)
+features a very comprehensive guide to setting up a community radio station.
+This guide is aimed at people thinking about setting up a radio station in
+India, but includes lots of practical advice that would be useful in any
+country.

docs/manual/history-templates/index.md

@@ -0,0 +1 @@
+**TBD**

docs/manual/history/index.md

@@ -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 LibreTime interface once the print job is complete.
+
+This page has three tabs: **Log Sheet**, **File Summary** and **Show Summary**. On any of these tabs, you can select a date and time range by clicking the calendar and clock icons in the upper left corner of the page. Then click the search button, which has a magnifying glass icon, to the right. A list of files played during that date and time range will appear further down the page.
+
+In the **Log Sheet** tab, the playout history is sorted by **Start Time** and **End Time** by default.
+
+<img src="static/Screenshot533-Playout_history_250.png" width="595" height="385" />
+
+The number of times each file was played and the length of the files are shown in the **File Summary** tab. To make optimal use of this feature for royalty reporting purposes, music files must be tagged with **Composer** and **Copyright** metadata. The artist performing a piece of music may not be the original composer of the work, or the copyright holder of the sound recording.
+
+<img src="static/Screenshot534-File_summary_250.png" width="595" height="415" />
+
+On the **Show Summary** tab, click the name of a show within the search range to expand its row and see its playout details.
+
+<img src="static/Screenshot535-Show_summary_250.png" width="595" height="480" />
+
+Manual logging
+--------------
+
+If your station features playout from analogue sources such as turntables or microphones, there is no automatic metadata for LibreTime to collect from these inputs. To ensure that the playout history is complete, you can add log entries manually by clicking the **+ Create Entry** button. This action opens a pop-up window with default fields of Start Time, End Time, Title and Creator. Click the **Find** button to automatically fill the **Choose Show Instance** menu with the names of shows that took place within the specified time range. Then click the **Save** button to enter the new item into the playout history.
+
+<img src="static/Screenshot536-Manual_login_250.png" width="530" height="575" />
+
+Log entries can also be manually deleted, using the button with the trashcan icon, to the right of the **+ Create Entry** button. Pages of entries can be selected for deletion using the **Select** drop-down menu.
+
+History Templates
+-----------------
+
+The **History Templates** page on the History menu enables you to prepare reports with the exact content required by regulatory agencies in the territories that you are broadcasting to. You can begin creating a custom template by clicking the button **New Log Sheet Template** or the button **New File Summary Template**.
+
+<img src="static/Screenshot537-History_templates.png" width="221" height="277" />
+
+Either of these actions opens a page in which you can name the new template, and add or remove elements from the list on the left. To add a new element from the list on the right, click the plus icon for the item you require. If the element you require is not listed, you can use the **Add New Field** box at the lower end of the right side column. Select *string*, *boolean*, *integer*, or *float*, depending on the type of data that you wish to log, and then click the **+ Add** button.
+
+<img src="static/Screenshot538-Log_sheet_template_250.png" width="595" height="517" />
+
+When the template is in the format you require, click the **Save** button, and **Set Default Template** if you wish. The new template will now be listed on the History Templates page. If you have set a new default template, any changes will be visible on the tabs of the Playout History page.
+

docs/manual/host-configuration.md

@@ -0,0 +1,175 @@
+Host configuration
+------------------
+
+The streaming host configuration for LibreTime is shown in the file */etc/airtime/liquidsoap.cfg* which is automatically generated by the **Streams** page, found on the **System** menu of the LibreTime administration interface. For this reason, you would not normally edit the streaming configuration manually, as any changes are likely to be overwritten by the administration interface.
+
+Database and RabbitMQ hosts
+---------------------------
+
+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 LibreTime server and SoundCloud uploads in this file, although you should not normally need to adjust the defaults unless you are running a large LibreTime system distributed across multiple servers. To run the LibreTime 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 = libretime.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**.  In order to update the configuration
+used by the various components of LibreTime, run the following commands
+
+    sudo systemctl restart airtime-liquidsoap
+    sudo systemctl restart airtime-playout
+    sudo systemctl restart airtime-celery
+    sudo systemctl restart airtime_analyzer
+
+Changing the default PostgreSQL passwords
+----------------------------------------
+
+Two of the most important passwords that should be changed *immediately* after installation
+are the passwords used by the PostgreSQL database.
+It is strongly recommended that you do this before exposing your server to the internet beyond your internal network.
+
+1. Login to PostgreSQL with `sudo -u postgres psql`. The PostgreSQL shell - `postgres=#` - means that you have logged in successfully.
+2. Change the admin password with `ALTER USER postgres PASSWORD 'myPassword';`, where `myPassword` is the new password.
+Make sure to include the semicolon at the end! A response of `ALTER ROLE` means that the command ran successfully.
+3. Change the password for the *airtime* user with `ALTER USER airtime WITH PASSWORD 'new_password';`
+A response of `ALTER ROLE` means that the command ran successfully.
+4. If all is successful, logout of PostgreSQL with `\q`, go back to */etc/airtime/airtime.conf* to edit the password
+in the config file, and restart all services mentioned in the previous section.
+
+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 = libretime.example.com
+    base_port = 80
+    base_dir = /
+
+Apache max file size configuration
+----------------------------------
+
+By default, the maximum upload file size is 500 MB, which may not be large enough for some stations, especially if they are uploading prerecorded shows. The setting for this is located in */etc/apache2/sites-available/airtime.config*. Search for and update the following in megabytes:
+
+```
+; Maximum allowed size for uploaded files.
+upload_max_filesize = 40M
+
+; Must be greater than or equal to upload_max_filesize
+post_max_size = 40M
+```
+
+For quick reference, 1024 MB = 1 GB and 2048 MB = 2 GB, but most will be okay with rounding to the nearest thousand. After updating the config file, restart Apache by `sudo systemctl apache restart`.
+
+
+Playout and recorder settings
+-----------------------------
+
+Settings for pypo, the playout and recording engine used by LibreTime, are found in the file */etc/airtime/airtime.conf*. After making changes to this file, you will have to issue the command:
+
+    sudo systemctl restart airtime-playout
+
+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

docs/manual/icecast-and-shoutcast/index.md

@@ -0,0 +1,30 @@
+LibreTime 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 LibreTime, 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 LibreTime 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 LibreTime'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 LibreTime 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:
+
+![](static/Screenshot223-Icecast_UTF-8_metadata.png)
+
+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 *libretime.mp3* is the name of your mount point:
+
+      <mount>
+           <mount-name>/libretime.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.

docs/manual/icecast-handover/index.md

@@ -0,0 +1,45 @@
+In a typical radio station configuration, the live output from the broadcast studio and the scheduled output from LibreTime 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 LibreTime 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 LibreTime output to a show from another source, and handover to LibreTime 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 LibreTime 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 LibreTime 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.
+
+![](static/Screenshot123-Mixxx_Preferences.png) 
+
+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.

docs/manual/install-vps.md

@@ -0,0 +1,4 @@
+# How to Install LibreTime on a VPS
+* YouTube video
+
+[![How to Install LibreTime on a VPS](http://img.youtube.com/vi/Djo_55LgjXE/0.jpg)](https://www.youtube-nocookie.com/embed/Djo_55LgjXE "How to Install LibreTime on a VPS")

docs/manual/interface-customization/index.md

@@ -0,0 +1,53 @@
+Modifying the LibreTime interface
+----------------------------------
+
+The LibreTime administration interface, as a web application, is fully customizable using the same methods that you might use to modify a website. For instance, you may wish to increase certain font sizes or change the colours in the LibreTime interface to better suit staff users with impaired vision. To do this, open one of the CSS files in the */public/css/* directory under the LibreTime *DocumentRoot* directory in an editor such as **nano**:
+
+    sudo nano /usr/share/airtime/public/css/styles.css
+
+To change the background colour of the administration interface from dark gray to white, the *background:* property of the body tag could be changed to *\#ffffff* as follows:
+
+    body {
+          font-size: 62.5%;
+          font-family:Arial, Helvetica, sans-serif;
+          background: #ffffff;
+          margin: 0;
+          padding: 0;
+    }
+
+Save the file with **Ctrl+O**, then refresh your browser to see the change to the interface background colour.
+
+Any custom changes that you make to the administration interface should be backed up before upgrading LibreTime to a newer version, otherwise they could be overwritten. If you have made improvements that you think might be useful to other LibreTime users, please contact LibreTime and tell us about them.
+
+Modifying the LibreTime Radio Page
+-----------------------------------
+
+The background of the mini-site that appears when you visit the server's domain in your web browser can be changed by modifying the page's CSS file, located at */usr/share/airtime/php/airtime_mvc/public/css/radio-page/radio-page.css*.
+
+```
+html {
+    background: url("img/background-testing-3.jpg") no-repeat center center fixed;
+    -webkit-background-size: cover;
+    -moz-background-size: cover;
+    -o-background-size: cover;
+    background-size: cover;
+    overflow-y: auto;
+}
+```
+
+Place the new background image in the */usr/share/airtime/public/css/radio-page/img/* folder and change the `background:` entry's URL to point to the new image. The new image should be at least 1280 x 720 in pixel size to avoid being blurry.
+
+Modifying the Icecast interface
+-------------------------------
+
+If you have installed Icecast, in the directory */etc/icecast2/web/* you will find several XSLT and other files which are used to generate the Icecast web interface. If you are familiar with HTML you should be able to modify these pages, as they are well commented. You do have to be careful with syntax, because something as simple as a missing bracket can cause the Icecast web interface to break down.
+
+For example, you could change the *status.xsl* page:
+
+    sudo nano /etc/icecast2/web/status.xsl
+
+Modifying the *status.xsl* page is a good place to start, because this is the default page that site visitors see when they browse port 8000 on your Icecast server. The most obvious change to make in the XSLT pages is the content of the *<title>* and *<h2>* tags, to announce the name of your station. You can also modify the *style.css* file in this directory to change colour and layout options.
+
+After saving the file with Ctrl+O, refresh your web browser, and the new look should now be visible.
+
+![](static/Screenshot177-Icecast_rocks.png)

docs/manual/interface-localization/index.md

@@ -0,0 +1,57 @@
+The LibreTime administration interface can be localized using the standard GNU **gettext** method. Using GitHub for this task means you don't have to tackle the whole of a localization yourself; just as much as you can manage.
+
+![](static/Screenshot464-Korean_stream_setting.png)
+
+First, you should check if a localization is already under way for your locale of choice. The best way to do this is to take a look at the 'master' branch in the GitHub repository for LibreTime at <https://github.com/LibreTime/libretime>. You can also ask in the LibreTime development forum at <https://discourse.libretime.org/>, where you might find community members who can help you with the translation.
+
+GNU **gettext** means using a .po file for each language or dialect, a specially formatted plain text file with groups of three or more lines, like this example from LibreTime's Korean localization:
+
+    #: airtime_mvc/application/configs/navigation.php:57
+    msgid "Media Folders"
+    msgstr "미디어 폴더"
+
+The first of these three lines starts with the hash symbol, and references where this string of text is found in the source code by its file name and line number. If this string is found more than once in the source code, you will see other reference lines here. The second line contains the **msgid**, which is the original version of the string. The third line contains the **msgstr**, which is the translation of that string for the localization that this particular .po file relates to.
+
+If you use the cross-platform program **Poedit** (<http://www.poedit.net/>) to edit the .po file, this formatting of the text is hidden by an easy-to-use GUI. The *poedit* package can be installed on most GNU/Linux distributions using the standard software installer. Versions of Poedit for Mac and Windows are available for free download from the project's homepage.
+
+Before manually translating strings in Poedit from scratch, you should take a look at the online translation services available, such as Lingohub (<https://lingohub.com>) or Google's Translator Toolkit (<http://translate.google.com/toolkit/>), which both support gettext .po files. If using automatic translation, you can then use Poedit to fine-tune the localization and fix any formatting errors.
+
+If you don't already have a GitHub account, you can sign up at <https://github.com/signup/free>. Once you have a GitHub account, you can fork a copy (<https://help.github.com/articles/fork-a-repo>) of the LibreTime project. Work for the next major version of the software is done in the **master** branch of each project, so that's the branch to **checkout** after you have made the initial **git clone**.
+
+In the locale code *de\_CH*, for example, *de* represents the German language and the suffix *\_CH* indicates the dialect spoken in Switzerland. Some languages have a wide variety of dialect localizations, which can be differentiated with a suffix in this way. You should update the header information in the .po file, which includes the language code and a country code, using one of the existing .po files as a guide.
+
+After forking the LibreTime git repository, make sure you're in the **master** branch:
+
+    git branch
+      devel
+    * master
+
+Create a new locale directory (e.g. *airtime\_mvc/locale/de\_CH/LC\_MESSAGES/* for German as spoken in Switzerland):
+
+    mkdir -p airtime_mvc/locale/de_CH/LC_MESSAGES/
+
+Copy the template *airtime.po* file into the directory you just created:
+
+    cp airtime_mvc_locale/template/airtime.po airtime_mvc/locale/de_CH/LC_MESSAGES
+
+and update the header information in the new copy of the *airtime.po* file using the **nano** editor:
+
+    nano airtime_mvc/locale/de_CH/LC_MESSAGES/airtime.po
+
+For the example of Swiss German, the header of the file should now look like this:
+
+    # SWISS GERMAN (de_CH) translation for LibreTime.
+    # Copyright (C) 2013 Sourcefabric
+    # This file is distributed under the same license as the LibreTime package.
+    # Sourcefabric <contact@sourcefabric.org>, 2013.
+    #
+    msgid ""
+    msgstr ""
+    "Project-Id-Version: LibreTime 3.0-Alpha\n"
+    "Report-Msgid-Bugs-To: https://discourse.libretime.org/\n"
+
+After using an online translation tool to begin a new localization, you can load the exported .po file into Poedit and complete your translation there. Enter the localization team's contact information and language into Poedit's **Edit -&gt; Preferences** and **Catalog -&gt; Settings** dialogs, which will be added to the .po file. When you save a .po file in Poedit, the corresponding binary .mo file will be compiled automatically.
+
+Finally, **git add**, **git commit** and **git push** these new .mo and .po files to your GitHub fork of the project, and send a git pull request (<https://help.github.com/articles/using-pull-requests>) to the LibreTime developers. The localization can then be added to a forthcoming LibreTime release.
+
+If you don't want to work with git, that's no problem - download a copy of the .po template file, edit the header, run it through an automatic translator and check it with Poedit. Then email your contribution to the LibreTime team as an attachment - it will be very welcome! However, learning to use git is a good idea, because it means you can work directly on the current source code, share the localization work with the LibreTime community, and avoid duplicated effort.

docs/manual/intro-playlist.md

@@ -0,0 +1,40 @@
+# How to automatically schedule an Intro Playlist
+
+**Audience**: Adminstrators
+
+## Creating the Top of the hour smartblock
+
+1. Login to LibreTime
+1. Click **Smart Blocks**
+1. Click the blue **+New** button
+1. On the right (or below if screen width is limited), type in the Smart Block
+Name: **Top of the Hour Station ID**
+1. Under **Search Criteria** select **Genre** for the criteria
+1. Select **is** for modifier
+1. Type TOTHID in the third box. *Note: all Top of The Hour Station ID tracks
+will need to have TOTHID as their **Genre** to match*
+1. Under Limit To – click the second box and select **items** instead of hours
+1. Click **Save**
+
+## Adding Smartblock to Intro Playlist
+
+1. Click **Playlist**
+1. Click **+ New**
+1. Type **Intro Playlist** in the Name.
+1. Click **Smart Blocks**
+1. Click the box to the left of **Top of the Hour Station ID**
+1. Click **+ Add to current playlist** or drag the smart block to the right
+bottom of the playlist window.
+1. Click **Save**.
+
+## How to Set Default Intro Playlist
+
+1. Click **Settings**.
+1, Click **General** and then scroll to **Intro Autoloading Playlist** and
+click the drop down to select the **Intro Playlist**
+1. Click **Save**.
+
+Now everytime an autoloading playlist is scheduled the system will select a
+random top of the hour ID and insert it before any other content. You can other
+content to the Intro Playlist to also have it scheduled before any shows with
+Autoloading Playlists enabled.

docs/manual/listen/index.md

@@ -0,0 +1,17 @@
+In the Master Panel, beneath the **ON AIR** indicator, you will find the **LISTEN** button.
+
+![](static/Screenshot358-Listen_button.png)
+
+This button opens a pop-up **Live stream** window, which enables you to monitor the streams that have been configured previously in the **Streams** page on the **System** menu. In the **Live stream** window, a drop-down menu enables you to switch between the streams which are currently available. Both the streaming server and name of the stream are shown. Your station logo is shown in the top left corner of the window, if you have uploaded one via the **Preferences** page on the **System** menu.
+
+![](static/Screenshot477-Live_stream_chooser.png)
+
+Beneath the drop-down menu for stream selection is an orange volume control bar. This volume control only adjusts the output level of the pop-up **Live Stream** window, not the output level of the LibreTime server itself. To adjust output level between muted and maximum, click on the corresponding place in the orange bar, with maximum level on the right side. Click on the left side speaker icon to mute the output. 
+
+![](static/Screenshot478-Live_stream_mute.png) 
+
+To display the URL of the stream you are monitoring, so that you can copy and paste it into an email or web page, click the **Share** button. Click the **X** icon to the right of the URL to return to the drop-down menu of available streams.
+
+![](static/Screenshot479-Live_stream_share.png)
+
+When you have finished monitoring the streams, you can close the pop-up window in the normal way, depending on the browser you are using. In Firefox, you can close the window by clicking the **X** button in the top right corner. This action will not shut down the output from the LibreTime server, only the stream monitoring on your desktop computer or laptop.

docs/manual/listener-stats/index.md

@@ -0,0 +1,13 @@
+The Listener Stats page on the Analytics menu shows graphs of listener connections to the configured streaming servers for the selected date and time range.  On the right side, a green **Status** indicator shows **OK** if the connection to the streaming server is active.
+
+![](static/Screenshot483-Listener_Stats.png)
+
+If the status indicator is red, check that the **Admin User** and **Admin Password** settings are correct under **Additional Options** for the named mount point, such as *libretime\_128*, on the **Streams** page of the **Settings** menu.
+
+By default, statistics for the last 24 hours of streaming are shown. To change this date and time range, click the calendar and clock icons in the lower left corner of the page, then click the magnifying glass icon.
+
+![](static/Screenshot484-Listener_Stats_date_range.png)
+
+To choose which particular streams should have statistics displayed, click the check boxes for the individual colour-coded mount points, just below the graph.
+
+![](static/Screenshot522-Select_stream_stats_240.png)