diff --git a/.forgejo/workflows/build.yml b/.forgejo/workflows/build.yml deleted file mode 100644 index c7c6fa3..0000000 --- a/.forgejo/workflows/build.yml +++ /dev/null @@ -1,57 +0,0 @@ -on: - push: - tags: - - 'v*.*.*' - workflow_dispatch: - -jobs: - build: - runs-on: docker - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: '3.11' - - - name: Install dependencies - run: | - pip install -r requirements.txt - pip install pyinstaller - - - name: Build with PyInstaller - run: | - pyinstaller --onefile --console --name TinyWeb app.py - - - name: Upload artifact - uses: actions/upload-artifact@v4 - with: - name: TinyWeb-linux-x64 - path: dist/TinyWeb - if-no-files-found: error - - release: - needs: build - runs-on: docker - if: startsWith(github.ref, 'refs/tags/v') - - steps: - - name: Download artifact - uses: actions/download-artifact@v4 - with: - name: TinyWeb-linux-x64 - - - name: Make executable - run: chmod +x TinyWeb-linux-x64 - - - name: Create Release - uses: actions/forgejo-release@v2 - with: - direction: upload - release-dir: . - override: true - prerelease: ${{ contains(github.ref_name, 'alpha') || contains(github.ref_name, 'beta') }} - diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml deleted file mode 100644 index d79edb3..0000000 --- a/.github/workflows/build.yml +++ /dev/null @@ -1,75 +0,0 @@ -name: Build - -on: - push: - tags: - - 'v*.*.*' - workflow_dispatch: - -jobs: - build: - strategy: - fail-fast: false - matrix: - include: - - os: windows-latest - artifact: TinyWeb-windows-x64.exe - - os: macos-latest - artifact: TinyWeb-macos-arm64 - - os: ubuntu-latest - artifact: TinyWeb-linux-x64 - - runs-on: ${{ matrix.os }} - - steps: - - name: Checkout code - uses: actions/checkout@v4 - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: '3.11' - - - name: Install dependencies - run: | - pip install -r requirements.txt - pip install pyinstaller - - - name: Build with PyInstaller - run: | - pyinstaller --onefile --console --name TinyWeb app.py - - - name: Get artifact path - id: artifact - run: | - if [[ "${{ matrix.os }}" == "windows-latest" ]]; then - echo "path=dist/TinyWeb.exe" >> $GITHUB_OUTPUT - else - echo "path=dist/TinyWeb" >> $GITHUB_OUTPUT - fi - - - name: Create ZIP - uses: actions/upload-artifact@v4 - with: - name: ${{ matrix.artifact }} - path: ${{ steps.artifact.outputs.path }} - if-no-files-found: error - - release: - needs: build - runs-on: ubuntu-latest - if: startsWith(github.ref, 'refs/tags/v') - - steps: - - name: Download all artifacts - uses: actions/download-artifact@v4 - with: - path: artifacts - - - name: Create Release - uses: softprops/action-gh-release@v1 - with: - files: artifacts/** - generate_release_notes: true - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 5445774..0000000 --- a/LICENSE +++ /dev/null @@ -1,574 +0,0 @@ -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 giving 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 -are made publicly available of their being a derivative work, need not -be distributed to others. - - For example, if you modify a part of a free program, you are -not required to distribute the object code for the modified version -itself; however, the GNU Affero General Public License requires you -to provide source code for any version of the program that you use -or modify. This requirement is similar to the requirement that -the user can receive the source code if they distribute a copy. - - Also, if you link or combine the program with any other software -that contains code covered by this License (or any work based on the -program), you must provide the source code for that combined work -as well. The GNU Affero General Public License normally requires -that any work that you distribute or publish that in whole or in -part contains or is derived from the program or any part thereof, -to be licensed as a whole at no charge to all third parties under -the terms of this License. This is known as "providing source code" -or "making available" the work. - - An "aggregated" or "combined" work is not covered by this License -if you do not meet these conditions, and you must provide the source -code as above. Additionally, aggregating works does not exempt you -from the requirements of this License. - - Specifically, if you make an "aggregate" or "combined" work by -combining this program with other software (or any work based on this -program) on a volume of a storage or distribution medium, you must -provide the source code for the combined work as above. This -requirement is intended to ensure that any user of the combined work -gets the source code that you made available, and can exercise the -right to modify and re-distribute the combined work. - - This License is specifically intended to limit any attempt to -place your modifications under a license that would restrict re-use -or further modification by others. This is to ensure that any -derivative work you create will be available under the same license -as the original, so that any derivative work can be re-distributed -under the same conditions as the original. - - Finally, this License is not intended to limit your rights under -fair use or other limitations on exclusive rights, such as patents -or trademarks. This License does not grant you any rights to the -names of the authors or copyright holders, nor to trade names, -trademarks, or service marks, except as needed for the normal and -customary use in describing the origin of the work and reproducing -the content of the notice file. - - 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. - - "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. - - 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 in 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 contain prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must contain 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 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 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, then 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, or selling the work, -or by making, using, or selling the work. - - 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 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 to anyone -in the United States, you may not convey the work under this License. -This is done by providing access to copy the corresponding source code -from a network server at no charge. - - If, during the execution of the Program, the Program is transmitted -to a user or a computer, either the source code or object code, you -must meet the requirements of this License regarding the -Corresponding Source of the work. You must make sure that the source -code or object code (as applicable) is available for such users to -copy and modify, and to run, for their own use, the corresponding -source in accordance with this License. This requirement applies -both to the work as stand-alone and to the work as part of an -aggregate. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - 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. - - 12. No Warranty - - THE PROGRAM IS PROVIDED 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. - - 13. Disclaimer 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. - - 14. Interpretation of Sections 12 and 13. - - 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 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 AGPL, - see . diff --git a/README.md b/README.md index 371f15d..ec66704 100644 --- a/README.md +++ b/README.md @@ -12,38 +12,6 @@ A personal, decentralized search engine built on the [Reticulum](https://reticul - **Import/export** — JSON-based backup and restore - **Mesh-native** — Works over Reticulum without the internet; encrypted and decentralized by default -## Download (pre-built binaries) - -Download the latest release for your platform from the [GitHub Releases](https://github.com/anomalyco/tinyweb/releases) page: - -| Platform | File | -|----------|------| -| Windows | `TinyWeb-windows-x64.exe` | -| macOS | `TinyWeb-macos-arm64` | -| Linux | `TinyWeb-linux-x64` | - -Run the downloaded file — no installation required. - -## Data storage - -Your data is stored in `~/.tinyweb/`: - -| File | Description | -|------|-------------| -| `index.db` | SQLite database with your indexed pages | -| `tinyweb_identity` | Your Reticulum identity (keep safe!) | -| `models/` | Downloaded AI models for semantic search | -| `index.hnsw` | Semantic search index | - -This allows your data to persist between upgrades and stay separate from the application. - -### Command line options - -```bash -./TinyWeb --version # Show version -./TinyWeb -p 9000 # Use port 9000 instead of default 8080 -``` - ## Getting started ```bash diff --git a/app.py b/app.py index 8302d91..cde4d84 100644 --- a/app.py +++ b/app.py @@ -1,8 +1,6 @@ import os -import sys import time import threading -import argparse import RNS from http.server import HTTPServer @@ -15,59 +13,18 @@ ASPECTS = ["server"] IDENTITY_FILE = "tinyweb_identity" DEFAULT_TRANSPORT_HOST = "reticulum.derickphan.com" DEFAULT_TRANSPORT_PORT = 4242 -DATA_DIR = os.path.expanduser("~/.tinyweb") - - -def get_transport_config(): - host = get_setting("transport_host", DEFAULT_TRANSPORT_HOST) - port = get_setting("transport_port", str(DEFAULT_TRANSPORT_PORT)) - return host, int(port) - - -def find_available_port(start=8080, max_attempts=20): - """Find an available port starting from start.""" - import socket - for port in range(start, start + max_attempts): - try: - with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as s: - s.bind(("0.0.0.0", port)) - return port - except OSError: - continue - return start - - -def get_version(): - """Get version from git tag or VERSION file.""" - try: - import subprocess - tag = subprocess.check_output( - ["git", "describe", "--tags", "--abbrev=0"], - stderr=subprocess.DEVNULL, - text=True - ).strip() - if tag.startswith("v"): - return tag[1:] - return tag - except Exception: - version_file = os.path.join(os.path.dirname(__file__), "VERSION") - if os.path.exists(version_file): - with open(version_file) as f: - return f.read().strip() - return "0.0.0" def load_or_create_identity(): - os.makedirs(DATA_DIR, exist_ok=True) - identity_path = os.path.join(DATA_DIR, IDENTITY_FILE) - if os.path.isfile(identity_path): - current = os.stat(identity_path).st_mode & 0o777 + if os.path.isfile(IDENTITY_FILE): + # Ensure identity file is only readable by owner + current = os.stat(IDENTITY_FILE).st_mode & 0o777 if current != 0o600: - os.chmod(identity_path, 0o600) - return RNS.Identity.from_file(identity_path) + os.chmod(IDENTITY_FILE, 0o600) + return RNS.Identity.from_file(IDENTITY_FILE) identity = RNS.Identity() - identity.to_file(identity_path) - os.chmod(identity_path, 0o600) + identity.to_file(IDENTITY_FILE) + os.chmod(IDENTITY_FILE, 0o600) return identity @@ -85,35 +42,13 @@ def start_gateway(reticulum): thread.start() -def _transport_settings_match(config_file, desired_host, desired_port): - """Check if existing config transport settings match desired values.""" - import configparser - try: - config = configparser.ConfigParser() - config.read(config_file) - if config.has_section("TCP Transport"): - existing_host = config.get("TCP Transport", "target_host") - existing_port = config.get("TCP Transport", "target_port") - return existing_host == desired_host and existing_port == str(desired_port) - except Exception: - pass - return False - - -def ensure_rns_config(config_dir, transport_host=None, transport_port=None): +def ensure_rns_config(config_dir): """Generate a default Reticulum config with internet transport if none exists.""" if config_dir is None: config_dir = os.path.expanduser("~/.reticulum") config_file = os.path.join(config_dir, "config") - if transport_host is None: - transport_host = get_setting("transport_host", DEFAULT_TRANSPORT_HOST) - if transport_port is None: - transport_port = int(get_setting("transport_port", str(DEFAULT_TRANSPORT_PORT))) - if os.path.exists(config_file): - if _transport_settings_match(config_file, transport_host, transport_port): - return - + return os.makedirs(config_dir, exist_ok=True) with open(config_file, "w") as f: f.write(f"""[reticulum] @@ -131,22 +66,23 @@ def ensure_rns_config(config_dir, transport_host=None, transport_port=None): [[TCP Transport]] type = TCPClientInterface enabled = yes - target_host = {transport_host} - target_port = {transport_port} + target_host = {DEFAULT_TRANSPORT_HOST} + target_port = {DEFAULT_TRANSPORT_PORT} """) print(f"Created Reticulum config at {config_file}") def _preload_embeddings(): """Pre-load the embedding model and build the HNSW index in background.""" - if get_setting("semantic_search", "0") != "1": + if get_setting("semantic_search", "1") != "1": print("Semantic search disabled.") return try: from embeddings import _get_session, _get_reranker, build_index - _get_session() - build_index() - if get_setting("use_reranker", "0") == "1": + _get_session() # downloads model on first run, loads ONNX session + build_index() # builds HNSW index from existing chunks + # Preload cross-encoder unless user has explicitly disabled it + if get_setting("use_reranker", "1") == "1": _get_reranker() print("Semantic search ready (with reranker).") else: @@ -156,25 +92,10 @@ def _preload_embeddings(): def main(): - parser = argparse.ArgumentParser(prog="tinyweb", description="Personal decentralized search engine") - parser.add_argument("--version", "-v", action="store_true", help="Show version") - parser.add_argument("--port", "-p", type=int, default=None, help="HTTP gateway port (default: 8080)") - args = parser.parse_args() - - if args.version: - print(f"TinyWeb {get_version()}") - return - - port = args.port or 8080 - import gateway - gateway.GATEWAY_PORT = find_available_port(port) - init_db() - transport_host = get_setting("transport_host", DEFAULT_TRANSPORT_HOST) - transport_port = int(get_setting("transport_port", str(DEFAULT_TRANSPORT_PORT))) threading.Thread(target=_preload_embeddings, daemon=True).start() config_dir = os.environ.get("RNS_CONFIG_DIR") - ensure_rns_config(config_dir, transport_host, transport_port) + ensure_rns_config(config_dir) reticulum = RNS.Reticulum(configdir=config_dir) identity = load_or_create_identity() diff --git a/db.py b/db.py index 295da86..4943855 100644 --- a/db.py +++ b/db.py @@ -2,12 +2,10 @@ import socket import ipaddress import sqlite3 import requests -import os from urllib.parse import urlparse, urljoin, parse_qs, urlencode, urlunparse, quote from bs4 import BeautifulSoup -DATA_DIR = os.path.expanduser("~/.tinyweb") -DATABASE = os.path.join(DATA_DIR, "index.db") +DATABASE = "index.db" BLOCKED_NETWORKS = [ ipaddress.ip_network("127.0.0.0/8"), @@ -125,7 +123,6 @@ def return_db(db): def init_db(): - os.makedirs(DATA_DIR, exist_ok=True) db = sqlite3.connect(DATABASE) db.execute( "CREATE TABLE IF NOT EXISTS pages (" diff --git a/embeddings.py b/embeddings.py index 302a31f..aa6a4ff 100644 --- a/embeddings.py +++ b/embeddings.py @@ -5,11 +5,10 @@ import re import threading import numpy as np -DATA_DIR = os.path.expanduser("~/.tinyweb") MODEL_ID = "Snowflake/snowflake-arctic-embed-s" -MODEL_DIR = os.path.join(DATA_DIR, "models", "snowflake-arctic-embed-s") -RERANKER_DIR = os.path.join(DATA_DIR, "models", "cross-encoder") -HNSW_PATH = os.path.join(DATA_DIR, "index.hnsw") +MODEL_DIR = os.path.join(os.path.dirname(__file__), "models", "snowflake-arctic-embed-s") +RERANKER_DIR = os.path.join(os.path.dirname(__file__), "models", "cross-encoder") +HNSW_PATH = os.path.join(os.path.dirname(__file__), "index.hnsw") DIMS = 384 MAX_TOKENS = 512 QUERY_PREFIX = "Represent this sentence for searching relevant passages: " @@ -34,7 +33,6 @@ _hnsw_lock = threading.Lock() def _ensure_model(): """Download the ONNX model and tokenizer from HuggingFace if not present.""" - os.makedirs(MODEL_DIR, exist_ok=True) model_path = os.path.join(MODEL_DIR, "model.onnx") tokenizer_path = os.path.join(MODEL_DIR, "tokenizer.json") if os.path.exists(model_path) and os.path.exists(tokenizer_path): diff --git a/handlers.py b/handlers.py index ae7f484..1665cae 100644 --- a/handlers.py +++ b/handlers.py @@ -678,14 +678,12 @@ def handle_style_form(msg=""): name = get_site_name() sharing = get_setting("sharing_enabled", "0") checked = " checked" if sharing == "1" else "" - semantic = get_setting("semantic_search", "0") + semantic = get_setting("semantic_search", "1") semantic_checked = " checked" if semantic == "1" else "" - reranker = get_setting("use_reranker", "0") + reranker = get_setting("use_reranker", "1") reranker_checked = " checked" if reranker == "1" else "" disabled = "" if semantic == "1" else " disabled" dimmed = ' style="opacity:0.4"' if semantic != "1" else "" - transport_host = get_setting("transport_host", "reticulum.derickphan.com") - transport_port = get_setting("transport_port", "4242") return _respond( f"

customize

" f"

name your search engine

" @@ -695,12 +693,6 @@ def handle_style_form(msg=""): f"

sharing

" f'

" - f"

mesh network

" - f"

Connect to a Reticulum transport node to reach other peers.

" - f"Default: reticulum.derickphan.com:4242
" - f'' - f'
' - f'

discover more nodes


' f"

search

" f"

ai

" f'