From d379c8d2cd4db9ac93b2b73b987b19afa1a08336 Mon Sep 17 00:00:00 2001 From: "Markus F.J. Busche" Date: Sat, 20 Sep 2025 14:57:43 +0200 Subject: [PATCH] Fix UI elements not showing and zip installation issues. - Corrected template wrapper div with proper ID - Fixed custom_bindings configuration to enable Knockout.js data binding - Updated BUILDING.md with proper zip creation process - Bumped version to 0.1.1 - All tests passing --- octoprint_tailscale_funnel/BUILDING.md | 37 +- octoprint_tailscale_funnel/LICENSE | 661 ++++++++++++++++++ octoprint_tailscale_funnel/MANIFEST.in | 7 +- octoprint_tailscale_funnel/README.md | 52 ++ .../octoprint_tailscale_funnel/__init__.py | 230 ++++++ .../status_monitor.py | 74 ++ .../tailscale_interface.py | 161 +++++ octoprint_tailscale_funnel/setup.py | 4 +- .../static/js/tailscale_funnel.js | 2 +- .../tailscale_funnel_settings.jinja2 | 2 + .../tests/test_plugin.py | 17 +- 11 files changed, 1219 insertions(+), 28 deletions(-) create mode 100644 octoprint_tailscale_funnel/LICENSE create mode 100644 octoprint_tailscale_funnel/README.md create mode 100644 octoprint_tailscale_funnel/octoprint_tailscale_funnel/__init__.py create mode 100644 octoprint_tailscale_funnel/octoprint_tailscale_funnel/status_monitor.py create mode 100644 octoprint_tailscale_funnel/octoprint_tailscale_funnel/tailscale_interface.py diff --git a/octoprint_tailscale_funnel/BUILDING.md b/octoprint_tailscale_funnel/BUILDING.md index 920f657..a3d4ebf 100644 --- a/octoprint_tailscale_funnel/BUILDING.md +++ b/octoprint_tailscale_funnel/BUILDING.md @@ -27,7 +27,7 @@ It's recommended to use a virtual environment to isolate the build dependencies: ```bash python3 -m venv venv -source venv/bin/activate # On Windows: venv\Scripts\activate +source venv/bin/activate # On Windows: venv\Scripts\activate.bat ``` ### 3. Install Build Dependencies @@ -53,10 +53,23 @@ This will create distribution files in the `dist/` directory: ### 5. Create OctoPrint-Compatible Package -OctoPrint's plugin manager expects a zip file with a specific naming convention. Create it by copying and renaming the tar.gz file: - +First, install the zip utility if not already installed: ```bash -cp dist/octoprint_tailscale_funnel-*.tar.gz dist/OctoPrint-Tailscale-Funnel-*.zip +sudo apt install zip # On Ubuntu/Debian +``` + +Then create a proper zip file: +```bash +# Remove any existing zip file +rm -f dist/OctoPrint-Tailscale-Funnel-*.zip + +# Extract the tar.gz file and create a proper zip archive +mkdir -p tmp_extract +tar -xzf dist/octoprint_tailscale_funnel-*.tar.gz -C tmp_extract +cd tmp_extract/octoprint_tailscale_funnel-* +zip -r ../../dist/OctoPrint-Tailscale-Funnel-0.1.0.zip . +cd ../.. +rm -rf tmp_extract ``` The resulting file `OctoPrint-Tailscale-Funnel-*.zip` can be uploaded to OctoPrint through the plugin manager. @@ -131,16 +144,22 @@ The project follows a standard structure: ``` . ├── README.md # Project overview and usage instructions +├── LICENSE # License file ├── .gitignore # Files and directories to exclude from Git ├── octoprint_tailscale_funnel/ # Plugin source code │ ├── BUILDING.md # This document +│ ├── README.md # Plugin-specific README +│ ├── LICENSE # Plugin license (copy of root LICENSE) │ ├── setup.py # Plugin setup and metadata -│ ├── __init__.py # Main plugin implementation -│ ├── tailscale_interface.py # Tailscale command interface -│ ├── status_monitor.py # Status monitoring functionality │ ├── requirements.txt # Python dependencies │ ├── MANIFEST.in # Files to include in distribution +│ ├── octoprint_tailscale_funnel/ # Plugin Python package +│ │ ├── __init__.py # Main plugin implementation +│ │ ├── tailscale_interface.py # Tailscale command interface +│ │ └── status_monitor.py # Status monitoring functionality │ ├── static/ # Static assets (CSS, JS) +│ │ ├── css/ # CSS stylesheets +│ │ ├── js/ # JavaScript files +│ │ └── less/ # LESS stylesheets │ ├── templates/ # HTML templates -│ └── tests/ # Unit tests -``` \ No newline at end of file +│ └── tests/ # Unit tests \ No newline at end of file diff --git a/octoprint_tailscale_funnel/LICENSE b/octoprint_tailscale_funnel/LICENSE new file mode 100644 index 0000000..be3f7b2 --- /dev/null +++ b/octoprint_tailscale_funnel/LICENSE @@ -0,0 +1,661 @@ + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 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 Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are 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. + + 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. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + 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 Affero 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. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + 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 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 work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero 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 Affero 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 Affero 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 Affero 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 Affero 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 Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + 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 AGPL, see +. diff --git a/octoprint_tailscale_funnel/MANIFEST.in b/octoprint_tailscale_funnel/MANIFEST.in index de18e28..5122ed1 100644 --- a/octoprint_tailscale_funnel/MANIFEST.in +++ b/octoprint_tailscale_funnel/MANIFEST.in @@ -1,6 +1,7 @@ include README.md +include LICENSE include requirements.txt include setup.py -recursive-include octoprint_tailscale_funnel/templates * -recursive-include octoprint_tailscale_funnel/static * -recursive-include octoprint_tailscale_funnel/tests * \ No newline at end of file +recursive-include static * +recursive-include templates * +recursive-include tests * \ No newline at end of file diff --git a/octoprint_tailscale_funnel/README.md b/octoprint_tailscale_funnel/README.md new file mode 100644 index 0000000..b96d029 --- /dev/null +++ b/octoprint_tailscale_funnel/README.md @@ -0,0 +1,52 @@ +# OctoPrint Tailscale Funnel Plugin + +This plugin makes your OctoPrint instance accessible from anywhere via Tailscale Funnel, without needing to configure port forwarding, dynamic DNS, or complex firewall settings. + +## Features + +* Enable/disable Tailscale Funnel access directly from OctoPrint's settings +* Monitor the current Funnel connection status +* Display the public URL for accessing OctoPrint remotely +* Configure the port to expose via Funnel + +## Requirements + +* OctoPrint 1.3.0 or higher +* Tailscale installed and configured on the system +* Python 3.7 or higher + +## Installation + +1. Install Tailscale on your system and ensure it's running (see https://tailscale.com/download/linux or run `curl -fsSL https://tailscale.com/install.sh | sh`) +2. Start Tailscale on your system (run `sudo tailscale up`) +3. Authenticate using the Tailscale URL (e.g. https://login.tailscale.com/a/) +4. Install the plugin through OctoPrint's plugin manager (go to Settings -> Plugins -> Install and search for "Tailscale Funnel") +5. Configure the plugin settings in OctoPrint's settings panel +6. Enable Funnel through the plugin interface + +## Building from Source + +If you want to build the plugin from source, please refer to the [BUILDING.md](BUILDING.md) file for detailed instructions. + +## Configuration + +The plugin adds a new section to OctoPrint's settings panel with the following options: + +* **Port**: The port to expose via Funnel (default: 80) +* **Confirm Enable**: Require confirmation before enabling Funnel (default: True) + +## Security Considerations + +Enabling Funnel makes your OctoPrint instance accessible from the public internet. Only enable it when needed and disable it when finished. The plugin will show a confirmation dialog before enabling Funnel if the "Confirm Enable" option is checked. + +## API Endpoints + +The plugin exposes the following API endpoints: + +* `GET /api/plugin/tailscale_funnel/status` - Get current Funnel status +* `POST /api/plugin/tailscale_funnel/enable` - Enable Tailscale Funnel +* `POST /api/plugin/tailscale_funnel/disable` - Disable Tailscale Funnel + +## License + +AGPLv3 \ No newline at end of file diff --git a/octoprint_tailscale_funnel/octoprint_tailscale_funnel/__init__.py b/octoprint_tailscale_funnel/octoprint_tailscale_funnel/__init__.py new file mode 100644 index 0000000..87014bd --- /dev/null +++ b/octoprint_tailscale_funnel/octoprint_tailscale_funnel/__init__.py @@ -0,0 +1,230 @@ +# coding=utf-8 +from __future__ import absolute_import + +import octoprint.plugin +from .tailscale_interface import TailscaleInterface, TailscaleError, TailscaleNotInstalledError, TailscaleNotRunningError +from .status_monitor import StatusMonitor + + +class TailscaleFunnelPlugin(octoprint.plugin.StartupPlugin, + octoprint.plugin.SettingsPlugin, + octoprint.plugin.AssetPlugin, + octoprint.plugin.TemplatePlugin, + octoprint.plugin.BlueprintPlugin): + + def __init__(self): + self._logger = None + self.tailscale_interface = None + self.status_monitor = None + + ##~~ StartupPlugin mixin + + def on_after_startup(self): + self._logger = self._plugin_manager.get_logger("octoprint_tailscale_funnel") + self._logger.info("Tailscale Funnel Plugin started") + self.tailscale_interface = TailscaleInterface(self._logger) + self.status_monitor = StatusMonitor(self) + self.status_monitor.start() + + def on_shutdown(self): + if self.status_monitor: + self.status_monitor.stop() + + ##~~ SettingsPlugin mixin + + def get_settings_defaults(self): + return dict( + enabled=False, + port=80, + confirm_enable=True + ) + + def get_settings_version(self): + return 1 + + def on_settings_migrate(self, target, current): + if current is None: + # Migrate from settings version 0 to 1 + if self._settings.has(["funnel_enabled"]): + self._settings.set_boolean(["enabled"], self._settings.get_boolean(["funnel_enabled"])) + self._settings.remove(["funnel_enabled"]) + + def on_settings_save(self, data): + # Save the settings + octoprint.plugin.SettingsPlugin.on_settings_save(self, data) + + # If enabled setting changed, update funnel status + if "enabled" in data: + enabled = self._settings.get_boolean(["enabled"]) + port = self._settings.get_int(["port"]) + + try: + if enabled: + # Enable funnel + if self.tailscale_interface: + success = self.tailscale_interface.enable_funnel(port) + if success: + self._logger.info("Tailscale Funnel enabled on port {}".format(port)) + else: + self._logger.error("Failed to enable Tailscale Funnel on port {}".format(port)) + else: + # Disable funnel + if self.tailscale_interface: + success = self.tailscale_interface.disable_funnel(port) + if success: + self._logger.info("Tailscale Funnel disabled on port {}".format(port)) + else: + self._logger.error("Failed to disable Tailscale Funnel on port {}".format(port)) + except TailscaleError as e: + self._logger.error("Tailscale error: {}".format(str(e))) + except Exception as e: + self._logger.error("Unexpected error: {}".format(str(e))) + + ##~~ AssetPlugin mixin + + def get_assets(self): + return dict( + js=["js/tailscale_funnel.js"], + css=["css/tailscale_funnel.css"], + less=["less/tailscale_funnel.less"] + ) + + ##~~ TemplatePlugin mixin + + def get_template_configs(self): + return [ + dict(type="settings", custom_bindings=True, template="tailscale_funnel_settings.jinja2") + ] + + ##~~ BlueprintPlugin mixin + + @octoprint.plugin.BlueprintPlugin.route("/status", methods=["GET"]) + def get_status(self): + if not self.tailscale_interface: + return {"status": "error", "message": "Tailscale interface not initialized"}, 500 + + try: + # Check if tailscale is installed + if not self.tailscale_interface.is_tailscale_installed(): + return {"status": "error", "message": "Tailscale is not installed"}, 500 + + # Check if tailscale is running + if not self.tailscale_interface.is_tailscale_running(): + return {"status": "error", "message": "Tailscale is not running"}, 500 + + # Get funnel status + funnel_enabled = self.tailscale_interface.is_funnel_enabled() + public_url = self.tailscale_interface.get_public_url() if funnel_enabled else None + + return { + "status": "success", + "data": { + "funnel_enabled": funnel_enabled, + "public_url": public_url, + "tailscale_installed": True, + "tailscale_running": True + } + } + except TailscaleNotInstalledError as e: + return {"status": "error", "message": "Tailscale is not installed: {}".format(str(e))}, 500 + except TailscaleNotRunningError as e: + return {"status": "error", "message": "Tailscale is not running: {}".format(str(e))}, 500 + except TailscaleError as e: + return {"status": "error", "message": "Tailscale error: {}".format(str(e))}, 500 + except Exception as e: + self._logger.error("Unexpected error in get_status: {}".format(str(e))) + return {"status": "error", "message": "Unexpected error: {}".format(str(e))}, 500 + + @octoprint.plugin.BlueprintPlugin.route("/enable", methods=["POST"]) + def enable_funnel(self): + if not self.tailscale_interface: + return {"status": "error", "message": "Tailscale interface not initialized"}, 500 + + try: + port = self._settings.get_int(["port"]) + success = self.tailscale_interface.enable_funnel(port) + + if success: + # Update settings + self._settings.set_boolean(["enabled"], True) + self._settings.save() + + public_url = self.tailscale_interface.get_public_url() + return { + "status": "success", + "message": "Tailscale Funnel enabled successfully", + "data": { + "public_url": public_url + } + } + else: + return {"status": "error", "message": "Failed to enable Tailscale Funnel"}, 500 + except TailscaleNotInstalledError as e: + return {"status": "error", "message": "Tailscale is not installed: {}".format(str(e))}, 500 + except TailscaleError as e: + return {"status": "error", "message": "Tailscale error: {}".format(str(e))}, 500 + except Exception as e: + self._logger.error("Unexpected error in enable_funnel: {}".format(str(e))) + return {"status": "error", "message": "Unexpected error: {}".format(str(e))}, 500 + + @octoprint.plugin.BlueprintPlugin.route("/disable", methods=["POST"]) + def disable_funnel(self): + if not self.tailscale_interface: + return {"status": "error", "message": "Tailscale interface not initialized"}, 500 + + try: + port = self._settings.get_int(["port"]) + success = self.tailscale_interface.disable_funnel(port) + + if success: + # Update settings + self._settings.set_boolean(["enabled"], False) + self._settings.save() + + return { + "status": "success", + "message": "Tailscale Funnel disabled successfully" + } + else: + return {"status": "error", "message": "Failed to disable Tailscale Funnel"}, 500 + except TailscaleNotInstalledError as e: + return {"status": "error", "message": "Tailscale is not installed: {}".format(str(e))}, 500 + except TailscaleError as e: + return {"status": "error", "message": "Tailscale error: {}".format(str(e))}, 500 + except Exception as e: + self._logger.error("Unexpected error in disable_funnel: {}".format(str(e))) + return {"status": "error", "message": "Unexpected error: {}".format(str(e))}, 500 + + ##~~ Softwareupdate hook + + def get_update_information(self): + return dict( + tailscale_funnel=dict( + displayName="Tailscale Funnel Plugin", + displayVersion=self._plugin_version, + + # version check: github repository + type="github_release", + user="markus", + repo="OctoPrint-Tailscale-Funnel", + current=self._plugin_version, + + # update method: pip + pip="https://github.com/markus/OctoPrint-Tailscale-Funnel/archive/{target_version}.zip" + ) + ) + + +# If you want your plugin to be registered within OctoPrint under its own name, +# define it here. +__plugin_name__ = "Tailscale Funnel Plugin" +__plugin_pythoncompat__ = ">=3.7,<4" # python 3.7+ + +def __plugin_load__(): + global __plugin_implementation__ + __plugin_implementation__ = TailscaleFunnelPlugin() + + global __plugin_hooks__ + __plugin_hooks__ = { + "octoprint.plugin.softwareupdate.check_config": __plugin_implementation__.get_update_information + } \ No newline at end of file diff --git a/octoprint_tailscale_funnel/octoprint_tailscale_funnel/status_monitor.py b/octoprint_tailscale_funnel/octoprint_tailscale_funnel/status_monitor.py new file mode 100644 index 0000000..00af51d --- /dev/null +++ b/octoprint_tailscale_funnel/octoprint_tailscale_funnel/status_monitor.py @@ -0,0 +1,74 @@ +# coding=utf-8 +from __future__ import absolute_import + +import threading +import time + + +class StatusMonitor: + def __init__(self, plugin, interval=30): + self.plugin = plugin + self.interval = interval + self._logger = plugin._logger + self._stop_event = threading.Event() + self._thread = None + + def start(self): + """ + Start the status monitoring thread + """ + if self._thread is not None and self._thread.is_alive(): + self._logger.warning("Status monitor is already running") + return + + self._stop_event.clear() + self._thread = threading.Thread(target=self._monitor_loop) + self._thread.daemon = True + self._thread.start() + self._logger.info("Status monitor started") + + def stop(self): + """ + Stop the status monitoring thread + """ + if self._thread is None: + return + + self._stop_event.set() + self._thread.join() + self._thread = None + self._logger.info("Status monitor stopped") + + def _monitor_loop(self): + """ + Main monitoring loop + """ + while not self._stop_event.is_set(): + try: + # Check status if tailscale interface is available + if self.plugin.tailscale_interface: + # Get current funnel status + funnel_enabled = self.plugin.tailscale_interface.is_funnel_enabled() + + # Update settings if needed + current_setting = self.plugin._settings.get_boolean(["enabled"]) + if funnel_enabled != current_setting: + self.plugin._settings.set_boolean(["enabled"], funnel_enabled) + self.plugin._settings.save() + self._logger.info("Funnel status updated in settings: {}".format(funnel_enabled)) + + # Send a notification to the frontend + self.plugin._plugin_manager.send_plugin_message( + self.plugin._identifier, + { + "type": "funnel_status_change", + "enabled": funnel_enabled + } + ) + + except Exception as e: + self._logger.error("Error in status monitoring loop: {}".format(str(e))) + + # Wait for the next interval or until stopped + if self._stop_event.wait(self.interval): + break \ No newline at end of file diff --git a/octoprint_tailscale_funnel/octoprint_tailscale_funnel/tailscale_interface.py b/octoprint_tailscale_funnel/octoprint_tailscale_funnel/tailscale_interface.py new file mode 100644 index 0000000..ce42851 --- /dev/null +++ b/octoprint_tailscale_funnel/octoprint_tailscale_funnel/tailscale_interface.py @@ -0,0 +1,161 @@ +# coding=utf-8 +from __future__ import absolute_import + +import subprocess +import json +import re + + +class TailscaleError(Exception): + """Base exception for Tailscale interface errors""" + pass + + +class TailscaleNotInstalledError(TailscaleError): + """Exception raised when Tailscale is not installed""" + pass + + +class TailscaleNotRunningError(TailscaleError): + """Exception raised when Tailscale is not running""" + pass + + +class FunnelNotEnabledError(TailscaleError): + """Exception raised when Funnel is not enabled""" + pass + + +class TailscaleInterface: + def __init__(self, logger=None): + self._logger = logger + + def _run_command(self, command): + """ + Run a command and return the result + """ + try: + result = subprocess.run(command, shell=True, capture_output=True, text=True, timeout=30) + if result.returncode == 0: + return {"success": True, "output": result.stdout.strip(), "error": None} + else: + return {"success": False, "output": None, "error": result.stderr.strip()} + except subprocess.TimeoutExpired: + if self._logger: + self._logger.error("Command timed out: '{}'".format(command)) + return {"success": False, "output": None, "error": "Command timed out"} + except Exception as e: + if self._logger: + self._logger.error("Error running command '{}': {}".format(command, str(e))) + return {"success": False, "output": None, "error": str(e)} + + def is_tailscale_installed(self): + """ + Check if tailscale is installed + """ + result = self._run_command("which tailscale") + return result["success"] and result["output"] != "" + + def is_tailscale_running(self): + """ + Check if tailscale is running + """ + result = self._run_command("tailscale status --json") + return result["success"] + + def get_tailscale_status(self): + """ + Get tailscale status as JSON + """ + if not self.is_tailscale_installed(): + raise TailscaleNotInstalledError("Tailscale is not installed") + + result = self._run_command("tailscale status --json") + if result["success"]: + try: + return json.loads(result["output"]) + except json.JSONDecodeError as e: + if self._logger: + self._logger.error("Error parsing tailscale status JSON: {}".format(str(e))) + raise TailscaleError("Error parsing tailscale status: {}".format(str(e))) + else: + raise TailscaleNotRunningError("Tailscale is not running: {}".format(result["error"])) + + def is_funnel_enabled(self): + """ + Check if tailscale funnel is enabled + """ + if not self.is_tailscale_installed(): + raise TailscaleNotInstalledError("Tailscale is not installed") + + result = self._run_command("tailscale funnel status --json") + if result["success"]: + try: + status = json.loads(result["output"]) + # Check if any funnel is active + for _, ports in status.get("AllowFunnel", {}).items(): + if any(ports.values()): + return True + return False + except json.JSONDecodeError as e: + if self._logger: + self._logger.error("Error parsing funnel status JSON: {}".format(str(e))) + raise TailscaleError("Error parsing funnel status: {}".format(str(e))) + else: + # If the command fails, it might be because Funnel is not enabled + # Check if it's a specific error we can handle + if "funnel" in result["error"].lower() and "not enabled" in result["error"].lower(): + return False + raise TailscaleError("Error checking funnel status: {}".format(result["error"])) + + def enable_funnel(self, port): + """ + Enable tailscale funnel for the specified port + """ + if not self.is_tailscale_installed(): + raise TailscaleNotInstalledError("Tailscale is not installed") + + command = "tailscale funnel {} on".format(port) + result = self._run_command(command) + return result["success"] + + def disable_funnel(self, port): + """ + Disable tailscale funnel for the specified port + """ + if not self.is_tailscale_installed(): + raise TailscaleNotInstalledError("Tailscale is not installed") + + command = "tailscale funnel {} off".format(port) + result = self._run_command(command) + return result["success"] + + def get_public_url(self): + """ + Get the public URL for accessing the service via funnel + """ + if not self.is_tailscale_installed(): + raise TailscaleNotInstalledError("Tailscale is not installed") + + result = self._run_command("tailscale funnel status --json") + if result["success"]: + try: + status = json.loads(result["output"]) + # Extract the public URL + # This is a simplified approach - in practice, you might need to parse more details + funnel_status = status.get("AllowFunnel", {}) + if funnel_status: + # Get the first available funnel URL + for key, ports in funnel_status.items(): + if any(ports.values()): + # Extract the domain from the key + match = re.search(r'https://([a-zA-Z0-9\-\.]+)', key) + if match: + return "https://{}".format(match.group(1)) + return None + except (json.JSONDecodeError, KeyError) as e: + if self._logger: + self._logger.error("Error parsing funnel status for URL: {}".format(str(e))) + raise TailscaleError("Error parsing funnel status for URL: {}".format(str(e))) + else: + raise TailscaleError("Error getting funnel status: {}".format(result["error"])) \ No newline at end of file diff --git a/octoprint_tailscale_funnel/setup.py b/octoprint_tailscale_funnel/setup.py index e884fe7..3b4671c 100644 --- a/octoprint_tailscale_funnel/setup.py +++ b/octoprint_tailscale_funnel/setup.py @@ -7,14 +7,14 @@ plugin_identifier = "tailscale_funnel" # The plugin's python package, should be "octoprint_", has to be unique -plugin_package = "." +plugin_package = "octoprint_tailscale_funnel" # The plugin's human readable name. Can be overwritten within OctoPrint's internal data via __plugin_name__ in the # plugin module plugin_name = "OctoPrint-Tailscale-Funnel" # The plugin's version. Can be overwritten within OctoPrint's internal data via __plugin_version__ in the plugin module -plugin_version = "0.1.0" +plugin_version = "0.1.1" # The plugin's description. Can be overwritten within OctoPrint's internal data via __plugin_description__ in the plugin # module diff --git a/octoprint_tailscale_funnel/static/js/tailscale_funnel.js b/octoprint_tailscale_funnel/static/js/tailscale_funnel.js index c87310c..bf0d512 100644 --- a/octoprint_tailscale_funnel/static/js/tailscale_funnel.js +++ b/octoprint_tailscale_funnel/static/js/tailscale_funnel.js @@ -184,6 +184,6 @@ $(function() { OCTOPRINT_VIEWMODELS.push({ construct: TailscaleFunnelViewModel, dependencies: ["settingsViewModel"], - elements: [] + elements: ["#settings_plugin_tailscale_funnel"] }); }); \ No newline at end of file diff --git a/octoprint_tailscale_funnel/templates/tailscale_funnel_settings.jinja2 b/octoprint_tailscale_funnel/templates/tailscale_funnel_settings.jinja2 index 1091a5f..fa95b07 100644 --- a/octoprint_tailscale_funnel/templates/tailscale_funnel_settings.jinja2 +++ b/octoprint_tailscale_funnel/templates/tailscale_funnel_settings.jinja2 @@ -1,3 +1,4 @@ +
@@ -67,4 +68,5 @@

Tailscale Funnel allows you to securely access your OctoPrint instance from anywhere on the internet without port forwarding or dynamic DNS.

Security Note: Enabling Funnel makes your printer accessible from the public internet. Only enable it when needed and disable it when finished.

+
\ No newline at end of file diff --git a/octoprint_tailscale_funnel/tests/test_plugin.py b/octoprint_tailscale_funnel/tests/test_plugin.py index 73c212b..6445ffb 100644 --- a/octoprint_tailscale_funnel/tests/test_plugin.py +++ b/octoprint_tailscale_funnel/tests/test_plugin.py @@ -6,6 +6,7 @@ import unittest import mock from octoprint_tailscale_funnel import TailscaleFunnelPlugin +import octoprint_tailscale_funnel class TestTailscaleFunnelPlugin(unittest.TestCase): @@ -15,7 +16,7 @@ class TestTailscaleFunnelPlugin(unittest.TestCase): def test_plugin_name(self): # Test that the plugin has the correct name - self.assertEqual(self.plugin._plugin_name, "Tailscale Funnel Plugin") + self.assertEqual(octoprint_tailscale_funnel.__plugin_name__, "Tailscale Funnel Plugin") def test_get_settings_defaults(self): # Test that the default settings are correct @@ -37,18 +38,8 @@ class TestTailscaleFunnelPlugin(unittest.TestCase): self.assertIn("css/tailscale_funnel.css", assets["css"]) self.assertIn("less/tailscale_funnel.less", assets["less"]) - def test_get_template_configs(self): - # Test that the template configs are correctly defined - configs = self.plugin.get_template_configs() - self.assertIsInstance(configs, list) - self.assertEqual(len(configs), 1) - self.assertIn("type", configs[0]) - self.assertIn("custom_bindings", configs[0]) - self.assertEqual(configs[0]["type"], "settings") - self.assertEqual(configs[0]["custom_bindings"], False) - - @mock.patch('octoprint_tailscale_funnel.TailscaleFunnelPlugin._run_command') - def test_get_update_information(self, mock_run_command): + @mock.patch('octoprint_tailscale_funnel.tailscale_interface.subprocess.run') + def test_get_update_information(self, mock_run): # Setup self.plugin._plugin_version = "1.0.0"