From fbf466da8e38c458f0a9be21b66026896e6687da Mon Sep 17 00:00:00 2001 From: Console and webGui login account Date: Thu, 28 Dec 2023 00:57:14 -1000 Subject: [PATCH 01/10] Slightly altered branch based on 303-Proxy that includes dockerization files for container deployments --- app.py | 45 +-- docker/Dockerfile | 20 ++ docker/LICENSE | 674 ++++++++++++++++++++++++++++++++++++++ docker/README.md | 127 +++++++ docker/docker-compose.yml | 18 + docker/entrypoint.sh | 22 ++ karaoke.py | 8 +- templates/splash.html | 43 ++- 8 files changed, 932 insertions(+), 25 deletions(-) create mode 100644 docker/Dockerfile create mode 100644 docker/LICENSE create mode 100644 docker/README.md create mode 100644 docker/docker-compose.yml create mode 100755 docker/entrypoint.sh diff --git a/app.py b/app.py index d62cd040..0b948e84 100644 --- a/app.py +++ b/app.py @@ -13,8 +13,9 @@ import cherrypy import flask_babel import psutil -from flask import (Flask, flash, make_response, redirect, render_template, - request, send_file, url_for) +import requests +from flask import (Flask, Response, flash, make_response, redirect, + render_template, request, send_file, url_for) from flask_babel import Babel from flask_paginate import Pagination, get_page_parameter from selenium import webdriver @@ -608,6 +609,27 @@ def expand_fs(): flash("You don't have permission to resize the filesystem", "is-danger") return redirect(url_for("home")) +# Proxy the video stream from ffmpeg to /stream/, so pikaraoke works over a single port +@app.route('/stream/', methods=["GET", "POST"]) +def redirect_to_ffmpeg_stream(path): #NOTE var :path will be unused as all path we need will be read from :request ie from flask import request + res = requests.request( # ref. https://stackoverflow.com/a/36601467/248616 + method = request.method, + url = request.url.replace(request.host_url, f'{k.ffmpeg_url_base}/'), + headers = {k:v for k,v in request.headers if k.lower() != 'host'}, # exclude 'host' header + data = request.get_data(), + cookies = request.cookies, + allow_redirects = False, + ) + + #region exlcude some keys in :res response + excluded_headers = ['content-encoding', 'content-length', 'transfer-encoding', 'connection'] #NOTE we here exclude all "hop-by-hop headers" defined by RFC 2616 section 13.5.1 ref. https://www.rfc-editor.org/rfc/rfc2616#section-13.5.1 + headers = [ + (k,v) for k,v in res.raw.headers.items() + if k.lower() not in excluded_headers + ] + #endregion exclude some keys in :res response + response = Response(res.content, res.status_code, headers) + return response # Handle sigterm, apparently cherrypy won't shut down without explicit handling signal.signal(signal.SIGTERM, lambda signum, stack_frame: k.stop()) @@ -616,24 +638,7 @@ def get_default_youtube_dl_path(platform): if platform == "windows": return os.path.join(os.path.dirname(__file__), ".venv\Scripts\yt-dlp.exe") return os.path.join(os.path.dirname(__file__), ".venv/bin/yt-dlp") - # if platform == "windows": - # choco_ytdl_path = r"C:\ProgramData\chocolatey\bin\yt-dlp.exe" - # scoop_ytdl_path = os.path.expanduser(r"~\scoop\shims\yt-dlp.exe") - # if os.path.isfile(choco_ytdl_path): - # return choco_ytdl_path - # if os.path.isfile(scoop_ytdl_path): - # return scoop_ytdl_path - # return r"C:\Program Files\yt-dlp\yt-dlp.exe" - # default_ytdl_unix_path = "/usr/local/bin/yt-dlp" - # if platform == "osx": - # if os.path.isfile(default_ytdl_unix_path): - # return default_ytdl_unix_path - # else: - # # just a guess based on the default python 3 install in OSX monterey - # return "/Library/Frameworks/Python.framework/Versions/3.10/bin/yt-dlp" - # else: - # return default_ytdl_unix_path - + def get_default_dl_dir(platform): if is_raspberry_pi: diff --git a/docker/Dockerfile b/docker/Dockerfile new file mode 100644 index 00000000..e6ef1fca --- /dev/null +++ b/docker/Dockerfile @@ -0,0 +1,20 @@ +# Use Alpine as the base image +FROM alpine:latest + +# Install required packages +RUN apk add --no-cache bash zsh git gcc python3-dev musl-dev linux-headers py3-pip ffmpeg htop screen figlet + +# Clone the pikaraoke repository +RUN git clone -b PiKaraoke-Docker https://github.com/vicwomg/pikaraoke.git /pikaraoke + +# Run the setup script +RUN cd /pikaraoke && echo y | bash setup.sh + +# Copy the entrypoint script into the container +COPY entrypoint.sh /entrypoint.sh + +# Set permissions for the entrypoint script +RUN chmod +x /entrypoint.sh + +# Set the entrypoint +ENTRYPOINT ["/entrypoint.sh"] diff --git a/docker/LICENSE b/docker/LICENSE new file mode 100644 index 00000000..f288702d --- /dev/null +++ b/docker/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. + +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 +. diff --git a/docker/README.md b/docker/README.md new file mode 100644 index 00000000..c7796f7a --- /dev/null +++ b/docker/README.md @@ -0,0 +1,127 @@ + +# Dockerized PiKaraoke + +PiKaraoke is a "KTV"-style karaoke song search and queueing system, originally designed to work on Raspberry Pi, OSX, Windows, and Linux. This repository contains a Dockerized version of PiKaraoke, built on an alpine base, making it easy to set up and run on any system with Docker support. + +The original project can be found here + +## Features + +The Dockerized version retains all the features of the original PiKaraoke, including: + +- Web interface for multiple users to queue tracks +- Player/splash screen with connection QR code and "Next up" display +- Searching/browsing a local song library +- Adding new songs from YouTube +- mp3 + cdg support, including compressed .zip bundles +- Pause/Skip/Restart and volume control +- Advanced editing of downloaded file names +- Queue management +- Key Change / Pitch shifting +- Lock down features with admin mode + +(Refer to the original PiKaraoke features for more details.) + +--- + +## Support the Original Project + +If you want to support the original PiKaraoke project with a monetary tip, it's much appreciated by the original developer: + +[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/vicwomg) + +--- + + +## Running Dockerized PiKaraoke + +### Prerequisites + +- Docker and Docker Compose installed on your system + +### Installation and Launch + + +## Using Docker Compose Command Line + +1. **Clone the Repository**: + First, clone the repository from GitHub to get the `docker-compose.yml` file and any other necessary configurations: + ```bash + git clone https://github.com/honestlai/pikaraoke-docker.git + cd pikaraoke-docker + ``` + +2. **Running the Container**: + Use Docker Compose to pull the image from Docker Hub and start the container in detached mode: + ```bash + docker-compose up -d + ``` + +## Using Portainer + +1. **Access Portainer**: + Open Portainer and navigate to the 'Stacks' section in the left sidebar. + +2. **Add a New Stack**: + Click on '+ Add stack'. Enter a name for the stack in the 'Name' field. + +3. **Compose File**: + Clone the repository from GitHub or copy the contents of the `docker-compose.yml` file into the 'Web editor'. The repository can be cloned using: + ```bash + git clone https://github.com/honestlai/pikaraoke-docker.git + ``` + +4. **Environment Variables**: + Below the web editor, use the 'Add an environment variable' button to add necessary environment variables. The primary variables you might need are: + - `URL`: The URL for the pikaraoke service. + - `PASSWORD`: The admin password for pikaraoke (optional). + +5. **Deploy the Stack**: + After setting up your compose file and environment variables, click on 'Deploy the stack'. Portainer will pull the image from Docker Hub and start the container based on your configurations. + +## Building the container locally + +1. **Clone this Dockerized repository:** + + ```bash + git clone https://github.com/honestlai/pikaraoke-docker.git + cd pikaraoke-docker + ``` + +2. **Build and run the Docker container:** + + ```bash + docker-compose up --build + ``` + + This command builds the Docker image and starts the PiKaraoke server. + +3. **Accessing PiKaraoke:** + + After the container is up and running, PiKaraoke will be accessible at `http://localhost:8888`. You can connect to this address from any device on the same network to access the PiKaraoke web interface. + +### Customizing Your Setup + +- Configuration options can be adjusted through environment variables in the `docker-compose.yml` file. +- Songs are stored within a docker volume, and you can manage this storage as per your requirements. + +--- + +## Screenshots + +### TV + +

+ pikaraoke-tv1 +pikaraoke-tv2 +

+ +### Web interface + +
+pikaraoke-nowplaying +pikaraoke-queue +pikaraoke-browse +pikaraoke-search1 +pikaraoke-search2 +
diff --git a/docker/docker-compose.yml b/docker/docker-compose.yml new file mode 100644 index 00000000..7bd5e174 --- /dev/null +++ b/docker/docker-compose.yml @@ -0,0 +1,18 @@ +version: '3' + +services: + pikaraoke: + image: honestlai/pikaraoke-docker:latest + container_name: PiKaraoke + volumes: + - pikaraoke-songs:/pikaraoke-songs + environment: + URL: #https://karaoke.yourdomain.com + PASSWORD: #optionalpassword + restart: unless-stopped + ports: + - "5555:5555" + +volumes: + pikaraoke-songs: + # Define your volume specifics here, if any. diff --git a/docker/entrypoint.sh b/docker/entrypoint.sh new file mode 100755 index 00000000..7319bade --- /dev/null +++ b/docker/entrypoint.sh @@ -0,0 +1,22 @@ +#!/bin/sh + +# Correcting the URL format +URL=$(echo "$URL" | sed 's|/$||') # Remove trailing slash if exists +if ! echo "$URL" | grep -q "^https://"; then + URL="https://$URL" # Add https:// if not present +fi + +# Exporting the corrected URL +export URL + +# Run pikaraoke with environment variables +if [ -z "$PASSWORD" ]; then + figlet PiKaraoke + /pikaraoke/pikaraoke.sh -d /pikaraoke-songs/ --headless -u $URL +else + figlet PiKaraoke + /pikaraoke/pikaraoke.sh -d /pikaraoke-songs/ --headless -u $URL --admin-password $PASSWORD +fi + +# Keep the container running +tail -f /dev/null diff --git a/karaoke.py b/karaoke.py index 85dfc454..9bae1a6f 100644 --- a/karaoke.py +++ b/karaoke.py @@ -81,6 +81,7 @@ def __init__( # override with supplied constructor args if provided self.port = port self.ffmpeg_port = ffmpeg_port + self.ffmpeg_url_base = f"http://0.0.0.0:{self.ffmpeg_port}" self.hide_url = hide_url self.hide_raspiwifi_instructions = hide_raspiwifi_instructions self.hide_splash_screen = hide_splash_screen @@ -360,9 +361,10 @@ def get_youtube_id_from_url(self, url): def play_file(self, file_path, semitones=0): logging.info(f"Playing file: {file_path} transposed {semitones} semitones") stream_uid = int(time.time()) - stream_url = f"{self.url_parsed.scheme}://{self.url_parsed.hostname}:{self.ffmpeg_port}/{stream_uid}" - # pass a 0.0.0.0 IP to ffmpeg which will work for both hostnames and direct IP access - ffmpeg_url = f"http://0.0.0.0:{self.ffmpeg_port}/{stream_uid}" + # This is the stream URL that will be accessed by the splash screen client, Flask will + stream_url = f"{self.url}/stream/{stream_uid}" + # Used by ffmpeg, pass a 0.0.0.0 IP to ffmpeg which will work for both hostnames and direct IP access + ffmpeg_url = f"{self.ffmpeg_url_base}/{stream_uid}" pitch = 2**(semitones/12) #The pitch value is (2^x/12), where x represents the number of semitones diff --git a/templates/splash.html b/templates/splash.html index d9cbf786..6fab643c 100644 --- a/templates/splash.html +++ b/templates/splash.html @@ -265,6 +265,27 @@ } }); }); + + // Script for forcing browser to go full screen + function handleConfirmation() { + $("#permissions-modal").removeClass("is-active"); + confirmationDismissed = true; + goFullScreen(); + } + + function goFullScreen() { + var elem = document.documentElement; // Get the document's root element + if (elem.requestFullscreen) { + elem.requestFullscreen(); + } else if (elem.mozRequestFullScreen) { /* Firefox */ + elem.mozRequestFullScreen(); + } else if (elem.webkitRequestFullscreen) { /* Chrome, Safari & Opera */ + elem.webkitRequestFullscreen(); + } else if (elem.msRequestFullscreen) { /* IE/Edge */ + elem.msRequestFullscreen(); + } + } + {% endblock %} {% block body %} @@ -389,16 +410,25 @@ body { background-color: black; } + .backdrop-blur { + -webkit-backdrop-filter: blur(10px); /* For Safari */ + backdrop-filter: blur(10px); /* Standard syntax */ + } + #now-playing, #qr-code, #up-next { + background-color: rgba(100, 100, 100, 0.3); + -webkit-backdrop-filter: blur(6px); /* For Safari */ + backdrop-filter: blur(6px); /* Standard syntax */ + } + #top-container, #bottom-container { position: absolute; z-index: 1; - padding: 10px 20px; } #top-container { top: 0px; right: 0px; - max-width: 75%; + max-width: 75%; } #bottom-container { bottom: 0px; @@ -408,11 +438,20 @@ justify-content: space-between; align-items: flex-end; } + #now-playing { + padding: 10px 20px 10px 20px; + border-bottom-left-radius: 20px; + } #qr-code { max-width: 25%; + border-top-right-radius: 20px; /* Rounded corner */ + text-align: center; /* Center QR code */ + padding: 20px; } #up-next { max-width: 75%; + border-top-left-radius: 20px; /* Rounded corner */ + padding: 10px 20px 10px 20px; } .video-container { position: absolute; From 356d5b765be240abf704b489b59430fdf22f3fd2 Mon Sep 17 00:00:00 2001 From: Console and webGui login account Date: Fri, 29 Dec 2023 00:42:28 -1000 Subject: [PATCH 02/10] Added a new fullscreen button and menu background for the nav button area, also updated the docker readme --- docker/README.md | 110 ++++++--------------------------- templates/splash.html | 139 +++++++++++++++++++++++++++++++----------- 2 files changed, 124 insertions(+), 125 deletions(-) diff --git a/docker/README.md b/docker/README.md index c7796f7a..35a0ad70 100644 --- a/docker/README.md +++ b/docker/README.md @@ -3,125 +3,55 @@ PiKaraoke is a "KTV"-style karaoke song search and queueing system, originally designed to work on Raspberry Pi, OSX, Windows, and Linux. This repository contains a Dockerized version of PiKaraoke, built on an alpine base, making it easy to set up and run on any system with Docker support. -The original project can be found here - ## Features -The Dockerized version retains all the features of the original PiKaraoke, including: - -- Web interface for multiple users to queue tracks -- Player/splash screen with connection QR code and "Next up" display -- Searching/browsing a local song library -- Adding new songs from YouTube -- mp3 + cdg support, including compressed .zip bundles -- Pause/Skip/Restart and volume control -- Advanced editing of downloaded file names -- Queue management -- Key Change / Pitch shifting -- Lock down features with admin mode - -(Refer to the original PiKaraoke features for more details.) - ---- - -## Support the Original Project - -If you want to support the original PiKaraoke project with a monetary tip, it's much appreciated by the original developer: - -[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/vicwomg) +- The Dockerized version retains all features of the original PiKaraoke. +- Easy to set up and run on any system with Docker support. +- Automatically exposes on port 5555. +- URL is required for reverse proxy setup with either http:// or https://. +- The PASSWORD variable is optional. ---- - - -## Running Dockerized PiKaraoke - -### Prerequisites +## Prerequisites -- Docker and Docker Compose installed on your system +- Docker and Docker Compose installed on your system. +- A reverse proxy like nginx is very helpful but not required. -### Installation and Launch +## Installation and Launch - -## Using Docker Compose Command Line +### Using Docker Compose Command Line 1. **Clone the Repository**: - First, clone the repository from GitHub to get the `docker-compose.yml` file and any other necessary configurations: ```bash git clone https://github.com/honestlai/pikaraoke-docker.git cd pikaraoke-docker ``` 2. **Running the Container**: - Use Docker Compose to pull the image from Docker Hub and start the container in detached mode: ```bash docker-compose up -d ``` -## Using Portainer +### Using Portainer -1. **Access Portainer**: - Open Portainer and navigate to the 'Stacks' section in the left sidebar. +1. **Access Portainer**: Navigate to the 'Stacks' section. +2. **Add a New Stack**: Click on '+ Add stack'. +3. **Compose File**: Clone the repository or copy the `docker-compose.yml` content. +4. **Environment Variables**: Add necessary variables like `URL` and `PASSWORD`. +5. **Deploy the Stack**: Click on 'Deploy the stack'. -2. **Add a New Stack**: - Click on '+ Add stack'. Enter a name for the stack in the 'Name' field. - -3. **Compose File**: - Clone the repository from GitHub or copy the contents of the `docker-compose.yml` file into the 'Web editor'. The repository can be cloned using: - ```bash - git clone https://github.com/honestlai/pikaraoke-docker.git - ``` - -4. **Environment Variables**: - Below the web editor, use the 'Add an environment variable' button to add necessary environment variables. The primary variables you might need are: - - `URL`: The URL for the pikaraoke service. - - `PASSWORD`: The admin password for pikaraoke (optional). - -5. **Deploy the Stack**: - After setting up your compose file and environment variables, click on 'Deploy the stack'. Portainer will pull the image from Docker Hub and start the container based on your configurations. - -## Building the container locally - -1. **Clone this Dockerized repository:** +### Building the Container Locally +1. **Clone this Dockerized repository**: ```bash git clone https://github.com/honestlai/pikaraoke-docker.git cd pikaraoke-docker ``` -2. **Build and run the Docker container:** - +2. **Build and Run the Docker Container**: ```bash docker-compose up --build ``` - This command builds the Docker image and starts the PiKaraoke server. - -3. **Accessing PiKaraoke:** - - After the container is up and running, PiKaraoke will be accessible at `http://localhost:8888`. You can connect to this address from any device on the same network to access the PiKaraoke web interface. - -### Customizing Your Setup - -- Configuration options can be adjusted through environment variables in the `docker-compose.yml` file. -- Songs are stored within a docker volume, and you can manage this storage as per your requirements. - --- -## Screenshots - -### TV - -

- pikaraoke-tv1 -pikaraoke-tv2 -

- -### Web interface - -
-pikaraoke-nowplaying -pikaraoke-queue -pikaraoke-browse -pikaraoke-search1 -pikaraoke-search2 -
+For more details on the project and additional features, please visit the [main repository page](https://github.com/vicwomg/pikaraoke). diff --git a/templates/splash.html b/templates/splash.html index 6fab643c..905e630f 100644 --- a/templates/splash.html +++ b/templates/splash.html @@ -215,18 +215,35 @@ cursorVisible = true; } if (!menuButtonVisible) { - $("#menu a").addClass("visible").removeClass("hidden"); + $("#menubg").addClass("visible").removeClass("hidden"); menuButtonVisible = true; } mouseTimer = window.setTimeout(() => { mouseTimer = null; document.body.style.cursor = "none"; cursorVisible = false; - $("#menu a").addClass("hidden").removeClass("visible"); + $("#menubg").addClass("hidden").removeClass("visible"); menuButtonVisible = false; }, 5000); + }; + function toggleFullscreen() { + const expandIcon = document.querySelector('#fullscreen-button svg:nth-child(1)'); + const shrinkIcon = document.querySelector('#fullscreen-button svg:nth-child(2)'); + if (!document.fullscreenElement) { + document.documentElement.requestFullscreen(); + expandIcon.style.display = 'none'; + shrinkIcon.style.display = 'block'; + } else { + document.exitFullscreen(); + expandIcon.style.display = 'block'; + shrinkIcon.style.display = 'none'; + } + } + document.getElementById('fullscreen-button').addEventListener("click", toggleFullscreen); + + //Video status events for communicating state back to server $("#video")[0].addEventListener("play", () => { $("#video-container").show(); @@ -251,40 +268,31 @@ true ); + // Set the iframe source initially if not set + let menuIframe = $("#menu-container iframe"); + if (menuIframe.attr("src") === "") { + menuIframe.attr("src", `${window.location.protocol}//${window.location.host}`); + } + //open menu iframe $("#menu a").click(function () { if (showMenu) { $("#menu-container").hide(); - $("#menu-container iframe").attr("src", ""); showMenu = false; } else { setUserCookie(); $("#menu-container").show(); - $("#menu-container iframe").attr("src", url); showMenu = true; } }); }); - // Script for forcing browser to go full screen + function handleConfirmation() { - $("#permissions-modal").removeClass("is-active"); - confirmationDismissed = true; - goFullScreen(); - } + $("#permissions-modal").removeClass("is-active"); + confirmationDismissed = true; +} - function goFullScreen() { - var elem = document.documentElement; // Get the document's root element - if (elem.requestFullscreen) { - elem.requestFullscreen(); - } else if (elem.mozRequestFullScreen) { /* Firefox */ - elem.mozRequestFullScreen(); - } else if (elem.webkitRequestFullscreen) { /* Chrome, Safari & Opera */ - elem.webkitRequestFullscreen(); - } else if (elem.msRequestFullscreen) { /* IE/Edge */ - elem.msRequestFullscreen(); - } - } {% endblock %} {% block body %} @@ -371,20 +379,35 @@ -