From 764e1a89ab9313fc99e32e47e683161a0e756d15 Mon Sep 17 00:00:00 2001 From: Eric Hough Date: Tue, 3 Apr 2018 17:01:03 -0700 Subject: [PATCH] initial commit --- .gitignore | 1 + LICENSE | 674 +++++++++++++++++++++++++++++++++++ README.md | 95 +++++ docker-kodi.sh | 356 ++++++++++++++++++ docker/alsa/Dockerfile | 30 ++ docker/base/Dockerfile | 45 +++ docker/base/entrypoint.sh | 108 ++++++ docker/pulseaudio/Dockerfile | 30 ++ 8 files changed, 1339 insertions(+) create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 README.md create mode 100755 docker-kodi.sh create mode 100644 docker/alsa/Dockerfile create mode 100644 docker/base/Dockerfile create mode 100644 docker/base/entrypoint.sh create mode 100644 docker/pulseaudio/Dockerfile diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..85e7c1d --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/.idea/ diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..9bcb1b4 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + 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. + + TERMS AND CONDITIONS + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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. + + 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 + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details.x + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..6069be2 --- /dev/null +++ b/README.md @@ -0,0 +1,95 @@ +# ehough/docker-kodi + +Dockerized Kodi with audio and video. + +![Kodi screenshot](https://kodi.wiki/images/3/33/Estuary-home.jpg "Kodi screenshot") + +## Why? + +This is the only setup that offers a fully-functional, Dockerized Kodi installation complete with audio and video. + +This project is in an early stage of development, but has been operating on the author's HTPC for a long time without issue. Contributions and suggestions are welcome. + +## Features + +* video and audio via [x11docker](https://github.com/mviereck/x11docker/) +* optional hardware video acceleration +* sound via ALSA or PulseAudio +* simple, Ubuntu-based image that adheres to the [official Kodi installation instructions](https://kodi.wiki/view/HOW-TO:Install_Kodi_for_Linux#Installing_Kodi_on_Ubuntu-based_distributions) +* clean shutdown of Kodi when its container is terminated + +## Host Requirements + +The Docker **host** will need the following: + +1. **Linux** + + Though not extensively tested yet, this project should work on any Linux distribution. Windows support is not yet implemented. + +1. **A connected display & speakers** + +## Installation + +Installation is easy. + +1. **Install [x11docker](https://github.com/mviereck/x11docker/)** + + `x11docker` allows Docker-based applications to utilize X and/or Wayland. Please follow the `x11docker` [installation instructions](https://github.com/mviereck/x11docker#installation) and ensure that you have a [working setup](https://github.com/mviereck/x11docker#examples). + +1. **Install [X](https://www.x.org/) or [Wayland](https://wayland.freedesktop.org/)** + + Ensure that the packages for an X or Wayland server are installed. Please consult your OS's documentation if you're not sure what to install. A display server does *not* need to be running ahead of time. + +1. **Clone this repo to your Docker host** + + $ git clone https://github.com/ehough/docker-kodi + + The exact location of your clone doesn't matter. + +## Usage + +`docker-kodi.sh` is the script that you will use to cleanly start and stop Kodi. It's a simple wrapper around `x11docker` and the Docker CLI. + + Usage: docker-kodi.sh [-a|--action ] [-i|--image ] [-h|--help] [-v|--verbose] [--] [] ... [] ... + : arguments to pass to x11docker + -a,--action: action to perform (start, stop, or status (default: 'start') + -i,--image: image name or identifier to execute (default: 'ehough/kodi:alsa') + -h,--help: Prints help + -v,--verbose: Set verbose output (can be specified multiple times to increase the effect) + +### Starting Kodi + +To start Kodi, invoke `docker-kodi.sh` with your desired image variant (`ehough/kodi:alsa` or `ehough/kodi:pulseaudio`) and arguments to `x11docker`. Arguments following the first `--` delimeter (if present) are passed directly to `x11docker`. +This gives you tremendous flexibility in configuring your environment. + +e.g. for ALSA sound, no window manager, a new Xorg X server on virtual terminal 7, hardware video acceleration, a persistent Kodi home directory, and a shared read-only Docker volume for Kodi media: + + $ /path/to/docker-kodi.sh --image ehough/kodi:alsa \ + -- \ + --wm none \ + --xorg \ + --gpu \ + --alsa \ + --homedir /host/path/to/kodi/home \ + --vt 7 \ + -- \ + -v /host/path/to/media:/media:ro + +Detailing the myriad of `x11docker` options is beyond the scope of this document. Please consult the [`x11docker` documentation](https://github.com/mviereck/x11docker/) to find the set of options that work for your system. + +### Stopping Kodi + +Either `Ctrl-C` the running `docker-kodi.sh` process or call: + + $ docker-kodi.sh --action stop + +Under the hood, this will call `docker stop` on the Kodi container, which allows Kodi to shut itself down properly. + +## Contributing + +Contributions are welcome! Please submit an issue or pull request. + +## Future Work + +* Windows support +* Kodi PVR support diff --git a/docker-kodi.sh b/docker-kodi.sh new file mode 100755 index 0000000..27fed3c --- /dev/null +++ b/docker-kodi.sh @@ -0,0 +1,356 @@ +#!/bin/bash + +########################################################################## +# +# ehough/docker-kodi - Kodi in a Docker container +# +# https://github.com/ehough/docker-kodi +# +# Copyright 2018 - Eric Hough (eric@tubepress.com) +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program 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 program. If not, see . +# +########################################################################## + + +########################################################################## +# This script runs on the Docker host, and is a wrapper around the Docker +# CLI and x11docker. Its primary purpose is to provide a means to cleanly +# stop the running Kodi container, which will in turn stop the parent +# x11docker process. +########################################################################## + + +########################################################################################################### +########################################################################################################### +## START ARGBASH CODE ##################################################################################### +########################################################################################################### +########################################################################################################### + +# +# ARG_OPTIONAL_SINGLE([action],[a],[action to perform (start, stop, or status],[start]) +# ARG_HELP([]) +# ARG_VERBOSE([v]) +# ARG_POSITIONAL_DOUBLEDASH([]) +# ARG_POSITIONAL_INF([x11docker-argument],[arguments to pass to x11docker]) +# ARGBASH_GO() +# needed because of Argbash --> m4_ignore([ +### START OF CODE GENERATED BY Argbash v2.6.1 one line above ### +# Argbash is a bash code generator used to get arguments parsing right. +# Argbash is FREE SOFTWARE, see https://argbash.io for more info +# Generated online by https://argbash.io/generate + +# When called, the process ends. +# Args: +# $1: The exit message (print to stderr) +# $2: The exit code (default is 1) +# if env var _PRINT_HELP is set to 'yes', the usage is print to stderr (prior to ) +argbash_die () { + + local _ret=$2 + test -n "$_ret" || _ret=1 + test "$_PRINT_HELP" = yes && argbash_print_help >&2 + echo "$1" >&2 + exit ${_ret} +} + +# Function that evaluates whether a value passed to it begins by a character +# that is a short option of an argument the script knows about. +# This is required in order to support getopts-like short options grouping. +argbash_begins_with_short_option() { + + local first_option all_short_options + all_short_options='ahv' + first_option="${1:0:1}" + test "$all_short_options" = "${all_short_options/$first_option/}" && return 1 || return 0 +} + +# THE DEFAULTS INITIALIZATION - POSITIONALS +# The positional args array has to be reset before the parsing, because it may already be defined +# - for example if this script is sourced by an argbash-powered script. +_positionals=() +_arg_x11docker_argument=() +# THE DEFAULTS INITIALIZATION - OPTIONALS +_arg_action="start" +_arg_image="ehough/kodi:alsa" +_arg_verbose=0 + +# Function that prints general usage of the script. +# This is useful if users asks for it, or if there is an argument parsing error (unexpected / spurious arguments) +# and it makes sense to remind the user how the script is supposed to be called. +argbash_print_help () { + + printf 'Usage: %s [-a|--action ] [-i|--image ] [-h|--help] [-v|--verbose] [--] [] ... [] ...\n' "$0" + printf '\t%s\n' ": arguments to pass to x11docker" + printf '\t%s\n' "-a,--action: action to perform (start, stop, or status (default: 'start')" + printf '\t%s\n' "-i,--image: image name or identifier to execute (default: 'ehough/kodi:alsa')" + printf '\t%s\n' "-h,--help: Prints help" + printf '\t%s\n' "-v,--verbose: Set verbose output (can be specified multiple times to increase the effect)" +} + +# The parsing of the command-line +argbash_parse_commandline () { + + while test $# -gt 0 + do + _key="$1" + # If two dashes (i.e. '--') were passed on the command-line, + # assign the rest of arguments as positional arguments and bail out. + if test "$_key" = '--' + then + shift + _positionals+=("$@") + break + fi + case "$_key" in + # We support whitespace as a delimiter between option argument and its value. + # Therefore, we expect the --action or -a value. + # so we watch for --action and -a. + # Since we know that we got the long or short option, + # we just reach out for the next argument to get the value. + -a|--action) + test $# -lt 2 && argbash_die "Missing value for the optional argument '$_key'." 1 + _arg_action="$2" + shift + ;; + # We support the = as a delimiter between option argument and its value. + # Therefore, we expect --action=value, so we watch for --action=* + # For whatever we get, we strip '--action=' using the ${var##--action=} notation + # to get the argument value + --action=*) + _arg_action="${_key##--action=}" + ;; + # We support getopts-style short arguments grouping, + # so as -a accepts value, we allow it to be appended to it, so we watch for -a* + # and we strip the leading -a from the argument string using the ${var##-a} notation. + -a*) + _arg_action="${_key##-a}" + ;; + # See the comment of option '--action' to see what's going on here - principle is the same. + -i|--image) + test $# -lt 2 && die "Missing value for the optional argument '$_key'." 1 + _arg_image="$2" + shift + ;; + # See the comment of option '--action=' to see what's going on here - principle is the same. + --image=*) + _arg_image="${_key##--image=}" + ;; + # See the comment of option '-a' to see what's going on here - principle is the same. + -i*) + _arg_image="${_key##-i}" + ;; + # The help argurment doesn't accept a value, + # we expect the --help or -h, so we watch for them. + -h|--help) + argbash_print_help + exit 0 + ;; + # We support getopts-style short arguments clustering, + # so as -h doesn't accept value, other short options may be appended to it, so we watch for -h*. + # After stripping the leading -h from the argument, we have to make sure + # that the first character that follows coresponds to a short option. + -h*) + argbash_print_help + exit 0 + ;; + # See the comment of option '--help' to see what's going on here - principle is the same. + -v|--verbose) + _arg_verbose=$((_arg_verbose + 1)) + ;; + # See the comment of option '-h' to see what's going on here - principle is the same. + -v*) + _arg_verbose=$((_arg_verbose + 1)) + _next="${_key##-v}" + if test -n "$_next" -a "$_next" != "$_key" + then + argbash_begins_with_short_option "$_next" && shift && set -- "-v" "-${_next}" "$@" || argbash_die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option." + fi + ;; + *) + _positionals+=("$1") + ;; + esac + shift + done +} + +# Take arguments that we have received, and save them in variables of given names. +# The 'eval' command is needed as the name of target variable is saved into another variable. +argbash_assign_positional_args () { + + # We have an array of variables to which we want to save positional args values. + # This array is able to hold array elements as targets. + _positional_names=() + # If we allow up to infinitely many args, we calculate how many of values + # were actually passed, and we extend the target array accordingly. + _our_args=$((${#_positionals[@]} - ${#_positional_names[@]})) + for ((ii = 0; ii < _our_args; ii++)) + do + _positional_names+=("_arg_x11docker_argument[$((ii + 0))]") + done + + for (( ii = 0; ii < ${#_positionals[@]}; ii++)) + do + eval "${_positional_names[ii]}=\${_positionals[ii]}" || argbash_die "Error during argument parsing, possibly an Argbash bug." 1 + done +} + +# Now call all the functions defined above that are needed to get the job done +argbash_parse_commandline "$@" +argbash_assign_positional_args + +unset -v ii _positionals _positional_names _our_args _key + +########################################################################################################### +########################################################################################################### +## END ARGBASH CODE ####################################################################################### +########################################################################################################### +########################################################################################################### + +log () { + + if [[ $_arg_verbose -ge 1 ]]; then + echo "---> $1" + fi +} + +bail () { + + echo "" + echo "FATAL ERROR: $1" + echo "" + exit 1 +} + +warn_on_failure () { + + if [[ $? -ne 0 ]]; then + log "WARNING: $1" + fi +} + +bail_on_failure () { + + if [[ $? -ne 0 ]]; then + bail "$1" + fi +} + +ensure_executable () { + + log "ensuring that $1 is executable" + + local command_result + command_result=$(command -v "$1") + + if [[ ! -x "$command_result" ]]; then + bail "$1 is missing or not executable" + else + log "$1 is executable at $command_result" + fi +} + +find_running_container_id () { + + log "asking Docker for a running Kodi container" + docker ps --filter "name=x11docker_" --filter "name=kodi" --filter "status=running" -q --last 1 + bail_on_failure "unable to query Docker for Kodi container status" +} + +stop_kodi () { + + log "stopping $_arg_image" + + local container_id + container_id=$(find_running_container_id) + + if [[ -n "$container_id" ]]; then + docker stop "$container_id" + bail_on_failure "Docker returned an error when we tried to stop $container_id" + else + log "$_arg_image did not appear to be running" + fi +} + +start_kodi () { + + log "starting $_arg_image" + + ensure_executable 'x11docker' + + local command + local i + command='x11docker' + + if [[ $_arg_verbose -ge 1 ]]; then + command="$command -v" + fi + + for i in "${_arg_x11docker_argument[@]}"; do + command="$command $i" + done + + command="$command $_arg_image" + + # gracefully stop Kodi whenever this script is terminated for any reason + trap stop_kodi EXIT + + log "will now execute: $command" + + # this is where x11docker will take over + "$command" + + # x11docker finished + warn_on_failure "command did not exit cleanly: $command" +} + +status_kodi () { + + log "checking to see if $_arg_image is running" + + local container_id + container_id=$(find_running_container_id) + + if [[ -n "$container_id" ]]; then + echo "$_arg_image appears to be running in container $container_id" + else + echo "$_arg_image does not appear to be running" + fi +} + +go () { + + case "$_arg_action" in + start|stop|status) + ;; + *) + argbash_print_help + exit 1 + esac + + case "$_arg_action" in + start) + start_kodi + ;; + stop) + stop_kodi + ;; + status) + status_kodi + ;; + esac +} + +go \ No newline at end of file diff --git a/docker/alsa/Dockerfile b/docker/alsa/Dockerfile new file mode 100644 index 0000000..80eb590 --- /dev/null +++ b/docker/alsa/Dockerfile @@ -0,0 +1,30 @@ +########################################################################## +# +# ehough/docker-kodi - Kodi in a Docker container (ALSA sound) +# +# https://github.com/ehough/docker-kodi +# +# Copyright 2018 - Eric Hough (eric@tubepress.com) +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program 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 program. If not, see . +# +########################################################################## + +FROM ehough/kodi:xenial + +# install ALSA +RUN apt-get update && \ + apt-get install -y --no-install-recommends libasound2 && \ + apt-get -y --purge autoremove && \ + rm -rf /var/lib/apt/lists/* diff --git a/docker/base/Dockerfile b/docker/base/Dockerfile new file mode 100644 index 0000000..0c7e152 --- /dev/null +++ b/docker/base/Dockerfile @@ -0,0 +1,45 @@ +########################################################################## +# +# ehough/docker-kodi - Kodi in a Docker container +# +# https://github.com/ehough/docker-kodi +# +# Copyright 2018 - Eric Hough (eric@tubepress.com) +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program 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 program. If not, see . +# +########################################################################## + +FROM ubuntu:xenial + +# install the team-xbmc ppa +RUN apt-get update && \ + apt-get install -y --no-install-recommends software-properties-common && \ + add-apt-repository ppa:team-xbmc/ppa && \ + apt-get -y purge software-properties-common && \ + apt-get -y --purge autoremove && \ + rm -rf /var/lib/apt/lists/* + +# install packages +RUN packages="kodi kodi-eventclients-xbmc-send ca-certificates" && \ + apt-get update && \ + apt-get install -y --no-install-recommends $packages && \ + apt-get -y --purge autoremove && \ + rm -rf /var/lib/apt/lists/* + +# setup entry point +ADD entrypoint.sh /usr/local/bin +RUN chmod +x /usr/local/bin/entrypoint.sh + +ENTRYPOINT ["/usr/local/bin/entrypoint.sh"] \ No newline at end of file diff --git a/docker/base/entrypoint.sh b/docker/base/entrypoint.sh new file mode 100644 index 0000000..f458f5b --- /dev/null +++ b/docker/base/entrypoint.sh @@ -0,0 +1,108 @@ +#!/bin/bash + +########################################################################## +# +# ehough/docker-kodi - Kodi in a Docker container +# +# https://github.com/ehough/docker-kodi +# +# Copyright 2018 - Eric Hough (eric@tubepress.com) +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program 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 program. If not, see . +# +########################################################################## + + +########################################################################## +# This script is the entrypoint for the Kodi container and has two jobs: +# +# 1. start Kodi by calling kodi-standalone (configurable via environment +# variable KODI_COMMAND). +# +# 2. cleanly stop Kodi when the container terminates, waiting up to 10 +# seconds (configurable via environment variable KODI_QUIT_TIMEOUT) +# before itself exiting. +# +########################################################################## + + +readonly ENV_VAR_KODI_COMMAND="KODI_COMMAND" +readonly ENV_VAR_KODI_QUIT_TIMEOUT="KODI_QUIT_TIMEOUT" + +log () { + + echo "---> $1" +} + +get_sound_package () { + + for package in libasound2, pulseaudio; do + + if [[ "$(dpkg -L $package) 2&> /dev/null)" -eq 0 ]]; then + echo "$package" + break + fi + done +} + +stop_kodi () { + + if [[ -z $(pidof kodi.bin) ]]; then + log "Kodi did not appear to be running" + exit 0 + fi + + local timer + local remaining + local -r timeout="${!ENV_VAR_KODI_QUIT_TIMEOUT:-10}" + timer=0 + + log "asking Kodi to quit" + kodi-send --action="Quit" + + while [[ $timer -lt $timeout && -n $(pidof kodi.bin) ]]; do + + remaining=$((timeout - timer)) + + log "waiting for Kodi to terminate ($remaining seconds until timeout)" + sleep 1 + timer=$((timer+1)) + done + + if [[ -z $(pidof kodi.bin) ]]; then + log 'Kodi terminated successfully' + exit 0 + fi + + log 'WARNING: timeout reached' +} + +start_kodi () { + + local -r command="${!ENV_VAR_KODI_COMMAND:-kodi-standalone}" + + if [[ -z $(get_sound_package) ]]; then + log "FATAL ERROR: libasound2 or pulseaudio is required to run Kodi" + exit 1 + fi + + # gracefully stop Kodi whenever this script is terminated for any reason + trap stop_kodi EXIT + + log "starting Kodi with command: $command" + + "$command" +} + +start_kodi \ No newline at end of file diff --git a/docker/pulseaudio/Dockerfile b/docker/pulseaudio/Dockerfile new file mode 100644 index 0000000..bd2bc33 --- /dev/null +++ b/docker/pulseaudio/Dockerfile @@ -0,0 +1,30 @@ +########################################################################## +# +# ehough/docker-kodi - Kodi in a Docker container (PulseAudio sound) +# +# https://github.com/ehough/docker-kodi +# +# Copyright 2018 - Eric Hough (eric@tubepress.com) +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. + +# This program 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 program. If not, see . +# +########################################################################## + +FROM ehough/kodi:xenial + +# install PulseAudio +RUN apt-get update && \ + apt-get install -y --no-install-recommends pulseaudio && \ + apt-get -y --purge autoremove && \ + rm -rf /var/lib/apt/lists/* \ No newline at end of file