diff --git a/archive/README.md b/archive/README.md index c90b3cab129..3b649683a2b 100644 --- a/archive/README.md +++ b/archive/README.md @@ -1,3 +1,3 @@ # archive -This repo contains old TrueCharts project code +This folder contains old TrueCharts project code diff --git a/archive/catalog_validation/ix-source/.github/workflows/ci.yml b/archive/catalog_validation/ix-source/.github/workflows/ci.yml deleted file mode 100644 index 0fa6c8caba8..00000000000 --- a/archive/catalog_validation/ix-source/.github/workflows/ci.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: CI - -on: [push] - -jobs: - build-deb: - runs-on: ubuntu-latest - container: - image: ixsystems/catalog_validation:latest@sha256:ec054455af9857782d13f0507b0e0378ed0dee83dab11a3e1e5939eebb083522 - - steps: - - name: Checkout - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1 - - - name: Build deb package - run: > - dpkg-buildpackage - -B - --no-sign - -jauto - - - name: Create artifacts dir - run: mkdir artifacts - if: success() - - - name: Move artifacts - run: mv ../*.deb artifacts - if: success() - - - uses: actions/upload-artifact@3446296876d12d4e3a0f3145a3c87e67bf0a16b5 # v1 - with: - name: py-catalog-validation - path: artifacts - if: success() diff --git a/archive/catalog_validation/ix-source/.github/workflows/docker_image.yml b/archive/catalog_validation/ix-source/.github/workflows/docker_image.yml deleted file mode 100644 index 3757dc9595f..00000000000 --- a/archive/catalog_validation/ix-source/.github/workflows/docker_image.yml +++ /dev/null @@ -1,28 +0,0 @@ -name: build_image - -on: - push: - branches: - - "master" - -jobs: - docker: - runs-on: ubuntu-latest - steps: - - name: Set up QEMU - uses: docker/setup-qemu-action@27d0a4f181a40b142cce983c5393082c365d1480 # v1 - - name: Set up Docker Buildx - uses: docker/setup-buildx-action@f211e3e9ded2d9377c8cadc4489a4e38014bc4c9 # v1 - - name: Login to DockerHub - uses: docker/login-action@dd4fa0671be5250ee6f50aedf4cb05514abda2c7 # v1 - with: - username: ${{ secrets.DOCKERHUB_USERNAME }} - password: ${{ secrets.DOCKERHUB_TOKEN }} - - name: Build and push - id: docker_build - uses: docker/build-push-action@ac9327eae2b366085ac7f6a2d02df8aa8ead720a # v2 - with: - push: true - tags: ixsystems/catalog_validation:latest - - name: Image digest - run: echo ${{ steps.docker_build.outputs.digest }} diff --git a/archive/catalog_validation/ix-source/.github/workflows/lint.yml b/archive/catalog_validation/ix-source/.github/workflows/lint.yml deleted file mode 100644 index 4e606196860..00000000000 --- a/archive/catalog_validation/ix-source/.github/workflows/lint.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: flake8 - -on: [push] - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2 - - name: Set up Python 3.8 - uses: actions/setup-python@0f07f7f756721ebd886c2462646a35f78a8bc4de # v1 - with: - python-version: 3.8 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install flake8 - - name: Analysing the code with flake8 - run: flake8 . diff --git a/archive/catalog_validation/ix-source/.github/workflows/test.yaml b/archive/catalog_validation/ix-source/.github/workflows/test.yaml deleted file mode 100644 index 023ca14ebff..00000000000 --- a/archive/catalog_validation/ix-source/.github/workflows/test.yaml +++ /dev/null @@ -1,26 +0,0 @@ -name: catalog_validation_test - -on: [push] - -jobs: - build: - runs-on: ubuntu-latest - container: - image: ghcr.io/truenas/middleware:master@sha256:f6d1c7a932e0745d3bf9928711de0e715d7d130e317931a2498457aec5aa555b - - steps: - - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2 - - name: Setup dependencies - run: | - /usr/bin/install-dev-tools - - - name: Install dependencies - run: | - pip install --break-system-packages -r catalog_validation/pytest/requirements.txt - pip install --break-system-packages -r requirements.txt - - - name: Installing catalog validation - run: python setup.py install - - - name: Running test - run: pytest catalog_validation/pytest/ diff --git a/archive/catalog_validation/ix-source/.gitignore b/archive/catalog_validation/ix-source/.gitignore deleted file mode 100644 index 99ac911613d..00000000000 --- a/archive/catalog_validation/ix-source/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -catalog_validation/__pycache__ -catalog_validation/schema/__pycache__ diff --git a/archive/catalog_validation/ix-source/Dockerfile b/archive/catalog_validation/ix-source/Dockerfile deleted file mode 100644 index 1d29a60560d..00000000000 --- a/archive/catalog_validation/ix-source/Dockerfile +++ /dev/null @@ -1,23 +0,0 @@ -FROM ghcr.io/truenas/middleware:master - -RUN /usr/bin/install-dev-tools - -RUN apt-get install -y \ - debhelper-compat \ - dh-python \ - python3-dev \ - python3-setuptools \ - devscripts \ - python3-jsonschema \ - python3-semantic-version \ - python3-kubernetes \ - python3-yaml - -ENV PYTHONUNBUFFERED 1 -ENV WORK_DIR /app -RUN mkdir -p ${WORK_DIR} -WORKDIR ${WORK_DIR} - -ADD . ${WORK_DIR}/ -RUN pip install --break-system-packages -r requirements.txt -RUN pip install --break-system-packages -U . diff --git a/archive/catalog_validation/ix-source/LICENSE b/archive/catalog_validation/ix-source/LICENSE deleted file mode 100644 index f288702d2fa..00000000000 --- a/archive/catalog_validation/ix-source/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/archive/catalog_validation/ix-source/README.md b/archive/catalog_validation/ix-source/README.md deleted file mode 100644 index e142d111462..00000000000 --- a/archive/catalog_validation/ix-source/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# catalogs_validation -Validate truenas compliant catalog structure / format. diff --git a/archive/catalog_validation/ix-source/catalog_validation/__init__.py b/archive/catalog_validation/ix-source/catalog_validation/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/ix-source/catalog_validation/ci/__init__.py b/archive/catalog_validation/ix-source/catalog_validation/ci/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/ix-source/catalog_validation/ci/utils.py b/archive/catalog_validation/ix-source/catalog_validation/ci/utils.py deleted file mode 100644 index 2b8f0914fdd..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/ci/utils.py +++ /dev/null @@ -1,54 +0,0 @@ -import os -import yaml - -from catalog_validation.items.utils import DEVELOPMENT_DIR -from jsonschema import validate as json_schema_validate -from semantic_version import Version - - -DEV_DIRECTORY_RELATIVE_PATH: str = os.path.join('library', DEVELOPMENT_DIR) -TO_KEEP_VERSIONS = 'to_keep_versions.yaml' -OPTIONAL_METADATA_FILES = ['upgrade_info.json', 'upgrade_strategy', TO_KEEP_VERSIONS] -REQUIRED_METADATA_FILES = ['item.yaml'] -UPDATE_STRATEGY_FILE = 'upgrade_strategy' - - -REQUIRED_VERSIONS_SCHEMA = { - 'type': 'array', - 'items': { - 'type': 'string', - 'pattern': '[0-9]+.[0-9]+.[0-9]+' - } -} - - -def get_app_version(app_path: str) -> str: - # This assumes that file exists and version is specified and is good - with open(os.path.join(app_path, 'Chart.yaml'), 'r') as f: - return yaml.safe_load(f.read())['version'] - - -def get_ci_development_directory(catalog_path: str) -> str: - return os.path.join(catalog_path, DEV_DIRECTORY_RELATIVE_PATH) - - -def get_to_keep_versions(app_dir_path: str) -> list: - required_version_path = os.path.join(app_dir_path, TO_KEEP_VERSIONS) - if not os.path.exists(required_version_path): - return [] - - with open(required_version_path, 'r') as f: - data = yaml.safe_load(f.read()) - json_schema_validate(data, REQUIRED_VERSIONS_SCHEMA) - return data - - -def version_has_been_bumped(app_path: str, new_version: str) -> bool: - if not os.path.isdir(app_path): - return True - - versions = [ - Version(version) for version in filter(lambda v: os.path.isdir(os.path.join(app_path, v)), os.listdir(app_path)) - ] - versions.sort() - return not versions or Version(new_version) > versions[-1] diff --git a/archive/catalog_validation/ix-source/catalog_validation/ci/validate.py b/archive/catalog_validation/ix-source/catalog_validation/ci/validate.py deleted file mode 100644 index 6de3a360b27..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/ci/validate.py +++ /dev/null @@ -1,96 +0,0 @@ -import os -import yaml - -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.validation import validate_catalog_item_version, validate_chart_version -from jsonschema import ValidationError as JsonValidationError - -from .utils import ( - get_app_version, get_ci_development_directory, REQUIRED_METADATA_FILES, version_has_been_bumped, - TO_KEEP_VERSIONS, REQUIRED_VERSIONS_SCHEMA, get_to_keep_versions, UPDATE_STRATEGY_FILE -) - - -def validate_dev_directory_structure(catalog_path: str, to_check_apps: dict) -> None: - verrors = ValidationErrors() - dev_directory = get_ci_development_directory(catalog_path) - if not os.path.exists(dev_directory): - return - - for train_name in filter( - lambda name: name in to_check_apps and os.path.isdir(os.path.join(dev_directory, name)), - os.listdir(dev_directory) - ): - validate_train( - catalog_path, os.path.join(dev_directory, train_name), f'dev.{train_name}', to_check_apps[train_name] - ) - verrors.check() - - -def validate_train(catalog_path: str, train_path: str, schema: str, to_check_apps: list) -> None: - verrors = ValidationErrors() - train_name = os.path.basename(train_path) - for app_name in filter( - lambda name: os.path.isdir(os.path.join(train_path, name)), os.listdir(train_path) - ): - if app_name not in to_check_apps: - continue - - app_path = os.path.join(train_path, app_name) - try: - validate_app(app_path, f'{schema}.{app_name}') - except ValidationErrors as ve: - verrors.extend(ve) - else: - published_train_app_path = os.path.join(catalog_path, train_name, app_name) - if not os.path.exists(published_train_app_path): - # The application is new and we are good - continue - - if not version_has_been_bumped(published_train_app_path, get_app_version(app_path)): - verrors.add( - f'{schema}.{app_name}.version', - 'Version must be bumped as app has been changed but version has not been updated' - ) - - verrors.check() - - -def validate_keep_versions(app_dir_path: str, schema: str, verrors: ValidationErrors) -> ValidationErrors: - try: - get_to_keep_versions(app_dir_path) - except yaml.YAMLError: - verrors.add(f'{schema}.{REQUIRED_VERSIONS_SCHEMA}', 'Invalid yaml format') - except JsonValidationError: - verrors.add( - f'{schema}.{REQUIRED_VERSIONS_SCHEMA}', - f'Invalid json schema {TO_KEEP_VERSIONS} must contain list of required versions' - ) - - -def validate_upgrate_strategy(app_path, schema, verrors): - upgrade_strategy_path = os.path.join(app_path, UPDATE_STRATEGY_FILE) - if os.path.exists(upgrade_strategy_path) and not os.access(upgrade_strategy_path, os.X_OK): - verrors.add(schema, f'{upgrade_strategy_path!r} is not executable') - - -def validate_app(app_dir_path: str, schema: str) -> None: - app_name = os.path.basename(app_dir_path) - chart_version_path = os.path.join(app_dir_path, 'Chart.yaml') - verrors = validate_chart_version(ValidationErrors(), chart_version_path, schema, app_name) - validate_keep_versions(app_dir_path, app_name, verrors) - verrors.check() - - validate_catalog_item_version(app_dir_path, schema, get_app_version(app_dir_path), app_name, True) - - required_files = set(REQUIRED_METADATA_FILES) - available_files = set( - f for f in filter(lambda f: os.path.isfile(os.path.join(app_dir_path, f)), os.listdir(app_dir_path)) - ) - if missing_files := required_files - available_files: - verrors.add( - f'{schema}.required_files', - f'{", ".join(missing_files)!r} file(s) must be specified' - ) - validate_upgrate_strategy(app_dir_path, f'{schema}.{UPDATE_STRATEGY_FILE}', verrors) - verrors.check() diff --git a/archive/catalog_validation/ix-source/catalog_validation/exceptions.py b/archive/catalog_validation/ix-source/catalog_validation/exceptions.py deleted file mode 100644 index 5fba74a23a8..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/exceptions.py +++ /dev/null @@ -1,67 +0,0 @@ -import errno - - -class ValidationException(Exception): - def __init__(self, error_msg, error_no=errno.EFAULT): - self.errmsg = error_msg - self.errno = error_no - - def get_error_name(self): - return errno.errorcode.get(self.errno) or 'EUNKNOWN' - - def __str__(self): - return f'[{self.get_error_name()}] {self.errmsg}' - - -class ValidationError(ValidationException): - def __init__(self, attribute, errmsg, errno=errno.EFAULT): - self.attribute = attribute - self.errmsg = errmsg - self.errno = errno - - def __str__(self): - return f'[{self.get_error_name()}] {self.attribute}: {self.errmsg}' - - -class ValidationErrors(ValidationException): - def __init__(self, errors=None): - self.errors = errors or [] - - def add(self, attribute, errmsg, errno=errno.EINVAL): - self.errors.append(ValidationError(attribute, errmsg, errno)) - - def add_validation_error(self, validation_error): - self.errors.append(validation_error) - - def add_child(self, attribute, child): - for e in child.errors: - self.add(f"{attribute}.{e.attribute}", e.errmsg, e.errno) - - def check(self): - if self: - raise self - - def extend(self, errors): - for e in errors.errors: - self.add(e.attribute, e.errmsg, e.errno) - - def __iter__(self): - for e in self.errors: - yield e.attribute, e.errmsg, e.errno - - def __bool__(self): - return bool(self.errors) - - def __str__(self): - output = '' - for e in self.errors: - output += str(e) + '\n' - return output - - def __contains__(self, item): - return item in [e.attribute for e in self.errors] - - -class CatalogDoesNotExist(ValidationException): - def __init__(self, path): - super().__init__(f'Failed to find a catalog at {path}', errno.ENOENT) diff --git a/archive/catalog_validation/ix-source/catalog_validation/git_utils.py b/archive/catalog_validation/ix-source/catalog_validation/git_utils.py deleted file mode 100644 index adbcf5fb0c2..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/git_utils.py +++ /dev/null @@ -1,42 +0,0 @@ -import os -import subprocess - -from catalog_validation.ci.utils import DEV_DIRECTORY_RELATIVE_PATH, get_ci_development_directory -from catalog_validation.items.utils import valid_train -from collections import defaultdict - -from .ci.utils import OPTIONAL_METADATA_FILES -from .exceptions import CatalogDoesNotExist - - -def get_changed_apps(catalog_path: str, base_branch: str = 'master') -> dict: - if not os.path.exists(catalog_path): - raise CatalogDoesNotExist(catalog_path) - - cp = subprocess.run( - ['git', '-C', catalog_path, '--no-pager', 'diff', '--name-only', base_branch], - capture_output=True, check=True, - ) - dev_directory_path = get_ci_development_directory(catalog_path) - to_check_apps = defaultdict(list) - for file_path in filter( - lambda path: path and path.startswith(f'{DEV_DIRECTORY_RELATIVE_PATH}/'), - map(str.strip, cp.stdout.decode().split('\n')) - ): - dev_dir_relative_path = file_path.strip(f'{DEV_DIRECTORY_RELATIVE_PATH}/') - train_name = dev_dir_relative_path.split('/', 1)[0] - if not valid_train(train_name, os.path.join(dev_directory_path, train_name)): - continue - - app_name = dev_dir_relative_path.split('/')[1] - base_name = os.path.basename(file_path) - - if base_name in OPTIONAL_METADATA_FILES: - continue - if not os.path.isdir(os.path.join(dev_directory_path, train_name, app_name)): - continue - - if app_name not in to_check_apps[train_name]: - to_check_apps[train_name].append(app_name) - - return to_check_apps diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/__init__.py b/archive/catalog_validation/ix-source/catalog_validation/items/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/catalog.py b/archive/catalog_validation/ix-source/catalog_validation/items/catalog.py deleted file mode 100644 index b45dff64331..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/items/catalog.py +++ /dev/null @@ -1,83 +0,0 @@ -import concurrent.futures -import functools -import os -import typing -import yaml - -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from .items_util import get_item_details, get_default_questions_context -from .utils import RECOMMENDED_APPS_FILENAME, RECOMMENDED_APPS_SCHEMA, valid_train - - -def item_details(items: dict, location: str, questions_context: typing.Optional[dict], item_key: str) -> dict: - train = items[item_key] - item = item_key.removesuffix(f'_{train}') - item_location = os.path.join(location, train, item) - return get_item_details(item_location, questions_context, {'retrieve_versions': True}) - - -def retrieve_train_names(location: str, all_trains=True, trains_filter=None) -> list: - train_names = [] - trains_filter = trains_filter or [] - for train in os.listdir(location): - if not (all_trains or train in trains_filter) or not valid_train(train, os.path.join(location, train)): - continue - train_names.append(train) - return train_names - - -def get_items_in_trains(trains_to_traverse: list, catalog_location: str) -> dict: - items = {} - for train in trains_to_traverse: - items.update({ - f'{i}_{train}': train for i in os.listdir(os.path.join(catalog_location, train)) - if os.path.isdir(os.path.join(catalog_location, train, i)) - }) - - return items - - -def retrieve_trains_data( - items: dict, catalog_location: str, preferred_trains: list, - trains_to_traverse: list, job: typing.Any = None, questions_context: typing.Optional[dict] = None -) -> typing.Tuple[dict, set]: - questions_context = questions_context or get_default_questions_context() - trains = { - 'charts': {}, - 'test': {}, - **{k: {} for k in trains_to_traverse}, - } - unhealthy_apps = set() - - total_items = len(items) - with concurrent.futures.ProcessPoolExecutor(max_workers=(5 if total_items > 10 else 2)) as exc: - for index, result in enumerate(zip(items, exc.map( - functools.partial(item_details, items, catalog_location, questions_context), - items, chunksize=(10 if total_items > 10 else 5) - ))): - item_key = result[0] - item_info = result[1] - train = items[item_key] - item = item_key.removesuffix(f'_{train}') - if job: - job.set_progress( - int((index / total_items) * 80) + 10, - f'Retrieved information of {item!r} item from {train!r} train' - ) - trains[train][item] = item_info - if train in preferred_trains and not trains[train][item]['healthy']: - unhealthy_apps.add(f'{item} ({train} train)') - - return trains, unhealthy_apps - - -def retrieve_recommended_apps(catalog_location: str) -> typing.Dict[str, list]: - try: - with open(os.path.join(catalog_location, RECOMMENDED_APPS_FILENAME), 'r') as f: - data = yaml.safe_load(f.read()) - json_schema_validate(data, RECOMMENDED_APPS_SCHEMA) - except (FileNotFoundError, JsonValidationError, yaml.YAMLError): - return {} - else: - return data diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/features.py b/archive/catalog_validation/ix-source/catalog_validation/items/features.py deleted file mode 100644 index 3ec64c8f22a..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/items/features.py +++ /dev/null @@ -1,19 +0,0 @@ -SUPPORTED_FEATURES = { - 'normalize/interfaceConfiguration', - 'normalize/ixVolume', - 'definitions/certificate', - 'definitions/certificateAuthority', - 'definitions/interface', - 'definitions/gpuConfiguration', - 'definitions/timezone', - 'definitions/nodeIP', - 'validations/containerImage', - 'validations/nodePort', - 'validations/hostPath', - 'validations/lockedHostPath', - 'validations/hostPathAttachments', -} - - -def version_supported(version_details: dict) -> bool: - return not bool(set(version_details['required_features']) - SUPPORTED_FEATURES) diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/items_util.py b/archive/catalog_validation/ix-source/catalog_validation/items/items_util.py deleted file mode 100644 index 468b4bbbd4b..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/items/items_util.py +++ /dev/null @@ -1,216 +0,0 @@ -import markdown -import os -import typing -import yaml - -from pkg_resources import parse_version - -from catalog_validation.exceptions import ValidationErrors - -from .features import version_supported -from .questions_utils import normalise_questions -from .utils import get_last_updated_date -from .validate_utils import validate_item, validate_item_version - - -ITEM_KEYS = ['icon_url'] - - -def get_item_details_base(retrieve_complete_item_keys: bool = True) -> dict: - return { - 'app_readme': None, - 'categories': [], - 'description': None, - 'healthy': False, # healthy means that each version the item hosts is valid and healthy - 'healthy_error': None, # An error string explaining why the item is not healthy - 'home': None, - 'location': None, - 'latest_version': None, - 'latest_app_version': None, - 'latest_human_version': None, - 'last_update': None, - 'name': None, - 'recommended': False, - 'title': None, - 'maintainers': [], - 'tags': [], - 'screenshots': [], - 'sources': [], - **({ - 'versions': {}, - } if retrieve_complete_item_keys else {}), - } - - -def get_item_details( - item_location: str, questions_context: typing.Optional[dict] = None, options: typing.Optional[dict] = None -) -> dict: - catalog_path = item_location.rstrip('/').rsplit('/', 2)[0] - item = item_location.rsplit('/', 1)[-1] - train = item_location.rsplit('/', 2)[-2] - - options = options or {} - retrieve_versions = options.get('retrieve_versions', True) - item_data = get_item_details_base() - item_data.update({ - 'location': item_location, - 'last_update': get_last_updated_date(catalog_path, item_location), - 'name': item, - 'title': item.capitalize(), - }) - - schema = f'{train}.{item}' - try: - validate_item(item_location, schema, False) - except ValidationErrors as verrors: - item_data['healthy_error'] = f'Following error(s) were found with {item!r}:\n' - for verror in verrors: - item_data['healthy_error'] += f'{verror[0]}: {verror[1]}' - - # If the item format is not valid - there is no point descending any further into versions - if not retrieve_versions: - item_data.pop('versions') - return item_data - - item_data.update(get_item_details_impl(item_location, schema, questions_context, { - 'retrieve_latest_version': not retrieve_versions, - 'default_values_callable': options.get('default_values_callable'), - })) - unhealthy_versions = [] - for k, v in sorted(item_data['versions'].items(), key=lambda v: parse_version(v[0]), reverse=True): - if not v['healthy']: - unhealthy_versions.append(k) - else: - chart_metadata = v['chart_metadata'] - if not item_data['app_readme']: - item_data['app_readme'] = v['app_readme'] - if not item_data['maintainers'] and chart_metadata.get('maintainers'): - item_data['maintainers'] = chart_metadata['maintainers'] - if not item_data['latest_version']: - item_data['latest_version'] = k - item_data['latest_app_version'] = chart_metadata.get('appVersion') - item_data['latest_human_version'] = '' - if item_data['latest_app_version']: - item_data['latest_human_version'] = f'{item_data["latest_app_version"]}_' - item_data['latest_human_version'] += k - if not item_data['description'] and chart_metadata.get('description'): - item_data['description'] = v['chart_metadata']['description'] - if item_data['title'] == item_data['name'].capitalize() and chart_metadata.get( - 'annotations', {} - ).get('title'): - item_data['title'] = chart_metadata['annotations']['title'] - if item_data['home'] is None and chart_metadata.get('home'): - item_data['home'] = chart_metadata['home'] - if not item_data['sources'] and chart_metadata.get('sources'): - item_data['sources'] = chart_metadata['sources'] - - if unhealthy_versions: - item_data['healthy_error'] = f'Errors were found with {", ".join(unhealthy_versions)} version(s)' - else: - item_data['healthy'] = True - if not retrieve_versions: - item_data.pop('versions') - - return item_data - - -def get_item_details_impl( - item_path: str, schema: str, questions_context: typing.Optional[dict], options: typing.Optional[dict] -) -> dict: - # Each directory under item path represents a version of the item and we need to retrieve details - # for each version available under the item - retrieve_latest_version = options.get('retrieve_latest_version') - item_data = { - 'categories': [], - 'icon_url': None, - 'screenshots': [], - 'tags': [], - 'versions': {}, - } - with open(os.path.join(item_path, 'item.yaml'), 'r') as f: - item_data.update(yaml.safe_load(f.read())) - - item_data.update({k: item_data.get(k) for k in ITEM_KEYS}) - - for version in sorted( - filter(lambda p: os.path.isdir(os.path.join(item_path, p)), os.listdir(item_path)), - reverse=True, key=parse_version, - ): - catalog_path = item_path.rstrip('/').rsplit('/', 2)[0] - version_path = os.path.join(item_path, version) - item_data['versions'][version] = version_details = { - 'healthy': False, - 'supported': False, - 'healthy_error': None, - 'location': version_path, - 'last_update': get_last_updated_date(catalog_path, version_path), - 'required_features': [], - 'human_version': version, - 'version': version, - } - try: - validate_item_version(version_details['location'], f'{schema}.{version}') - except ValidationErrors as verrors: - version_details['healthy_error'] = f'Following error(s) were found with {schema}.{version!r}:\n' - for verror in verrors: - version_details['healthy_error'] += f'{verror[0]}: {verror[1]}' - - # There is no point in trying to see what questions etc the version has as it's invalid - continue - - version_details.update({ - 'healthy': True, - **get_item_version_details(version_details['location'], questions_context) - }) - if retrieve_latest_version: - break - - return item_data - - -def get_item_version_details( - version_path: str, questions_context: typing.Optional[dict], options: typing.Optional[dict] = None -) -> dict: - version_data = {'location': version_path, 'required_features': set()} - for key, filename, parser in ( - ('chart_metadata', 'Chart.yaml', yaml.safe_load), - ('app_metadata', 'metadata.yaml', yaml.safe_load), - ('schema', 'questions.yaml', yaml.safe_load), - ('app_readme', 'app-readme.md', markdown.markdown), - ('detailed_readme', 'README.md', markdown.markdown), - ('changelog', 'CHANGELOG.md', markdown.markdown), - ): - if os.path.exists(os.path.join(version_path, filename)): - with open(os.path.join(version_path, filename), 'r') as f: - version_data[key] = parser(f.read()) - else: - version_data[key] = None - - # We will normalise questions now so that if they have any references, we render them accordingly - # like a field referring to available interfaces on the system - normalise_questions(version_data, questions_context or get_default_questions_context()) - - version_data.update({ - 'supported': version_supported(version_data), - 'required_features': list(version_data['required_features']), - }) - if options and options.get('default_values_callable'): - version_data['values'] = options['default_values_callable'](version_data) - chart_metadata = version_data['chart_metadata'] - if chart_metadata['name'] != 'ix-chart' and chart_metadata.get('appVersion'): - version_data['human_version'] = f'{chart_metadata["appVersion"]}_{chart_metadata["version"]}' - - return version_data - - -def get_default_questions_context() -> dict: - return { - 'nic_choices': [], - 'gpus': {}, - 'timezones': {'Asia/Saigon': 'Asia/Saigon', 'Asia/Damascus': 'Asia/Damascus'}, - 'node_ip': '192.168.0.10', - 'certificates': [], - 'certificate_authorities': [], - 'system.general.config': {'timezone': 'America/Los_Angeles'}, - 'unused_ports': [i for i in range(1025, 65535)], - } diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/ix_values_utils.py b/archive/catalog_validation/ix-source/catalog_validation/items/ix_values_utils.py deleted file mode 100644 index 0fcc046b439..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/items/ix_values_utils.py +++ /dev/null @@ -1,58 +0,0 @@ -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from catalog_validation.exceptions import ValidationErrors - - -CUSTOM_PORTALS_JSON_SCHEMA = { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'portalName': { - 'type': 'string', - }, - 'protocol': { - 'type': 'string', 'enum': ['http', 'https'], - }, - 'useNodeIP': { - 'type': 'boolean', - }, - 'port': { - 'type': 'integer', - }, - 'path': { - 'type': 'string', - }, - }, - 'allOf': [ - { - 'if': { - 'properties': { - 'useNodeIP': { - 'const': False, - }, - }, - }, - 'then': { - 'required': ['host'], - 'properties': { - 'host': { - 'type': 'string', - }, - }, - }, - }], - 'required': ['portalName', 'protocol', 'useNodeIP', 'port'], - }, -} - - -def validate_ix_values_schema(schema, data): - verrors = ValidationErrors() - - try: - json_schema_validate(data, CUSTOM_PORTALS_JSON_SCHEMA) - except JsonValidationError as e: - verrors.add(schema, f'Failed to validate schema: {e}') - - verrors.check() diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/questions_utils.py b/archive/catalog_validation/ix-source/catalog_validation/items/questions_utils.py deleted file mode 100644 index d0255d2add3..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/items/questions_utils.py +++ /dev/null @@ -1,186 +0,0 @@ -import itertools - -from .utils import ACL_QUESTION, IX_VOLUMES_ACL_QUESTION - - -CUSTOM_PORTALS_KEY = 'iXPortals' -CUSTOM_PORTALS_ENABLE_KEY = 'enableIXPortals' -CUSTOM_PORTAL_GROUP_KEY = 'iXPortalsGroupName' - - -def get_custom_portal_question(group_name: str) -> dict: - return { - 'variable': CUSTOM_PORTALS_KEY, - 'label': 'User Specified Web Portals', - 'description': 'User(s) can specify custom webUI portals', - 'group': group_name, - 'schema': { - 'type': 'list', - 'items': [{ - 'variable': 'portalConfiguration', - 'label': 'Portal Configuration', - 'description': 'Configure WebUI Portal', - 'schema': { - 'type': 'dict', - 'attrs': [ - { - 'variable': 'portalName', - 'label': 'Portal Name', - 'description': 'Specify a UI Portal name to use which would be displayed in the UI', - 'schema': { - 'type': 'string', - 'default': 'Web Portal', - 'empty': False, - }, - }, - { - 'variable': 'protocol', - 'label': 'Protocol for Portal', - 'description': 'Specify protocol for Portal', - 'schema': { - 'type': 'string', - 'default': 'http', - 'enum': [ - {'value': 'http', 'description': 'HTTP Protocol'}, - {'value': 'https', 'description': 'HTTPS Protocol'}, - ], - }, - }, - { - 'variable': 'useNodeIP', - 'label': 'Use Node IP for Portal IP/Domain', - 'schema': { - 'type': 'boolean', - 'default': True, - }, - }, - { - 'variable': 'host', - 'label': 'Portal IP/Domain', - 'schema': { - 'type': 'string', - 'show_if': [['useNodeIP', '=', False]], - '$ref': ['definitions/nodeIP'], - }, - }, - { - 'variable': 'port', - 'label': 'Port', - 'description': 'Specify port to be used for Portal access', - 'schema': { - 'type': 'int', - 'max': 65535, - 'default': 15000, - }, - }, - { - 'variable': 'path', - 'label': 'Path (optional - leave empty if not required)', - 'description': 'Some app(s) might have a sub path i.e http://192.168.0.10:9000/api/', - 'schema': { - 'type': 'string', - }, - }, - ], - }, - }], - }, - } - - -def normalise_questions(version_data: dict, context: dict) -> None: - version_data['required_features'] = set() - version_data['schema']['questions'].extend( - [ - get_custom_portal_question(version_data['schema'][CUSTOM_PORTAL_GROUP_KEY]) - ] if version_data['schema'].get(CUSTOM_PORTALS_ENABLE_KEY) else [] - ) - for question in version_data['schema']['questions']: - normalise_question(question, version_data, context) - version_data['required_features'] = list(version_data['required_features']) - - -def normalise_question(question: dict, version_data: dict, context: dict) -> None: - schema = question['schema'] - for attr in itertools.chain(*[schema.get(k, []) for k in ('attrs', 'items', 'subquestions')]): - normalise_question(attr, version_data, context) - - if '$ref' not in schema: - return - - data = {} - for ref in schema['$ref']: - version_data['required_features'].add(ref) - if ref == 'definitions/interface': - data['enum'] = [ - {'value': i, 'description': f'{i!r} Interface'} for i in context['nic_choices'] - ] - elif ref == 'definitions/gpuConfiguration': - data['attrs'] = [ - { - 'variable': gpu, - 'label': f'GPU Resource ({gpu})', - 'description': 'Please enter the number of GPUs to allocate', - 'schema': { - 'type': 'int', - 'max': int(quantity), - 'enum': [ - {'value': i, 'description': f'Allocate {i!r} {gpu} GPU'} - for i in range(int(quantity) + 1) - ], - 'default': 0, - } - } for gpu, quantity in context['gpus'].items() - ] - elif ref == 'definitions/timezone': - data.update({ - 'enum': [{'value': t, 'description': f'{t!r} timezone'} for t in sorted(context['timezones'])], - 'default': context['system.general.config']['timezone'] - }) - elif ref == 'definitions/nodeIP': - data['default'] = context['node_ip'] - elif ref == 'definitions/certificate': - get_cert_ca_options(schema, data, {'value': None, 'description': 'No Certificate'}) - data['enum'] += [ - {'value': i['id'], 'description': f'{i["name"]!r} Certificate'} - for i in context['certificates'] - ] - elif ref == 'definitions/certificateAuthority': - get_cert_ca_options(schema, data, {'value': None, 'description': 'No Certificate Authority'}) - data['enum'] += [{'value': None, 'description': 'No Certificate Authority'}] + [ - {'value': i['id'], 'description': f'{i["name"]!r} Certificate Authority'} - for i in context['certificate_authorities'] - ] - elif ref == 'definitions/port': - data['enum'] = [{'value': None, 'description': 'No Port Selected'}] if schema.get('null') else [] - data['enum'] += [ - {'value': i, 'description': f'{i!r} Port'} - for i in filter( - lambda p: schema.get('min', 9000) <= p <= schema.get('max', 65534), - context['unused_ports'] - ) - ] - elif ref == 'normalize/acl': - data['attrs'] = ACL_QUESTION - elif ref == 'normalize/ixVolume': - if schema['type'] == 'dict' and any(i['variable'] == 'aclEntries' for i in schema['attrs']): - # get index of aclEntries from attrs - acl_index = next(i for i, v in enumerate(schema['attrs']) if v['variable'] == 'aclEntries') - # insert acl question before aclEntries - schema['attrs'][acl_index]['schema']['attrs'] = IX_VOLUMES_ACL_QUESTION - - schema.update(data) - - -def get_cert_ca_options(schema: dict, data: dict, default_entry: dict): - if schema.get('null', True): - data.update({ - 'enum': [default_entry], - 'default': None, - 'null': True, - }) - else: - data.update({ - 'enum': [], - 'required': True, - }) diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/utils.py b/archive/catalog_validation/ix-source/catalog_validation/items/utils.py deleted file mode 100644 index 64abe39f908..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/items/utils.py +++ /dev/null @@ -1,243 +0,0 @@ -import contextlib -import os -import subprocess - -from datetime import datetime -from typing import Optional - -from catalog_validation.schema.migration_schema import MIGRATION_DIRS -from catalog_validation.utils import VALID_TRAIN_REGEX - - -DEVELOPMENT_DIR = 'ix-dev' -RECOMMENDED_APPS_FILENAME = 'recommended_apps.yaml' -RECOMMENDED_APPS_SCHEMA = { - 'type': 'object', - 'patternProperties': { - '.*': { - 'type': 'array', - 'items': {'type': 'string'}, - } - }, -} -TRAIN_IGNORE_DIRS = ['library', 'docs', DEVELOPMENT_DIR] + MIGRATION_DIRS - - -ACL_QUESTION = [ - { - 'variable': 'path', - 'label': 'Host Path', - 'description': 'Host Path to perform ACL', - 'schema': { - 'type': 'hostpath', - 'required': True, - 'empty': False, - } - }, - { - 'variable': 'entries', - 'label': 'ACL Entries', - 'description': 'ACL Entries', - 'schema': { - 'type': 'list', - 'items': [{ - 'variable': 'aclEntry', - 'label': 'ACL Entry', - 'schema': { - 'type': 'dict', - 'attrs': [ - { - 'variable': 'id_type', - 'label': 'ID Type', - 'schema': { - 'type': 'string', - 'enum': [ - {'value': 'USER', 'description': 'Entry is for a USER'}, - {'value': 'GROUP', 'description': 'Entry is for a GROUP'}, - ], - 'default': 'USER', - } - }, - { - 'variable': 'id', - 'label': 'ID', - 'description': 'Make sure to check the ID value is correct and aligns with ' - 'RunAs user context of the application', - 'schema': { - 'type': 'int', - 'required': True, - 'min': 0, - } - }, - { - 'variable': 'access', - 'label': 'Access', - 'schema': { - 'type': 'string', - 'enum': [ - {'value': 'READ', 'description': 'Read Access'}, - {'value': 'MODIFY', 'description': 'Modify Access'}, - {'value': 'FULL_CONTROL', 'description': 'FULL_CONTROL Access'}, - ], - } - } - ], - } - }] - } - }, - { - 'variable': 'options', - 'label': 'ACL Options', - 'schema': { - 'type': 'dict', - 'attrs': [ - { - 'variable': 'force', - 'label': 'Force Flag', - 'description': 'Enabling `Force` applies ACL even if the path has existing data', - 'schema': { - 'type': 'boolean', - 'default': False, - } - }, - ], - }, - }, -] - -IX_VOLUMES_ACL_QUESTION = [ - { - 'variable': 'path', - 'label': 'Path', - 'description': 'Path to perform ACL', - 'schema': { - 'type': 'string', - 'hidden': True - } - }, - ACL_QUESTION[1] -] - - -def get_catalog_json_schema() -> dict: - return { - 'type': 'object', - 'patternProperties': { - '.*': { - 'type': 'object', - 'title': 'Train', - 'patternProperties': { - '.*': { - 'type': 'object', - 'title': 'Item', - 'properties': { - 'name': { - 'type': 'string', - 'title': 'Name', - }, - 'categories': { - 'type': 'array', - 'items': { - 'type': 'string' - }, - }, - 'app_readme': { - 'type': 'string', - }, - 'location': { - 'type': 'string', - }, - 'healthy': { - 'type': 'boolean', - }, - 'healthy_error': { - 'type': ['string', 'null'], - }, - 'last_update': { - 'type': 'string', - 'pattern': r'^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$', - }, - 'latest_version': { - 'type': 'string', - }, - 'latest_app_version': { - 'type': 'string', - }, - 'latest_human_version': { - 'type': 'string', - }, - 'description': { - 'type': ['string', 'null'], - }, - 'title': { - 'type': 'string', - }, - 'icon_url': { - 'type': ['string', 'null'], - }, - 'maintainers': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': {'type': 'string'}, - 'url': {'type': ['string', 'null']}, - 'email': {'type': 'string'} - }, - 'required': ['name', 'email'], - } - }, - 'home': { - 'type': 'string', - }, - 'tags': { - 'type': 'array', - 'items': { - 'type': 'string', - } - }, - 'screenshots': { - 'type': 'array', - 'items': { - 'type': 'string', - } - }, - 'sources': { - 'type': 'array', - 'items': { - 'type': 'string', - } - }, - }, - 'required': [ - 'name', 'categories', 'location', 'healthy', 'icon_url', - 'latest_version', 'latest_app_version', 'latest_human_version', - 'last_update', 'recommended', 'healthy_error', 'maintainers', - 'home', 'tags', 'sources', 'screenshots', - ], - } - } - - } - } - } - - -def get_last_updated_date(repo_path: str, folder_path: str) -> Optional[str]: - with contextlib.suppress(Exception): - # We don't want to fail querying items if for whatever reason this fails - output = subprocess.check_output( - ['git', 'log', '-n', '1', '--pretty=format:%ct', f'{folder_path}'], - cwd=repo_path, - stderr=subprocess.DEVNULL - ) - if output: - timestamp = datetime.fromtimestamp(int(output)) - return timestamp.strftime('%Y-%m-%d %H:%M:%S') - - -def valid_train(train_name: str, train_location: str) -> bool: - return VALID_TRAIN_REGEX.match( - train_name - ) and not train_name.startswith('.') and train_name not in TRAIN_IGNORE_DIRS and os.path.isdir(train_location) diff --git a/archive/catalog_validation/ix-source/catalog_validation/items/validate_utils.py b/archive/catalog_validation/ix-source/catalog_validation/items/validate_utils.py deleted file mode 100644 index 3cecf3bafa0..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/items/validate_utils.py +++ /dev/null @@ -1,9 +0,0 @@ -from catalog_validation.validation import validate_catalog_item, validate_catalog_item_version - - -def validate_item(path: str, schema: str, validate_versions: bool = True): - validate_catalog_item(path, schema, validate_versions) - - -def validate_item_version(path: str, schema: str): - validate_catalog_item_version(path, schema) diff --git a/archive/catalog_validation/ix-source/catalog_validation/k8s/__init__.py b/archive/catalog_validation/ix-source/catalog_validation/k8s/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/ix-source/catalog_validation/k8s/api_client.py b/archive/catalog_validation/ix-source/catalog_validation/k8s/api_client.py deleted file mode 100644 index cec1da78513..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/k8s/api_client.py +++ /dev/null @@ -1,15 +0,0 @@ -from contextlib import contextmanager - -from kubernetes import client, config - -from .utils import KUBECONFIG_FILE - - -@contextmanager -def api_client(): - config.load_kube_config(config_file=KUBECONFIG_FILE) - api_cl = client.api_client.ApiClient() - try: - yield client.CoreV1Api(api_cl) - finally: - api_cl.close() diff --git a/archive/catalog_validation/ix-source/catalog_validation/k8s/utils.py b/archive/catalog_validation/ix-source/catalog_validation/k8s/utils.py deleted file mode 100644 index c973e77e210..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/k8s/utils.py +++ /dev/null @@ -1 +0,0 @@ -KUBECONFIG_FILE = '/etc/rancher/k3s/k3s.yaml' diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/requirements.txt b/archive/catalog_validation/ix-source/catalog_validation/pytest/requirements.txt deleted file mode 100644 index 12136494321..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -pytest -pytest-mock diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_catalog_validate.py b/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_catalog_validate.py deleted file mode 100644 index d22b2ac5762..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_catalog_validate.py +++ /dev/null @@ -1,368 +0,0 @@ -import pytest - -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.utils import WANTED_FILES_IN_ITEM_VERSION -from catalog_validation.validation import ( - validate_train_structure, validate_questions_yaml, validate_catalog_item, - validate_catalog_item_version, validate_variable_uniqueness, -) - - -@pytest.mark.parametrize('train_path,should_work', [ - ('/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts', True), - ('/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/', False), - -]) -def test_validate_train_structure(train_path, should_work): - if should_work: - assert validate_train_structure(train_path) is None - else: - with pytest.raises(ValidationErrors): - validate_train_structure(train_path) - - -@pytest.mark.parametrize('test_yaml,should_work', [ - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - portals: - web_portal: - protocols: - - "http" - host: - - "$node_ip" - ports: - - "$variable-machinaris_ui_port" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - True - ), - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - portals: - web_portal: - protocols: {} - host: {} - ports: {} - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - ( - ''' - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - True - ), - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Network" - group: "Machinaris Network Configuration" - description: "Configure timezone for machianaris" - - ''', - False - ), - ( - ''' - enableIXPortals: true - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - ( - ''' - enableIXPortals: true - iXPortalsGroupName: "Machinaris Configuration" - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - True - ), - ( - ''' - enableIXPortals: true - iXPortalsGroupName: "Invalid Group name" - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - -]) -def test_validate_questions_yaml(mocker, test_yaml, should_work): - open_file_data = mocker.mock_open(read_data=test_yaml) - mocker.patch('builtins.open', open_file_data) - mocker.patch('catalog_validation.validation.validate_question', return_value=None) - if should_work: - assert validate_questions_yaml(None, 'charts.machinaris.versions.1.1.13.questions_configuration') is None - else: - with pytest.raises(ValidationErrors): - validate_questions_yaml(None, 'charts.machinaris.versions.1.1.13.questions_configuration') - - -@pytest.mark.parametrize('catalog_item_path,test_yaml,should_work', [ - ( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/machinaris', - ''' - categories: - - storage - - crypto - icon_url: https://raw.githubusercontent.com/guydavis/machinaris/main/web/static/machinaris.png - ''', - True - ), - ( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/machinaris', - ''' - icon_url: https://raw.githubusercontent.com/guydavis/machinaris/main/web/static/machinaris.png - ''', - False - ), -]) -def test_validate_catalog_item(mocker, catalog_item_path, test_yaml, should_work): - mocker.patch('os.path.isdir', side_effect=[True, True, False]) - mocker.patch('os.listdir', return_value=['1.1.13', 'item.yaml']) - open_file_data = mocker.mock_open(read_data=test_yaml) - mocker.patch('builtins.open', open_file_data) - mocker.patch('catalog_validation.validation.validate_catalog_item_version', return_value=None) - if not should_work: - with pytest.raises(ValidationErrors): - validate_catalog_item(catalog_item_path, 'charts.machinaris') - else: - assert validate_catalog_item(catalog_item_path, 'charts.machinaris') is None - - -@pytest.mark.parametrize('chart_yaml,should_work', [ - ( - ''' - name: storj - version: 1.0.4 - ''', - True - ), - ( - ''' - name: storj - version: 1.0.0 - ''', - False - ), - ( - ''' - name: storj_s - version: 1.0.0 - ''', - False - ) -]) -def test_validate_catalog_item_version(mocker, chart_yaml, should_work): - mocker.patch('os.listdir', return_value=WANTED_FILES_IN_ITEM_VERSION) - mocker.patch('os.path.exists', return_value=True) - open_file = mocker.mock_open(read_data=chart_yaml) - mocker.patch('builtins.open', open_file) - mocker.patch('catalog_validation.validation.validate_questions_yaml', return_value=None) - mocker.patch('catalog_validation.validation.validate_ix_values_yaml', return_value=None) - mocker.patch('catalog_validation.validation.validate_app_migrations', return_value=None) - if should_work: - assert validate_catalog_item_version( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/storj/1.0.4', - 'charts.storj.versions.1.0.4') is None - else: - with pytest.raises(ValidationErrors): - validate_catalog_item_version( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/storj/1.0.4', - 'charts.storj.versions.1.0.4' - ) - - -@pytest.mark.parametrize('data,schema,should_work', [ - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'dnsConfig', - 'label': 'DNS Configuration', - 'group': 'Advanced DNS Settings', - 'schema': { - 'type': 'dict', - 'attrs': [] - } - }, - ], 'plex.questions', True), - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - ], 'plex.questions', False), - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'hostPathEnabled', - 'label': 'Enable Host Path for Plex Transcode Volume', - 'type': 'boolean', - 'default': False, - 'show_subquestions_if': False, - 'subquestions': [ - { - 'variable': 'hostPath', - 'label': 'Host Path for Plex Transcode Volume', - 'schema': { - 'type': 'hostpath', - 'required': True, - '$ref': [ - 'validations/lockedHostPath' - ] - } - }, - ] - } - ], 'plex.questions', True), - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'mountPath', - 'label': 'Plex Transcode Mount Path', - 'description': 'Path where the volume will be mounted inside the pod', - 'schema': { - 'type': 'path', - } - }, - { - 'variable': 'hostPathEnabled', - 'label': 'Enable Host Path for Plex Transcode Volume', - 'type': 'boolean', - 'default': False, - 'show_subquestions_if': False, - 'subquestions': [ - { - 'variable': 'hostPath', - 'label': 'Host Path for Plex Transcode Volume', - 'schema': { - 'type': 'hostpath', - 'required': True, - '$ref': [ - 'validations/lockedHostPath' - ] - } - }, - { - 'variable': 'mountPath', - 'label': 'Plex Transcode Mount Path', - 'description': 'Path where the volume will be mounted inside the pod', - 'schema': { - 'type': 'path', - } - }, - ] - } - ], 'plex.questions', False), -]) -def test_validate_variable_uniqueness(data, schema, should_work): - verrors = ValidationErrors() - if should_work: - assert validate_variable_uniqueness(data, schema, verrors) is None - else: - with pytest.raises(ValidationErrors): - validate_variable_uniqueness(data, schema, verrors) diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_items_util.py b/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_items_util.py deleted file mode 100644 index aab41eb59a9..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_items_util.py +++ /dev/null @@ -1,107 +0,0 @@ -import pytest - -from catalog_validation.items.items_util import get_item_details, get_item_details_impl - - -QUESTION_CONTEXT = { - 'nic_choices': [], - 'gpus': {}, - 'timezones': {'Asia/Saigon': 'Asia/Saigon', 'Asia/Damascus': 'Asia/Damascus'}, - 'node_ip': '192.168.0.10', - 'certificates': [], - 'certificate_authorities': [], - 'system.general.config': {'timezone': 'America/Los_Angeles'}, -} - - -@pytest.mark.parametrize('item_location,options,items_data', [ - ('/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/chia', - {'retrieve_versions': True}, - { - 'name': 'chia', - 'categories': [], - 'app_readme': None, - 'location': '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/chia', - 'healthy': True, - 'healthy_error': None, - 'home': None, - 'last_update': None, - 'versions': {}, - 'maintainers': [], - 'latest_version': None, - 'latest_app_version': None, - 'latest_human_version': None, - 'recommended': False, - 'title': 'Chia', - 'description': None, - 'tags': [], - 'screenshots': [], - 'sources': [], - } - ), -]) -def test_get_item_details(mocker, item_location, options, items_data): - mocker.patch('catalog_validation.items.items_util.validate_item', return_value=None) - mocker.patch('catalog_validation.items.items_util.get_item_details_impl', return_value={}) - assert get_item_details(item_location, QUESTION_CONTEXT, options) == items_data - - -@pytest.mark.parametrize('item_path,schema,options,yaml_data,item_data_impl,open_yaml', [ - ( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/chia', - 'charts.chia', - {'retrieve_latest_version': True}, { - 'variable': 'web_port', - 'label': 'Web Port for Diskover', - 'group': 'Networking', - 'schema': { - 'type': 'int', - 'min': 8000, - 'max': 65535, - 'default': 22510, - 'required': True - } - }, { - 'versions': { - '1.3.37': { - 'healthy': True, - 'supported': False, - 'healthy_error': None, - 'last_update': None, - 'location': '/mnt/mypool/ix-applications/catalogs/github_com_truenas_' - 'charts_git_master/charts/chia/1.3.37', - 'required_features': [], - 'human_version': '1.3.37', - 'version': '1.3.37' - } - }, - 'categories': ['storage', 'crypto'], - 'icon_url': 'https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg', - 'tags': ['finance'], - 'screenshots': ['https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg'], - 'sources': ['https://hub.docker.com/r/emby/embyserver'], - }, - ''' - screenshots: - - 'https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg' - tags: - - finance - categories: - - storage - - crypto - icon_url: https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg - sources: - - https://hub.docker.com/r/emby/embyserver - ''' - ), -]) -def test_get_item_details_impl( - mocker, item_path, schema, options, yaml_data, item_data_impl, open_yaml, -): - open_file_data = mocker.mock_open(read_data=open_yaml) - mocker.patch('builtins.open', open_file_data) - mocker.patch('os.path.isdir', return_value=True) - mocker.patch('os.listdir', return_value=['1.3.37']) - mocker.patch('catalog_validation.items.items_util.validate_item_version', return_value=None) - mocker.patch('catalog_validation.items.items_util.get_item_version_details', return_value={}) - assert get_item_details_impl(item_path, schema, QUESTION_CONTEXT, options) == item_data_impl diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_normalise_questions.py b/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_normalise_questions.py deleted file mode 100644 index 5372d6f63fa..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_normalise_questions.py +++ /dev/null @@ -1,321 +0,0 @@ -from catalog_validation.items.questions_utils import normalise_question -import pytest - - -VERSION_DATA = { - 'location': '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/syncthing/1.0.14', - 'required_features': { - 'normalize/ixVolume', - 'validations/lockedHostPath', - }, - 'chart_metadata': {}, - 'schema': { - 'variable': 'hostNetwork', - 'label': 'Host Network', - 'group': 'Networking', - }, - 'app_readme': 'there is not any', - 'detailed_readme': 'there is not any', - 'changelog': None, -} - - -@pytest.mark.parametrize('question,normalise_data,context', [ - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - 'enum': [], - } - }, { - 'nic_choices': [], - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - 'enum': [{ - 'value': 'ens0', - 'description': "'ens0' Interface" - }], - } - }, { - 'nic_choices': ['ens0'] - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - 'attrs': [{ - 'variable': 'test@gpu', - 'label': 'GPU Resource (test@gpu)', - 'description': 'Please enter the number of GPUs to allocate', - 'schema': { - 'type': 'int', - 'max': 3, - 'enum': [ - {'value': i, 'description': f'Allocate {i!r} test@gpu GPU'} - for i in range(4) - ], - 'default': 0, - } - }], - } - }, { - 'gpus': { - 'test@gpu': 3 - } - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - 'attrs': [], - } - }, { - 'gpus': {} - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/timezone'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/timezone'], - 'enum': [{ - 'value': 'Asia/Damascus', - 'description': "'Asia/Damascus' timezone", - }, { - 'value': 'Asia/Saigon', - 'description': "'Asia/Saigon' timezone", - }], - 'default': 'America/Los_Angeles', - } - }, - { - 'timezones': { - 'Asia/Saigon': 'Asia/Saigon', - 'Asia/Damascus': 'Asia/Damascus', - }, - 'system.general.config': { - 'timezone': 'America/Los_Angeles', - } - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/nodeIP'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/nodeIP'], - 'default': '192.168.0.10', - } - }, - { - 'node_ip': '192.168.0.10' - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate' - }, - { - 'value': '1', - 'description': "'testcert' Certificate" - } - ], - 'default': None, - 'null': True - } - }, {'certificates': [{ - 'id': '1', - 'name': 'testcert' - }], - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate' - }], - 'default': None, - 'null': True - } - }, { - 'certificates': [] - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate Authority' - }, { - 'value': None, - 'description': 'No Certificate Authority' - }], - 'default': None, - 'null': True - } - }, { - 'certificate_authorities': [] - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate Authority' - }, { - 'value': None, - 'description': 'No Certificate Authority' - }, - { - 'value': '1', - 'description': "'testca' Certificate Authority" - } - ], - 'default': None, - 'null': True - } - }, { - 'certificate_authorities': [{ - 'id': '1', - 'name': 'testca' - }], - } - ) -]) -def test_normalise_question(question, normalise_data, context): - normalise_question(question, VERSION_DATA, context) - assert question == normalise_data diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_schema.py b/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_schema.py deleted file mode 100644 index a741a0fa086..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_schema.py +++ /dev/null @@ -1,577 +0,0 @@ -import pytest - -from catalog_validation.schema.schema_gen import get_schema -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.validation import validate_question - - -@pytest.mark.parametrize('schema,should_work', [ - ( - { - 'type': 'dict', - 'attrs': [] - }, - True - ), - ( - { - 'type': 'dict', - 'attrs': {} - }, - False - ), - ( - { - 'type': 'list' - }, - False - ), - ( - { - 'type': 'list', - 'items': [] - }, - True - ), - ( - { - 'type': 'list', - 'items': {} - }, - False - ), - ( - { - 'type': 'string', - 'editable': True - }, - True - ), - ( - { - 'type': 'string', - 'default': 'hello' - }, - True - ), - ( - { - 'type': 'string', - 'default': 1 - }, - False - ), - ( - { - 'type': 'string', - 'editable': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'private': True - }, - True - ), - ( - { - 'type': 'string', - 'private': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'max_length': 233 - }, - True - ), - ( - { - 'type': 'string', - 'max_length': '233' - }, - False - ), - ( - { - 'type': 'string', - 'min_length': 233 - }, - True - ), - ( - { - 'type': 'string', - 'min_length': '233' - }, - False - ), - ( - { - 'type': 'string', - 'valid_chars': '[a-z]*' - }, - True - ), - ( - { - 'type': 'string', - 'valid_chars': ['a-z'] - }, - False - ), - ( - { - 'type': 'string', 'null': True - }, - True - ), - ( - { - 'type': 'string', - 'null': 'true' - }, False - ), - ( - { - 'type': 'string', - 'immutable': True - }, - True - ), - ( - { - 'type': 'string', - 'immutable': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'required': True - }, - True - ), - ( - { - 'type': 'string', - 'required': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'hidden': True - }, - True - ), - ( - { - 'type': 'string', - 'hidden': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'show_if': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'show_if': [['hello', '=', 'world']] - }, - True - ), - ( - { - 'type': 'string', - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'subquestions': {} - }, - False - ), - ( - { - 'type': 'string', - 'show_subquestions_if': None - }, False - ), - ( - { - 'type': 'string', - 'show_subquestions_if': None, - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': 1, - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': 'test', - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': {}, - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': [], - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - '$ui-ref': [] - }, - True - ), - ( - { - 'type': 'string', - '$ui-ref': {} - }, - False - ), - ( - { - 'type': 'string', - '$ref': [] - }, - True - ), - ( - { - 'type': 'string', - '$ref': {} - }, - False - ), - ( - { - 'type': 'int', - 'min': 233, - 'max': 2311 - }, - True - ), - ( - { - 'type': 'int', - 'min': '233', - 'max': 2311 - }, - False - ), - ( - { - 'type': 'int', - 'min': 233, - 'max': '2311' - }, - False - ), - ( - { - 'type': 'int', - 'default': 23 - }, - True - ), - ( - { - 'type': 'int', - 'default': '23' - }, - False - ), - ( - { - 'type': 'ipaddr', - 'ipv4': True, - 'ipv6': False, - 'cidr': True - }, - True - ), - ( - { - 'type': 'ipaddr', - 'ipv4': True, - 'ipv6': False, - 'cidr': 'true' - }, - False - ), - ( - { - 'type': 'ipaddr', - 'ipv4': True, - 'ipv6': 'False', - 'cidr': True - }, - False - ), - ( - { - 'type': 'ipaddr', - 'ipv4': 'True', - 'ipv6': False, - 'cidr': True - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{ - 'value': 'test', - 'description': 'test' - }] - }, - True - ), - ( - { - 'type': 'string', - 'enum': [{ - 'value': 'test', - 'description': 'test', - 'obj': {} - }] - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{ - 'value': 'test' - }] - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{ - 'key': 'value' - }] - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{}] - }, - False - ), - ( - { - 'type': 'hostpath' - }, - True - ), - ( - { - 'type': 'hostpath', - 'default': '/root/' - }, - True - ), - ( - { - 'type': 'hostpath', - 'default': 231 - }, - False - ), - ( - { - 'type': 'path' - }, - True - ), - ( - { - 'type': 'path', - 'default': '/root/' - }, - True - ), - ( - { - 'type': 'path', - 'default': 231 - }, - False - ), - ( - { - 'type': 'boolean' - }, - True - ), - ( - { - 'type': 'boolean', - 'default': True - }, - True - ), - ( - { - 'type': 'boolean', - 'default': 'true' - }, - False - ), - ( - { - 'type': 'cron' - }, - True - ), - ( - { - 'type': 'cron', - 'default': {} - }, - True - ), - ( - { - 'type': 'cron', - 'default': [] - }, - False - ), - ( - { - 'type': 'uri' - }, - True - ), - ( - { - 'type': 'uri', - 'default': 'http://www.google.com' - }, - True - ), - ( - { - 'type': 'uri', - 'default': 2133 - }, - False - ), -]) -def test_schema_validation(schema, should_work): - if not should_work: - with pytest.raises(ValidationErrors): - get_schema(schema).validate('') - else: - assert get_schema(schema).validate('') is None - - -@pytest.mark.parametrize('variable,should_work', [ - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing', - 'group': 'testing', - 'schema': { - 'type': 'boolean', - 'default': True - } - }, - True - ), - ( - { - 'variable': 'testing', - 'description': 'for testing', - 'group': 'testing', - 'schema': { - 'type': 'boolean', - 'default': True - } - }, - False - ), - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing' - }, - False - ), - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing', - 'schema': { - 'type': 'boolean', - 'default': True - } - }, - True - ), - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing', - 'schema': { - 'default': True - } - }, - False - ), -]) -def test_question_variable_validation(variable, should_work): - verrors = ValidationErrors() - validate_question(variable, '', verrors) - if not should_work: - with pytest.raises(ValidationErrors): - verrors.check() - else: - verrors.check() diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_util.py b/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_util.py deleted file mode 100644 index c4e8b75c33b..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_util.py +++ /dev/null @@ -1,17 +0,0 @@ -import pytest - -from catalog_validation.utils import RE_VERSION_PATTERN - - -@pytest.mark.parametrize('version,result', [ - ('22.04-MASTER-12345678', '22.04'), - ('24.10.1', '24.10.1'), - ('23.12', '23.12'), - ('22.02.0.1', '22.02.0.1'), - ('22.02-ALPHA', '22.02'), - ('24.04-MASTER', '24.04'), - ('20.23-INTERNAL', '20.23'), -]) -def test_version_regex_match(version, result): - match = RE_VERSION_PATTERN.findall(version) - assert len(match) == 1 and match[0] == result diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_validate_ix_values.py b/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_validate_ix_values.py deleted file mode 100644 index f634a92720c..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_validate_ix_values.py +++ /dev/null @@ -1,94 +0,0 @@ -import pytest -from catalog_validation.validation import validate_ix_values_yaml -from catalog_validation.exceptions import ValidationErrors - - -@pytest.mark.parametrize('schema, ix_values_yaml_path, test_yaml, should_work', [ - - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 'http', useNodeIP: false, host: '192.168.0.18', port: 9898}] - ''', - True - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 'http', useNodeIP: true, port: 9898}] - ''', - True - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 'htts', useNodeIP: true, port: 9898}] - ''', - False - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 09088, useNodeIP: true, port: '9898'}] - ''', - False - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', useNodeIP: true, port: '9898'}] - ''', - False - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - '', - False, - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - 'image pullPolicy ifNotPresent', - False, - ) -]) -def test_validate_ix_values(mocker, schema, ix_values_yaml_path, test_yaml, should_work): - open_file = mocker.mock_open(read_data=test_yaml) - mocker.patch('builtins.open', open_file) - - if should_work: - assert validate_ix_values_yaml(ix_values_yaml_path, schema) is None - else: - with pytest.raises(ValidationErrors): - validate_ix_values_yaml(ix_values_yaml_path, schema) diff --git a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_validation_utils.py b/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_validation_utils.py deleted file mode 100644 index 3f7eb815c36..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/pytest/unit/test_validation_utils.py +++ /dev/null @@ -1,104 +0,0 @@ -import pytest - -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.validation_utils import validate_min_max_version_values - - -@pytest.mark.parametrize( - 'annotations_dict,schema,expected_error', - [ - ( - { - 'min_scale_version': '23.04', - 'max_scale_version': '24.04' - }, - 'charts.plex.versions.1.7.56', - None - ), - ( - { - 'min_scale_version': '22.02-RC.2', - 'max_scale_version': '24.04' - }, - 'charts.plex.versions.1.7.56', - None - ), - ( - { - 'min_scale_version': '24.04', - 'max_scale_version': '23.04' - }, - 'charts.plex.versions.1.7.56', - 'Provided min_scale_version is greater than provided max_scale_version' - ), - ( - { - 'min_scale_version': '12', - 'max_scale_version': '24.04' - }, - 'charts.plex.versions.1.7.56', - 'Format of provided min_scale_version value is not correct' - ), - ( - { - 'min_scale_version': '24.04-MASTER-20230928-144829', - 'max_scale_version': '24.04' - }, - 'charts.plex.versions.1.7.56', - 'Format of provided min_scale_version value is not correct' - ), - ( - { - 'min_scale_version': '22.12.2-INTERNAL.9', - 'max_scale_version': '24.04' - }, - 'charts.plex.versions.1.7.56', - 'Format of provided min_scale_version value is not correct' - ), - ( - { - 'min_scale_version': '23.04', - }, - 'charts.plex.versions.1.7.56', - None - ), - ( - { - 'min_scale_version': 24.04, - }, - 'charts.plex.versions.1.7.56', - '\'min_scale_version\' value should be a \'str\'' - ), - ( - { - 'min_scale_version': None - }, - 'charts.plex.versions.1.7.56', - '\'min_scale_version\' value should be a \'str\'' - ), - ( - { - 'min_scale_version': '22.02.CUSTOM', - }, - 'charts.plex.versions.1.7.56', - 'Format of provided min_scale_version value is not correct' - ), - ( - { - 'min_scale_version': 'TrueNAS-SCALE-22.02-RC.1', - 'max_scale_version': '24.04' - }, - 'charts.plex.versions.1.7.56', - 'Format of provided min_scale_version value is not correct' - ), - ] -) -def test_validate_min_max_version_values(annotations_dict, schema, expected_error): - verrors = ValidationErrors() - if expected_error: - with pytest.raises(ValidationErrors) as ve: - validate_min_max_version_values(annotations_dict, verrors, schema) - verrors.check() - assert ve.value.errors[0].errmsg == expected_error - else: - assert validate_min_max_version_values(annotations_dict, verrors, schema) is None diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/__init__.py b/archive/catalog_validation/ix-source/catalog_validation/schema/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/attrs.py b/archive/catalog_validation/ix-source/catalog_validation/schema/attrs.py deleted file mode 100644 index dbf525f1754..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/schema/attrs.py +++ /dev/null @@ -1,282 +0,0 @@ -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from catalog_validation.exceptions import ValidationErrors - -from .feature_gen import get_feature -from .variable_gen import generate_variable - - -class Schema: - - DEFAULT_TYPE = NotImplementedError - - def __init__(self, include_subquestions_attrs=True, data=None): - self.required = self.null = self.show_if = self.ref = self.ui_ref = self.type =\ - self.editable = self.hidden = self.default = self._schema_data = None - self._skip_data_values = [] - if include_subquestions_attrs: - self.subquestions = self.show_subquestions_if = None - if data: - self.initialize_values(data) - - def initialize_values(self, data): - self._schema_data = data - for key, value in filter( - lambda k: hasattr(self, k[0]) and k[0] not in self._skip_data_values, data.items() - ): - setattr(self, key, value) - - def get_schema_str(self, schema): - if schema: - return f'{schema}.' - return '' - - def validate(self, schema, data=None): - if data: - self.initialize_values(data) - - if not self._schema_data: - raise Exception('Schema data must be initialized before validating schema') - - verrors = ValidationErrors() - try: - json_schema_validate(self._schema_data, self.json_schema()) - except JsonValidationError as e: - verrors.add(schema, f'Failed to validate schema: {e}') - - verrors.check() - - if '$ref' in self._schema_data: - for index, ref in enumerate(self._schema_data['$ref']): - if not isinstance(ref, str): - verrors.add(f'{schema}.$ref.{index}', 'Must be a string') - continue - - feature_obj = get_feature(ref) - if not feature_obj: - continue - try: - feature_obj.validate(self, f'{schema}.$ref.{index}') - except ValidationErrors as e: - verrors.extend(e) - - verrors.check() - - def json_schema(self): - schema = { - 'type': 'object', - 'properties': { - 'required': { - 'type': 'boolean', - }, - 'null': { - 'type': 'boolean', - }, - 'show_if': { - 'type': 'array', - }, - '$ref': { - 'type': 'array', - }, - '$ui-ref': { - 'type': 'array', - }, - 'subquestions': { - 'type': 'array', - }, - 'show_subquestions_if': { - 'type': ['string', 'integer', 'boolean', 'object', 'array', 'null'], - }, - 'type': { - 'type': 'string', - }, - 'editable': { - 'type': 'boolean', - }, - 'immutable': { - 'type': 'boolean', - }, - 'hidden': { - 'type': 'boolean', - }, - }, - 'required': ['type'], - 'dependentRequired': { - 'show_subquestions_if': ['subquestions'] - } - } - if self.DEFAULT_TYPE: - schema['properties']['default'] = { - 'type': [self.DEFAULT_TYPE] + (['null'] if self.null else []) - } - if hasattr(self, 'enum'): - schema['properties']['enum'] = { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'value': {'type': [self.DEFAULT_TYPE] + (['null'] if self.null else [])}, - 'description': {'type': ['string', 'null']}, - }, - 'additionalProperties': False, - 'required': ['value', 'description'] - }, - } - return schema - - -class BooleanSchema(Schema): - DEFAULT_TYPE = 'boolean' - - -class StringSchema(Schema): - DEFAULT_TYPE = 'string' - - def __init__(self, data): - self.min_length = self.max_length = self.enum = self.private = self.valid_chars = self.valid_chars_error = None - super().__init__(data=data) - - def json_schema(self): - schema = super().json_schema() - schema['properties'].update({ - 'min_length': { - 'type': 'integer', - }, - 'max_length': { - 'type': 'integer', - }, - 'private': { - 'type': 'boolean', - }, - 'valid_chars': { - 'type': 'string', - }, - 'valid_chars_error': { - 'type': 'string' - }, - }) - return schema - - -class TextFieldSchema(StringSchema): - def __init__(self, data): - super().__init__(data) - self.max_length = 1024 * 1024 - - def json_schema(self): - schema = super().json_schema() - schema['properties'].update({ - 'max_length': { - 'type': 'integer', - 'const': 1024 * 1024 - }, - 'language': { - 'type': 'string', - 'enum': ['yaml', 'json', 'toml', 'text'], - } - }) - return schema - - -class IntegerSchema(Schema): - DEFAULT_TYPE = 'integer' - - def __init__(self, data): - self.min = self.max = self.enum = None - super().__init__(data=data) - - def json_schema(self): - schema = super().json_schema() - schema['properties'].update({ - 'min': { - 'type': 'integer', - }, - 'max': { - 'type': 'integer', - }, - }) - return schema - - -class PathSchema(Schema): - DEFAULT_TYPE = 'string' - - -class HostPathSchema(Schema): - DEFAULT_TYPE = 'string' - - -class HostPathDirSchema(Schema): - DEFAULT_TYPE = 'string' - - -class HostPathFileSchema(Schema): - DEFAULT_TYPE = 'string' - - -class URISchema(Schema): - DEFAULT_TYPE = 'string' - - -class IPAddrSchema(Schema): - DEFAULT_TYPE = 'string' - - def __init__(self, data): - self.ipv4 = self.ipv6 = self.cidr = None - super().__init__(data=data) - - def json_schema(self): - schema = super().json_schema() - schema['properties'].update({ - 'ipv4': {'type': 'boolean'}, - 'ipv6': {'type': 'boolean'}, - 'cidr': {'type': 'boolean'}, - }) - return schema - - -class CronSchema(Schema): - DEFAULT_TYPE = 'object' - - -class DictSchema(Schema): - DEFAULT_TYPE = 'object' - - def __init__(self, data): - self.attrs = [] - self.additional_attrs = None - super().__init__(data=data) - self._skip_data_values = ['attrs'] - - def initialize_values(self, data): - super().initialize_values(data) - self.attrs = [generate_variable(d) for d in (data.get('attrs') or [])] - - def json_schema(self): - schema = super().json_schema() - schema['additionalProperties'] = bool(self.additional_attrs) - schema['properties']['attrs'] = {'type': 'array'} - schema['required'].append('attrs') - # We do not validate nested children and hence do not add it in the - # json schema as it makes it very complex to handle all the possibilities - return schema - - -class ListSchema(Schema): - - DEFAULT_TYPE = 'array' - - def __init__(self, data): - self.items = [] - super().__init__(False, data=data) - self._skip_data_values = ['items'] - - def initialize_values(self, data): - super().initialize_values(data) - self.items = [generate_variable(d) for d in (data.get('items') or [])] - - def json_schema(self): - schema = super().json_schema() - schema['properties']['items'] = {'type': 'array'} - schema['required'].append('items') - return schema diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/feature_gen.py b/archive/catalog_validation/ix-source/catalog_validation/schema/feature_gen.py deleted file mode 100644 index 62dd657fd22..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/schema/feature_gen.py +++ /dev/null @@ -1,4 +0,0 @@ -def get_feature(feature): - from .features import FEATURES - if feature in FEATURES: - return FEATURES[FEATURES.index(feature)] diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/features.py b/archive/catalog_validation/ix-source/catalog_validation/schema/features.py deleted file mode 100644 index c69c7b44c08..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/schema/features.py +++ /dev/null @@ -1,158 +0,0 @@ -from catalog_validation.exceptions import ValidationErrors - -from .schema_gen import DictSchema, IntegerSchema, StringSchema - - -class Feature: - - NAME = NotImplementedError - VALID_SCHEMAS = [] - - def __str__(self): - return self.NAME - - def validate(self, schema_obj, schema_str): - verrors = ValidationErrors() - if not isinstance(schema_obj, tuple(self.VALID_SCHEMAS)): - verrors.add( - f'{schema_str}.type', - f'Schema must be one of {", ".join(str(v) for v in self.VALID_SCHEMAS)} schema types' - ) - - if not verrors: - self._validate(verrors, schema_obj, schema_str) - verrors.check() - - def _validate(self, verrors, schema_obj, schema_str): - pass - - def __eq__(self, other): - return self.NAME == (other if isinstance(other, str) else other.NAME) - - -class IXVolumeFeature(Feature): - - NAME = 'normalize/ixVolume' - VALID_SCHEMAS = [DictSchema, StringSchema] - - def _validate(self, verrors, schema_obj, schema_str): - if isinstance(schema_obj, StringSchema): - return - - attrs = schema_obj.attrs - if 'datasetName' not in attrs: - verrors.add(f'{schema_str}.attrs', 'Variable "datasetName" must be specified.') - elif not isinstance(attrs[attrs.index('datasetName')].schema, StringSchema): - verrors.add(f'{schema_str}.attrs', 'Variable "datasetName" must be of string type.') - - if 'aclEntries' in attrs and not isinstance(attrs[attrs.index('aclEntries')].schema, DictSchema): - verrors.add(f'{schema_str}.attrs', 'Variable "aclEntries" must be of dict type.') - - if 'properties' in attrs: - index = attrs.index('properties') - properties = attrs[index] - properties_schema = properties.schema - supported_props = { - 'recordsize': { - 'valid_schema_type': [StringSchema], - }, - } - not_supported = set([str(v) for v in properties_schema.attrs]) - set(supported_props) - if not_supported: - verrors.add( - f'{schema_str}.attrs.{index}.attrs', f'{", ".join(not_supported)} properties are not supported' - ) - - for prop_index, prop in enumerate(properties_schema.attrs): - if prop.name not in supported_props: - continue - - prop_schema = prop.schema - check_prop = supported_props[prop.name] - if not isinstance(prop_schema, tuple(check_prop['valid_schema_type'])): - verrors.add( - f'{schema_str}.attrs.{index}.attrs.{prop_index}', - f'{prop.name!r} must be of ' - f'{", ".join([str(s) for s in check_prop["valid_schema_type"]])} type(s)' - ) - - -class NormalizeInterfaceConfiguration(Feature): - NAME = 'normalize/interfaceConfiguration' - VALID_SCHEMAS = [DictSchema] - - -class DefinitionInterfaceFeature(Feature): - - NAME = 'definitions/interface' - VALID_SCHEMAS = [StringSchema] - - -class DefinitionGPUConfigurationFeature(Feature): - - NAME = 'definitions/gpuConfiguration' - VALID_SCHEMAS = [DictSchema] - - -class DefinitionTimezoneFeature(Feature): - - NAME = 'definitions/timezone' - VALID_SCHEMAS = [StringSchema] - - -class DefinitionNodeIPFeature(Feature): - - NAME = 'definitions/nodeIP' - VALID_SCHEMAS = [StringSchema] - - -class ValidationNodePortFeature(Feature): - - NAME = 'validations/nodePort' - VALID_SCHEMAS = [IntegerSchema] - - -class CertificateFeature(Feature): - - NAME = 'definitions/certificate' - VALID_SCHEMAS = [IntegerSchema] - - -class CertificateAuthorityFeature(Feature): - - NAME = 'definitions/certificateAuthority' - VALID_SCHEMAS = [IntegerSchema] - - -class ContainerImageFeature(Feature): - - NAME = 'validations/containerImage' - VALID_SCHEMAS = [DictSchema] - - def _validate(self, verrors, schema_obj, schema_str): - attrs = schema_obj.attrs - for check_attr in ('repository', 'tag'): - if check_attr not in attrs: - verrors.add(f'{schema_str}.attrs', f'Variable {check_attr!r} must be specified.') - elif not isinstance(attrs[attrs.index(check_attr)].schema, StringSchema): - verrors.add(f'{schema_str}.attrs', f'Variable {check_attr!r} must be of string type.') - - -class ACLFeature(Feature): - - NAME = 'normalize/acl' - VALID_SCHEMAS = [DictSchema] - - -FEATURES = [ - ACLFeature(), - IXVolumeFeature(), - DefinitionInterfaceFeature(), - DefinitionGPUConfigurationFeature(), - DefinitionTimezoneFeature(), - DefinitionNodeIPFeature(), - ValidationNodePortFeature(), - CertificateFeature(), - CertificateAuthorityFeature(), - ContainerImageFeature(), -] diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/migration_schema.py b/archive/catalog_validation/ix-source/catalog_validation/schema/migration_schema.py deleted file mode 100644 index 9b535d9a263..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/schema/migration_schema.py +++ /dev/null @@ -1,42 +0,0 @@ -import re - - -APP_MIGRATION_DIR = 'migrations' -APP_MIGRATION_SCHEMA = { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'app_name': {'type': 'string'}, - 'action': {'type': 'string', 'enum': ['move']}, - }, - 'required': [ - 'app_name', - 'action' - ], - 'allOf': [ - { - 'if': { - 'properties': { - 'action': { - 'const': 'move', - }, - }, - }, - 'then': { - 'properties': { - 'old_train': {'type': 'string'}, - 'new_train': {'type': 'string'}, - }, - 'required': [ - 'new_train', - 'old_train', - ], - }, - }, - ], - }, -} -MIGRATION_DIRS = ['.migrations', 'ix-migrations'] -RE_MIGRATION_NAME_STR = r'^\d+\w+.json' -RE_MIGRATION_NAME = re.compile(RE_MIGRATION_NAME_STR) diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/schema_gen.py b/archive/catalog_validation/ix-source/catalog_validation/schema/schema_gen.py deleted file mode 100644 index 34d7ba296dc..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/schema/schema_gen.py +++ /dev/null @@ -1,43 +0,0 @@ -from .attrs import ( - BooleanSchema, StringSchema, TextFieldSchema, IntegerSchema, PathSchema, HostPathSchema, HostPathDirSchema, - HostPathFileSchema, ListSchema, DictSchema, IPAddrSchema, CronSchema, URISchema -) - - -def get_schema(schema_data): - schema = None - if not isinstance(schema_data, dict): - return schema - - s_type = schema_data.get('type') - if s_type == 'boolean': - schema = BooleanSchema - elif s_type == 'string': - schema = StringSchema - elif s_type == 'text': - schema = TextFieldSchema - elif s_type == 'int': - schema = IntegerSchema - elif s_type == 'path': - schema = PathSchema - elif s_type == 'hostpath': - schema = HostPathSchema - elif s_type == 'hostpathdirectory': - schema = HostPathDirSchema - elif s_type == 'hostpathfile': - schema = HostPathFileSchema - elif s_type == 'list': - schema = ListSchema - elif s_type == 'dict': - schema = DictSchema - elif s_type == 'ipaddr': - schema = IPAddrSchema - elif s_type == 'cron': - schema = CronSchema - elif s_type == 'uri': - schema = URISchema - - if schema: - schema = schema(data=schema_data) - - return schema diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/variable.py b/archive/catalog_validation/ix-source/catalog_validation/schema/variable.py deleted file mode 100644 index e11d522af57..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/schema/variable.py +++ /dev/null @@ -1,37 +0,0 @@ -from catalog_validation.exceptions import ValidationErrors - -from .schema_gen import get_schema - - -class Variable: - def __init__(self, data): - self.name = self.label = self.description = self.group = None - self.schema = None - self.update_from_data(data) - - def update_from_data(self, data): - self.name = data.get('variable') - self.label = data.get('label') - self.description = data.get('description') - self.schema = get_schema(data.get('schema')) - - def validate(self, schema): - verrors = ValidationErrors() - if not self.name: - verrors.add(f'{schema}.variable', 'Variable value must be specified') - - if not self.schema: - verrors.add(f'{schema}.schema', 'Schema must be specified for variable') - else: - try: - self.schema.validate(f'{schema}.schema') - except ValidationErrors as ve: - verrors.extend(ve) - - verrors.check() - - def __str__(self): - return self.name - - def __eq__(self, other): - return (other if isinstance(other, str) else other.name) == self.name diff --git a/archive/catalog_validation/ix-source/catalog_validation/schema/variable_gen.py b/archive/catalog_validation/ix-source/catalog_validation/schema/variable_gen.py deleted file mode 100644 index 8784e4f9754..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/schema/variable_gen.py +++ /dev/null @@ -1,3 +0,0 @@ -def generate_variable(variable_data): - from .variable import Variable - return Variable(variable_data) diff --git a/archive/catalog_validation/ix-source/catalog_validation/scripts/__init__.py b/archive/catalog_validation/ix-source/catalog_validation/scripts/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/ix-source/catalog_validation/scripts/catalog_update.py b/archive/catalog_validation/ix-source/catalog_validation/scripts/catalog_update.py deleted file mode 100644 index 0d52a8b6c8e..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/scripts/catalog_update.py +++ /dev/null @@ -1,171 +0,0 @@ -#!/usr/bin/env python -import argparse -import contextlib -import json -import os -import shutil -import typing - -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from catalog_validation.ci.utils import ( - get_app_version, get_ci_development_directory, OPTIONAL_METADATA_FILES, - REQUIRED_METADATA_FILES, version_has_been_bumped, get_to_keep_versions -) -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.items.catalog import get_items_in_trains, retrieve_train_names, retrieve_trains_data -from catalog_validation.items.utils import get_catalog_json_schema -from catalog_validation.utils import CACHED_CATALOG_FILE_NAME, CACHED_VERSION_FILE_NAME -from catalog_validation.validation import validate_catalog_item_version_data -from collections import defaultdict - - -def get_trains(location: str) -> typing.Tuple[dict, dict]: - preferred_trains: list = [] - trains_to_traverse = retrieve_train_names(location) - catalog_data = {} - versions_data = {} - for train_name, train_data in retrieve_trains_data( - get_items_in_trains(trains_to_traverse, location), location, preferred_trains, trains_to_traverse - )[0].items(): - catalog_data[train_name] = {} - versions_data[train_name] = {} - for app_name, app_data in train_data.items(): - catalog_data[train_name][app_name] = {} - versions_data[train_name][app_name] = {} - for k, v in app_data.items(): - if k == 'versions': - versions_data[train_name][app_name][k] = v - else: - catalog_data[train_name][app_name][k] = v - - return catalog_data, versions_data - - -def validate_train_data(train_data): - verrors = ValidationErrors() - try: - json_schema_validate(train_data, get_catalog_json_schema()) - except (json.JSONDecodeError, JsonValidationError) as e: - verrors.add( - 'catalog_json', - f'Failed to validate contents of train data: {e!r}' - ) - verrors.check() - - -def validate_versions_data(versions_data): - verrors = ValidationErrors() - for train_name, train_data in versions_data.items(): - for app_name, app_version_data in train_data.items(): - validate_catalog_item_version_data(app_version_data['versions'], f'{train_name}.{app_name}', verrors) - verrors.check() - - -def get_apps_to_publish(catalog_path: str) -> dict: - ci_dev_dir = get_ci_development_directory(catalog_path) - to_publish_apps = defaultdict(list) - for train_name in os.listdir(ci_dev_dir): - train_path = os.path.join(ci_dev_dir, train_name) - if not os.path.isdir(train_path): - continue - - for app_name in os.listdir(train_path): - app_path = os.path.join(train_path, app_name) - if not os.path.isdir(app_path): - continue - - app_current_version = get_app_version(app_path) - if version_has_been_bumped(os.path.join(catalog_path, train_name, app_name), app_current_version): - to_publish_apps[train_name].append({'name': app_name, 'version': app_current_version}) - - return to_publish_apps - - -def publish_updated_apps(catalog_path: str) -> None: - ci_dev_directory = get_ci_development_directory(catalog_path) - if not os.path.isdir(ci_dev_directory): - return - - for train_name, apps in get_apps_to_publish(catalog_path).items(): - dev_train_path = os.path.join(ci_dev_directory, train_name) - publish_train_path = os.path.join(catalog_path, train_name) - os.makedirs(publish_train_path, exist_ok=True) - - for app in apps: - app_name, app_version = app['name'], app['version'] - dev_app_path = os.path.join(dev_train_path, app_name) - publish_app_path = os.path.join(publish_train_path, app_name) - publish_app_version_path = os.path.join(publish_app_path, app_version) - required_versions = get_to_keep_versions(dev_app_path) - os.makedirs(publish_app_path, exist_ok=True) - - dev_item_yaml_path = os.path.join(dev_app_path, 'item.yaml') - publish_item_yaml_path = os.path.join(publish_app_path, 'item.yaml') - shutil.copy(dev_item_yaml_path, publish_item_yaml_path) - shutil.copytree(dev_app_path, publish_app_version_path) - - for file_name in OPTIONAL_METADATA_FILES + REQUIRED_METADATA_FILES: - with contextlib.suppress(OSError): - os.unlink(os.path.join(publish_app_version_path, file_name)) - - ix_values_path = os.path.join(publish_app_version_path, 'ix_values.yaml') - values_path = os.path.join(publish_app_version_path, 'values.yaml') - if not os.path.exists(ix_values_path) and os.path.exists(values_path): - shutil.move(values_path, ix_values_path) - - for version in os.listdir(publish_app_path): - version_path = os.path.join(publish_app_path, version) - if not os.path.isdir(version_path) or version in required_versions: - continue - - if version != app_version: - shutil.rmtree(version_path) - - print( - f'[\033[92mOK\x1B[0m]\tPublished {app_name!r} having {app_version!r} version ' - f'to {train_name!r} train successfully!' - ) - - -def update_catalog_file(location: str) -> None: - catalog_file_path = os.path.join(location, CACHED_CATALOG_FILE_NAME) - catalog_data, versions_data = get_trains(location) - validate_train_data(catalog_data) - validate_versions_data(versions_data) - - with open(catalog_file_path, 'w') as f: - f.write(json.dumps(catalog_data, indent=4)) - - print(f'[\033[92mOK\x1B[0m]\tUpdated {catalog_file_path!r} successfully!') - - for train_name, train_data in versions_data.items(): - for app_name, app_data in train_data.items(): - version_path = os.path.join(location, train_name, app_name, CACHED_VERSION_FILE_NAME) - with open(version_path, 'w') as f: - f.write(json.dumps(app_data['versions'], indent=4)) - - print(f'[\033[92mOK\x1B[0m]\tUpdated {version_path!r} successfully!') - - -def main(): - parser = argparse.ArgumentParser() - subparsers = parser.add_subparsers(help='sub-command help', dest='action') - - publish_setup = subparsers.add_parser('publish', help='Publish apps of TrueNAS catalog') - publish_setup.add_argument('--path', help='Specify path of TrueNAS catalog') - - parser_setup = subparsers.add_parser('update', help='Update TrueNAS catalog') - parser_setup.add_argument('--path', help='Specify path of TrueNAS catalog') - - args = parser.parse_args() - if args.action == 'publish': - publish_updated_apps(args.path) - elif args.action == 'update': - update_catalog_file(args.path) - else: - parser.print_help() - - -if __name__ == '__main__': - main() diff --git a/archive/catalog_validation/ix-source/catalog_validation/scripts/catalog_validate.py b/archive/catalog_validation/ix-source/catalog_validation/scripts/catalog_validate.py deleted file mode 100644 index 6d4b8d3f3d7..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/scripts/catalog_validate.py +++ /dev/null @@ -1,39 +0,0 @@ -#!/usr/bin/env python -import argparse - -from catalog_validation.exceptions import CatalogDoesNotExist, ValidationErrors -from catalog_validation.validation import validate_catalog - - -def validate(catalog_path): - - try: - validate_catalog(catalog_path) - except CatalogDoesNotExist: - print(f'[\033[91mFAILED\x1B[0m]\tSpecified {catalog_path!r} path does not exist') - exit(1) - except ValidationErrors as verrors: - print('[\033[91mFAILED\x1B[0m]\tFollowing validation failures were found:') - for index, verror in enumerate(verrors.errors): - print(f'[\033[91m{index}\x1B[0m]\t{verror}') - exit(1) - else: - print('[\033[92mOK\x1B[0m]\tPASSED VALIDATION CHECKS') - - -def main(): - parser = argparse.ArgumentParser() - subparsers = parser.add_subparsers(help='sub-command help', dest='action') - - parser_setup = subparsers.add_parser('validate', help='Validate TrueNAS catalog') - parser_setup.add_argument('--path', help='Specify path of TrueNAS catalog') - - args = parser.parse_args() - if args.action == 'validate': - validate(args.path) - else: - parser.print_help() - - -if __name__ == '__main__': - main() diff --git a/archive/catalog_validation/ix-source/catalog_validation/scripts/dev_apps_validate.py b/archive/catalog_validation/ix-source/catalog_validation/scripts/dev_apps_validate.py deleted file mode 100644 index 1ce514beaed..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/scripts/dev_apps_validate.py +++ /dev/null @@ -1,28 +0,0 @@ -#!/usr/bin/env python -import argparse - -from catalog_validation.ci.validate import validate_dev_directory_structure -from catalog_validation.git_utils import get_changed_apps - - -def main(): - parser = argparse.ArgumentParser() - subparsers = parser.add_subparsers(help='sub-command help', dest='action') - - parser_setup = subparsers.add_parser( - 'validate', help='Validate TrueNAS dev catalog items' - ) - parser_setup.add_argument('--path', help='Specify path of TrueNAS dev catalog', required=True) - parser_setup.add_argument( - '--base_branch', help='Specify base branch to find changed catalog items', default='master' - ) - - args = parser.parse_args() - if args.action == 'validate': - validate_dev_directory_structure(args.path, get_changed_apps(args.path, args.base_branch)) - else: - parser.print_help() - - -if __name__ == '__main__': - main() diff --git a/archive/catalog_validation/ix-source/catalog_validation/utils.py b/archive/catalog_validation/ix-source/catalog_validation/utils.py deleted file mode 100644 index 42874798fde..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/utils.py +++ /dev/null @@ -1,225 +0,0 @@ -import re - - -CACHED_CATALOG_FILE_NAME = 'catalog.json' -CACHED_VERSION_FILE_NAME = 'app_versions.json' -METADATA_JSON_SCHEMA = { - 'type': 'object', - 'properties': { - 'runAsContext': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'description': {'type': 'string'}, - 'gid': {'type': 'integer'}, - 'groupName': {'type': 'string'}, - 'userName': {'type': 'string'}, - 'uid': {'type': 'integer'}, - }, - 'required': ['description'], - }, - }, - 'capabilities': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'description': {'type': 'string'}, - 'name': {'type': 'string'}, - }, - 'required': ['description', 'name'], - }, - }, - 'hostMounts': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'description': {'type': 'string'}, - 'hostPath': {'type': 'string'}, - }, - 'required': ['description', 'hostPath'], - }, - }, - }, -} -RE_SCALE_VERSION = re.compile(r'^(\d{2}\.\d{2}(?:\.\d)*(?:-?(?:RC|BETA)\.?\d?)?)$') # 24.04 / 24.04.1 / 24.04-RC.1 -RE_VERSION_PATTERN = re.compile(r'(\d{2}\.\d{2}(?:\.\d)*)') # We are only interested in XX.XX here -VALID_TRAIN_REGEX = re.compile(r'^\w+[\w.-]*$') -VERSION_VALIDATION_SCHEMA = { - 'type': 'object', - 'title': 'Versions', - 'patternProperties': { - '[0-9]+.[0-9]+.[0-9]+': { - 'type': 'object', - 'properties': { - 'healthy': { - 'type': 'boolean', - }, - 'supported': { - 'type': 'boolean', - }, - 'healthy_error': { - 'type': ['string', 'null'] - }, - 'location': { - 'type': 'string', - 'pattern': r'^(\/[a-zA-Z0-9_.-]+)+$' - }, - 'last_update': { - 'type': 'string', - 'pattern': '^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$' - }, - 'required_features': { - 'type': 'array', - 'items': { - 'type': 'string' - } - }, - 'human_version': { - 'type': 'string' - }, - 'version': { - 'type': 'string', - 'pattern': '[0-9]+.[0-9]+.[0-9]+' - }, - 'chart_metadata': { - 'type': 'object', - 'properties': { - 'name': { - 'type': 'string' - }, - 'description': { - 'type': 'string' - }, - 'annotations': { - 'type': 'object' - }, - 'type': { - 'type': 'string' - }, - 'version': { - 'type': 'string', - 'pattern': '[0-9]+.[0-9]+.[0-9]+' - }, - 'apiVersion': { - 'type': 'string', - }, - 'appVersion': { - 'type': 'string' - }, - 'kubeVersion': { - 'type': 'string' - }, - 'app_readme': {'type': 'string'}, - 'detailed_readme': {'type': 'string'}, - 'changelog': {'type': ['string', 'null']}, - 'maintainers': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': {'type': 'string'}, - 'url': {'type': ['string', 'null']}, - 'email': {'type': 'string'}, - }, - 'required': ['name', 'email'], - } - }, - 'dependencies': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': {'type': 'string'}, - 'repository': {'type': 'string'}, - 'version': {'type': 'string'} - } - } - }, - 'home': {'type': 'string'}, - 'icon': {'type': 'string'}, - 'sources': { - 'type': 'array', - 'items': { - 'type': 'string' - } - }, - 'keywords': { - 'type': 'array', - 'items': { - 'type': 'string' - } - }, - } - }, - 'app_metadata': { - **METADATA_JSON_SCHEMA, - 'type': ['object', 'null'], - }, - 'schema': { - 'type': 'object', - 'properties': { - 'groups': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': { - 'type': 'string' - }, - 'description': { - 'type': 'string' - }, - }, - 'required': ['description', 'name'], - } - }, - 'portals': { - 'type': 'object' - }, - 'questions': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'variable': {'type': 'string'}, - 'label': {'type': 'string'}, - 'group': {'type': 'string'}, - 'schema': { - 'type': 'object', - 'properties': { - 'type': {'type': 'string'} - }, - 'required': ['type'] - } - } - } - } - }, - 'required': ['groups', 'questions'] - }, - }, - 'required': [ - 'healthy', 'supported', 'healthy_error', 'location', 'last_update', 'required_features', - 'human_version', 'version', 'chart_metadata', 'app_metadata', 'schema', - ], - }, - }, - 'additionalProperties': False -} -WANTED_FILES_IN_ITEM_VERSION = {'questions.yaml', 'app-readme.md', 'Chart.yaml', 'README.md'} - - -def validate_key_value_types(data_to_check, mapping, verrors, schema): - for key_mapping in mapping: - if len(key_mapping) == 2: - key, value_type, required = *key_mapping, True - else: - key, value_type, required = key_mapping - - if required and key not in data_to_check: - verrors.add(f'{schema}.{key}', f'Missing required {key!r} key.') - elif key in data_to_check and not isinstance(data_to_check[key], value_type): - verrors.add(f'{schema}.{key}', f'{key!r} value should be a {value_type.__name__!r}') diff --git a/archive/catalog_validation/ix-source/catalog_validation/validation.py b/archive/catalog_validation/ix-source/catalog_validation/validation.py deleted file mode 100644 index 5d348f39499..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/validation.py +++ /dev/null @@ -1,459 +0,0 @@ -import concurrent.futures -import json -import jsonschema -import os -import yaml - -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError -from middlewared.validators import validate_filters -from semantic_version import Version -from typing import Optional - -from .exceptions import CatalogDoesNotExist, ValidationErrors -from .items.ix_values_utils import validate_ix_values_schema -from .items.questions_utils import ( - CUSTOM_PORTALS_KEY, CUSTOM_PORTALS_ENABLE_KEY, CUSTOM_PORTAL_GROUP_KEY, -) -from .items.utils import get_catalog_json_schema, RECOMMENDED_APPS_FILENAME, RECOMMENDED_APPS_SCHEMA, TRAIN_IGNORE_DIRS -from .schema.migration_schema import ( - APP_MIGRATION_SCHEMA, MIGRATION_DIRS, RE_MIGRATION_NAME, RE_MIGRATION_NAME_STR, APP_MIGRATION_DIR, -) -from .schema.variable import Variable -from .validation_utils import validate_chart_version -from .utils import ( - CACHED_CATALOG_FILE_NAME, CACHED_VERSION_FILE_NAME, METADATA_JSON_SCHEMA, validate_key_value_types, - VALID_TRAIN_REGEX, VERSION_VALIDATION_SCHEMA, WANTED_FILES_IN_ITEM_VERSION -) - - -def validate_catalog(catalog_path): - if not os.path.exists(catalog_path): - raise CatalogDoesNotExist(catalog_path) - - verrors = ValidationErrors() - items = [] - item_futures = [] - cached_catalog_file_path = os.path.join(catalog_path, CACHED_CATALOG_FILE_NAME) - if not os.path.exists(cached_catalog_file_path): - verrors.add( - 'cached_catalog_file', - f'{CACHED_CATALOG_FILE_NAME!r} metadata file must be specified for a valid catalog' - ) - else: - try: - with open(cached_catalog_file_path, 'r') as f: - json_schema_validate(json.loads(f.read()), get_catalog_json_schema()) - - except (json.JSONDecodeError, JsonValidationError) as e: - verrors.add( - 'cached_catalog_file', - f'Failed to validate contents of {cached_catalog_file_path!r}: {e!r}' - ) - - verrors.check() - - validate_recommended_apps_file(catalog_path) - - for file_dir in os.listdir(catalog_path): - complete_path = os.path.join(catalog_path, file_dir) - if file_dir not in MIGRATION_DIRS and ( - file_dir.startswith('.') or not os.path.isdir(complete_path) or file_dir in TRAIN_IGNORE_DIRS - ): - continue - if file_dir in MIGRATION_DIRS: - if all(os.path.exists(migration_dir) for migration_dir in map( - lambda d: os.path.join(catalog_path, d), MIGRATION_DIRS - )): - verrors.add( - 'app_migrations', f'Both {", ".join(MIGRATION_DIRS)!r} cannot be used to specify app migrations' - ) - else: - for directory in MIGRATION_DIRS: - migration_dir = os.path.join(catalog_path, directory) - if not os.path.exists(migration_dir): - continue - if os.path.isdir(migration_dir): - try: - validate_migrations(migration_dir) - except ValidationErrors as e: - verrors.extend(e) - else: - verrors.add('app_migrations', f'{directory!r} is not a directory') - else: - try: - validate_train_structure(complete_path) - except ValidationErrors as e: - verrors.extend(e) - else: - items.extend(get_train_items(complete_path)) - - with concurrent.futures.ProcessPoolExecutor(max_workers=5 if len(items) > 10 else 2) as exc: - for item in items: - item_futures.append(exc.submit(validate_catalog_item, item[0], item[1])) - - for future in item_futures: - try: - future.result() - except ValidationErrors as e: - verrors.extend(e) - - verrors.check() - - -def validate_recommended_apps_file(catalog_location: str) -> None: - verrors = ValidationErrors() - try: - with open(os.path.join(catalog_location, RECOMMENDED_APPS_FILENAME), 'r') as f: - data = yaml.safe_load(f.read()) - json_schema_validate(data, RECOMMENDED_APPS_SCHEMA) - except FileNotFoundError: - return - except yaml.YAMLError: - verrors.add(RECOMMENDED_APPS_FILENAME, 'Must be a valid yaml file') - except JsonValidationError as e: - verrors.add(RECOMMENDED_APPS_FILENAME, f'Invalid format specified: {e}') - - verrors.check() - - -def validate_migrations(migration_dir): - verrors = ValidationErrors() - for migration_file in os.listdir(migration_dir): - if not RE_MIGRATION_NAME.findall(migration_file): - verrors.add( - f'app_migrations.{migration_file}', - 'Invalid naming scheme used for migration file name. ' - f'It should be conforming to {RE_MIGRATION_NAME_STR!r} pattern.' - ) - else: - try: - with open(os.path.join(migration_dir, migration_file), 'r') as f: - data = json.loads(f.read()) - jsonschema.validate(data, APP_MIGRATION_SCHEMA) - except (json.JSONDecodeError, jsonschema.ValidationError) as e: - verrors.add( - f'app_migrations.{migration_file}', - f'Failed to validate migration file structure: {e}' - ) - verrors.check() - - -def validate_train_structure(train_path): - train = os.path.basename(train_path) - verrors = ValidationErrors() - if not VALID_TRAIN_REGEX.match(train): - verrors.add(train, 'Train name is invalid.') - - verrors.check() - - -def get_train_items(train_path): - train = os.path.basename(train_path) - items = [] - for catalog_item in os.listdir(train_path): - item_path = os.path.join(train_path, catalog_item) - if not os.path.isdir(item_path): - continue - items.append((item_path, f'{train}.{catalog_item}')) - return items - - -def validate_catalog_item(catalog_item_path, schema, validate_versions=True): - # We should ensure that each catalog item has at least 1 version available - # Also that we have item.yaml present - verrors = ValidationErrors() - item_name = os.path.join(catalog_item_path) - files = [] - versions = [] - - if not os.path.isdir(catalog_item_path): - verrors.add(schema, 'Catalog item must be a directory') - verrors.check() - - for file_dir in os.listdir(catalog_item_path): - complete_path = os.path.join(catalog_item_path, file_dir) - if os.path.isdir(complete_path): - versions.append(complete_path) - else: - files.append(file_dir) - - if not versions: - verrors.add(f'{schema}.versions', f'No versions found for {item_name} item.') - - if 'item.yaml' not in files: - verrors.add(f'{schema}.item', 'Item configuration (item.yaml) not found') - else: - with open(os.path.join(catalog_item_path, 'item.yaml'), 'r') as f: - item_config = yaml.safe_load(f.read()) - - validate_key_value_types( - item_config, ( - ('categories', list), ('tags', list, False), ('screenshots', list, False), - ), verrors, f'{schema}.item_config' - ) - - cached_version_file_path = os.path.join(catalog_item_path, CACHED_VERSION_FILE_NAME) - if os.path.exists(cached_version_file_path): - try: - with open(cached_version_file_path, 'r') as f: - validate_catalog_item_version_data( - json.loads(f.read()), f'{schema}.{CACHED_VERSION_FILE_NAME}', verrors - ) - except json.JSONDecodeError: - verrors.add( - f'{schema}.{CACHED_VERSION_FILE_NAME}', f'{CACHED_VERSION_FILE_NAME!r} is not a valid json file' - ) - - for version_path in (versions if validate_versions else []): - try: - validate_catalog_item_version(version_path, f'{schema}.versions.{os.path.basename(version_path)}') - except ValidationErrors as e: - verrors.extend(e) - - verrors.check() - - -def validate_app_migrations(verrors, version_path, schema): - app_migration_path = os.path.join(version_path, APP_MIGRATION_DIR) - - if not os.path.exists(app_migration_path): - return verrors - - for migration_file in os.listdir(app_migration_path): - migration_file_path = os.path.join(app_migration_path, migration_file) - if not os.access(migration_file_path, os.X_OK): - verrors.add(schema, f'{migration_file!r} is not executable') - return verrors - - -def validate_catalog_item_version_data(version_data: dict, schema: str, verrors: ValidationErrors) -> ValidationErrors: - try: - json_schema_validate(version_data, VERSION_VALIDATION_SCHEMA) - except JsonValidationError as e: - verrors.add(schema, f'Invalid format specified for application versions: {e}') - return verrors - - -def validate_catalog_item_version( - version_path: str, schema: str, version_name: Optional[str] = None, item_name: Optional[str] = None, - validate_values: bool = False, -): - verrors = ValidationErrors() - version_name = version_name or os.path.basename(version_path) - item_name = item_name or version_path.split('/')[-2] - try: - Version(version_name) - except ValueError: - verrors.add(f'{schema}.name', f'{version_name!r} is not a valid version name.') - - files_diff = WANTED_FILES_IN_ITEM_VERSION ^ set( - f for f in os.listdir(version_path) if f in WANTED_FILES_IN_ITEM_VERSION - ) - if files_diff: - verrors.add(f'{schema}.required_files', f'Missing {", ".join(files_diff)} required configuration files.') - - chart_version_path = os.path.join(version_path, 'Chart.yaml') - validate_chart_version(verrors, chart_version_path, schema, item_name, version_name) - - questions_path = os.path.join(version_path, 'questions.yaml') - if os.path.exists(questions_path): - try: - validate_questions_yaml(questions_path, f'{schema}.questions_configuration') - except ValidationErrors as v: - verrors.extend(v) - - for values_file in ['ix_values.yaml'] + (['values.yaml'] if validate_values else []): - values_path = os.path.join(version_path, values_file) - if os.path.exists(values_path): - try: - validate_ix_values_yaml(values_path, f'{schema}.values_configuration') - except ValidationErrors as v: - verrors.extend(v) - - metadata_path = os.path.join(version_path, 'metadata.yaml') - if os.path.exists(metadata_path): - try: - validate_metadata_yaml(metadata_path, f'{schema}.metadata_configuration') - except ValidationErrors as v: - verrors.extend(v) - - validate_app_migrations(verrors, version_path, f'{schema}.app_migrations') - - verrors.check() - - -def validate_ix_values_yaml(ix_values_yaml_path, schema): - verrors = ValidationErrors() - - with open(ix_values_yaml_path, 'r') as f: - try: - ix_values = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - - verrors.check() - - if isinstance(ix_values, dict): - portals = ix_values.get(CUSTOM_PORTALS_KEY) - if portals: - try: - validate_ix_values_schema(schema, portals) - except ValidationErrors as ve: - verrors.extend(ve) - else: - verrors.add(schema, 'Must be a dictionary') - - verrors.check() - - -def validate_metadata_yaml(metadata_yaml_path, schema): - verrors = ValidationErrors() - with open(metadata_yaml_path, 'r') as f: - try: - metadata = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - else: - try: - json_schema_validate(metadata, METADATA_JSON_SCHEMA) - except JsonValidationError as e: - verrors.add(schema, f'Invalid format specified for application metadata: {e}') - - verrors.check() - - -def validate_questions_yaml(questions_yaml_path, schema): - verrors = ValidationErrors() - - with open(questions_yaml_path, 'r') as f: - try: - questions_config = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - else: - if not isinstance(questions_config, dict): - verrors.add(schema, 'Must be a dictionary') - - verrors.check() - - validate_key_value_types( - questions_config, ( - ('groups', list), ('questions', list), ('portals', dict, False), (CUSTOM_PORTALS_ENABLE_KEY, bool, False), - (CUSTOM_PORTAL_GROUP_KEY, str, False), - ), verrors, schema - ) - - verrors.check() - - groups = [] - for index, group in enumerate(questions_config['groups']): - if not isinstance(group, dict): - verrors.add(f'{schema}.groups.{index}', 'Type of group should be a dictionary.') - continue - - if group.get('name'): - groups.append(group['name']) - - validate_key_value_types(group, (('name', str), ('description', str)), verrors, f'{schema}.group.{index}') - - for index, portal_details in enumerate((questions_config.get('portals') or {}).items()): - portal_type, portal_schema = portal_details - error_schema = f'{schema}.portals.{index}' - if not isinstance(portal_type, str): - verrors.add(error_schema, 'Portal type must be a string') - if not isinstance(portal_schema, dict): - verrors.add(error_schema, 'Portal schema must be a dictionary') - else: - validate_key_value_types( - portal_schema, (('protocols', list), ('host', list), ('ports', list), ('path', str, False)), - verrors, error_schema - ) - - validate_variable_uniqueness(questions_config['questions'], f'{schema}.questions', verrors) - for index, question in enumerate(questions_config['questions']): - validate_question(question, f'{schema}.questions.{index}', verrors, (('group', str),)) - if question.get('group') and question['group'] not in groups: - verrors.add(f'{schema}.questions.{index}.group', f'Please specify a group declared in "{schema}.groups"') - - if questions_config.get(CUSTOM_PORTALS_ENABLE_KEY): - if not questions_config.get(CUSTOM_PORTAL_GROUP_KEY): - verrors.add( - f'{schema}.{CUSTOM_PORTALS_ENABLE_KEY}', - f'{CUSTOM_PORTAL_GROUP_KEY!r} must be specified when user specified portals are desired' - ) - elif questions_config[CUSTOM_PORTAL_GROUP_KEY] not in groups: - verrors.add( - f'{schema}.{CUSTOM_PORTAL_GROUP_KEY}', - 'Specified group not declared under "groups"' - ) - - verrors.check() - - -def validate_variable_uniqueness(data, schema, verrors): - variables = [] - for index, question in enumerate(data): - if question['variable'] in variables: - verrors.add( - f'{schema}.{index}', f'Variable name {question["variable"]!r} has been used again which is not allowed' - ) - else: - variables.append(question['variable']) - sub_questions = question.get('subquestions') or [] - for sub_index, sub_question in enumerate(sub_questions): - if sub_question['variable'] in variables: - verrors.add( - f'{schema}.{index}.subquestions.{sub_index}', - f'Variable name {sub_question["variable"]!r} has been used again which is not allowed' - ) - else: - variables.append(sub_question['variable']) - - verrors.check() - - -def validate_question(question_data, schema, verrors, validate_top_level_attrs=None): - if not isinstance(question_data, dict): - verrors.add(schema, 'Question must be a valid dictionary.') - return - - validate_top_level_attrs = validate_top_level_attrs or tuple() - validate_key_value_types( - question_data, (('variable', str), ('label', str), ('schema', dict)) + validate_top_level_attrs, verrors, schema - ) - if type(question_data.get('schema')) != dict: - return - - if question_data['variable'] == CUSTOM_PORTALS_KEY: - verrors.add( - f'{schema}.variable', - f'{CUSTOM_PORTALS_KEY!r} is a reserved variable name and cannot be specified by app developer' - ) - # No need to validate the question data etc here - return - - try: - Variable(question_data).validate(schema) - except ValidationErrors as ve: - verrors.extend(ve) - return - - schema_data = question_data['schema'] - variable_type = schema_data['type'] - - if filters := schema_data.get('show_if'): - validate_filters(filters) - - for condition, key, schema_str in ( - (variable_type != 'list', 'subquestions', f'{schema}.schema.subquestions'), - (variable_type == 'list', 'items', f'{schema}.schema.items'), - (variable_type == 'dict', 'attrs', f'{schema}.schema.attrs'), - ): - if not (condition and type(schema_data.get(key)) == list): - continue - - if variable_type == 'dict': - validate_variable_uniqueness(schema_data[key], f'{schema}.{schema_str}', verrors) - - for index, item in enumerate(schema_data[key]): - validate_question(item, f'{schema_str}.{index}', verrors) diff --git a/archive/catalog_validation/ix-source/catalog_validation/validation_utils.py b/archive/catalog_validation/ix-source/catalog_validation/validation_utils.py deleted file mode 100644 index c6ad270f7dc..00000000000 --- a/archive/catalog_validation/ix-source/catalog_validation/validation_utils.py +++ /dev/null @@ -1,94 +0,0 @@ -import os -import yaml - -from middlewared.plugins.update_.utils import can_update -from semantic_version import Version -from typing import Optional - -from .exceptions import ValidationErrors -from .utils import validate_key_value_types, RE_SCALE_VERSION - - -def validate_min_max_version_values(annotations_dict, verrors, schema): - validate_key_value_types( - annotations_dict, (('min_scale_version', str, False), ('max_scale_version', str, False)), verrors, schema - ) - - if verrors: - # No point in proceeding further - return - - for version in filter(lambda v: v in annotations_dict, ['min_scale_version', 'max_scale_version']): - if not RE_SCALE_VERSION.match(annotations_dict[version]): - verrors.add( - f'{schema}.{version}', - f'Format of provided {version} value is not correct' - ) - - if ( - not verrors and all(version in annotations_dict for version in ['min_scale_version', 'max_scale_version']) and - annotations_dict['min_scale_version'] != annotations_dict['max_scale_version'] and - not can_update(annotations_dict['min_scale_version'], annotations_dict['max_scale_version']) - ): - verrors.add(schema, 'Provided min_scale_version is greater than provided max_scale_version') - - -def validate_chart_version( - verrors: ValidationErrors, chart_version_path: str, schema: str, item_name: str, version_name: Optional[str] = None, -) -> ValidationErrors: - if os.path.exists(chart_version_path): - with open(chart_version_path, 'r') as f: - try: - chart_config = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - else: - if not isinstance(chart_config, dict): - verrors.add(schema, 'Must be a dictionary') - else: - if chart_config.get('name') != item_name: - verrors.add(f'{schema}.item_name', 'Item name not correctly set in "Chart.yaml".') - - if not isinstance(chart_config.get('annotations', {}), dict): - verrors.add(f'{schema}.annotations', 'Annotations must be a dictionary') - elif chart_config.get('annotations'): - validate_min_max_version_values(chart_config['annotations'], verrors, schema) - - if not isinstance(chart_config.get('sources', []), list): - verrors.add(f'{schema}.sources', 'Sources must be a list') - else: - for index, source in enumerate(chart_config.get('sources', [])): - if not isinstance(source, str): - verrors.add(f'{schema}.sources.{index}', 'Source must be a string') - - if not isinstance(chart_config.get('maintainers', []), list): - verrors.add(f'{schema}.maintainers', 'Maintainers must be a list') - else: - for index, maintainer in enumerate(chart_config.get('maintainers', [])): - if not isinstance(maintainer, dict): - verrors.add(f'{schema}.maintainers.{index}', 'Maintainer must be a dictionary') - elif not all(k in maintainer and isinstance(maintainer[k], str) for k in ('name', 'email')): - verrors.add( - f'{schema}.maintainers.{index}', - 'Maintainer must have name and email attributes defined and be strings.' - ) - - chart_version = chart_config.get('version') - if chart_version is None: - verrors.add(f'{schema}.version', 'Version must be configured in "Chart.yaml"') - else: - try: - Version(chart_version) - except ValueError: - verrors.add(f'{schema}.version', f'{chart_version!r} is not a valid version name') - - if version_name is not None and chart_version != version_name: - verrors.add( - f'{schema}.version', - 'Configured version in "Chart.yaml" does not match version directory name.' - ) - - else: - verrors.add(schema, 'Missing chart version file') - - return verrors diff --git a/archive/catalog_validation/ix-source/debian/changelog b/archive/catalog_validation/ix-source/debian/changelog deleted file mode 100644 index 0019cb792ff..00000000000 --- a/archive/catalog_validation/ix-source/debian/changelog +++ /dev/null @@ -1,5 +0,0 @@ -catalog-validation (0.1-0~truenas+1) bullseye-truenas-unstable; urgency=medium - - * Initial release - - -- Waqar Ahmed Fri, 27 Nov 2020 00:26:21 +0500 diff --git a/archive/catalog_validation/ix-source/debian/control b/archive/catalog_validation/ix-source/debian/control deleted file mode 100644 index 3034a70dcc0..00000000000 --- a/archive/catalog_validation/ix-source/debian/control +++ /dev/null @@ -1,27 +0,0 @@ -Source: catalog-validation -Section: contrib/python -Priority: optional -Maintainer: Waqar Ahmed -Build-Depends: debhelper-compat (= 12), - dh-python, - python3-dev, - python3-jsonschema, - python3-semantic-version, - python3-kubernetes, - python3-yaml, - python3-setuptools -Standards-Version: 4.4.1 -Homepage: https://github.com/truenas/catalog_validation -Testsuite: autopkgtest-pkg-python - -Package: python3-catalog-validation -Architecture: any -Depends: python3-semantic-version, - python3-jsonschema, - python3-kubernetes, - python3-yaml, - ${shlibs:Depends}, - ${misc:Depends}, - ${python3:Depends} -Description: Validate TrueNAS Catalogs - This package helps validate truenas catalogs. diff --git a/archive/catalog_validation/ix-source/debian/rules b/archive/catalog_validation/ix-source/debian/rules deleted file mode 100644 index 3bb0ffc0074..00000000000 --- a/archive/catalog_validation/ix-source/debian/rules +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/make -f -export DH_VERBOSE = 1 - -export PYBUILD_NAME=catalog_validation - -%: - dh $@ --with python3 --buildsystem=pybuild diff --git a/archive/catalog_validation/ix-source/debian/source/format b/archive/catalog_validation/ix-source/debian/source/format deleted file mode 100644 index 163aaf8d82b..00000000000 --- a/archive/catalog_validation/ix-source/debian/source/format +++ /dev/null @@ -1 +0,0 @@ -3.0 (quilt) diff --git a/archive/catalog_validation/ix-source/debian/source/options b/archive/catalog_validation/ix-source/debian/source/options deleted file mode 100644 index cb61fa5267b..00000000000 --- a/archive/catalog_validation/ix-source/debian/source/options +++ /dev/null @@ -1 +0,0 @@ -extend-diff-ignore = "^[^/]*[.]egg-info/" diff --git a/archive/catalog_validation/ix-source/requirements.txt b/archive/catalog_validation/ix-source/requirements.txt deleted file mode 100644 index ac13017da4e..00000000000 --- a/archive/catalog_validation/ix-source/requirements.txt +++ /dev/null @@ -1,6 +0,0 @@ -gitpython -jsonschema==4.10.3 -kubernetes -markdown -pyyaml -semantic_version diff --git a/archive/catalog_validation/ix-source/setup.cfg b/archive/catalog_validation/ix-source/setup.cfg deleted file mode 100644 index aa079ec57f8..00000000000 --- a/archive/catalog_validation/ix-source/setup.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[flake8] -max-line-length=120 diff --git a/archive/catalog_validation/ix-source/setup.py b/archive/catalog_validation/ix-source/setup.py deleted file mode 100644 index a64ad680466..00000000000 --- a/archive/catalog_validation/ix-source/setup.py +++ /dev/null @@ -1,21 +0,0 @@ -from distutils.core import setup -from setuptools import find_packages - -VERSION = '0.1' - -setup( - name='catalog_validation', - description='Validate TrueNAS Catalog(s)', - version=VERSION, - include_package_data=True, - packages=find_packages(), - license='GNU3', - platforms='any', - entry_points={ - 'console_scripts': [ - 'catalog_validate = catalog_validation.scripts.catalog_validate:main', - 'catalog_update = catalog_validation.scripts.catalog_update:main', - 'dev_charts_validate = catalog_validation.scripts.dev_apps_validate:main', - ], - }, -) diff --git a/archive/catalog_validation/truecharts-fork/.github/workflows/ci.yml b/archive/catalog_validation/truecharts-fork/.github/workflows/ci.yml deleted file mode 100644 index 9358902f1e1..00000000000 --- a/archive/catalog_validation/truecharts-fork/.github/workflows/ci.yml +++ /dev/null @@ -1,34 +0,0 @@ -name: CI - -on: [push] - -jobs: - build-deb: - runs-on: ubuntu-latest - container: - image: tccr.io/truecharts/catalog_validation:latest@sha256:35d6b9765e7f86f064b494c640b60ca485b4a82a12e4851930dd50fca83c6c2e - - steps: - - name: Checkout - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1 - - - name: Build deb package - run: > - dpkg-buildpackage - -B - --no-sign - -jauto - - - name: Create artifacts dir - run: mkdir artifacts - if: success() - - - name: Move artifacts - run: mv ../*.deb artifacts - if: success() - - - uses: actions/upload-artifact@3446296876d12d4e3a0f3145a3c87e67bf0a16b5 # v1 - with: - name: py-catalog-validation - path: artifacts - if: success() diff --git a/archive/catalog_validation/truecharts-fork/.github/workflows/containers.build.yaml b/archive/catalog_validation/truecharts-fork/.github/workflows/containers.build.yaml deleted file mode 100644 index 1330159b3a1..00000000000 --- a/archive/catalog_validation/truecharts-fork/.github/workflows/containers.build.yaml +++ /dev/null @@ -1,178 +0,0 @@ -name: build_image - -on: - push: - branches: - - "master" - -jobs: - build: - permissions: - actions: read # for detecting the Github Actions environment. - id-token: write # for creating OIDC tokens for signing. - packages: write # for uploading attestations. - name: Build - runs-on: ubuntu-22.04 - if: "!contains(github.event.head_commit.message, '[ci-skip]')" - steps: - - name: Checkout - uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4 - - # Define if tests and push should be run against which versions/platforms - - name: Prepare - id: prep - run: | - PLATFORM="linux/amd64" - echo ::set-output name=platform::${PLATFORM} - - if [ "${{github.event_name}}" == "pull_request" ]; then - echo ::set-output name=push::false - echo ::set-output name=cache_from::"type=registry,ref=ghcr.io/${{ github.repository_owner }}/${{ matrix.container }}:buildcache" || echo ::set-output name=cache_from::"" - echo ::set-output name=cache_to::"" - else - echo ::set-output name=push::true - echo ::set-output name=cache_from::"type=registry,ref=ghcr.io/${{ github.repository_owner }}/${{ matrix.container }}:buildcache" - echo ::set-output name=cache_to::"type=registry,ref=ghcr.io/${{ github.repository_owner }}/${{ matrix.container }}:buildcache,mode=max" - fi - - name: Get Time - id: time - uses: nanzm/get-time-action@887e4db9af58ebae64998b7105921b816af77977 # v2.0 - with: - timeZone: 1 - format: "YYYYMMDDHHmmss" - - - name: Set up QEMU - uses: docker/setup-qemu-action@49b3bc8e6bdd4a60e6116a5414239cba5943d3cf # v3 - with: - platforms: amd64 - - - uses: sigstore/cosign-installer@main - - - name: Install Syft - uses: anchore/sbom-action/download-syft@61119d458adab75f756bc0b9e4bde25725f86a7a # v0.17.2 - - - name: Login to Quay - uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3 - if: github.event_name != 'pull_request' - with: - registry: quay.io - username: ${{ secrets.QUAY_USER }} - password: ${{ secrets.QUAY_SECRET }} - - - name: Login to GHCR - uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3 - if: github.event_name != 'pull_request' - with: - registry: ghcr.io - username: ${{ secrets.GHCR_USERNAME }} - password: ${{ secrets.GHCR_TOKEN }} - - - name: Docker meta - id: meta - uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5 - with: - # list of Docker images to use as base name for tags - images: | - quay.io/truecharts/catalog_validation - ghcr.io/truecharts/catalog_validation - tccr.io/truecharts/catalog_validation - - # Install and configure Buildx - - name: Set up Docker Buildx - id: buildx - uses: docker/setup-buildx-action@c47758b77c9736f4b2ef4073d4d51994fabfe349 # v3 - with: - install: true - version: latest - driver-opts: image=moby/buildkit:latest - - # Creates a local build to run tests on - - name: Build and Load local test-container - if: ${{ steps.prep.outputs.goss == 'true' }} - uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25 # v5 - with: - build-args: | - CONTAINER_NAME=catalog_validation - context: . - file: ./Dockerfile - load: true - tags: | - ghcr.io/${{ github.repository_owner }}/catalog_validation:test - - # Push if not a PR, otherwise just test the build process for all requested platforms - - name: Build and Push - id: push - uses: docker/build-push-action@ca052bb54ab0790a636c9b5f226502c73d547a25 # v5 - with: - build-args: | - CONTAINER_NAME=catalog_validation - context: . - platforms: ${{ steps.prep.outputs.platform }} - file: ./Dockerfile - push: ${{ steps.prep.outputs.push }} - labels: ${{ steps.meta.outputs.labels }} - tags: | - quay.io/truecharts/catalog_validation:latest - quay.io/truecharts/catalog_validation:build${{ steps.time.outputs.time }} - - - name: Set quay to Public - if: github.event_name != 'pull_request' - run: | - curl -X POST -H "Content-Type: application/json" -d '{"visibility": "public"}' -H "Authorization: Bearer ${{ secrets.QUAY_TOKEN }}" "https://quay.io/api/v1/repository/truecharts/catalog_validation/changevisibility" - - - name: Sign the images - if: github.event_name != 'pull_request' - run: | - cosign sign quay.io/truecharts/catalog_validation@${{ steps.push.outputs.digest }} -y -a "repo=${{ github.repository }}" -a "workflow=${{ github.workflow }}" -a "ref=${{ github.sha }}" - - - name: Verify the pushed tags - if: github.event_name != 'pull_request' - run: | - cosign verify quay.io/truecharts/catalog_validation@${{ steps.push.outputs.digest }} --certificate-oidc-issuer=https://token.actions.githubusercontent.com --certificate-identity=https://github.com/truecharts/catalog_validation/.github/workflows/containers.build.yaml@refs/heads/master - - - name: Generate SBOM - if: github.event_name != 'pull_request' - run: | - syft "quay.io/truecharts/catalog_validation:build${{ steps.time.outputs.time }}@${{ steps.push.outputs.digest }}" -o spdx-json=catalog_validation-sbom-spdx.json - - - name: Attach SBOM to image - if: github.event_name != 'pull_request' - run: | - cosign attest --predicate catalog_validation-sbom-spdx.json --type spdx "quay.io/truecharts/catalog_validation@${{ steps.push.outputs.digest }}" -y - - - name: Verify SBOM attestation - if: github.event_name != 'pull_request' - run: | - cosign verify-attestation quay.io/truecharts/catalog_validation@${{ steps.push.outputs.digest }} --type https://spdx.dev/Document --certificate-oidc-issuer=https://token.actions.githubusercontent.com --certificate-identity=https://github.com/truecharts/catalog_validation/.github/workflows/containers.build.yaml@refs/heads/master | jq '.payload |= @base64d | .payload | fromjson' - - - name: Generate provenance - id: gen-prov - if: github.event_name != 'pull_request' - run: | - wget https://github.com/slsa-framework/slsa-github-generator/releases/download/v1.5.0/slsa-generator-container-linux-amd64 - chmod +x slsa-generator-container-linux-amd64 - # Generate a predicate only. - ./slsa-generator-container-linux-amd64 generate --predicate="catalog_validation-predicate.json" - env: - UNTRUSTED_IMAGE: "quay.io/truecharts/catalog_validation" - UNTRUSTED_DIGEST: "${{ steps.push.outputs.digest }}" - GITHUB_CONTEXT: "${{ toJSON(github) }}" - - - name: Sign provenance - id: sign-prov - if: github.event_name != 'pull_request' - run: | - cosign attest --predicate="catalog_validation-predicate.json" \ - --type slsaprovenance \ - --yes \ - "quay.io/truecharts/catalog_validation@${{ steps.push.outputs.digest }}" - env: - COSIGN_EXPERIMENTAL: 1 - - - name: Verify provenance attestation - if: github.event_name != 'pull_request' - id: verf-prov - run: | - cosign verify-attestation quay.io/truecharts/catalog_validation@${{ steps.push.outputs.digest }} --type slsaprovenance --certificate-oidc-issuer=https://token.actions.githubusercontent.com --certificate-identity=https://github.com/truecharts/catalog_validation/.github/workflows/containers.build.yaml@refs/heads/master | jq '.payload |= @base64d | .payload | fromjson' - env: - COSIGN_EXPERIMENTAL: 1 diff --git a/archive/catalog_validation/truecharts-fork/.github/workflows/lint.yml b/archive/catalog_validation/truecharts-fork/.github/workflows/lint.yml deleted file mode 100644 index 4e606196860..00000000000 --- a/archive/catalog_validation/truecharts-fork/.github/workflows/lint.yml +++ /dev/null @@ -1,20 +0,0 @@ -name: flake8 - -on: [push] - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2 - - name: Set up Python 3.8 - uses: actions/setup-python@0f07f7f756721ebd886c2462646a35f78a8bc4de # v1 - with: - python-version: 3.8 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install flake8 - - name: Analysing the code with flake8 - run: flake8 . diff --git a/archive/catalog_validation/truecharts-fork/.github/workflows/test.yaml b/archive/catalog_validation/truecharts-fork/.github/workflows/test.yaml deleted file mode 100644 index 6bd70ffe254..00000000000 --- a/archive/catalog_validation/truecharts-fork/.github/workflows/test.yaml +++ /dev/null @@ -1,23 +0,0 @@ -name: catalog_validation_test - -on: [push] - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - uses: actions/checkout@ee0669bd1cc54295c223e0bb666b733df41de1c5 # v2 - - name: Set up Python 3.8 - uses: actions/setup-python@0f07f7f756721ebd886c2462646a35f78a8bc4de # v1 - with: - python-version: 3.8 - - name: Install dependencies - run: | - python -m pip install --upgrade pip - pip install -r catalog_validation/pytest/requirements.txt - pip install -r requirements.txt - - name: Installing catalog validation - run: python setup.py install - - name: Running test - run: pytest catalog_validation/pytest/ diff --git a/archive/catalog_validation/truecharts-fork/.gitignore b/archive/catalog_validation/truecharts-fork/.gitignore deleted file mode 100644 index 99ac911613d..00000000000 --- a/archive/catalog_validation/truecharts-fork/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -catalog_validation/__pycache__ -catalog_validation/schema/__pycache__ diff --git a/archive/catalog_validation/truecharts-fork/Dockerfile b/archive/catalog_validation/truecharts-fork/Dockerfile deleted file mode 100644 index d5e9bc466bd..00000000000 --- a/archive/catalog_validation/truecharts-fork/Dockerfile +++ /dev/null @@ -1,24 +0,0 @@ -FROM debian:bookworm - -RUN apt-get update - -RUN apt-get install -y \ - debhelper-compat \ - dh-python \ - python3-dev \ - python3-setuptools \ - devscripts \ - python3-jsonschema \ - python3-semantic-version \ - python3-kubernetes \ - python3-yaml \ - python3-pip - -ENV PYTHONUNBUFFERED 1 -ENV WORK_DIR /app -RUN mkdir -p ${WORK_DIR} -WORKDIR ${WORK_DIR} - -ADD . ${WORK_DIR}/ -RUN pip install --break-system-packages -r requirements.txt -RUN pip install --break-system-packages -U . diff --git a/archive/catalog_validation/truecharts-fork/LICENSE b/archive/catalog_validation/truecharts-fork/LICENSE deleted file mode 100644 index f288702d2fa..00000000000 --- a/archive/catalog_validation/truecharts-fork/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/archive/catalog_validation/truecharts-fork/README.md b/archive/catalog_validation/truecharts-fork/README.md deleted file mode 100644 index e142d111462..00000000000 --- a/archive/catalog_validation/truecharts-fork/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# catalogs_validation -Validate truenas compliant catalog structure / format. diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/__init__.py b/archive/catalog_validation/truecharts-fork/catalog_validation/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/ci/__init__.py b/archive/catalog_validation/truecharts-fork/catalog_validation/ci/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/ci/utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/ci/utils.py deleted file mode 100644 index 2b8f0914fdd..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/ci/utils.py +++ /dev/null @@ -1,54 +0,0 @@ -import os -import yaml - -from catalog_validation.items.utils import DEVELOPMENT_DIR -from jsonschema import validate as json_schema_validate -from semantic_version import Version - - -DEV_DIRECTORY_RELATIVE_PATH: str = os.path.join('library', DEVELOPMENT_DIR) -TO_KEEP_VERSIONS = 'to_keep_versions.yaml' -OPTIONAL_METADATA_FILES = ['upgrade_info.json', 'upgrade_strategy', TO_KEEP_VERSIONS] -REQUIRED_METADATA_FILES = ['item.yaml'] -UPDATE_STRATEGY_FILE = 'upgrade_strategy' - - -REQUIRED_VERSIONS_SCHEMA = { - 'type': 'array', - 'items': { - 'type': 'string', - 'pattern': '[0-9]+.[0-9]+.[0-9]+' - } -} - - -def get_app_version(app_path: str) -> str: - # This assumes that file exists and version is specified and is good - with open(os.path.join(app_path, 'Chart.yaml'), 'r') as f: - return yaml.safe_load(f.read())['version'] - - -def get_ci_development_directory(catalog_path: str) -> str: - return os.path.join(catalog_path, DEV_DIRECTORY_RELATIVE_PATH) - - -def get_to_keep_versions(app_dir_path: str) -> list: - required_version_path = os.path.join(app_dir_path, TO_KEEP_VERSIONS) - if not os.path.exists(required_version_path): - return [] - - with open(required_version_path, 'r') as f: - data = yaml.safe_load(f.read()) - json_schema_validate(data, REQUIRED_VERSIONS_SCHEMA) - return data - - -def version_has_been_bumped(app_path: str, new_version: str) -> bool: - if not os.path.isdir(app_path): - return True - - versions = [ - Version(version) for version in filter(lambda v: os.path.isdir(os.path.join(app_path, v)), os.listdir(app_path)) - ] - versions.sort() - return not versions or Version(new_version) > versions[-1] diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/ci/validate.py b/archive/catalog_validation/truecharts-fork/catalog_validation/ci/validate.py deleted file mode 100644 index 6de3a360b27..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/ci/validate.py +++ /dev/null @@ -1,96 +0,0 @@ -import os -import yaml - -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.validation import validate_catalog_item_version, validate_chart_version -from jsonschema import ValidationError as JsonValidationError - -from .utils import ( - get_app_version, get_ci_development_directory, REQUIRED_METADATA_FILES, version_has_been_bumped, - TO_KEEP_VERSIONS, REQUIRED_VERSIONS_SCHEMA, get_to_keep_versions, UPDATE_STRATEGY_FILE -) - - -def validate_dev_directory_structure(catalog_path: str, to_check_apps: dict) -> None: - verrors = ValidationErrors() - dev_directory = get_ci_development_directory(catalog_path) - if not os.path.exists(dev_directory): - return - - for train_name in filter( - lambda name: name in to_check_apps and os.path.isdir(os.path.join(dev_directory, name)), - os.listdir(dev_directory) - ): - validate_train( - catalog_path, os.path.join(dev_directory, train_name), f'dev.{train_name}', to_check_apps[train_name] - ) - verrors.check() - - -def validate_train(catalog_path: str, train_path: str, schema: str, to_check_apps: list) -> None: - verrors = ValidationErrors() - train_name = os.path.basename(train_path) - for app_name in filter( - lambda name: os.path.isdir(os.path.join(train_path, name)), os.listdir(train_path) - ): - if app_name not in to_check_apps: - continue - - app_path = os.path.join(train_path, app_name) - try: - validate_app(app_path, f'{schema}.{app_name}') - except ValidationErrors as ve: - verrors.extend(ve) - else: - published_train_app_path = os.path.join(catalog_path, train_name, app_name) - if not os.path.exists(published_train_app_path): - # The application is new and we are good - continue - - if not version_has_been_bumped(published_train_app_path, get_app_version(app_path)): - verrors.add( - f'{schema}.{app_name}.version', - 'Version must be bumped as app has been changed but version has not been updated' - ) - - verrors.check() - - -def validate_keep_versions(app_dir_path: str, schema: str, verrors: ValidationErrors) -> ValidationErrors: - try: - get_to_keep_versions(app_dir_path) - except yaml.YAMLError: - verrors.add(f'{schema}.{REQUIRED_VERSIONS_SCHEMA}', 'Invalid yaml format') - except JsonValidationError: - verrors.add( - f'{schema}.{REQUIRED_VERSIONS_SCHEMA}', - f'Invalid json schema {TO_KEEP_VERSIONS} must contain list of required versions' - ) - - -def validate_upgrate_strategy(app_path, schema, verrors): - upgrade_strategy_path = os.path.join(app_path, UPDATE_STRATEGY_FILE) - if os.path.exists(upgrade_strategy_path) and not os.access(upgrade_strategy_path, os.X_OK): - verrors.add(schema, f'{upgrade_strategy_path!r} is not executable') - - -def validate_app(app_dir_path: str, schema: str) -> None: - app_name = os.path.basename(app_dir_path) - chart_version_path = os.path.join(app_dir_path, 'Chart.yaml') - verrors = validate_chart_version(ValidationErrors(), chart_version_path, schema, app_name) - validate_keep_versions(app_dir_path, app_name, verrors) - verrors.check() - - validate_catalog_item_version(app_dir_path, schema, get_app_version(app_dir_path), app_name, True) - - required_files = set(REQUIRED_METADATA_FILES) - available_files = set( - f for f in filter(lambda f: os.path.isfile(os.path.join(app_dir_path, f)), os.listdir(app_dir_path)) - ) - if missing_files := required_files - available_files: - verrors.add( - f'{schema}.required_files', - f'{", ".join(missing_files)!r} file(s) must be specified' - ) - validate_upgrate_strategy(app_dir_path, f'{schema}.{UPDATE_STRATEGY_FILE}', verrors) - verrors.check() diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/exceptions.py b/archive/catalog_validation/truecharts-fork/catalog_validation/exceptions.py deleted file mode 100644 index 5fba74a23a8..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/exceptions.py +++ /dev/null @@ -1,67 +0,0 @@ -import errno - - -class ValidationException(Exception): - def __init__(self, error_msg, error_no=errno.EFAULT): - self.errmsg = error_msg - self.errno = error_no - - def get_error_name(self): - return errno.errorcode.get(self.errno) or 'EUNKNOWN' - - def __str__(self): - return f'[{self.get_error_name()}] {self.errmsg}' - - -class ValidationError(ValidationException): - def __init__(self, attribute, errmsg, errno=errno.EFAULT): - self.attribute = attribute - self.errmsg = errmsg - self.errno = errno - - def __str__(self): - return f'[{self.get_error_name()}] {self.attribute}: {self.errmsg}' - - -class ValidationErrors(ValidationException): - def __init__(self, errors=None): - self.errors = errors or [] - - def add(self, attribute, errmsg, errno=errno.EINVAL): - self.errors.append(ValidationError(attribute, errmsg, errno)) - - def add_validation_error(self, validation_error): - self.errors.append(validation_error) - - def add_child(self, attribute, child): - for e in child.errors: - self.add(f"{attribute}.{e.attribute}", e.errmsg, e.errno) - - def check(self): - if self: - raise self - - def extend(self, errors): - for e in errors.errors: - self.add(e.attribute, e.errmsg, e.errno) - - def __iter__(self): - for e in self.errors: - yield e.attribute, e.errmsg, e.errno - - def __bool__(self): - return bool(self.errors) - - def __str__(self): - output = '' - for e in self.errors: - output += str(e) + '\n' - return output - - def __contains__(self, item): - return item in [e.attribute for e in self.errors] - - -class CatalogDoesNotExist(ValidationException): - def __init__(self, path): - super().__init__(f'Failed to find a catalog at {path}', errno.ENOENT) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/git_utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/git_utils.py deleted file mode 100644 index adbcf5fb0c2..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/git_utils.py +++ /dev/null @@ -1,42 +0,0 @@ -import os -import subprocess - -from catalog_validation.ci.utils import DEV_DIRECTORY_RELATIVE_PATH, get_ci_development_directory -from catalog_validation.items.utils import valid_train -from collections import defaultdict - -from .ci.utils import OPTIONAL_METADATA_FILES -from .exceptions import CatalogDoesNotExist - - -def get_changed_apps(catalog_path: str, base_branch: str = 'master') -> dict: - if not os.path.exists(catalog_path): - raise CatalogDoesNotExist(catalog_path) - - cp = subprocess.run( - ['git', '-C', catalog_path, '--no-pager', 'diff', '--name-only', base_branch], - capture_output=True, check=True, - ) - dev_directory_path = get_ci_development_directory(catalog_path) - to_check_apps = defaultdict(list) - for file_path in filter( - lambda path: path and path.startswith(f'{DEV_DIRECTORY_RELATIVE_PATH}/'), - map(str.strip, cp.stdout.decode().split('\n')) - ): - dev_dir_relative_path = file_path.strip(f'{DEV_DIRECTORY_RELATIVE_PATH}/') - train_name = dev_dir_relative_path.split('/', 1)[0] - if not valid_train(train_name, os.path.join(dev_directory_path, train_name)): - continue - - app_name = dev_dir_relative_path.split('/')[1] - base_name = os.path.basename(file_path) - - if base_name in OPTIONAL_METADATA_FILES: - continue - if not os.path.isdir(os.path.join(dev_directory_path, train_name, app_name)): - continue - - if app_name not in to_check_apps[train_name]: - to_check_apps[train_name].append(app_name) - - return to_check_apps diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/__init__.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/catalog.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/catalog.py deleted file mode 100644 index 2fcdea53732..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/items/catalog.py +++ /dev/null @@ -1,83 +0,0 @@ -import concurrent.futures -import functools -import os -import typing -import yaml - -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from .items_util import get_item_details, get_default_questions_context -from .utils import RECOMMENDED_APPS_FILENAME, RECOMMENDED_APPS_SCHEMA, valid_train - - -def item_details(items: dict, location: str, questions_context: typing.Optional[dict], item_key: str) -> dict: - train = items[item_key] - item = item_key.removesuffix(f'_{train}') - item_location = os.path.join(location, train, item) - return get_item_details(item_location, questions_context, {'retrieve_versions': True}) - - -def retrieve_train_names(location: str, all_trains=True, trains_filter=None) -> list: - train_names = [] - trains_filter = trains_filter or [] - for train in os.listdir(location): - if not (all_trains or train in trains_filter) or not valid_train(train, os.path.join(location, train)): - continue - train_names.append(train) - return train_names - - -def get_items_in_trains(trains_to_traverse: list, catalog_location: str) -> dict: - items = {} - for train in trains_to_traverse: - items.update({ - f'{i}_{train}': train for i in os.listdir(os.path.join(catalog_location, train)) - if os.path.isdir(os.path.join(catalog_location, train, i)) - }) - - return items - - -def retrieve_trains_data( - items: dict, catalog_location: str, preferred_trains: list, - trains_to_traverse: list, job: typing.Any = None, questions_context: typing.Optional[dict] = None -) -> typing.Tuple[dict, set]: - questions_context = questions_context or get_default_questions_context() - trains = { - 'charts': {}, - 'test': {}, - **{k: {} for k in trains_to_traverse}, - } - unhealthy_apps = set() - - total_items = len(items) - with concurrent.futures.ProcessPoolExecutor(max_workers=(20 if total_items > 10 else 5)) as exc: - for index, result in enumerate(zip(items, exc.map( - functools.partial(item_details, items, catalog_location, questions_context), - items, chunksize=(10 if total_items > 10 else 5) - ))): - item_key = result[0] - item_info = result[1] - train = items[item_key] - item = item_key.removesuffix(f'_{train}') - if job: - job.set_progress( - int((index / total_items) * 80) + 10, - f'Retrieved information of {item!r} item from {train!r} train' - ) - trains[train][item] = item_info - if train in preferred_trains and not trains[train][item]['healthy']: - unhealthy_apps.add(f'{item} ({train} train)') - - return trains, unhealthy_apps - - -def retrieve_recommended_apps(catalog_location: str) -> typing.Dict[str, list]: - try: - with open(os.path.join(catalog_location, RECOMMENDED_APPS_FILENAME), 'r') as f: - data = yaml.safe_load(f.read()) - json_schema_validate(data, RECOMMENDED_APPS_SCHEMA) - except (FileNotFoundError, JsonValidationError, yaml.YAMLError): - return {} - else: - return data diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/features.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/features.py deleted file mode 100644 index 3ec64c8f22a..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/items/features.py +++ /dev/null @@ -1,19 +0,0 @@ -SUPPORTED_FEATURES = { - 'normalize/interfaceConfiguration', - 'normalize/ixVolume', - 'definitions/certificate', - 'definitions/certificateAuthority', - 'definitions/interface', - 'definitions/gpuConfiguration', - 'definitions/timezone', - 'definitions/nodeIP', - 'validations/containerImage', - 'validations/nodePort', - 'validations/hostPath', - 'validations/lockedHostPath', - 'validations/hostPathAttachments', -} - - -def version_supported(version_details: dict) -> bool: - return not bool(set(version_details['required_features']) - SUPPORTED_FEATURES) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/items_util.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/items_util.py deleted file mode 100644 index 466bf284ab2..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/items/items_util.py +++ /dev/null @@ -1,214 +0,0 @@ -import markdown -import os -import typing -import yaml - -from pkg_resources import parse_version - -from catalog_validation.exceptions import ValidationErrors - -from .features import version_supported -from .questions_utils import normalise_questions -from .utils import get_last_updated_date -from .validate_utils import validate_item, validate_item_version - - -ITEM_KEYS = ['icon_url'] - - -def get_item_details_base() -> dict: - return { - 'app_readme': None, - 'categories': [], - 'description': None, - 'healthy': False, # healthy means that each version the item hosts is valid and healthy - 'healthy_error': None, # An error string explaining why the item is not healthy - 'home': None, - 'location': None, - 'latest_version': None, - 'latest_app_version': None, - 'latest_human_version': None, - 'last_update': None, - 'name': None, - 'recommended': False, - 'title': None, - 'versions': {}, - 'maintainers': [], - 'tags': [], - 'screenshots': [], - 'sources': [], - } - - -def get_item_details( - item_location: str, questions_context: typing.Optional[dict] = None, options: typing.Optional[dict] = None -) -> dict: - catalog_path = item_location.rstrip('/').rsplit('/', 2)[0] - item = item_location.rsplit('/', 1)[-1] - train = item_location.rsplit('/', 2)[-2] - - options = options or {} - retrieve_versions = options.get('retrieve_versions', True) - item_data = get_item_details_base() - item_data.update({ - 'location': item_location, - 'last_update': get_last_updated_date(catalog_path, item_location), - 'name': item, - 'title': item.capitalize(), - }) - - schema = f'{train}.{item}' - try: - validate_item(item_location, schema, False) - except ValidationErrors as verrors: - item_data['healthy_error'] = f'Following error(s) were found with {item!r}:\n' - for verror in verrors: - item_data['healthy_error'] += f'{verror[0]}: {verror[1]}' - - # If the item format is not valid - there is no point descending any further into versions - if not retrieve_versions: - item_data.pop('versions') - return item_data - - item_data.update(get_item_details_impl(item_location, schema, questions_context, { - 'retrieve_latest_version': not retrieve_versions, - 'default_values_callable': options.get('default_values_callable'), - })) - unhealthy_versions = [] - for k, v in sorted(item_data['versions'].items(), key=lambda v: parse_version(v[0]), reverse=True): - if not v['healthy']: - unhealthy_versions.append(k) - else: - chart_metadata = v['chart_metadata'] - if not item_data['app_readme']: - item_data['app_readme'] = v['app_readme'] - if not item_data['maintainers'] and chart_metadata.get('maintainers'): - item_data['maintainers'] = chart_metadata['maintainers'] - if not item_data['latest_version']: - item_data['latest_version'] = k - item_data['latest_app_version'] = chart_metadata.get('appVersion') - item_data['latest_human_version'] = '' - if item_data['latest_app_version']: - item_data['latest_human_version'] = f'{item_data["latest_app_version"]}_' - item_data['latest_human_version'] += k - if not item_data['description'] and chart_metadata.get('description'): - item_data['description'] = v['chart_metadata']['description'] - if item_data['title'] == item_data['name'].capitalize() and chart_metadata.get( - 'annotations', {} - ).get('title'): - item_data['title'] = chart_metadata['annotations']['title'] - if item_data['home'] is None and chart_metadata.get('home'): - item_data['home'] = chart_metadata['home'] - if not item_data['sources'] and chart_metadata.get('sources'): - item_data['sources'] = chart_metadata['sources'] - - if unhealthy_versions: - item_data['healthy_error'] = f'Errors were found with {", ".join(unhealthy_versions)} version(s)' - else: - item_data['healthy'] = True - if not retrieve_versions: - item_data.pop('versions') - - return item_data - - -def get_item_details_impl( - item_path: str, schema: str, questions_context: typing.Optional[dict], options: typing.Optional[dict] -) -> dict: - # Each directory under item path represents a version of the item and we need to retrieve details - # for each version available under the item - retrieve_latest_version = options.get('retrieve_latest_version') - item_data = { - 'categories': [], - 'icon_url': None, - 'screenshots': [], - 'tags': [], - 'versions': {}, - } - with open(os.path.join(item_path, 'item.yaml'), 'r') as f: - item_data.update(yaml.safe_load(f.read())) - - item_data.update({k: item_data.get(k) for k in ITEM_KEYS}) - - for version in sorted( - filter(lambda p: os.path.isdir(os.path.join(item_path, p)), os.listdir(item_path)), - reverse=True, key=parse_version, - ): - catalog_path = item_path.rstrip('/').rsplit('/', 2)[0] - version_path = os.path.join(item_path, version) - item_data['versions'][version] = version_details = { - 'healthy': False, - 'supported': False, - 'healthy_error': None, - 'location': version_path, - 'last_update': get_last_updated_date(catalog_path, version_path), - 'required_features': [], - 'human_version': version, - 'version': version, - } - try: - validate_item_version(version_details['location'], f'{schema}.{version}') - except ValidationErrors as verrors: - version_details['healthy_error'] = f'Following error(s) were found with {schema}.{version!r}:\n' - for verror in verrors: - version_details['healthy_error'] += f'{verror[0]}: {verror[1]}' - - # There is no point in trying to see what questions etc the version has as it's invalid - continue - - version_details.update({ - 'healthy': True, - **get_item_version_details(version_details['location'], questions_context) - }) - if retrieve_latest_version: - break - - return item_data - - -def get_item_version_details( - version_path: str, questions_context: typing.Optional[dict], options: typing.Optional[dict] = None -) -> dict: - version_data = {'location': version_path, 'required_features': set()} - for key, filename, parser in ( - ('chart_metadata', 'Chart.yaml', yaml.safe_load), - ('app_metadata', 'metadata.yaml', yaml.safe_load), - ('schema', 'questions.yaml', yaml.safe_load), - ('app_readme', 'app-readme.md', markdown.markdown), - ('detailed_readme', 'README.md', markdown.markdown), - ('changelog', 'CHANGELOG.md', markdown.markdown), - ): - if os.path.exists(os.path.join(version_path, filename)): - with open(os.path.join(version_path, filename), 'r') as f: - version_data[key] = parser(f.read()) - else: - version_data[key] = None - - # We will normalise questions now so that if they have any references, we render them accordingly - # like a field referring to available interfaces on the system - normalise_questions(version_data, questions_context or get_default_questions_context()) - - version_data.update({ - 'supported': version_supported(version_data), - 'required_features': list(version_data['required_features']), - }) - if options and options.get('default_values_callable'): - version_data['values'] = options['default_values_callable'](version_data) - chart_metadata = version_data['chart_metadata'] - if chart_metadata['name'] != 'ix-chart' and chart_metadata.get('appVersion'): - version_data['human_version'] = f'{chart_metadata["appVersion"]}_{chart_metadata["version"]}' - - return version_data - - -def get_default_questions_context() -> dict: - return { - 'nic_choices': [], - 'gpus': {}, - 'timezones': {'Asia/Saigon': 'Asia/Saigon', 'Asia/Damascus': 'Asia/Damascus'}, - 'node_ip': '192.168.0.10', - 'certificates': [], - 'certificate_authorities': [], - 'system.general.config': {'timezone': 'America/Los_Angeles'}, - 'unused_ports': [i for i in range(1025, 65535)], - } diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/ix_values_utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/ix_values_utils.py deleted file mode 100644 index 0fcc046b439..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/items/ix_values_utils.py +++ /dev/null @@ -1,58 +0,0 @@ -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from catalog_validation.exceptions import ValidationErrors - - -CUSTOM_PORTALS_JSON_SCHEMA = { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'portalName': { - 'type': 'string', - }, - 'protocol': { - 'type': 'string', 'enum': ['http', 'https'], - }, - 'useNodeIP': { - 'type': 'boolean', - }, - 'port': { - 'type': 'integer', - }, - 'path': { - 'type': 'string', - }, - }, - 'allOf': [ - { - 'if': { - 'properties': { - 'useNodeIP': { - 'const': False, - }, - }, - }, - 'then': { - 'required': ['host'], - 'properties': { - 'host': { - 'type': 'string', - }, - }, - }, - }], - 'required': ['portalName', 'protocol', 'useNodeIP', 'port'], - }, -} - - -def validate_ix_values_schema(schema, data): - verrors = ValidationErrors() - - try: - json_schema_validate(data, CUSTOM_PORTALS_JSON_SCHEMA) - except JsonValidationError as e: - verrors.add(schema, f'Failed to validate schema: {e}') - - verrors.check() diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/questions_utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/questions_utils.py deleted file mode 100644 index d0255d2add3..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/items/questions_utils.py +++ /dev/null @@ -1,186 +0,0 @@ -import itertools - -from .utils import ACL_QUESTION, IX_VOLUMES_ACL_QUESTION - - -CUSTOM_PORTALS_KEY = 'iXPortals' -CUSTOM_PORTALS_ENABLE_KEY = 'enableIXPortals' -CUSTOM_PORTAL_GROUP_KEY = 'iXPortalsGroupName' - - -def get_custom_portal_question(group_name: str) -> dict: - return { - 'variable': CUSTOM_PORTALS_KEY, - 'label': 'User Specified Web Portals', - 'description': 'User(s) can specify custom webUI portals', - 'group': group_name, - 'schema': { - 'type': 'list', - 'items': [{ - 'variable': 'portalConfiguration', - 'label': 'Portal Configuration', - 'description': 'Configure WebUI Portal', - 'schema': { - 'type': 'dict', - 'attrs': [ - { - 'variable': 'portalName', - 'label': 'Portal Name', - 'description': 'Specify a UI Portal name to use which would be displayed in the UI', - 'schema': { - 'type': 'string', - 'default': 'Web Portal', - 'empty': False, - }, - }, - { - 'variable': 'protocol', - 'label': 'Protocol for Portal', - 'description': 'Specify protocol for Portal', - 'schema': { - 'type': 'string', - 'default': 'http', - 'enum': [ - {'value': 'http', 'description': 'HTTP Protocol'}, - {'value': 'https', 'description': 'HTTPS Protocol'}, - ], - }, - }, - { - 'variable': 'useNodeIP', - 'label': 'Use Node IP for Portal IP/Domain', - 'schema': { - 'type': 'boolean', - 'default': True, - }, - }, - { - 'variable': 'host', - 'label': 'Portal IP/Domain', - 'schema': { - 'type': 'string', - 'show_if': [['useNodeIP', '=', False]], - '$ref': ['definitions/nodeIP'], - }, - }, - { - 'variable': 'port', - 'label': 'Port', - 'description': 'Specify port to be used for Portal access', - 'schema': { - 'type': 'int', - 'max': 65535, - 'default': 15000, - }, - }, - { - 'variable': 'path', - 'label': 'Path (optional - leave empty if not required)', - 'description': 'Some app(s) might have a sub path i.e http://192.168.0.10:9000/api/', - 'schema': { - 'type': 'string', - }, - }, - ], - }, - }], - }, - } - - -def normalise_questions(version_data: dict, context: dict) -> None: - version_data['required_features'] = set() - version_data['schema']['questions'].extend( - [ - get_custom_portal_question(version_data['schema'][CUSTOM_PORTAL_GROUP_KEY]) - ] if version_data['schema'].get(CUSTOM_PORTALS_ENABLE_KEY) else [] - ) - for question in version_data['schema']['questions']: - normalise_question(question, version_data, context) - version_data['required_features'] = list(version_data['required_features']) - - -def normalise_question(question: dict, version_data: dict, context: dict) -> None: - schema = question['schema'] - for attr in itertools.chain(*[schema.get(k, []) for k in ('attrs', 'items', 'subquestions')]): - normalise_question(attr, version_data, context) - - if '$ref' not in schema: - return - - data = {} - for ref in schema['$ref']: - version_data['required_features'].add(ref) - if ref == 'definitions/interface': - data['enum'] = [ - {'value': i, 'description': f'{i!r} Interface'} for i in context['nic_choices'] - ] - elif ref == 'definitions/gpuConfiguration': - data['attrs'] = [ - { - 'variable': gpu, - 'label': f'GPU Resource ({gpu})', - 'description': 'Please enter the number of GPUs to allocate', - 'schema': { - 'type': 'int', - 'max': int(quantity), - 'enum': [ - {'value': i, 'description': f'Allocate {i!r} {gpu} GPU'} - for i in range(int(quantity) + 1) - ], - 'default': 0, - } - } for gpu, quantity in context['gpus'].items() - ] - elif ref == 'definitions/timezone': - data.update({ - 'enum': [{'value': t, 'description': f'{t!r} timezone'} for t in sorted(context['timezones'])], - 'default': context['system.general.config']['timezone'] - }) - elif ref == 'definitions/nodeIP': - data['default'] = context['node_ip'] - elif ref == 'definitions/certificate': - get_cert_ca_options(schema, data, {'value': None, 'description': 'No Certificate'}) - data['enum'] += [ - {'value': i['id'], 'description': f'{i["name"]!r} Certificate'} - for i in context['certificates'] - ] - elif ref == 'definitions/certificateAuthority': - get_cert_ca_options(schema, data, {'value': None, 'description': 'No Certificate Authority'}) - data['enum'] += [{'value': None, 'description': 'No Certificate Authority'}] + [ - {'value': i['id'], 'description': f'{i["name"]!r} Certificate Authority'} - for i in context['certificate_authorities'] - ] - elif ref == 'definitions/port': - data['enum'] = [{'value': None, 'description': 'No Port Selected'}] if schema.get('null') else [] - data['enum'] += [ - {'value': i, 'description': f'{i!r} Port'} - for i in filter( - lambda p: schema.get('min', 9000) <= p <= schema.get('max', 65534), - context['unused_ports'] - ) - ] - elif ref == 'normalize/acl': - data['attrs'] = ACL_QUESTION - elif ref == 'normalize/ixVolume': - if schema['type'] == 'dict' and any(i['variable'] == 'aclEntries' for i in schema['attrs']): - # get index of aclEntries from attrs - acl_index = next(i for i, v in enumerate(schema['attrs']) if v['variable'] == 'aclEntries') - # insert acl question before aclEntries - schema['attrs'][acl_index]['schema']['attrs'] = IX_VOLUMES_ACL_QUESTION - - schema.update(data) - - -def get_cert_ca_options(schema: dict, data: dict, default_entry: dict): - if schema.get('null', True): - data.update({ - 'enum': [default_entry], - 'default': None, - 'null': True, - }) - else: - data.update({ - 'enum': [], - 'required': True, - }) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/utils.py deleted file mode 100644 index e2a4e16bfc8..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/items/utils.py +++ /dev/null @@ -1,223 +0,0 @@ -import contextlib -import os -import subprocess - -from datetime import datetime -from typing import Optional - -from catalog_validation.schema.migration_schema import MIGRATION_DIRS -from catalog_validation.utils import VALID_TRAIN_REGEX - - -DEVELOPMENT_DIR = 'ix-dev' -RECOMMENDED_APPS_FILENAME = 'recommended_apps.yaml' -RECOMMENDED_APPS_SCHEMA = { - 'type': 'object', - 'patternProperties': { - '.*': { - 'type': 'array', - 'items': {'type': 'string'}, - } - }, -} -TRAIN_IGNORE_DIRS = ['library', 'docs', DEVELOPMENT_DIR] + MIGRATION_DIRS - - -ACL_QUESTION = [ - { - 'variable': 'path', - 'label': 'Host Path', - 'description': 'Host Path to perform ACL', - 'schema': { - 'type': 'hostpath', - 'required': True, - 'empty': False, - } - }, - { - 'variable': 'entries', - 'label': 'ACL Entries', - 'description': 'ACL Entries', - 'schema': { - 'type': 'list', - 'items': [{ - 'variable': 'aclEntry', - 'label': 'ACL Entry', - 'schema': { - 'type': 'dict', - 'attrs': [ - { - 'variable': 'id_type', - 'label': 'ID Type', - 'schema': { - 'type': 'string', - 'enum': [ - {'value': 'USER', 'description': 'Entry is for a USER'}, - {'value': 'GROUP', 'description': 'Entry is for a GROUP'}, - ], - 'default': 'USER', - } - }, - { - 'variable': 'id', - 'label': 'ID', - 'schema': { - 'type': 'int', - 'required': True, - 'min': 0, - } - }, - { - 'variable': 'access', - 'label': 'Access', - 'schema': { - 'type': 'string', - 'enum': [ - {'value': 'READ', 'description': 'Read Access'}, - {'value': 'MODIFY', 'description': 'Modify Access'}, - {'value': 'FULL_CONTROL', 'description': 'FULL_CONTROL Access'}, - ], - } - } - ], - } - }] - } - } -] - -IX_VOLUMES_ACL_QUESTION = [ - { - 'variable': 'path', - 'label': 'Path', - 'description': 'Path to perform ACL', - 'schema': { - 'type': 'string', - 'hidden': True - } - }, - ACL_QUESTION[1] -] - - -def get_catalog_json_schema() -> dict: - return { - 'type': 'object', - 'patternProperties': { - '.*': { - 'type': 'object', - 'title': 'Train', - 'patternProperties': { - '.*': { - 'type': 'object', - 'title': 'Item', - 'properties': { - 'name': { - 'type': 'string', - 'title': 'Name', - }, - 'categories': { - 'type': 'array', - 'items': { - 'type': 'string' - }, - }, - 'app_readme': { - 'type': 'string', - }, - 'location': { - 'type': 'string', - }, - 'healthy': { - 'type': 'boolean', - }, - 'healthy_error': { - 'type': ['string', 'null'], - }, - 'last_update': { - 'type': 'string', - 'pattern': r'^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}$', - }, - 'latest_version': { - 'type': 'string', - }, - 'latest_app_version': { - 'type': 'string', - }, - 'latest_human_version': { - 'type': 'string', - }, - 'description': { - 'type': ['string', 'null'], - }, - 'title': { - 'type': 'string', - }, - 'icon_url': { - 'type': ['string', 'null'], - }, - 'maintainers': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': {'type': 'string'}, - 'url': {'type': ['string', 'null']}, - 'email': {'type': 'string'} - }, - 'required': ['name', 'email'], - } - }, - 'home': { - 'type': 'string', - }, - 'tags': { - 'type': 'array', - 'items': { - 'type': 'string', - } - }, - 'screenshots': { - 'type': 'array', - 'items': { - 'type': 'string', - } - }, - 'sources': { - 'type': 'array', - 'items': { - 'type': 'string', - } - }, - }, - 'required': [ - 'name', 'categories', 'location', 'healthy', 'icon_url', - 'latest_version', 'latest_app_version', 'latest_human_version', - 'last_update', 'recommended', 'healthy_error', 'maintainers', - 'home', 'tags', 'sources', 'screenshots', - ], - } - } - - } - } - } - - -def get_last_updated_date(repo_path: str, folder_path: str) -> Optional[str]: - with contextlib.suppress(Exception): - # We don't want to fail querying items if for whatever reason this fails - output = subprocess.check_output( - ['git', 'log', '-n', '1', '--pretty=format:%ct', f'{folder_path}'], - cwd=repo_path, - stderr=subprocess.DEVNULL - ) - if output: - timestamp = datetime.fromtimestamp(int(output)) - return timestamp.strftime('%Y-%m-%d %H:%M:%S') - - -def valid_train(train_name: str, train_location: str) -> bool: - return VALID_TRAIN_REGEX.match( - train_name - ) and not train_name.startswith('.') and train_name not in TRAIN_IGNORE_DIRS and os.path.isdir(train_location) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/items/validate_utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/items/validate_utils.py deleted file mode 100644 index 3cecf3bafa0..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/items/validate_utils.py +++ /dev/null @@ -1,9 +0,0 @@ -from catalog_validation.validation import validate_catalog_item, validate_catalog_item_version - - -def validate_item(path: str, schema: str, validate_versions: bool = True): - validate_catalog_item(path, schema, validate_versions) - - -def validate_item_version(path: str, schema: str): - validate_catalog_item_version(path, schema) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/__init__.py b/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/api_client.py b/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/api_client.py deleted file mode 100644 index cec1da78513..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/api_client.py +++ /dev/null @@ -1,15 +0,0 @@ -from contextlib import contextmanager - -from kubernetes import client, config - -from .utils import KUBECONFIG_FILE - - -@contextmanager -def api_client(): - config.load_kube_config(config_file=KUBECONFIG_FILE) - api_cl = client.api_client.ApiClient() - try: - yield client.CoreV1Api(api_cl) - finally: - api_cl.close() diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/utils.py deleted file mode 100644 index c973e77e210..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/k8s/utils.py +++ /dev/null @@ -1 +0,0 @@ -KUBECONFIG_FILE = '/etc/rancher/k3s/k3s.yaml' diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/requirements.txt b/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/requirements.txt deleted file mode 100644 index 12136494321..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/requirements.txt +++ /dev/null @@ -1,2 +0,0 @@ -pytest -pytest-mock diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_catalog_validate.py b/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_catalog_validate.py deleted file mode 100644 index 85fc5ff7337..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_catalog_validate.py +++ /dev/null @@ -1,367 +0,0 @@ -import pytest - -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.utils import WANTED_FILES_IN_ITEM_VERSION -from catalog_validation.validation import ( - validate_train_structure, validate_questions_yaml, validate_catalog_item, - validate_catalog_item_version, validate_variable_uniqueness, -) - - -@pytest.mark.parametrize('train_path,should_work', [ - ('/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts', True), - ('/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/', False), - -]) -def test_validate_train_structure(train_path, should_work): - if should_work: - assert validate_train_structure(train_path) is None - else: - with pytest.raises(ValidationErrors): - validate_train_structure(train_path) - - -@pytest.mark.parametrize('test_yaml,should_work', [ - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - portals: - web_portal: - protocols: - - "http" - host: - - "$node_ip" - ports: - - "$variable-machinaris_ui_port" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - True - ), - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - portals: - web_portal: - protocols: {} - host: {} - ports: {} - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - ( - ''' - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - True - ), - ( - ''' - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Network" - group: "Machinaris Network Configuration" - description: "Configure timezone for machianaris" - - ''', - False - ), - ( - ''' - enableIXPortals: true - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - ( - ''' - enableIXPortals: true - iXPortalsGroupName: "Machinaris Configuration" - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - True - ), - ( - ''' - enableIXPortals: true - iXPortalsGroupName: "Invalid Group name" - groups: - - name: "Machinaris Configuration" - description: "Configure timezone for machianaris" - - questions: - - variable: timezone - label: "Configure timezone" - group: "Machinaris Configuration" - description: "Configure timezone for machianaris" - ''', - False - ), - -]) -def test_validate_questions_yaml(mocker, test_yaml, should_work): - open_file_data = mocker.mock_open(read_data=test_yaml) - mocker.patch('builtins.open', open_file_data) - mocker.patch('catalog_validation.validation.validate_question', return_value=None) - if should_work: - assert validate_questions_yaml(None, 'charts.machinaris.versions.1.1.13.questions_configuration') is None - else: - with pytest.raises(ValidationErrors): - validate_questions_yaml(None, 'charts.machinaris.versions.1.1.13.questions_configuration') - - -@pytest.mark.parametrize('catalog_item_path,test_yaml,should_work', [ - ( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/machinaris', - ''' - categories: - - storage - - crypto - icon_url: https://raw.githubusercontent.com/guydavis/machinaris/main/web/static/machinaris.png - ''', - True - ), - ( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/machinaris', - ''' - icon_url: https://raw.githubusercontent.com/guydavis/machinaris/main/web/static/machinaris.png - ''', - False - ), -]) -def test_validate_catalog_item(mocker, catalog_item_path, test_yaml, should_work): - mocker.patch('os.path.isdir', side_effect=[True, True, False]) - mocker.patch('os.listdir', return_value=['1.1.13', 'item.yaml']) - open_file_data = mocker.mock_open(read_data=test_yaml) - mocker.patch('builtins.open', open_file_data) - mocker.patch('catalog_validation.validation.validate_catalog_item_version', return_value=None) - if not should_work: - with pytest.raises(ValidationErrors): - validate_catalog_item(catalog_item_path, 'charts.machinaris') - else: - assert validate_catalog_item(catalog_item_path, 'charts.machinaris') is None - - -@pytest.mark.parametrize('chart_yaml,should_work', [ - ( - ''' - name: storj - version: 1.0.4 - ''', - True - ), - ( - ''' - name: storj - version: 1.0.0 - ''', - False - ), - ( - ''' - name: storj_s - version: 1.0.0 - ''', - False - ) -]) -def test_validate_catalog_item_version(mocker, chart_yaml, should_work): - mocker.patch('os.listdir', return_value=WANTED_FILES_IN_ITEM_VERSION) - mocker.patch('os.path.exists', return_value=True) - open_file = mocker.mock_open(read_data=chart_yaml) - mocker.patch('builtins.open', open_file) - mocker.patch('catalog_validation.validation.validate_questions_yaml', return_value=None) - mocker.patch('catalog_validation.validation.validate_ix_values_yaml', return_value=None) - if should_work: - assert validate_catalog_item_version( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/storj/1.0.4', - 'charts.storj.versions.1.0.4') is None - else: - with pytest.raises(ValidationErrors): - validate_catalog_item_version( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/storj/1.0.4', - 'charts.storj.versions.1.0.4' - ) - - -@pytest.mark.parametrize('data,schema,should_work', [ - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'dnsConfig', - 'label': 'DNS Configuration', - 'group': 'Advanced DNS Settings', - 'schema': { - 'type': 'dict', - 'attrs': [] - } - }, - ], 'plex.questions', True), - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - ], 'plex.questions', False), - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'hostPathEnabled', - 'label': 'Enable Host Path for Plex Transcode Volume', - 'type': 'boolean', - 'default': False, - 'show_subquestions_if': False, - 'subquestions': [ - { - 'variable': 'hostPath', - 'label': 'Host Path for Plex Transcode Volume', - 'schema': { - 'type': 'hostpath', - 'required': True, - '$ref': [ - 'validations/lockedHostPath' - ] - } - }, - ] - } - ], 'plex.questions', True), - ([ - { - 'variable': 'enablePlexPass', - 'label': 'Use PlexPass', - 'group': 'Plex Configuration', - 'schema': { - 'type': 'boolean', - 'default': False - } - }, - { - 'variable': 'mountPath', - 'label': 'Plex Transcode Mount Path', - 'description': 'Path where the volume will be mounted inside the pod', - 'schema': { - 'type': 'path', - } - }, - { - 'variable': 'hostPathEnabled', - 'label': 'Enable Host Path for Plex Transcode Volume', - 'type': 'boolean', - 'default': False, - 'show_subquestions_if': False, - 'subquestions': [ - { - 'variable': 'hostPath', - 'label': 'Host Path for Plex Transcode Volume', - 'schema': { - 'type': 'hostpath', - 'required': True, - '$ref': [ - 'validations/lockedHostPath' - ] - } - }, - { - 'variable': 'mountPath', - 'label': 'Plex Transcode Mount Path', - 'description': 'Path where the volume will be mounted inside the pod', - 'schema': { - 'type': 'path', - } - }, - ] - } - ], 'plex.questions', False), -]) -def test_validate_variable_uniqueness(data, schema, should_work): - verrors = ValidationErrors() - if should_work: - assert validate_variable_uniqueness(data, schema, verrors) is None - else: - with pytest.raises(ValidationErrors): - validate_variable_uniqueness(data, schema, verrors) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_items_util.py b/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_items_util.py deleted file mode 100644 index aab41eb59a9..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_items_util.py +++ /dev/null @@ -1,107 +0,0 @@ -import pytest - -from catalog_validation.items.items_util import get_item_details, get_item_details_impl - - -QUESTION_CONTEXT = { - 'nic_choices': [], - 'gpus': {}, - 'timezones': {'Asia/Saigon': 'Asia/Saigon', 'Asia/Damascus': 'Asia/Damascus'}, - 'node_ip': '192.168.0.10', - 'certificates': [], - 'certificate_authorities': [], - 'system.general.config': {'timezone': 'America/Los_Angeles'}, -} - - -@pytest.mark.parametrize('item_location,options,items_data', [ - ('/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/chia', - {'retrieve_versions': True}, - { - 'name': 'chia', - 'categories': [], - 'app_readme': None, - 'location': '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/chia', - 'healthy': True, - 'healthy_error': None, - 'home': None, - 'last_update': None, - 'versions': {}, - 'maintainers': [], - 'latest_version': None, - 'latest_app_version': None, - 'latest_human_version': None, - 'recommended': False, - 'title': 'Chia', - 'description': None, - 'tags': [], - 'screenshots': [], - 'sources': [], - } - ), -]) -def test_get_item_details(mocker, item_location, options, items_data): - mocker.patch('catalog_validation.items.items_util.validate_item', return_value=None) - mocker.patch('catalog_validation.items.items_util.get_item_details_impl', return_value={}) - assert get_item_details(item_location, QUESTION_CONTEXT, options) == items_data - - -@pytest.mark.parametrize('item_path,schema,options,yaml_data,item_data_impl,open_yaml', [ - ( - '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/chia', - 'charts.chia', - {'retrieve_latest_version': True}, { - 'variable': 'web_port', - 'label': 'Web Port for Diskover', - 'group': 'Networking', - 'schema': { - 'type': 'int', - 'min': 8000, - 'max': 65535, - 'default': 22510, - 'required': True - } - }, { - 'versions': { - '1.3.37': { - 'healthy': True, - 'supported': False, - 'healthy_error': None, - 'last_update': None, - 'location': '/mnt/mypool/ix-applications/catalogs/github_com_truenas_' - 'charts_git_master/charts/chia/1.3.37', - 'required_features': [], - 'human_version': '1.3.37', - 'version': '1.3.37' - } - }, - 'categories': ['storage', 'crypto'], - 'icon_url': 'https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg', - 'tags': ['finance'], - 'screenshots': ['https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg'], - 'sources': ['https://hub.docker.com/r/emby/embyserver'], - }, - ''' - screenshots: - - 'https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg' - tags: - - finance - categories: - - storage - - crypto - icon_url: https://www.chia.net/wp-content/uploads/2022/09/chia-logo.svg - sources: - - https://hub.docker.com/r/emby/embyserver - ''' - ), -]) -def test_get_item_details_impl( - mocker, item_path, schema, options, yaml_data, item_data_impl, open_yaml, -): - open_file_data = mocker.mock_open(read_data=open_yaml) - mocker.patch('builtins.open', open_file_data) - mocker.patch('os.path.isdir', return_value=True) - mocker.patch('os.listdir', return_value=['1.3.37']) - mocker.patch('catalog_validation.items.items_util.validate_item_version', return_value=None) - mocker.patch('catalog_validation.items.items_util.get_item_version_details', return_value={}) - assert get_item_details_impl(item_path, schema, QUESTION_CONTEXT, options) == item_data_impl diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_normalise_questions.py b/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_normalise_questions.py deleted file mode 100644 index 5372d6f63fa..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_normalise_questions.py +++ /dev/null @@ -1,321 +0,0 @@ -from catalog_validation.items.questions_utils import normalise_question -import pytest - - -VERSION_DATA = { - 'location': '/mnt/mypool/ix-applications/catalogs/github_com_truenas_charts_git_master/charts/syncthing/1.0.14', - 'required_features': { - 'normalize/ixVolume', - 'validations/lockedHostPath', - }, - 'chart_metadata': {}, - 'schema': { - 'variable': 'hostNetwork', - 'label': 'Host Network', - 'group': 'Networking', - }, - 'app_readme': 'there is not any', - 'detailed_readme': 'there is not any', - 'changelog': None, -} - - -@pytest.mark.parametrize('question,normalise_data,context', [ - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - 'enum': [], - } - }, { - 'nic_choices': [], - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/interface'], - 'enum': [{ - 'value': 'ens0', - 'description': "'ens0' Interface" - }], - } - }, { - 'nic_choices': ['ens0'] - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - 'attrs': [{ - 'variable': 'test@gpu', - 'label': 'GPU Resource (test@gpu)', - 'description': 'Please enter the number of GPUs to allocate', - 'schema': { - 'type': 'int', - 'max': 3, - 'enum': [ - {'value': i, 'description': f'Allocate {i!r} test@gpu GPU'} - for i in range(4) - ], - 'default': 0, - } - }], - } - }, { - 'gpus': { - 'test@gpu': 3 - } - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/gpuConfiguration'], - 'attrs': [], - } - }, { - 'gpus': {} - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/timezone'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/timezone'], - 'enum': [{ - 'value': 'Asia/Damascus', - 'description': "'Asia/Damascus' timezone", - }, { - 'value': 'Asia/Saigon', - 'description': "'Asia/Saigon' timezone", - }], - 'default': 'America/Los_Angeles', - } - }, - { - 'timezones': { - 'Asia/Saigon': 'Asia/Saigon', - 'Asia/Damascus': 'Asia/Damascus', - }, - 'system.general.config': { - 'timezone': 'America/Los_Angeles', - } - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/nodeIP'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/nodeIP'], - 'default': '192.168.0.10', - } - }, - { - 'node_ip': '192.168.0.10' - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate' - }, - { - 'value': '1', - 'description': "'testcert' Certificate" - } - ], - 'default': None, - 'null': True - } - }, {'certificates': [{ - 'id': '1', - 'name': 'testcert' - }], - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificate'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate' - }], - 'default': None, - 'null': True - } - }, { - 'certificates': [] - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate Authority' - }, { - 'value': None, - 'description': 'No Certificate Authority' - }], - 'default': None, - 'null': True - } - }, { - 'certificate_authorities': [] - } - ), - ( - { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - } - }, { - 'variable': 'datasetName', - 'label': 'Plots Volume Name', - 'schema': { - 'type': 'string', - 'hidden': True, - '$ref': ['definitions/certificateAuthority'], - 'enum': [{ - 'value': None, - 'description': 'No Certificate Authority' - }, { - 'value': None, - 'description': 'No Certificate Authority' - }, - { - 'value': '1', - 'description': "'testca' Certificate Authority" - } - ], - 'default': None, - 'null': True - } - }, { - 'certificate_authorities': [{ - 'id': '1', - 'name': 'testca' - }], - } - ) -]) -def test_normalise_question(question, normalise_data, context): - normalise_question(question, VERSION_DATA, context) - assert question == normalise_data diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_schema.py b/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_schema.py deleted file mode 100644 index a741a0fa086..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_schema.py +++ /dev/null @@ -1,577 +0,0 @@ -import pytest - -from catalog_validation.schema.schema_gen import get_schema -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.validation import validate_question - - -@pytest.mark.parametrize('schema,should_work', [ - ( - { - 'type': 'dict', - 'attrs': [] - }, - True - ), - ( - { - 'type': 'dict', - 'attrs': {} - }, - False - ), - ( - { - 'type': 'list' - }, - False - ), - ( - { - 'type': 'list', - 'items': [] - }, - True - ), - ( - { - 'type': 'list', - 'items': {} - }, - False - ), - ( - { - 'type': 'string', - 'editable': True - }, - True - ), - ( - { - 'type': 'string', - 'default': 'hello' - }, - True - ), - ( - { - 'type': 'string', - 'default': 1 - }, - False - ), - ( - { - 'type': 'string', - 'editable': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'private': True - }, - True - ), - ( - { - 'type': 'string', - 'private': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'max_length': 233 - }, - True - ), - ( - { - 'type': 'string', - 'max_length': '233' - }, - False - ), - ( - { - 'type': 'string', - 'min_length': 233 - }, - True - ), - ( - { - 'type': 'string', - 'min_length': '233' - }, - False - ), - ( - { - 'type': 'string', - 'valid_chars': '[a-z]*' - }, - True - ), - ( - { - 'type': 'string', - 'valid_chars': ['a-z'] - }, - False - ), - ( - { - 'type': 'string', 'null': True - }, - True - ), - ( - { - 'type': 'string', - 'null': 'true' - }, False - ), - ( - { - 'type': 'string', - 'immutable': True - }, - True - ), - ( - { - 'type': 'string', - 'immutable': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'required': True - }, - True - ), - ( - { - 'type': 'string', - 'required': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'hidden': True - }, - True - ), - ( - { - 'type': 'string', - 'hidden': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'show_if': 'true' - }, - False - ), - ( - { - 'type': 'string', - 'show_if': [['hello', '=', 'world']] - }, - True - ), - ( - { - 'type': 'string', - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'subquestions': {} - }, - False - ), - ( - { - 'type': 'string', - 'show_subquestions_if': None - }, False - ), - ( - { - 'type': 'string', - 'show_subquestions_if': None, - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': 1, - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': 'test', - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': {}, - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - 'show_subquestions_if': [], - 'subquestions': [] - }, - True - ), - ( - { - 'type': 'string', - '$ui-ref': [] - }, - True - ), - ( - { - 'type': 'string', - '$ui-ref': {} - }, - False - ), - ( - { - 'type': 'string', - '$ref': [] - }, - True - ), - ( - { - 'type': 'string', - '$ref': {} - }, - False - ), - ( - { - 'type': 'int', - 'min': 233, - 'max': 2311 - }, - True - ), - ( - { - 'type': 'int', - 'min': '233', - 'max': 2311 - }, - False - ), - ( - { - 'type': 'int', - 'min': 233, - 'max': '2311' - }, - False - ), - ( - { - 'type': 'int', - 'default': 23 - }, - True - ), - ( - { - 'type': 'int', - 'default': '23' - }, - False - ), - ( - { - 'type': 'ipaddr', - 'ipv4': True, - 'ipv6': False, - 'cidr': True - }, - True - ), - ( - { - 'type': 'ipaddr', - 'ipv4': True, - 'ipv6': False, - 'cidr': 'true' - }, - False - ), - ( - { - 'type': 'ipaddr', - 'ipv4': True, - 'ipv6': 'False', - 'cidr': True - }, - False - ), - ( - { - 'type': 'ipaddr', - 'ipv4': 'True', - 'ipv6': False, - 'cidr': True - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{ - 'value': 'test', - 'description': 'test' - }] - }, - True - ), - ( - { - 'type': 'string', - 'enum': [{ - 'value': 'test', - 'description': 'test', - 'obj': {} - }] - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{ - 'value': 'test' - }] - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{ - 'key': 'value' - }] - }, - False - ), - ( - { - 'type': 'string', - 'enum': [{}] - }, - False - ), - ( - { - 'type': 'hostpath' - }, - True - ), - ( - { - 'type': 'hostpath', - 'default': '/root/' - }, - True - ), - ( - { - 'type': 'hostpath', - 'default': 231 - }, - False - ), - ( - { - 'type': 'path' - }, - True - ), - ( - { - 'type': 'path', - 'default': '/root/' - }, - True - ), - ( - { - 'type': 'path', - 'default': 231 - }, - False - ), - ( - { - 'type': 'boolean' - }, - True - ), - ( - { - 'type': 'boolean', - 'default': True - }, - True - ), - ( - { - 'type': 'boolean', - 'default': 'true' - }, - False - ), - ( - { - 'type': 'cron' - }, - True - ), - ( - { - 'type': 'cron', - 'default': {} - }, - True - ), - ( - { - 'type': 'cron', - 'default': [] - }, - False - ), - ( - { - 'type': 'uri' - }, - True - ), - ( - { - 'type': 'uri', - 'default': 'http://www.google.com' - }, - True - ), - ( - { - 'type': 'uri', - 'default': 2133 - }, - False - ), -]) -def test_schema_validation(schema, should_work): - if not should_work: - with pytest.raises(ValidationErrors): - get_schema(schema).validate('') - else: - assert get_schema(schema).validate('') is None - - -@pytest.mark.parametrize('variable,should_work', [ - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing', - 'group': 'testing', - 'schema': { - 'type': 'boolean', - 'default': True - } - }, - True - ), - ( - { - 'variable': 'testing', - 'description': 'for testing', - 'group': 'testing', - 'schema': { - 'type': 'boolean', - 'default': True - } - }, - False - ), - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing' - }, - False - ), - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing', - 'schema': { - 'type': 'boolean', - 'default': True - } - }, - True - ), - ( - { - 'variable': 'testing', - 'label': 'Testing', - 'description': 'for testing', - 'schema': { - 'default': True - } - }, - False - ), -]) -def test_question_variable_validation(variable, should_work): - verrors = ValidationErrors() - validate_question(variable, '', verrors) - if not should_work: - with pytest.raises(ValidationErrors): - verrors.check() - else: - verrors.check() diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_validate_ix_values.py b/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_validate_ix_values.py deleted file mode 100644 index f634a92720c..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/pytest/unit/test_validate_ix_values.py +++ /dev/null @@ -1,94 +0,0 @@ -import pytest -from catalog_validation.validation import validate_ix_values_yaml -from catalog_validation.exceptions import ValidationErrors - - -@pytest.mark.parametrize('schema, ix_values_yaml_path, test_yaml, should_work', [ - - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 'http', useNodeIP: false, host: '192.168.0.18', port: 9898}] - ''', - True - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 'http', useNodeIP: true, port: 9898}] - ''', - True - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 'htts', useNodeIP: true, port: 9898}] - ''', - False - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', protocol: 09088, useNodeIP: true, port: '9898'}] - ''', - False - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - ''' - image: - pullPolicy: IfNotPresent - repository: ixsystems/chia-docker - tag: v1.6.2 - updateStrategy: Recreate - iXPortals: [{portalName: 'web portal', useNodeIP: true, port: '9898'}] - ''', - False - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - '', - False, - ), - ( - 'charts.chia.versions.1.3.38.ix_values', - '/mnt/crave/ix-applications/catalogs/github_com_truenas_charts_git_master/test/chia/1.3.38/ix_values.yaml', - 'image pullPolicy ifNotPresent', - False, - ) -]) -def test_validate_ix_values(mocker, schema, ix_values_yaml_path, test_yaml, should_work): - open_file = mocker.mock_open(read_data=test_yaml) - mocker.patch('builtins.open', open_file) - - if should_work: - assert validate_ix_values_yaml(ix_values_yaml_path, schema) is None - else: - with pytest.raises(ValidationErrors): - validate_ix_values_yaml(ix_values_yaml_path, schema) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/__init__.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/attrs.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/attrs.py deleted file mode 100644 index 6e65d6761eb..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/attrs.py +++ /dev/null @@ -1,262 +0,0 @@ -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from catalog_validation.exceptions import ValidationErrors - -from .feature_gen import get_feature -from .variable_gen import generate_variable - - -class Schema: - - DEFAULT_TYPE = NotImplementedError - - def __init__(self, include_subquestions_attrs=True, data=None): - self.required = self.null = self.show_if = self.ref = self.ui_ref = self.type =\ - self.editable = self.hidden = self.default = self._schema_data = None - self._skip_data_values = [] - if include_subquestions_attrs: - self.subquestions = self.show_subquestions_if = None - if data: - self.initialize_values(data) - - def initialize_values(self, data): - self._schema_data = data - for key, value in filter( - lambda k: hasattr(self, k[0]) and k[0] not in self._skip_data_values, data.items() - ): - setattr(self, key, value) - - def get_schema_str(self, schema): - if schema: - return f'{schema}.' - return '' - - def validate(self, schema, data=None): - if data: - self.initialize_values(data) - - if not self._schema_data: - raise Exception('Schema data must be initialized before validating schema') - - verrors = ValidationErrors() - try: - json_schema_validate(self._schema_data, self.json_schema()) - except JsonValidationError as e: - verrors.add(schema, f'Failed to validate schema: {e}') - - verrors.check() - - if '$ref' in self._schema_data: - for index, ref in enumerate(self._schema_data['$ref']): - if not isinstance(ref, str): - verrors.add(f'{schema}.$ref.{index}', 'Must be a string') - continue - - feature_obj = get_feature(ref) - if not feature_obj: - continue - try: - feature_obj.validate(self, f'{schema}.$ref.{index}') - except ValidationErrors as e: - verrors.extend(e) - - verrors.check() - - def json_schema(self): - schema = { - 'type': 'object', - 'properties': { - 'required': { - 'type': 'boolean', - }, - 'null': { - 'type': 'boolean', - }, - 'show_if': { - 'type': 'array', - }, - '$ref': { - 'type': 'array', - }, - '$ui-ref': { - 'type': 'array', - }, - 'subquestions': { - 'type': 'array', - }, - 'show_subquestions_if': { - 'type': ['string', 'integer', 'boolean', 'object', 'array', 'null'], - }, - 'type': { - 'type': 'string', - }, - 'editable': { - 'type': 'boolean', - }, - 'immutable': { - 'type': 'boolean', - }, - 'hidden': { - 'type': 'boolean', - }, - }, - 'required': ['type'], - 'dependentRequired': { - 'show_subquestions_if': ['subquestions'] - } - } - if self.DEFAULT_TYPE: - schema['properties']['default'] = { - 'type': [self.DEFAULT_TYPE] + (['null'] if self.null else []) - } - if hasattr(self, 'enum'): - schema['properties']['enum'] = { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'value': {'type': [self.DEFAULT_TYPE] + (['null'] if self.null else [])}, - 'description': {'type': ['string', 'null']}, - }, - 'additionalProperties': False, - 'required': ['value', 'description'] - }, - } - return schema - - -class BooleanSchema(Schema): - DEFAULT_TYPE = 'boolean' - - -class StringSchema(Schema): - DEFAULT_TYPE = 'string' - - def __init__(self, data): - self.min_length = self.max_length = self.enum = self.private = self.valid_chars = self.valid_chars_error = None - super().__init__(data=data) - - def json_schema(self): - schema = super().json_schema() - schema['properties'].update({ - 'min_length': { - 'type': 'integer', - }, - 'max_length': { - 'type': 'integer', - }, - 'private': { - 'type': 'boolean', - }, - 'valid_chars': { - 'type': 'string', - }, - 'valid_chars_error': { - 'type': 'string' - }, - }) - return schema - - -class IntegerSchema(Schema): - DEFAULT_TYPE = 'integer' - - def __init__(self, data): - self.min = self.max = self.enum = None - super().__init__(data=data) - - def json_schema(self): - schema = super().json_schema() - schema['properties'].update({ - 'min': { - 'type': 'integer', - }, - 'max': { - 'type': 'integer', - }, - }) - return schema - - -class PathSchema(Schema): - DEFAULT_TYPE = 'string' - - -class HostPathSchema(Schema): - DEFAULT_TYPE = 'string' - - -class HostPathDirSchema(Schema): - DEFAULT_TYPE = 'string' - - -class HostPathFileSchema(Schema): - DEFAULT_TYPE = 'string' - - -class URISchema(Schema): - DEFAULT_TYPE = 'string' - - -class IPAddrSchema(Schema): - DEFAULT_TYPE = 'string' - - def __init__(self, data): - self.ipv4 = self.ipv6 = self.cidr = None - super().__init__(data=data) - - def json_schema(self): - schema = super().json_schema() - schema['properties'].update({ - 'ipv4': {'type': 'boolean'}, - 'ipv6': {'type': 'boolean'}, - 'cidr': {'type': 'boolean'}, - }) - return schema - - -class CronSchema(Schema): - DEFAULT_TYPE = 'object' - - -class DictSchema(Schema): - DEFAULT_TYPE = 'object' - - def __init__(self, data): - self.attrs = [] - self.additional_attrs = None - super().__init__(data=data) - self._skip_data_values = ['attrs'] - - def initialize_values(self, data): - super().initialize_values(data) - self.attrs = [generate_variable(d) for d in (data.get('attrs') or [])] - - def json_schema(self): - schema = super().json_schema() - schema['additionalProperties'] = bool(self.additional_attrs) - schema['properties']['attrs'] = {'type': 'array'} - schema['required'].append('attrs') - # We do not validate nested children and hence do not add it in the - # json schema as it makes it very complex to handle all the possibilities - return schema - - -class ListSchema(Schema): - - DEFAULT_TYPE = 'array' - - def __init__(self, data): - self.items = [] - super().__init__(False, data=data) - self._skip_data_values = ['items'] - - def initialize_values(self, data): - super().initialize_values(data) - self.items = [generate_variable(d) for d in (data.get('items') or [])] - - def json_schema(self): - schema = super().json_schema() - schema['properties']['items'] = {'type': 'array'} - schema['required'].append('items') - return schema diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/feature_gen.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/feature_gen.py deleted file mode 100644 index 62dd657fd22..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/feature_gen.py +++ /dev/null @@ -1,4 +0,0 @@ -def get_feature(feature): - from .features import FEATURES - if feature in FEATURES: - return FEATURES[FEATURES.index(feature)] diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/features.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/features.py deleted file mode 100644 index c69c7b44c08..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/features.py +++ /dev/null @@ -1,158 +0,0 @@ -from catalog_validation.exceptions import ValidationErrors - -from .schema_gen import DictSchema, IntegerSchema, StringSchema - - -class Feature: - - NAME = NotImplementedError - VALID_SCHEMAS = [] - - def __str__(self): - return self.NAME - - def validate(self, schema_obj, schema_str): - verrors = ValidationErrors() - if not isinstance(schema_obj, tuple(self.VALID_SCHEMAS)): - verrors.add( - f'{schema_str}.type', - f'Schema must be one of {", ".join(str(v) for v in self.VALID_SCHEMAS)} schema types' - ) - - if not verrors: - self._validate(verrors, schema_obj, schema_str) - verrors.check() - - def _validate(self, verrors, schema_obj, schema_str): - pass - - def __eq__(self, other): - return self.NAME == (other if isinstance(other, str) else other.NAME) - - -class IXVolumeFeature(Feature): - - NAME = 'normalize/ixVolume' - VALID_SCHEMAS = [DictSchema, StringSchema] - - def _validate(self, verrors, schema_obj, schema_str): - if isinstance(schema_obj, StringSchema): - return - - attrs = schema_obj.attrs - if 'datasetName' not in attrs: - verrors.add(f'{schema_str}.attrs', 'Variable "datasetName" must be specified.') - elif not isinstance(attrs[attrs.index('datasetName')].schema, StringSchema): - verrors.add(f'{schema_str}.attrs', 'Variable "datasetName" must be of string type.') - - if 'aclEntries' in attrs and not isinstance(attrs[attrs.index('aclEntries')].schema, DictSchema): - verrors.add(f'{schema_str}.attrs', 'Variable "aclEntries" must be of dict type.') - - if 'properties' in attrs: - index = attrs.index('properties') - properties = attrs[index] - properties_schema = properties.schema - supported_props = { - 'recordsize': { - 'valid_schema_type': [StringSchema], - }, - } - not_supported = set([str(v) for v in properties_schema.attrs]) - set(supported_props) - if not_supported: - verrors.add( - f'{schema_str}.attrs.{index}.attrs', f'{", ".join(not_supported)} properties are not supported' - ) - - for prop_index, prop in enumerate(properties_schema.attrs): - if prop.name not in supported_props: - continue - - prop_schema = prop.schema - check_prop = supported_props[prop.name] - if not isinstance(prop_schema, tuple(check_prop['valid_schema_type'])): - verrors.add( - f'{schema_str}.attrs.{index}.attrs.{prop_index}', - f'{prop.name!r} must be of ' - f'{", ".join([str(s) for s in check_prop["valid_schema_type"]])} type(s)' - ) - - -class NormalizeInterfaceConfiguration(Feature): - NAME = 'normalize/interfaceConfiguration' - VALID_SCHEMAS = [DictSchema] - - -class DefinitionInterfaceFeature(Feature): - - NAME = 'definitions/interface' - VALID_SCHEMAS = [StringSchema] - - -class DefinitionGPUConfigurationFeature(Feature): - - NAME = 'definitions/gpuConfiguration' - VALID_SCHEMAS = [DictSchema] - - -class DefinitionTimezoneFeature(Feature): - - NAME = 'definitions/timezone' - VALID_SCHEMAS = [StringSchema] - - -class DefinitionNodeIPFeature(Feature): - - NAME = 'definitions/nodeIP' - VALID_SCHEMAS = [StringSchema] - - -class ValidationNodePortFeature(Feature): - - NAME = 'validations/nodePort' - VALID_SCHEMAS = [IntegerSchema] - - -class CertificateFeature(Feature): - - NAME = 'definitions/certificate' - VALID_SCHEMAS = [IntegerSchema] - - -class CertificateAuthorityFeature(Feature): - - NAME = 'definitions/certificateAuthority' - VALID_SCHEMAS = [IntegerSchema] - - -class ContainerImageFeature(Feature): - - NAME = 'validations/containerImage' - VALID_SCHEMAS = [DictSchema] - - def _validate(self, verrors, schema_obj, schema_str): - attrs = schema_obj.attrs - for check_attr in ('repository', 'tag'): - if check_attr not in attrs: - verrors.add(f'{schema_str}.attrs', f'Variable {check_attr!r} must be specified.') - elif not isinstance(attrs[attrs.index(check_attr)].schema, StringSchema): - verrors.add(f'{schema_str}.attrs', f'Variable {check_attr!r} must be of string type.') - - -class ACLFeature(Feature): - - NAME = 'normalize/acl' - VALID_SCHEMAS = [DictSchema] - - -FEATURES = [ - ACLFeature(), - IXVolumeFeature(), - DefinitionInterfaceFeature(), - DefinitionGPUConfigurationFeature(), - DefinitionTimezoneFeature(), - DefinitionNodeIPFeature(), - ValidationNodePortFeature(), - CertificateFeature(), - CertificateAuthorityFeature(), - ContainerImageFeature(), -] diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/migration_schema.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/migration_schema.py deleted file mode 100644 index 9b535d9a263..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/migration_schema.py +++ /dev/null @@ -1,42 +0,0 @@ -import re - - -APP_MIGRATION_DIR = 'migrations' -APP_MIGRATION_SCHEMA = { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'app_name': {'type': 'string'}, - 'action': {'type': 'string', 'enum': ['move']}, - }, - 'required': [ - 'app_name', - 'action' - ], - 'allOf': [ - { - 'if': { - 'properties': { - 'action': { - 'const': 'move', - }, - }, - }, - 'then': { - 'properties': { - 'old_train': {'type': 'string'}, - 'new_train': {'type': 'string'}, - }, - 'required': [ - 'new_train', - 'old_train', - ], - }, - }, - ], - }, -} -MIGRATION_DIRS = ['.migrations', 'ix-migrations'] -RE_MIGRATION_NAME_STR = r'^\d+\w+.json' -RE_MIGRATION_NAME = re.compile(RE_MIGRATION_NAME_STR) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/schema_gen.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/schema_gen.py deleted file mode 100644 index 2504257361f..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/schema_gen.py +++ /dev/null @@ -1,41 +0,0 @@ -from .attrs import ( - BooleanSchema, StringSchema, IntegerSchema, PathSchema, HostPathSchema, HostPathDirSchema, - HostPathFileSchema, ListSchema, DictSchema, IPAddrSchema, CronSchema, URISchema -) - - -def get_schema(schema_data): - schema = None - if not isinstance(schema_data, dict): - return schema - - s_type = schema_data.get('type') - if s_type == 'boolean': - schema = BooleanSchema - elif s_type == 'string': - schema = StringSchema - elif s_type == 'int': - schema = IntegerSchema - elif s_type == 'path': - schema = PathSchema - elif s_type == 'hostpath': - schema = HostPathSchema - elif s_type == 'hostpathdirectory': - schema = HostPathDirSchema - elif s_type == 'hostpathfile': - schema = HostPathFileSchema - elif s_type == 'list': - schema = ListSchema - elif s_type == 'dict': - schema = DictSchema - elif s_type == 'ipaddr': - schema = IPAddrSchema - elif s_type == 'cron': - schema = CronSchema - elif s_type == 'uri': - schema = URISchema - - if schema: - schema = schema(data=schema_data) - - return schema diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/variable.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/variable.py deleted file mode 100644 index e11d522af57..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/variable.py +++ /dev/null @@ -1,37 +0,0 @@ -from catalog_validation.exceptions import ValidationErrors - -from .schema_gen import get_schema - - -class Variable: - def __init__(self, data): - self.name = self.label = self.description = self.group = None - self.schema = None - self.update_from_data(data) - - def update_from_data(self, data): - self.name = data.get('variable') - self.label = data.get('label') - self.description = data.get('description') - self.schema = get_schema(data.get('schema')) - - def validate(self, schema): - verrors = ValidationErrors() - if not self.name: - verrors.add(f'{schema}.variable', 'Variable value must be specified') - - if not self.schema: - verrors.add(f'{schema}.schema', 'Schema must be specified for variable') - else: - try: - self.schema.validate(f'{schema}.schema') - except ValidationErrors as ve: - verrors.extend(ve) - - verrors.check() - - def __str__(self): - return self.name - - def __eq__(self, other): - return (other if isinstance(other, str) else other.name) == self.name diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/variable_gen.py b/archive/catalog_validation/truecharts-fork/catalog_validation/schema/variable_gen.py deleted file mode 100644 index 8784e4f9754..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/schema/variable_gen.py +++ /dev/null @@ -1,3 +0,0 @@ -def generate_variable(variable_data): - from .variable import Variable - return Variable(variable_data) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/__init__.py b/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/__init__.py deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/catalog_update.py b/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/catalog_update.py deleted file mode 100644 index 0d52a8b6c8e..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/catalog_update.py +++ /dev/null @@ -1,171 +0,0 @@ -#!/usr/bin/env python -import argparse -import contextlib -import json -import os -import shutil -import typing - -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError - -from catalog_validation.ci.utils import ( - get_app_version, get_ci_development_directory, OPTIONAL_METADATA_FILES, - REQUIRED_METADATA_FILES, version_has_been_bumped, get_to_keep_versions -) -from catalog_validation.exceptions import ValidationErrors -from catalog_validation.items.catalog import get_items_in_trains, retrieve_train_names, retrieve_trains_data -from catalog_validation.items.utils import get_catalog_json_schema -from catalog_validation.utils import CACHED_CATALOG_FILE_NAME, CACHED_VERSION_FILE_NAME -from catalog_validation.validation import validate_catalog_item_version_data -from collections import defaultdict - - -def get_trains(location: str) -> typing.Tuple[dict, dict]: - preferred_trains: list = [] - trains_to_traverse = retrieve_train_names(location) - catalog_data = {} - versions_data = {} - for train_name, train_data in retrieve_trains_data( - get_items_in_trains(trains_to_traverse, location), location, preferred_trains, trains_to_traverse - )[0].items(): - catalog_data[train_name] = {} - versions_data[train_name] = {} - for app_name, app_data in train_data.items(): - catalog_data[train_name][app_name] = {} - versions_data[train_name][app_name] = {} - for k, v in app_data.items(): - if k == 'versions': - versions_data[train_name][app_name][k] = v - else: - catalog_data[train_name][app_name][k] = v - - return catalog_data, versions_data - - -def validate_train_data(train_data): - verrors = ValidationErrors() - try: - json_schema_validate(train_data, get_catalog_json_schema()) - except (json.JSONDecodeError, JsonValidationError) as e: - verrors.add( - 'catalog_json', - f'Failed to validate contents of train data: {e!r}' - ) - verrors.check() - - -def validate_versions_data(versions_data): - verrors = ValidationErrors() - for train_name, train_data in versions_data.items(): - for app_name, app_version_data in train_data.items(): - validate_catalog_item_version_data(app_version_data['versions'], f'{train_name}.{app_name}', verrors) - verrors.check() - - -def get_apps_to_publish(catalog_path: str) -> dict: - ci_dev_dir = get_ci_development_directory(catalog_path) - to_publish_apps = defaultdict(list) - for train_name in os.listdir(ci_dev_dir): - train_path = os.path.join(ci_dev_dir, train_name) - if not os.path.isdir(train_path): - continue - - for app_name in os.listdir(train_path): - app_path = os.path.join(train_path, app_name) - if not os.path.isdir(app_path): - continue - - app_current_version = get_app_version(app_path) - if version_has_been_bumped(os.path.join(catalog_path, train_name, app_name), app_current_version): - to_publish_apps[train_name].append({'name': app_name, 'version': app_current_version}) - - return to_publish_apps - - -def publish_updated_apps(catalog_path: str) -> None: - ci_dev_directory = get_ci_development_directory(catalog_path) - if not os.path.isdir(ci_dev_directory): - return - - for train_name, apps in get_apps_to_publish(catalog_path).items(): - dev_train_path = os.path.join(ci_dev_directory, train_name) - publish_train_path = os.path.join(catalog_path, train_name) - os.makedirs(publish_train_path, exist_ok=True) - - for app in apps: - app_name, app_version = app['name'], app['version'] - dev_app_path = os.path.join(dev_train_path, app_name) - publish_app_path = os.path.join(publish_train_path, app_name) - publish_app_version_path = os.path.join(publish_app_path, app_version) - required_versions = get_to_keep_versions(dev_app_path) - os.makedirs(publish_app_path, exist_ok=True) - - dev_item_yaml_path = os.path.join(dev_app_path, 'item.yaml') - publish_item_yaml_path = os.path.join(publish_app_path, 'item.yaml') - shutil.copy(dev_item_yaml_path, publish_item_yaml_path) - shutil.copytree(dev_app_path, publish_app_version_path) - - for file_name in OPTIONAL_METADATA_FILES + REQUIRED_METADATA_FILES: - with contextlib.suppress(OSError): - os.unlink(os.path.join(publish_app_version_path, file_name)) - - ix_values_path = os.path.join(publish_app_version_path, 'ix_values.yaml') - values_path = os.path.join(publish_app_version_path, 'values.yaml') - if not os.path.exists(ix_values_path) and os.path.exists(values_path): - shutil.move(values_path, ix_values_path) - - for version in os.listdir(publish_app_path): - version_path = os.path.join(publish_app_path, version) - if not os.path.isdir(version_path) or version in required_versions: - continue - - if version != app_version: - shutil.rmtree(version_path) - - print( - f'[\033[92mOK\x1B[0m]\tPublished {app_name!r} having {app_version!r} version ' - f'to {train_name!r} train successfully!' - ) - - -def update_catalog_file(location: str) -> None: - catalog_file_path = os.path.join(location, CACHED_CATALOG_FILE_NAME) - catalog_data, versions_data = get_trains(location) - validate_train_data(catalog_data) - validate_versions_data(versions_data) - - with open(catalog_file_path, 'w') as f: - f.write(json.dumps(catalog_data, indent=4)) - - print(f'[\033[92mOK\x1B[0m]\tUpdated {catalog_file_path!r} successfully!') - - for train_name, train_data in versions_data.items(): - for app_name, app_data in train_data.items(): - version_path = os.path.join(location, train_name, app_name, CACHED_VERSION_FILE_NAME) - with open(version_path, 'w') as f: - f.write(json.dumps(app_data['versions'], indent=4)) - - print(f'[\033[92mOK\x1B[0m]\tUpdated {version_path!r} successfully!') - - -def main(): - parser = argparse.ArgumentParser() - subparsers = parser.add_subparsers(help='sub-command help', dest='action') - - publish_setup = subparsers.add_parser('publish', help='Publish apps of TrueNAS catalog') - publish_setup.add_argument('--path', help='Specify path of TrueNAS catalog') - - parser_setup = subparsers.add_parser('update', help='Update TrueNAS catalog') - parser_setup.add_argument('--path', help='Specify path of TrueNAS catalog') - - args = parser.parse_args() - if args.action == 'publish': - publish_updated_apps(args.path) - elif args.action == 'update': - update_catalog_file(args.path) - else: - parser.print_help() - - -if __name__ == '__main__': - main() diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/catalog_validate.py b/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/catalog_validate.py deleted file mode 100644 index 1094bdf1361..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/catalog_validate.py +++ /dev/null @@ -1,40 +0,0 @@ -#!/usr/bin/env python -import argparse - -from catalog_validation.exceptions import CatalogDoesNotExist, ValidationErrors -from catalog_validation.validation import validate_catalog - - -def validate(catalog_path, ignore_catalog_json=False): - - try: - validate_catalog(catalog_path, ignore_catalog_json) - except CatalogDoesNotExist: - print(f'[\033[91mFAILED\x1B[0m]\tSpecified {catalog_path!r} path does not exist') - exit(1) - except ValidationErrors as verrors: - print('[\033[91mFAILED\x1B[0m]\tFollowing validation failures were found:') - for index, verror in enumerate(verrors.errors): - print(f'[\033[91m{index}\x1B[0m]\t{verror}') - exit(1) - else: - print('[\033[92mOK\x1B[0m]\tPASSED VALIDATION CHECKS') - - -def main(): - parser = argparse.ArgumentParser() - subparsers = parser.add_subparsers(help='sub-command help', dest='action') - - parser_setup = subparsers.add_parser('validate', help='Validate TrueNAS catalog') - parser_setup.add_argument('--path', help='Specify path of TrueNAS catalog') - parser_setup.add_argument('--ignore-catalog-json', help='Will not validate the catalog.json file', action=argparse.BooleanOptionalAction) - - args = parser.parse_args() - if args.action == 'validate': - validate(args.path, args.ignore_catalog_json) - else: - parser.print_help() - - -if __name__ == '__main__': - main() diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/dev_apps_validate.py b/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/dev_apps_validate.py deleted file mode 100644 index 1ce514beaed..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/scripts/dev_apps_validate.py +++ /dev/null @@ -1,28 +0,0 @@ -#!/usr/bin/env python -import argparse - -from catalog_validation.ci.validate import validate_dev_directory_structure -from catalog_validation.git_utils import get_changed_apps - - -def main(): - parser = argparse.ArgumentParser() - subparsers = parser.add_subparsers(help='sub-command help', dest='action') - - parser_setup = subparsers.add_parser( - 'validate', help='Validate TrueNAS dev catalog items' - ) - parser_setup.add_argument('--path', help='Specify path of TrueNAS dev catalog', required=True) - parser_setup.add_argument( - '--base_branch', help='Specify base branch to find changed catalog items', default='master' - ) - - args = parser.parse_args() - if args.action == 'validate': - validate_dev_directory_structure(args.path, get_changed_apps(args.path, args.base_branch)) - else: - parser.print_help() - - -if __name__ == '__main__': - main() diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/utils.py deleted file mode 100644 index 3a99c38cc3b..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/utils.py +++ /dev/null @@ -1,223 +0,0 @@ -import re - - -CACHED_CATALOG_FILE_NAME = 'catalog.json' -CACHED_VERSION_FILE_NAME = 'app_versions.json' -METADATA_JSON_SCHEMA = { - 'type': 'object', - 'properties': { - 'runAsContext': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'description': {'type': 'string'}, - 'gid': {'type': 'integer'}, - 'groupName': {'type': 'string'}, - 'userName': {'type': 'string'}, - 'uid': {'type': 'integer'}, - }, - 'required': ['description'], - }, - }, - 'capabilities': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'description': {'type': 'string'}, - 'name': {'type': 'string'}, - }, - 'required': ['description', 'name'], - }, - }, - 'hostMounts': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'description': {'type': 'string'}, - 'hostPath': {'type': 'string'}, - }, - 'required': ['description', 'hostPath'], - }, - }, - }, -} -VALID_TRAIN_REGEX = re.compile(r'^\w+[\w.-]*$') -VERSION_VALIDATION_SCHEMA = { - 'type': 'object', - 'title': 'Versions', - 'patternProperties': { - '[0-9]+.[0-9]+.[0-9]+': { - 'type': 'object', - 'properties': { - 'healthy': { - 'type': 'boolean', - }, - 'supported': { - 'type': 'boolean', - }, - 'healthy_error': { - 'type': ['string', 'null'] - }, - 'location': { - 'type': 'string', - 'pattern': r'^(\/[a-zA-Z0-9_.-]+)+$' - }, - 'last_update': { - 'type': 'string', - 'pattern': '^[0-9]{4}-[0-9]{2}-[0-9]{2} [0-9]{2}:[0-9]{2}:[0-9]{2}$' - }, - 'required_features': { - 'type': 'array', - 'items': { - 'type': 'string' - } - }, - 'human_version': { - 'type': 'string' - }, - 'version': { - 'type': 'string', - 'pattern': '[0-9]+.[0-9]+.[0-9]+' - }, - 'chart_metadata': { - 'type': 'object', - 'properties': { - 'name': { - 'type': 'string' - }, - 'description': { - 'type': 'string' - }, - 'annotations': { - 'type': 'object' - }, - 'type': { - 'type': 'string' - }, - 'version': { - 'type': 'string', - 'pattern': '[0-9]+.[0-9]+.[0-9]+' - }, - 'apiVersion': { - 'type': 'string', - }, - 'appVersion': { - 'type': 'string' - }, - 'kubeVersion': { - 'type': 'string' - }, - 'app_readme': {'type': 'string'}, - 'detailed_readme': {'type': 'string'}, - 'changelog': {'type': ['string', 'null']}, - 'maintainers': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': {'type': 'string'}, - 'url': {'type': ['string', 'null']}, - 'email': {'type': 'string'}, - }, - 'required': ['name', 'email'], - } - }, - 'dependencies': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': {'type': 'string'}, - 'repository': {'type': 'string'}, - 'version': {'type': 'string'} - } - } - }, - 'home': {'type': 'string'}, - 'icon': {'type': 'string'}, - 'sources': { - 'type': 'array', - 'items': { - 'type': 'string' - } - }, - 'keywords': { - 'type': 'array', - 'items': { - 'type': 'string' - } - }, - } - }, - 'app_metadata': { - **METADATA_JSON_SCHEMA, - 'type': ['object', 'null'], - }, - 'schema': { - 'type': 'object', - 'properties': { - 'groups': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'name': { - 'type': 'string' - }, - 'description': { - 'type': 'string' - }, - }, - 'required': ['description', 'name'], - } - }, - 'portals': { - 'type': 'object' - }, - 'questions': { - 'type': 'array', - 'items': { - 'type': 'object', - 'properties': { - 'variable': {'type': 'string'}, - 'label': {'type': 'string'}, - 'group': {'type': 'string'}, - 'schema': { - 'type': 'object', - 'properties': { - 'type': {'type': 'string'} - }, - 'required': ['type'] - } - } - } - } - }, - 'required': ['groups', 'questions'] - }, - }, - 'required': [ - 'healthy', 'supported', 'healthy_error', 'location', 'last_update', 'required_features', - 'human_version', 'version', 'chart_metadata', 'app_metadata', 'schema', - ], - }, - }, - 'additionalProperties': False -} -WANTED_FILES_IN_ITEM_VERSION = {'questions.yaml', 'app-readme.md', 'Chart.yaml', 'README.md'} - - -def validate_key_value_types(data_to_check, mapping, verrors, schema): - for key_mapping in mapping: - if len(key_mapping) == 2: - key, value_type, required = *key_mapping, True - else: - key, value_type, required = key_mapping - - if required and key not in data_to_check: - verrors.add(f'{schema}.{key}', f'Missing required {key!r} key.') - elif key in data_to_check and not isinstance(data_to_check[key], value_type): - verrors.add(f'{schema}.{key}', f'{key!r} value should be a {value_type.__name__!r}') diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/validation.py b/archive/catalog_validation/truecharts-fork/catalog_validation/validation.py deleted file mode 100644 index cd3cfdcfcfc..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/validation.py +++ /dev/null @@ -1,459 +0,0 @@ -import concurrent.futures -import json -import jsonschema -import os -import yaml - -from jsonschema import validate as json_schema_validate, ValidationError as JsonValidationError -from semantic_version import Version -from typing import Optional - -from .exceptions import CatalogDoesNotExist, ValidationErrors -from .items.ix_values_utils import validate_ix_values_schema -from .items.questions_utils import ( - CUSTOM_PORTALS_KEY, CUSTOM_PORTALS_ENABLE_KEY, CUSTOM_PORTAL_GROUP_KEY, -) -from .items.utils import get_catalog_json_schema, RECOMMENDED_APPS_FILENAME, RECOMMENDED_APPS_SCHEMA, TRAIN_IGNORE_DIRS -from .schema.migration_schema import ( - APP_MIGRATION_SCHEMA, MIGRATION_DIRS, RE_MIGRATION_NAME, RE_MIGRATION_NAME_STR, APP_MIGRATION_DIR, -) -from .schema.variable import Variable -from .validation_utils import validate_chart_version -from .utils import ( - CACHED_CATALOG_FILE_NAME, CACHED_VERSION_FILE_NAME, METADATA_JSON_SCHEMA, validate_key_value_types, - VALID_TRAIN_REGEX, VERSION_VALIDATION_SCHEMA, WANTED_FILES_IN_ITEM_VERSION -) - - -def validate_catalog(catalog_path, ignore_catalog_json=False): - if not os.path.exists(catalog_path): - raise CatalogDoesNotExist(catalog_path) - - verrors = ValidationErrors() - items = [] - item_futures = [] - - if not ignore_catalog_json: - cached_catalog_file_path = os.path.join(catalog_path, CACHED_CATALOG_FILE_NAME) - if not os.path.exists(cached_catalog_file_path): - verrors.add( - 'cached_catalog_file', - f'{CACHED_CATALOG_FILE_NAME!r} metadata file must be specified for a valid catalog' - ) - else: - try: - with open(cached_catalog_file_path, 'r') as f: - json_schema_validate(json.loads(f.read()), get_catalog_json_schema()) - - except (json.JSONDecodeError, JsonValidationError) as e: - verrors.add( - 'cached_catalog_file', - f'Failed to validate contents of {cached_catalog_file_path!r}: {e!r}' - ) - - verrors.check() - - validate_recommended_apps_file(catalog_path) - - for file_dir in os.listdir(catalog_path): - complete_path = os.path.join(catalog_path, file_dir) - if file_dir not in MIGRATION_DIRS and ( - file_dir.startswith('.') or not os.path.isdir(complete_path) or file_dir in TRAIN_IGNORE_DIRS - ): - continue - if file_dir in MIGRATION_DIRS: - if all(os.path.exists(migration_dir) for migration_dir in map( - lambda d: os.path.join(catalog_path, d), MIGRATION_DIRS - )): - verrors.add( - 'app_migrations', f'Both {", ".join(MIGRATION_DIRS)!r} cannot be used to specify app migrations' - ) - else: - for directory in MIGRATION_DIRS: - migration_dir = os.path.join(catalog_path, directory) - if not os.path.exists(migration_dir): - continue - if os.path.isdir(migration_dir): - try: - validate_migrations(migration_dir) - except ValidationErrors as e: - verrors.extend(e) - else: - verrors.add('app_migrations', f'{directory!r} is not a directory') - else: - try: - validate_train_structure(complete_path) - except ValidationErrors as e: - verrors.extend(e) - else: - items.extend(get_train_items(complete_path)) - - with concurrent.futures.ProcessPoolExecutor(max_workers=20 if len(items) > 10 else 5) as exc: - for item in items: - item_futures.append(exc.submit(validate_catalog_item, item[0], item[1])) - - for future in item_futures: - try: - future.result() - except ValidationErrors as e: - verrors.extend(e) - - verrors.check() - - -def validate_recommended_apps_file(catalog_location: str) -> None: - verrors = ValidationErrors() - try: - with open(os.path.join(catalog_location, RECOMMENDED_APPS_FILENAME), 'r') as f: - data = yaml.safe_load(f.read()) - json_schema_validate(data, RECOMMENDED_APPS_SCHEMA) - except FileNotFoundError: - return - except yaml.YAMLError: - verrors.add(RECOMMENDED_APPS_FILENAME, 'Must be a valid yaml file') - except JsonValidationError as e: - verrors.add(RECOMMENDED_APPS_FILENAME, f'Invalid format specified: {e}') - - verrors.check() - - -def validate_migrations(migration_dir): - verrors = ValidationErrors() - for migration_file in os.listdir(migration_dir): - if not RE_MIGRATION_NAME.findall(migration_file): - verrors.add( - f'app_migrations.{migration_file}', - 'Invalid naming scheme used for migration file name. ' - f'It should be conforming to {RE_MIGRATION_NAME_STR!r} pattern.' - ) - else: - try: - with open(os.path.join(migration_dir, migration_file), 'r') as f: - data = json.loads(f.read()) - jsonschema.validate(data, APP_MIGRATION_SCHEMA) - except (json.JSONDecodeError, jsonschema.ValidationError) as e: - verrors.add( - f'app_migrations.{migration_file}', - f'Failed to validate migration file structure: {e}' - ) - verrors.check() - - -def validate_train_structure(train_path): - train = os.path.basename(train_path) - verrors = ValidationErrors() - if not VALID_TRAIN_REGEX.match(train): - verrors.add(train, 'Train name is invalid.') - print(f' procssing train: {train} ') - verrors.check() - - -def get_train_items(train_path): - train = os.path.basename(train_path) - items = [] - for catalog_item in os.listdir(train_path): - item_path = os.path.join(train_path, catalog_item) - if not os.path.isdir(item_path): - continue - items.append((item_path, f'{train}.{catalog_item}')) - return items - - -def validate_catalog_item(catalog_item_path, schema, validate_versions=True): - # We should ensure that each catalog item has at least 1 version available - # Also that we have item.yaml present - verrors = ValidationErrors() - item_name = os.path.join(catalog_item_path) - files = [] - versions = [] - print(f' procssing catalog item: {item_name} ') - if not os.path.isdir(catalog_item_path): - verrors.add(schema, 'Catalog item must be a directory') - verrors.check() - - for file_dir in os.listdir(catalog_item_path): - complete_path = os.path.join(catalog_item_path, file_dir) - if os.path.isdir(complete_path): - versions.append(complete_path) - else: - files.append(file_dir) - - if not versions: - verrors.add(f'{schema}.versions', f'No versions found for {item_name} item.') - - if 'item.yaml' not in files: - verrors.add(f'{schema}.item', 'Item configuration (item.yaml) not found') - else: - with open(os.path.join(catalog_item_path, 'item.yaml'), 'r') as f: - item_config = yaml.safe_load(f.read()) - - validate_key_value_types( - item_config, ( - ('categories', list), ('tags', list, False), ('screenshots', list, False), - ), verrors, f'{schema}.item_config' - ) - - cached_version_file_path = os.path.join(catalog_item_path, CACHED_VERSION_FILE_NAME) - if os.path.exists(cached_version_file_path): - try: - with open(cached_version_file_path, 'r') as f: - validate_catalog_item_version_data( - json.loads(f.read()), f'{schema}.{CACHED_VERSION_FILE_NAME}', verrors - ) - except json.JSONDecodeError: - verrors.add( - f'{schema}.{CACHED_VERSION_FILE_NAME}', f'{CACHED_VERSION_FILE_NAME!r} is not a valid json file' - ) - - for version_path in (versions if validate_versions else []): - try: - validate_catalog_item_version(version_path, f'{schema}.versions.{os.path.basename(version_path)}') - except ValidationErrors as e: - verrors.extend(e) - - verrors.check() - - -def validate_app_migrations(version_path, schema): - verrors = ValidationErrors() - app_migration_path = os.path.join(version_path, APP_MIGRATION_DIR) - - if not os.path.exists(app_migration_path): - return verrors - - for migration_file in os.listdir(app_migration_path): - migration_file_path = os.path.join(app_migration_path, migration_file) - if not os.access(migration_file_path, os.X_OK): - verrors.add(schema, f'{migration_file!r} is not executable') - return verrors - - -def validate_catalog_item_version_data(version_data: dict, schema: str, verrors: ValidationErrors) -> ValidationErrors: - try: - json_schema_validate(version_data, VERSION_VALIDATION_SCHEMA) - except JsonValidationError as e: - verrors.add(schema, f'Invalid format specified for application versions: {e}') - return verrors - - -def validate_catalog_item_version( - version_path: str, schema: str, version_name: Optional[str] = None, item_name: Optional[str] = None, - validate_values: bool = False, -): - verrors = ValidationErrors() - version_name = version_name or os.path.basename(version_path) - item_name = item_name or version_path.split('/')[-2] - try: - Version(version_name) - except ValueError: - verrors.add(f'{schema}.name', f'{version_name!r} is not a valid version name.') - print(f' procssing catalog item version: {version_name} ') - - files_diff = WANTED_FILES_IN_ITEM_VERSION ^ set( - f for f in os.listdir(version_path) if f in WANTED_FILES_IN_ITEM_VERSION - ) - if files_diff: - verrors.add(f'{schema}.required_files', f'Missing {", ".join(files_diff)} required configuration files.') - - chart_version_path = os.path.join(version_path, 'Chart.yaml') - validate_chart_version(verrors, chart_version_path, schema, item_name, version_name) - - questions_path = os.path.join(version_path, 'questions.yaml') - if os.path.exists(questions_path): - try: - validate_questions_yaml(questions_path, f'{schema}.questions_configuration') - except ValidationErrors as v: - verrors.extend(v) - - for values_file in ['ix_values.yaml'] + (['values.yaml'] if validate_values else []): - values_path = os.path.join(version_path, values_file) - if os.path.exists(values_path): - try: - validate_ix_values_yaml(values_path, f'{schema}.values_configuration') - except ValidationErrors as v: - verrors.extend(v) - - metadata_path = os.path.join(version_path, 'metadata.yaml') - if os.path.exists(metadata_path): - try: - validate_metadata_yaml(metadata_path, f'{schema}.metadata_configuration') - except ValidationErrors as v: - verrors.extend(v) - - validate_app_migrations(version_path, f'{schema}.app_migrations') - - verrors.check() - - -def validate_ix_values_yaml(ix_values_yaml_path, schema): - verrors = ValidationErrors() - - with open(ix_values_yaml_path, 'r') as f: - try: - ix_values = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - - verrors.check() - - if isinstance(ix_values, dict): - portals = ix_values.get(CUSTOM_PORTALS_KEY) - if portals: - try: - validate_ix_values_schema(schema, portals) - except ValidationErrors as ve: - verrors.extend(ve) - else: - verrors.add(schema, 'Must be a dictionary') - - verrors.check() - - -def validate_metadata_yaml(metadata_yaml_path, schema): - verrors = ValidationErrors() - with open(metadata_yaml_path, 'r') as f: - try: - metadata = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - else: - try: - json_schema_validate(metadata, METADATA_JSON_SCHEMA) - except JsonValidationError as e: - verrors.add(schema, f'Invalid format specified for application metadata: {e}') - - verrors.check() - - -def validate_questions_yaml(questions_yaml_path, schema): - verrors = ValidationErrors() - - with open(questions_yaml_path, 'r') as f: - try: - questions_config = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - else: - if not isinstance(questions_config, dict): - verrors.add(schema, 'Must be a dictionary') - - verrors.check() - - validate_key_value_types( - questions_config, ( - ('groups', list), ('questions', list), ('portals', dict, False), (CUSTOM_PORTALS_ENABLE_KEY, bool, False), - (CUSTOM_PORTAL_GROUP_KEY, str, False), - ), verrors, schema - ) - - verrors.check() - - groups = [] - for index, group in enumerate(questions_config['groups']): - if not isinstance(group, dict): - verrors.add(f'{schema}.groups.{index}', 'Type of group should be a dictionary.') - continue - - if group.get('name'): - groups.append(group['name']) - - validate_key_value_types(group, (('name', str), ('description', str)), verrors, f'{schema}.group.{index}') - - for index, portal_details in enumerate((questions_config.get('portals') or {}).items()): - portal_type, portal_schema = portal_details - error_schema = f'{schema}.portals.{index}' - if not isinstance(portal_type, str): - verrors.add(error_schema, 'Portal type must be a string') - if not isinstance(portal_schema, dict): - verrors.add(error_schema, 'Portal schema must be a dictionary') - else: - validate_key_value_types( - portal_schema, (('protocols', list), ('host', list), ('ports', list), ('path', str, False)), - verrors, error_schema - ) - - validate_variable_uniqueness(questions_config['questions'], f'{schema}.questions', verrors) - for index, question in enumerate(questions_config['questions']): - validate_question(question, f'{schema}.questions.{index}', verrors, (('group', str),)) - if question.get('group') and question['group'] not in groups: - verrors.add(f'{schema}.questions.{index}.group', f'Please specify a group declared in "{schema}.groups"') - - if questions_config.get(CUSTOM_PORTALS_ENABLE_KEY): - if not questions_config.get(CUSTOM_PORTAL_GROUP_KEY): - verrors.add( - f'{schema}.{CUSTOM_PORTALS_ENABLE_KEY}', - f'{CUSTOM_PORTAL_GROUP_KEY!r} must be specified when user specified portals are desired' - ) - elif questions_config[CUSTOM_PORTAL_GROUP_KEY] not in groups: - verrors.add( - f'{schema}.{CUSTOM_PORTAL_GROUP_KEY}', - 'Specified group not declared under "groups"' - ) - - verrors.check() - - -def validate_variable_uniqueness(data, schema, verrors): - variables = [] - for index, question in enumerate(data): - if question['variable'] in variables: - verrors.add( - f'{schema}.{index}', f'Variable name {question["variable"]!r} has been used again which is not allowed' - ) - else: - variables.append(question['variable']) - sub_questions = question.get('subquestions') or [] - for sub_index, sub_question in enumerate(sub_questions): - if sub_question['variable'] in variables: - verrors.add( - f'{schema}.{index}.subquestions.{sub_index}', - f'Variable name {sub_question["variable"]!r} has been used again which is not allowed' - ) - else: - variables.append(sub_question['variable']) - - verrors.check() - - -def validate_question(question_data, schema, verrors, validate_top_level_attrs=None): - if not isinstance(question_data, dict): - verrors.add(schema, 'Question must be a valid dictionary.') - return - - validate_top_level_attrs = validate_top_level_attrs or tuple() - validate_key_value_types( - question_data, (('variable', str), ('label', str), ('schema', dict)) + validate_top_level_attrs, verrors, schema - ) - if type(question_data.get('schema')) != dict: - return - - if question_data['variable'] == CUSTOM_PORTALS_KEY: - verrors.add( - f'{schema}.variable', - f'{CUSTOM_PORTALS_KEY!r} is a reserved variable name and cannot be specified by app developer' - ) - # No need to validate the question data etc here - return - - try: - Variable(question_data).validate(schema) - except ValidationErrors as ve: - verrors.extend(ve) - return - - schema_data = question_data['schema'] - variable_type = schema_data['type'] - - for condition, key, schema_str in ( - (variable_type != 'list', 'subquestions', f'{schema}.schema.subquestions'), - (variable_type == 'list', 'items', f'{schema}.schema.items'), - (variable_type == 'dict', 'attrs', f'{schema}.schema.attrs'), - ): - if not (condition and type(schema_data.get(key)) == list): - continue - - if variable_type == 'dict': - validate_variable_uniqueness(schema_data[key], f'{schema}.{schema_str}', verrors) - - for index, item in enumerate(schema_data[key]): - validate_question(item, f'{schema_str}.{index}', verrors) diff --git a/archive/catalog_validation/truecharts-fork/catalog_validation/validation_utils.py b/archive/catalog_validation/truecharts-fork/catalog_validation/validation_utils.py deleted file mode 100644 index e8ba4851594..00000000000 --- a/archive/catalog_validation/truecharts-fork/catalog_validation/validation_utils.py +++ /dev/null @@ -1,66 +0,0 @@ -import os -import yaml - -from semantic_version import Version -from typing import Optional - -from .exceptions import ValidationErrors - - -def validate_chart_version( - verrors: ValidationErrors, chart_version_path: str, schema: str, item_name: str, version_name: Optional[str] = None, -) -> ValidationErrors: - if os.path.exists(chart_version_path): - with open(chart_version_path, 'r') as f: - try: - chart_config = yaml.safe_load(f.read()) - except yaml.YAMLError: - verrors.add(schema, 'Must be a valid yaml file') - else: - if not isinstance(chart_config, dict): - verrors.add(schema, 'Must be a dictionary') - else: - if chart_config.get('name') != item_name: - verrors.add(f'{schema}.item_name', 'Item name not correctly set in "Chart.yaml".') - - if not isinstance(chart_config.get('annotations', {}), dict): - verrors.add(f'{schema}.annotations', 'Annotations must be a dictionary') - - if not isinstance(chart_config.get('sources', []), list): - verrors.add(f'{schema}.sources', 'Sources must be a list') - else: - for index, source in enumerate(chart_config.get('sources', [])): - if not isinstance(source, str): - verrors.add(f'{schema}.sources.{index}', 'Source must be a string') - - if not isinstance(chart_config.get('maintainers', []), list): - verrors.add(f'{schema}.maintainers', 'Maintainers must be a list') - else: - for index, maintainer in enumerate(chart_config.get('maintainers', [])): - if not isinstance(maintainer, dict): - verrors.add(f'{schema}.maintainers.{index}', 'Maintainer must be a dictionary') - elif not all(k in maintainer and isinstance(maintainer[k], str) for k in ('name', 'email')): - verrors.add( - f'{schema}.maintainers.{index}', - 'Maintainer must have name and email attributes defined and be strings.' - ) - - chart_version = chart_config.get('version') - if chart_version is None: - verrors.add(f'{schema}.version', 'Version must be configured in "Chart.yaml"') - else: - try: - Version(chart_version) - except ValueError: - verrors.add(f'{schema}.version', f'{chart_version!r} is not a valid version name') - - if version_name is not None and chart_version != version_name: - verrors.add( - f'{schema}.version', - 'Configured version in "Chart.yaml" does not match version directory name.' - ) - - else: - verrors.add(schema, 'Missing chart version file') - - return verrors diff --git a/archive/catalog_validation/truecharts-fork/debian/changelog b/archive/catalog_validation/truecharts-fork/debian/changelog deleted file mode 100644 index 0019cb792ff..00000000000 --- a/archive/catalog_validation/truecharts-fork/debian/changelog +++ /dev/null @@ -1,5 +0,0 @@ -catalog-validation (0.1-0~truenas+1) bullseye-truenas-unstable; urgency=medium - - * Initial release - - -- Waqar Ahmed Fri, 27 Nov 2020 00:26:21 +0500 diff --git a/archive/catalog_validation/truecharts-fork/debian/control b/archive/catalog_validation/truecharts-fork/debian/control deleted file mode 100644 index 3034a70dcc0..00000000000 --- a/archive/catalog_validation/truecharts-fork/debian/control +++ /dev/null @@ -1,27 +0,0 @@ -Source: catalog-validation -Section: contrib/python -Priority: optional -Maintainer: Waqar Ahmed -Build-Depends: debhelper-compat (= 12), - dh-python, - python3-dev, - python3-jsonschema, - python3-semantic-version, - python3-kubernetes, - python3-yaml, - python3-setuptools -Standards-Version: 4.4.1 -Homepage: https://github.com/truenas/catalog_validation -Testsuite: autopkgtest-pkg-python - -Package: python3-catalog-validation -Architecture: any -Depends: python3-semantic-version, - python3-jsonschema, - python3-kubernetes, - python3-yaml, - ${shlibs:Depends}, - ${misc:Depends}, - ${python3:Depends} -Description: Validate TrueNAS Catalogs - This package helps validate truenas catalogs. diff --git a/archive/catalog_validation/truecharts-fork/debian/rules b/archive/catalog_validation/truecharts-fork/debian/rules deleted file mode 100644 index 3bb0ffc0074..00000000000 --- a/archive/catalog_validation/truecharts-fork/debian/rules +++ /dev/null @@ -1,7 +0,0 @@ -#!/usr/bin/make -f -export DH_VERBOSE = 1 - -export PYBUILD_NAME=catalog_validation - -%: - dh $@ --with python3 --buildsystem=pybuild diff --git a/archive/catalog_validation/truecharts-fork/debian/source/format b/archive/catalog_validation/truecharts-fork/debian/source/format deleted file mode 100644 index 163aaf8d82b..00000000000 --- a/archive/catalog_validation/truecharts-fork/debian/source/format +++ /dev/null @@ -1 +0,0 @@ -3.0 (quilt) diff --git a/archive/catalog_validation/truecharts-fork/debian/source/options b/archive/catalog_validation/truecharts-fork/debian/source/options deleted file mode 100644 index cb61fa5267b..00000000000 --- a/archive/catalog_validation/truecharts-fork/debian/source/options +++ /dev/null @@ -1 +0,0 @@ -extend-diff-ignore = "^[^/]*[.]egg-info/" diff --git a/archive/catalog_validation/truecharts-fork/requirements.txt b/archive/catalog_validation/truecharts-fork/requirements.txt deleted file mode 100644 index ac13017da4e..00000000000 --- a/archive/catalog_validation/truecharts-fork/requirements.txt +++ /dev/null @@ -1,6 +0,0 @@ -gitpython -jsonschema==4.10.3 -kubernetes -markdown -pyyaml -semantic_version diff --git a/archive/catalog_validation/truecharts-fork/setup.cfg b/archive/catalog_validation/truecharts-fork/setup.cfg deleted file mode 100644 index aa079ec57f8..00000000000 --- a/archive/catalog_validation/truecharts-fork/setup.cfg +++ /dev/null @@ -1,2 +0,0 @@ -[flake8] -max-line-length=120 diff --git a/archive/catalog_validation/truecharts-fork/setup.py b/archive/catalog_validation/truecharts-fork/setup.py deleted file mode 100644 index a64ad680466..00000000000 --- a/archive/catalog_validation/truecharts-fork/setup.py +++ /dev/null @@ -1,21 +0,0 @@ -from distutils.core import setup -from setuptools import find_packages - -VERSION = '0.1' - -setup( - name='catalog_validation', - description='Validate TrueNAS Catalog(s)', - version=VERSION, - include_package_data=True, - packages=find_packages(), - license='GNU3', - platforms='any', - entry_points={ - 'console_scripts': [ - 'catalog_validate = catalog_validation.scripts.catalog_validate:main', - 'catalog_update = catalog_validation.scripts.catalog_update:main', - 'dev_charts_validate = catalog_validation.scripts.dev_apps_validate:main', - ], - }, -) diff --git a/archive/charts/system/spegel/Chart.yaml b/archive/charts/system/spegel/Chart.yaml deleted file mode 100644 index 5bdf5f3628e..00000000000 --- a/archive/charts/system/spegel/Chart.yaml +++ /dev/null @@ -1,44 +0,0 @@ -annotations: - max_scale_version: 24.04.1 - min_scale_version: 24.04.0 - truecharts.org/category: operators - truecharts.org/max_helm_version: "3.15" - truecharts.org/min_helm_version: "3.11" - truecharts.org/train: system -apiVersion: v2 -appVersion: latest -dependencies: - - name: common - version: 25.0.0 - repository: oci://tccr.io/truecharts - condition: "" - alias: "" - tags: [] - import-values: [] - - name: spegel - version: v0.0.24 - repository: oci://ghcr.io/spegel-org/helm-charts - condition: "" - alias: spegel - tags: [] - import-values: [] -deprecated: false -description: A distributed image store -home: https://truecharts.org/charts/system/spegel -icon: https://truecharts.org/img/hotlink-ok/chart-icons/spegel.webp -keywords: - - spegel - - loadbalancer -kubeVersion: ">=1.24.0-0" -maintainers: - - name: TrueCharts - email: info@truecharts.org - url: https://truecharts.org -name: spegel -sources: - - https://github.com/spegel/spegel - - https://github.com/truecharts/charts/tree/master/charts/system/spegel - - https://github.com/truecharts/containers/tree/master/apps/alpine - - https://spegel.universe.tf -type: application -version: 1.0.0 diff --git a/archive/charts/system/spegel/README.md b/archive/charts/system/spegel/README.md deleted file mode 100644 index b069770b679..00000000000 --- a/archive/charts/system/spegel/README.md +++ /dev/null @@ -1,61 +0,0 @@ ---- -title: README ---- - -## General Info - -TrueCharts can be installed as both _normal_ Helm Charts or as TrueNAS SCALE Apps. -Both solutions are fully supported, but we heavily advice the use of normal Helm Charts where possible - -For more information about this Chart, please check the docs on the TrueCharts [website](https://truecharts.org/charts/system/spegel) - -**This chart is not maintained by the upstream project and any issues with the chart should be raised [here](https://github.com/truecharts/charts/issues/new/choose)** - -## Installation - -### Helm-Chart installation - -To install TrueCharts Helm charts using Helm, you can use our OCI Repository. - -`helm install mychart oci://tccr.io/truecharts/spegel` - -For more information on how to install TrueCharts Helm charts, checkout the [instructions on the website](/guides) - - -### TrueNAS SCALE Apps - -For more information on how to use TrueCharts as TrueNAS SCALE Apps, please checkout the [quick-start guides for TrueNAS SCALE](/deprecated/scale). - -## Chart Specific Guides and information - -All our charts have dedicated documentation pages. -The documentation for this chart can be found here: -https://truecharts.org/charts/system/spegel - -## Configuration Options - -Please note: For TrueNAS SCALE, only options available in the GUI are supported. -Hence most of these docs do not apply to TrueNAS SCALE - -To view the chart specific options, please view Values.yaml included in the chart. -The most recent version of which, is available here: https://github.com/truecharts/charts/blob/master/charts/system/spegel/values.yaml - -All our Charts use a shared "common" library chart that contains most of the templating and options. -For the complete overview of all available options, please checkout the documentation for them on the [common docs on our website](/common) - -For information about the common chart and all defaults included with it, please review its values.yaml file available here: https://github.com/truecharts/library-charts/blob/main/library/common/values.yaml - -## Support - -- See the [Website](https://truecharts.org) -- Check our [Discord](https://discord.gg/tVsPTHWTtr) -- Open a [issue](https://github.com/truecharts/charts/issues/new/choose) - ---- - -## Sponsor TrueCharts - -TrueCharts can only exist due to the incredible effort of our staff. -Please consider making a [donation](/general/sponsor) or contributing back to the project any way you can! - -_All Rights Reserved - The TrueCharts Project_ diff --git a/archive/charts/system/spegel/icon-small.webp b/archive/charts/system/spegel/icon-small.webp deleted file mode 100644 index 6380d00e9d6..00000000000 Binary files a/archive/charts/system/spegel/icon-small.webp and /dev/null differ diff --git a/archive/charts/system/spegel/templates/common.yaml b/archive/charts/system/spegel/templates/common.yaml deleted file mode 100644 index 995efb03eb0..00000000000 --- a/archive/charts/system/spegel/templates/common.yaml +++ /dev/null @@ -1,5 +0,0 @@ -{{/* Make sure all variables are set properly */}} -{{- include "tc.v1.common.loader.init" . }} - -{{/* Render the templates */}} -{{ include "tc.v1.common.loader.apply" . }} diff --git a/archive/charts/system/spegel/values.yaml b/archive/charts/system/spegel/values.yaml deleted file mode 100644 index 8ffafd21a48..00000000000 --- a/archive/charts/system/spegel/values.yaml +++ /dev/null @@ -1,25 +0,0 @@ -image: - repository: tccr.io/tccr/alpine - pullPolicy: IfNotPresent - tag: latest@sha256:ade0065e19edaa4f6903d464ee70605111a48394536deb94f31b661264704558 - -service: - main: - enabled: false - ports: - main: - enabled: false - -workload: - main: - enabled: false - -portal: - open: - enabled: false - -operator: - register: true - -manifestManager: - enabled: false diff --git a/archive/jailman/.github/CODEOWNERS b/archive/jailman/.github/CODEOWNERS deleted file mode 100644 index 3a39ae58968..00000000000 --- a/archive/jailman/.github/CODEOWNERS +++ /dev/null @@ -1,9 +0,0 @@ -# Default code owner -* @ornias1993 - -# code owner for the docs. -/docs/ @ornias1993 - -# Code owners for individual blueprints -/blueprints/influxdb/ @colemamd -/blueprints/unifi/ @colemamd diff --git a/archive/jailman/.github/FUNDING.yml b/archive/jailman/.github/FUNDING.yml deleted file mode 100644 index f5d4dae0ea1..00000000000 --- a/archive/jailman/.github/FUNDING.yml +++ /dev/null @@ -1,12 +0,0 @@ -# These are supported funding model platforms - -github: ornias1993 -patreon: # Replace with a single Patreon username -open_collective: # Replace with a single Open Collective username -ko_fi: # Replace with a single Ko-fi username -tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel -community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry -liberapay: # Replace with a single Liberapay username -issuehunt: # Replace with a single IssueHunt username -otechie: # Replace with a single Otechie username -custom: https://www.buymeacoffee.com/Xr9O4jc # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] diff --git a/archive/jailman/.github/ISSUE_TEMPLATE/bug_report.md b/archive/jailman/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 4449ce6c211..00000000000 --- a/archive/jailman/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve JailMan -title: "" -labels: bug -assignees: "" ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: - -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. diff --git a/archive/jailman/.github/ISSUE_TEMPLATE/feature_request.md b/archive/jailman/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 2bfb1fdfd01..00000000000 --- a/archive/jailman/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: "" -labels: Feature -assignees: "" ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. diff --git a/archive/jailman/.github/PULL_REQUEST_TEMPLATE/bug_fix.md b/archive/jailman/.github/PULL_REQUEST_TEMPLATE/bug_fix.md deleted file mode 100644 index 819fcaf4424..00000000000 --- a/archive/jailman/.github/PULL_REQUEST_TEMPLATE/bug_fix.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: Bug Fix -about: Submit a fix to help us improve JailMan -title: "" -labels: bug -assignees: "" ---- - -**Description** - -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) - -**Type of change** - -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Refactor of current code -- [ ] This change requires additional documentation update - -**How Has This Been Tested?** - -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - -- [ ] Test A -- [ ] Test B - -**Notes:** -_Please enter any other relevant information here_ - -**Checklist:** - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests to this description that prove my fix is effective or that my feature works -- [ ] Any new files are named using lowercase (to avoid issues on case sensitive file systems) diff --git a/archive/jailman/.github/PULL_REQUEST_TEMPLATE/general_improvement.md b/archive/jailman/.github/PULL_REQUEST_TEMPLATE/general_improvement.md deleted file mode 100644 index 2156542e13f..00000000000 --- a/archive/jailman/.github/PULL_REQUEST_TEMPLATE/general_improvement.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -name: General Improvement -about: Submit a fix to help us improve JailMan -title: "" -labels: enhancement -assignees: "" ---- - -**Description** - -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) - -**Type of change** - -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Refactor of current code -- [ ] This change requires additional documentation update - -**How Has This Been Tested?** - -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - -- [ ] Test A -- [ ] Test B - -**Notes:** -_Please enter any other relevant information here_ - -**Checklist:** - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests to this description that prove my fix is effective or that my feature works -- [ ] Any new files are named using lowercase (to avoid issues on case sensitive file systems) diff --git a/archive/jailman/.github/PULL_REQUEST_TEMPLATE/new_blueprint.md b/archive/jailman/.github/PULL_REQUEST_TEMPLATE/new_blueprint.md deleted file mode 100644 index 49e748324d4..00000000000 --- a/archive/jailman/.github/PULL_REQUEST_TEMPLATE/new_blueprint.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -name: New Blueprint -about: Submit a new blueprint to help us expand JailMan -title: "" -labels: feature -assignees: "" ---- - -**Description** - -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. - -Fixes # (issue) - -**Type of change** - -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Refactor of current code -- [ ] This change requires additional documentation update - -**How Has This Been Tested?** - -Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration - -- [ ] Test A -- [ ] Test B - -**Notes:** -_Please enter any other relevant information here_ - -**Checklist:** - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas -- [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings -- [ ] I have added tests to this description that prove my fix is effective or that my feature works -- [ ] Any new files are named using lowercase (to avoid issues on case sensitive file systems) -- [ ] I've added myself as a codeowner for the new blueprint in /docs/CODEOWNERS diff --git a/archive/jailman/.github/Readme.md b/archive/jailman/.github/Readme.md deleted file mode 100644 index beec278ce23..00000000000 --- a/archive/jailman/.github/Readme.md +++ /dev/null @@ -1,140 +0,0 @@ -### JailMan is a collection of shell scripts designed to make it easier to install all sorts of iocage Jails on FreeNAS. - -## Important: - -### Jailman as a project has stopped development in favor of [TrueCharts](https://github.com/truecharts/truecharts) for TrueNAS SCALE. - ---- - -[![GitHub last commit](https://img.shields.io/github/last-commit/jailmanager/jailman/dev.svg)](https://github.com/jailmanager/jailman/commits/dev) [![GitHub Release](https://img.shields.io/github/release/jailmanager/jailman.svg)](https://github.com/jailmanager/jailman/releases/latest) [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://github.com/jailmanager/jailman/blob/master/docs/LICENSE.GPLV2) [![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://github.com/jailmanager/jailman/blob/master/docs/LICENSE.BSD2) - -## Intro - -There are a lot of great scripts out there to create all sorts of custom jails on FreeNAS. Sadly enough, they all take their own approach to configuration, which lead to a lot of time wasted configuring all sorts of different scripts. - -We do not aim to be some sort of XKCD like "solution to replace all solutions", but aim to simply improve, iterate and integrate the great work others have already put forward. - -The goal of this project is to be able to install, update, reinstall, upgrade and delete most of your services by just running a single command using a single config file. While doing this we aim for a "docker like" scenario, where the jail is completely disposable and all configuration is saved outside of the jail. - -## Getting started - -### Installing - -- Get into FreeNAS using the in-gui console or SSH. - Run the following commands to install jailman: -- `git clone https://github.com/jailmanager/jailman.git` -- `cd jailman` -- `cp config.yml.example config.yml` -- edit config.yml to reflect your personal settings (optional, see "use") -- Run one of the commands under "How-To Use" - -### Updating - -This script includes an autoupdate feature which checks if changes to the script has been posted to github. - -## How-To Use - -Replace $jailname with the name of the jail you want to install. -For supported jails, please see this readme or config.yml.example - -- First: CD into the directory you downloaded jailman into (see above) - example: - `cd /root/jailman` - -- Install: - `./jailman.sh -i $jailname` - Example: - `./jailman.sh -i sonarr` - -- ReInstall: - `./jailman.sh -r $jailname` - Example: - `./jailman.sh -r sonarr` - -- Update: - `./jailman.sh -u $jailname` - Example: - `./jailman.sh -u sonarr` - -- Destroy - `./jailman.sh -d $jailname` - Example: - `./jailman.sh -d sonarr` - -You can also do multiple jails in one pass: -Example: -`jailman.sh -i sonarr radarr lidarr` - -This installs the jail, creates the config dataset if needed, installs all packages and sets them up for you. -Only thing you need to do is do the setup of the packages in their respective GUI. -All settings for the applications inside the jails are persistent across reinstalls, so don't worry reinstalling! - -config.yml.example includes basic configuration for all jails. -Basic means: The same setup as a FreeNAS plugin would've, DHCP on bridge0. - -### Currently Supported Services - -#### General - -- organizr -- py-kms -- nextcloud (currently broken, fix ready for 1.3.0) -- bitwarden -- unifi controller - -#### Backend - -- mariadb -- influxdb - -#### Downloads - -- transmission -- jackett - -#### Media - -- plex -- tautulli -- sonarr -- radarr -- lidarr - -## Get involved - -### Preparing your own copy of JailMan - -Getting involved with JailMan and creating your own Jails, is really simple although experience with Bash, BSD and iocage is highly recommended. - -- Fork the JailMan Repository and clone your own fork to disk. -- Create a new branch, starting from the dev branch (with all current development changes) -- Open Jailman.sh and `BRANCH="dev"`into your own branch. - -### Making changes - -To add a jail, you need 4 things: - -- A jailfolder under jails/ -- an install script in the jail folder, named `install.sh` -- an update script in the jail folder, named `update.sh` -- an entry in `config.yml` with the name of your jail - -All jails created by JailMan start with their own persistant data folder in a seperate dataset, mounted under `/config`. -You can safely use this, or create additional datasets and mount those. - -To make your experience making changes to Jailman as easy as possible, we already made some convenience functions in global.sh, those are available to your jail install and update scripts from the start! - -But above all: Have fun building it! - -## LICENCE - -This work is dual licenced under GPLv2 and BSD-2 clause - -### Sub-Licences - -Some sub-modules available under "jails" might be licenced under a different licence. -Please be aware of this and take note of any LICENCE files signaling a differently licenced sub-module. - ---- - -![built-with-resentment](http://forthebadge.com/images/badges/built-with-resentment.svg) ![contains-technical-debt](http://forthebadge.com/images/badges/contains-technical-debt.svg) diff --git a/archive/jailman/.github/SECURITY.md b/archive/jailman/.github/SECURITY.md deleted file mode 100644 index 361a7bde5b1..00000000000 --- a/archive/jailman/.github/SECURITY.md +++ /dev/null @@ -1,17 +0,0 @@ -# Security Policy - -## Supported Versions - -| Version | TrueNAS version | Supported with updates | -| ------- | --------------- | ---------------------- | -| 1.3.0 | 12.0 | NOT RELEASED YET | -| 1.2.x | 11.3U2-3 | :white_check_mark: | -| 1.1.x | 11.3U1-2 | :x: | -| 1.0.x | 11.3U1 | :x: | - -## Reporting a Vulnerability - -If you find any security issue, please email the project maintainer. - -Currently the Project Maintainer is: -[Ornias1993](https://github.com/Ornias1993) diff --git a/archive/jailman/.github/workflows/filecheck.yml b/archive/jailman/.github/workflows/filecheck.yml deleted file mode 100644 index 2b834758589..00000000000 --- a/archive/jailman/.github/workflows/filecheck.yml +++ /dev/null @@ -1,22 +0,0 @@ -name: File Presence QC -on: - pull_request: - branches: - - master - - dev - - minor-dev - -jobs: - build: - name: Check Files - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1 - - name: check existance - run: | - for pathname in blueprints/*; do test -e $pathname/readme.md || { echo "File missing: $pathname/readme.md"; error="true"; }; done - for pathname in blueprints/*; do test -e $pathname/install.sh || { echo "File missing: $pathname/install.sh"; error="true"; }; done - for pathname in blueprints/*; do test -e $pathname/update.sh || { echo "File missing: $pathname/update.sh"; error="true"; }; done - for pathname in blueprints/*; do test -e $pathname/config.yml || { echo "File missing: $pathname/config.yml"; error="true"; }; done - if [ "${error}" == "true" ]; then echo "Missing files detected" && exit 1; fi - shell: bash diff --git a/archive/jailman/.github/workflows/shellcheck.yml b/archive/jailman/.github/workflows/shellcheck.yml deleted file mode 100644 index f675764b010..00000000000 --- a/archive/jailman/.github/workflows/shellcheck.yml +++ /dev/null @@ -1,19 +0,0 @@ -# This is a workflow to run shellcheck on all scripts -name: Shell Linter QC - -# Controls when the action will run. Triggers the workflow on push or pull request -# events but only for the master branch -on: - pull_request: - branches: - - master - - dev - - minor-dev - -jobs: - Shellcheck: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1 - - name: Shell Linter - uses: azohra/shell-linter@6bbeaa868df09c34ddc008e6030cfe89c03394a1 # v0.6.0 diff --git a/archive/jailman/.github/workflows/wiki.yml b/archive/jailman/.github/workflows/wiki.yml deleted file mode 100644 index 91d67c67619..00000000000 --- a/archive/jailman/.github/workflows/wiki.yml +++ /dev/null @@ -1,23 +0,0 @@ -name: Publish docs via GitHub Pages -on: - push: - branches: - - master - -jobs: - build: - name: Deploy docs - runs-on: ubuntu-latest - steps: - - name: Checkout master - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1 - with: - ref: "master" - - name: rename-readme - run: | - for pathname in blueprints/*/readme.md; do cp "$pathname" "docs/blueprints/$( basename "$( dirname "$pathname" )" ).md"; done - shell: bash - - name: Deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - GITHUB_TOKEN: ${{ secrets.WIKI_GH_PAT }} diff --git a/archive/jailman/.gitignore b/archive/jailman/.gitignore deleted file mode 100644 index a0ec5967dd6..00000000000 --- a/archive/jailman/.gitignore +++ /dev/null @@ -1 +0,0 @@ -/config.yml diff --git a/archive/jailman/.shellcheckrc b/archive/jailman/.shellcheckrc deleted file mode 100644 index e70c89810e2..00000000000 --- a/archive/jailman/.shellcheckrc +++ /dev/null @@ -1 +0,0 @@ -disable=SC2034,SC2154 diff --git a/archive/jailman/CNAME b/archive/jailman/CNAME deleted file mode 100644 index 62bcfa8cb37..00000000000 --- a/archive/jailman/CNAME +++ /dev/null @@ -1 +0,0 @@ -wiki.jailmanager.org diff --git a/archive/jailman/LICENSE b/archive/jailman/LICENSE deleted file mode 100644 index 3c91742b82e..00000000000 --- a/archive/jailman/LICENSE +++ /dev/null @@ -1,25 +0,0 @@ -BSD 2-Clause License - -Copyright (c) 2020, Kjeld Schouten-Lebbing -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/archive/jailman/LICENSE.BSD2 b/archive/jailman/LICENSE.BSD2 deleted file mode 100644 index c739456913e..00000000000 --- a/archive/jailman/LICENSE.BSD2 +++ /dev/null @@ -1,25 +0,0 @@ -BSD 2-Clause License - -Copyright (c) 2019, Kjeld Schouten-Lebbing -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/archive/jailman/LICENSE.GPLV2 b/archive/jailman/LICENSE.GPLV2 deleted file mode 100644 index d159169d105..00000000000 --- a/archive/jailman/LICENSE.GPLV2 +++ /dev/null @@ -1,339 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause 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. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE 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. - - 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 -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision 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, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. diff --git a/archive/jailman/blueprints/bitwarden/config.yml b/archive/jailman/blueprints/bitwarden/config.yml deleted file mode 100644 index 936ab905fd1..00000000000 --- a/archive/jailman/blueprints/bitwarden/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - bitwarden: - pkgs: git sudo bash node npm mariadb104-client diff --git a/archive/jailman/blueprints/bitwarden/includes/bitwarden.rc b/archive/jailman/blueprints/bitwarden/includes/bitwarden.rc deleted file mode 100644 index 420f379ac1b..00000000000 --- a/archive/jailman/blueprints/bitwarden/includes/bitwarden.rc +++ /dev/null @@ -1,17 +0,0 @@ -#!/bin/sh - -# PROVIDE: bitwarden -# REQUIRE: LOGIN DAEMON NETWORKING FILESYSTEMS -# KEYWORD: jail rust - -. /etc/rc.subr - -name="bitwarden" - - -rcvar=${name}_enable -pidfile="/var/run/${name}.pid" -command="/usr/sbin/daemon" -command_args="-u bitwarden -c -f -P ${pidfile} -r /usr/local/share/bitwarden/bin/bitwarden_rs" -load_rc_config $name -run_rc_command "$1" diff --git a/archive/jailman/blueprints/bitwarden/includes/bitwarden.rc.conf b/archive/jailman/blueprints/bitwarden/includes/bitwarden.rc.conf deleted file mode 100644 index 2046bd0a36a..00000000000 --- a/archive/jailman/blueprints/bitwarden/includes/bitwarden.rc.conf +++ /dev/null @@ -1,13 +0,0 @@ -export DATA_FOLDER="/config" -export ENABLE_DB_WAL="false" -export ROCKET_TLS="{certs="/config/ssl/bitwarden-ssl.crt",key="/config/ssl/bitwarden-ssl.key"}" -export LOG_FILE="/config/bitwarden.log" -export WEB_VAULT_FOLDER="/usr/local/share/bitwarden/web-vault" -export LOG_LEVEL="trace" -export WEBSOCKET_ENABLED="true" -export DISABLE_ICON_DOWNLOAD=false -export ICON_CACHE_FOLDER="/config/icon_cache" -export ICON_CACHE_TTL=2592000 -export ICON_CACHE_NEGTTL=259200 -export ROCKET_WORKERS=20 -export ROCKET_PORT=8000 diff --git a/archive/jailman/blueprints/bitwarden/install.sh b/archive/jailman/blueprints/bitwarden/install.sh deleted file mode 100755 index 5941b778780..00000000000 --- a/archive/jailman/blueprints/bitwarden/install.sh +++ /dev/null @@ -1,119 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for bitwarden - -# Initialise defaults -JAIL_IP="jail_${1}_ip4_addr" -JAIL_IP="${!JAIL_IP%/*}" -HOST_NAME="jail_${1}_host_name" - -DB_DATABASE="jail_${1}_db_database" -DB_DATABASE="${!DB_DATABASE:-$1}" - -DB_USER="jail_${1}_db_user" -DB_USER="${!DB_USER:-$DB_DATABASE}" - -# shellcheck disable=SC2154 -INSTALL_TYPE="jail_${1}_db_type" -INSTALL_TYPE="${!INSTALL_TYPE:-mariadb}" - -DB_JAIL="jail_${1}_db_jail" -# shellcheck disable=SC2154 -DB_HOST="jail_${!DB_JAIL}_ip4_addr" -DB_HOST="${!DB_HOST%/*}:3306" - -# shellcheck disable=SC2154 -DB_PASSWORD="jail_${1}_db_password" -DB_STRING="mysql://${DB_USER}:${!DB_PASSWORD}@${DB_HOST}/${DB_DATABASE}" -# shellcheck disable=SC2154 -ADMIN_TOKEN="jail_${1}_admin_token" - -if [ -z "${!DB_PASSWORD}" ]; then - echo "db_password can't be empty" - exit 1 -fi - -if [ -z "${!DB_JAIL}" ]; then - echo "db_jail can't be empty" - exit 1 -fi - -if [ -z "${!JAIL_IP}" ]; then - echo "ip4_addr can't be empty" - exit 1 -fi - -if [ -z "${!ADMIN_TOKEN}" ]; then -ADMIN_TOKEN=$(openssl rand -base64 16) -fi - -# install latest rust version, pkg version is outdated and can't build bitwarden_rs -iocage exec "${1}" "curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y" - -# Install Bitwarden_rs -iocage exec "${1}" mkdir -p /usr/local/share/bitwarden/src -iocage exec "${1}" git clone https://github.com/dani-garcia/bitwarden_rs/ /usr/local/share/bitwarden/src -TAG=$(iocage exec "${1}" "git -C /usr/local/share/bitwarden/src tag --sort=v:refname | tail -n1") -iocage exec "${1}" "git -C /usr/local/share/bitwarden/src checkout ${TAG}" -#TODO replace with: cargo build --features mysql --release -if [ "${INSTALL_TYPE}" == "mariadb" ]; then - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features mysql --release" - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features mysql" -else - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features sqlite --release" - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features sqlite-bundled" -fi - - -iocage exec "${1}" cp -r /usr/local/share/bitwarden/src/target/release /usr/local/share/bitwarden/bin - -# Download and install webvault -WEB_RELEASE_URL=$(curl -Ls -o /dev/null -w "%{url_effective}" https://github.com/dani-garcia/bw_web_builds/releases/latest) -WEB_TAG="${WEB_RELEASE_URL##*/}" -iocage exec "${1}" "fetch http://github.com/dani-garcia/bw_web_builds/releases/download/$WEB_TAG/bw_web_$WEB_TAG.tar.gz -o /usr/local/share/bitwarden" -iocage exec "${1}" "tar -xzvf /usr/local/share/bitwarden/bw_web_$WEB_TAG.tar.gz -C /usr/local/share/bitwarden/" -iocage exec "${1}" rm /usr/local/share/bitwarden/bw_web_"$WEB_TAG".tar.gz - -# shellcheck disable=SC2154 -if [ -f "/mnt/${global_dataset_config}/${1}/ssl/bitwarden-ssl.crt" ]; then - echo "certificate exist... Skipping cert generation" -else - "No ssl certificate present, generating self signed certificate" - if [ ! -d "/mnt/${global_dataset_config}/${1}/ssl" ]; then - echo "cert folder not existing... creating..." - iocage exec "${1}" mkdir /config/ssl - fi - openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=localhost" -keyout /mnt/"${global_dataset_config}"/"${1}"/ssl/bitwarden-ssl.key -out /mnt/"${global_dataset_config}"/"${1}"/ssl/bitwarden-ssl.crt -fi - -if [ -f "/mnt/${global_dataset_config}/${1}/bitwarden.log" ]; then - echo "Reinstall of Bitwarden detected... using existing config and database" -elif [ "${INSTALL_TYPE}" == "mariadb" ]; then - echo "No config detected, doing clean install, utilizing the Mariadb database ${DB_HOST}" - iocage exec "${!DB_JAIL}" mysql -u root -e "CREATE DATABASE ${DB_DATABASE};" - iocage exec "${!DB_JAIL}" mysql -u root -e "GRANT ALL ON ${DB_DATABASE}.* TO ${DB_USER}@${JAIL_IP} IDENTIFIED BY '${!DB_PASSWORD}';" - iocage exec "${!DB_JAIL}" mysqladmin reload -else - echo "No config detected, doing clean install." -fi - -iocage exec "${1}" "pw user add bitwarden -c bitwarden -u 725 -d /nonexistent -s /usr/bin/nologin" -iocage exec "${1}" chown -R bitwarden:bitwarden /usr/local/share/bitwarden /config -iocage exec "${1}" mkdir /usr/local/etc/rc.d /usr/local/etc/rc.conf.d -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/bitwarden/includes/bitwarden.rc /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.d/bitwarden -cp "${SCRIPT_DIR}"/blueprints/bitwarden/includes/bitwarden.rc.conf /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.conf.d/bitwarden -echo 'export DATABASE_URL="'"${DB_STRING}"'"' >> /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.conf.d/bitwarden -echo 'export ADMIN_TOKEN="'"${!ADMIN_TOKEN}"'"' >> /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.conf.d/bitwarden - -if [ "${!ADMIN_TOKEN}" == "NONE" ]; then - echo "Admin_token set to NONE, disabling admin portal" -else - echo "Admin_token set and admin portal enabled" - iocage exec "${1}" echo "${DB_NAME} Admin Token is ${!ADMIN_TOKEN}" > /root/"${1}"_admin_token.txt -fi - -iocage exec "${1}" chmod u+x /usr/local/etc/rc.d/bitwarden -iocage exec "${1}" sysrc "bitwarden_enable=YES" -iocage exec "${1}" service bitwarden restart -echo "Jail ${1} finished Bitwarden install." -echo "Admin Token is ${!ADMIN_TOKEN}" diff --git a/archive/jailman/blueprints/bitwarden/readme.md b/archive/jailman/blueprints/bitwarden/readme.md deleted file mode 100644 index 5d520794907..00000000000 --- a/archive/jailman/blueprints/bitwarden/readme.md +++ /dev/null @@ -1,74 +0,0 @@ -# Bitwarden_RS - -## Original README from the Bitwarden_rs github: - -https://github.com/dani-garcia/bitwarden_rs - -# Bitwarden_RS - -### This is a Bitwarden server API implementation written in Rust compatible with [upstream Bitwarden clients](https://bitwarden.com/#download)\*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. - ---- - -[![Travis Build Status](https://travis-ci.org/dani-garcia/bitwarden_rs.svg?branch=master)](https://travis-ci.org/dani-garcia/bitwarden_rs) -[![Docker Pulls](https://img.shields.io/docker/pulls/bitwardenrs/server.svg)](https://hub.docker.com/r/bitwardenrs/server) -[![Dependency Status](https://deps.rs/repo/github/dani-garcia/bitwarden_rs/status.svg)](https://deps.rs/repo/github/dani-garcia/bitwarden_rs) -[![GitHub Release](https://img.shields.io/github/release/dani-garcia/bitwarden_rs.svg)](https://github.com/dani-garcia/bitwarden_rs/releases/latest) -[![GPL-3.0 Licensed](https://img.shields.io/github/license/dani-garcia/bitwarden_rs.svg)](https://github.com/dani-garcia/bitwarden_rs/blob/master/LICENSE.txt) -[![Matrix Chat](https://img.shields.io/matrix/bitwarden_rs:matrix.org.svg?logo=matrix)](https://matrix.to/#/#bitwarden_rs:matrix.org) - -Image is based on [Rust implementation of Bitwarden API](https://github.com/dani-garcia/bitwarden_rs). - -**This project is not associated with the [Bitwarden](https://bitwarden.com/) project nor 8bit Solutions LLC.** - -#### ⚠️**IMPORTANT**⚠️: When using this server, please report any bugs or suggestions to us directly (look at the bottom of this page for ways to get in touch), regardless of whatever clients you are using (mobile, desktop, browser...). DO NOT use the official support channels. - ---- - -## Features - -Basically full implementation of Bitwarden API is provided including: - -- Single user functionality -- Organizations support -- Attachments -- Vault API support -- Serving the static files for Vault interface -- Website icons API -- Authenticator and U2F support -- YubiKey and Duo support - -## Installation - -Pull the docker image and mount a volume from the host for persistent storage: - -```sh -docker pull bitwardenrs/server:latest -docker run -d --name bitwarden -v /bw-data/:/data/ -p 80:80 bitwardenrs/server:latest -``` - -This will preserve any persistent data under /bw-data/, you can adapt the path to whatever suits you. - -**IMPORTANT**: Some web browsers, like Chrome, disallow the use of Web Crypto APIs in insecure contexts. In this case, you might get an error like `Cannot read property 'importKey'`. To solve this problem, you need to access the web vault from HTTPS. - -This can be configured in [bitwarden_rs directly](https://github.com/dani-garcia/bitwarden_rs/wiki/Enabling-HTTPS) or using a third-party reverse proxy ([some examples](https://github.com/dani-garcia/bitwarden_rs/wiki/Proxy-examples)). - -If you have an available domain name, you can get HTTPS certificates with [Let's Encrypt](https://letsencrypt.org/), or you can generate self-signed certificates with utilities like [mkcert](https://github.com/FiloSottile/mkcert). Some proxies automatically do this step, like Caddy (see examples linked above). - -## Usage - -See the [bitwarden_rs wiki](https://github.com/dani-garcia/bitwarden_rs/wiki) for more information on how to configure and run the bitwarden_rs server. - -## Get in touch - -To ask a question, offer suggestions or new features or to get help configuring or installing the software, please [use the forum](https://bitwardenrs.discourse.group/). - -If you spot any bugs or crashes with bitwarden_rs itself, please [create an issue](https://github.com/dani-garcia/bitwarden_rs/issues/). Make sure there aren't any similar issues open, though! - -If you prefer to chat, we're usually hanging around at [#bitwarden_rs:matrix.org](https://matrix.to/#/#bitwarden_rs:matrix.org) room on Matrix. Feel free to join us! - -### Sponsors - -Thanks for your contribution to the project! - -- [@ChonoN](https://github.com/ChonoN) diff --git a/archive/jailman/blueprints/bitwarden/update.sh b/archive/jailman/blueprints/bitwarden/update.sh deleted file mode 100755 index e626df01a47..00000000000 --- a/archive/jailman/blueprints/bitwarden/update.sh +++ /dev/null @@ -1,100 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for bitwarden -# Due to it being build from scratch or downloaded directly to execution dir, -# Update for Bitwarden is pretty similair to installation - -# Initialise defaults -JAIL_IP="jail_${1}_ip4_addr" -JAIL_IP="${!JAIL_IP%/*}" -HOST_NAME="jail_${1}_host_name" -DB_DATABASE="jail_${1}_db_database" -DB_USER="jail_${1}_db_user" -# shellcheck disable=SC2154 -INSTALL_TYPE="jail_${1}_type" -DB_JAIL="jail_${1}_db_jail" -DB_JAIL="${!DB_JAIL}" -# shellcheck disable=SC2154 -DB_HOST="${DB_JAIL}_ip4_addr" -DB_HOST="${!DB_HOST%/*}:3306" -# shellcheck disable=SC2154 -DB_PASSWORD="jail_${1}_db_password" -DB_STRING="mysql://${!DB_USER}:${!DB_PASSWORD}@${DB_HOST}/${!DB_DATABASE}" -# shellcheck disable=SC2154 -ADMIN_TOKEN="jail_${1}_admin_token" - -if [ -z "${!DB_USER}" ]; then - echo "db_user can't be empty" - exit 1 -fi - -if [ -z "${!DB_DATABASE}" ]; then - echo "db_database can't be empty" - exit 1 -fi - -if [ -z "${!DB_PASSWORD}" ]; then - echo "db_password can't be empty" - exit 1 -fi - -if [ -z "${!DB_JAIL}" ]; then - echo "db_jail can't be empty" - exit 1 - fi - -if [ -z "${!JAIL_IP}" ]; then - echo "ip4_addr can't be empty" - exit 1 -fi - -if [ -z "${!ADMIN_TOKEN}" ]; then -ADMIN_TOKEN=$(openssl rand -base64 16) -fi - -iocage exec "${1}" service bitwarden stop - -# install latest rust version, pkg version is outdated and can't build bitwarden_rs -iocage exec "${1}" "curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y" - -# Install Bitwarden_rs -iocage exec "${1}" "git -C /usr/local/share/bitwarden/src fetch" -TAG=$(iocage exec "${1}" "git -C /usr/local/share/bitwarden/src tag --sort=v:refname | tail -n1") -iocage exec "${1}" "git -C /usr/local/share/bitwarden/src checkout ${TAG}" -#TODO replace with: cargo build --features mysql --release -if [ "${INSTALL_TYPE}" == "mariadb" ]; then - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features mysql --release" - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features mysql" -else - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo build --features sqlite --release" - iocage exec "${1}" "cd /usr/local/share/bitwarden/src && $HOME/.cargo/bin/cargo install diesel_cli --no-default-features --features sqlite-bundled" -fi - - -iocage exec "${1}" cp -r /usr/local/share/bitwarden/src/target/release /usr/local/share/bitwarden/bin - -# Download and install webvault -WEB_RELEASE_URL=$(curl -Ls -o /dev/null -w "%{url_effective}" https://github.com/dani-garcia/bw_web_builds/releases/latest) -WEB_TAG="${WEB_RELEASE_URL##*/}" -iocage exec "${1}" "fetch http://github.com/dani-garcia/bw_web_builds/releases/download/$WEB_TAG/bw_web_$WEB_TAG.tar.gz -o /usr/local/share/bitwarden" -iocage exec "${1}" "tar -xzvf /usr/local/share/bitwarden/bw_web_$WEB_TAG.tar.gz -C /usr/local/share/bitwarden/" -iocage exec "${1}" rm /usr/local/share/bitwarden/bw_web_"$WEB_TAG".tar.gz - -iocage exec "${1}" chown -R bitwarden:bitwarden /usr/local/share/bitwarden /config -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/"${1}"/includes/bitwarden.rc /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.d/bitwarden -cp "${SCRIPT_DIR}"/blueprints/"${1}"/includes/bitwarden.rc.conf /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.conf.d/bitwarden -echo 'export DATABASE_URL="'"${DB_STRING}"'"' >> /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.conf.d/bitwarden -echo 'export ADMIN_TOKEN="'"${!ADMIN_TOKEN}"'"' >> /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.conf.d/bitwarden - -if [ "${!ADMIN_TOKEN}" == "NONE" ]; then - echo "Admin_token set to NONE, disabling admin portal" -else - echo "Admin_token set and admin portal enabled" - iocage exec "${1}" echo "${DB_NAME} Admin Token is ${!ADMIN_TOKEN}" > /root/"${1}"_admin_token.txt -fi - - -iocage exec "${1}" chmod u+x /usr/local/etc/rc.d/bitwarden -iocage exec "${1}" service bitwarden restart -echo "Jail ${1} finished Bitwarden update." -echo "Admin Token is ${!ADMIN_TOKEN}" diff --git a/archive/jailman/blueprints/influxdb/config.yml b/archive/jailman/blueprints/influxdb/config.yml deleted file mode 100644 index a9b212a702d..00000000000 --- a/archive/jailman/blueprints/influxdb/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - influxdb: - pkgs: influxdb diff --git a/archive/jailman/blueprints/influxdb/includes/influxd.conf b/archive/jailman/blueprints/influxdb/includes/influxd.conf deleted file mode 100644 index 12b7b444823..00000000000 --- a/archive/jailman/blueprints/influxdb/includes/influxd.conf +++ /dev/null @@ -1,586 +0,0 @@ -### Welcome to the InfluxDB configuration file. - -# The values in this file override the default values used by the system if -# a config option is not specified. The commented out lines are the configuration -# field and the default value used. Uncommenting a line and changing the value -# will change the value used at runtime when the process is restarted. - -# Once every 24 hours InfluxDB will report usage data to usage.influxdata.com -# The data includes a random ID, os, arch, version, the number of series and other -# usage data. No data from user databases is ever transmitted. -# Change this option to true to disable reporting. -# reporting-disabled = false - -# Bind address to use for the RPC service for backup and restore. -# bind-address = "127.0.0.1:8088" - -### -### [meta] -### -### Controls the parameters for the Raft consensus group that stores metadata -### about the InfluxDB cluster. -### - -[meta] - # Where the metadata/raft database is stored - dir = "/config/db/meta" - - # Automatically create a default retention policy when creating a database. - # retention-autocreate = true - - # If log messages are printed for the meta service - # logging-enabled = true - -### -### [data] -### -### Controls where the actual shard data for InfluxDB lives and how it is -### flushed from the WAL. "dir" may need to be changed to a suitable place -### for your system, but the WAL settings are an advanced configuration. The -### defaults should work for most systems. -### - -[data] - # The directory where the TSM storage engine stores TSM files. - dir = "/config/db/data" - - # The directory where the TSM storage engine stores WAL files. - wal-dir = "/config/db/wal" - - # The amount of time that a write will wait before fsyncing. A duration - # greater than 0 can be used to batch up multiple fsync calls. This is useful for slower - # disks or when WAL write contention is seen. A value of 0s fsyncs every write to the WAL. - # Values in the range of 0-100ms are recommended for non-SSD disks. - # wal-fsync-delay = "0s" - - - # The type of shard index to use for new shards. The default is an in-memory index that is - # recreated at startup. A value of "tsi1" will use a disk based index that supports higher - # cardinality datasets. - # index-version = "inmem" - - # Trace logging provides more verbose output around the tsm engine. Turning - # this on can provide more useful output for debugging tsm engine issues. - # trace-logging-enabled = false - - # Whether queries should be logged before execution. Very useful for troubleshooting, but will - # log any sensitive data contained within a query. - # query-log-enabled = true - - # Validates incoming writes to ensure keys only have valid unicode characters. - # This setting will incur a small overhead because every key must be checked. - # validate-keys = false - - # Settings for the TSM engine - - # CacheMaxMemorySize is the maximum size a shard's cache can - # reach before it starts rejecting writes. - # Valid size suffixes are k, m, or g (case insensitive, 1024 = 1k). - # Values without a size suffix are in bytes. - # cache-max-memory-size = "1g" - - # CacheSnapshotMemorySize is the size at which the engine will - # snapshot the cache and write it to a TSM file, freeing up memory - # Valid size suffixes are k, m, or g (case insensitive, 1024 = 1k). - # Values without a size suffix are in bytes. - # cache-snapshot-memory-size = "25m" - - # CacheSnapshotWriteColdDuration is the length of time at - # which the engine will snapshot the cache and write it to - # a new TSM file if the shard hasn't received writes or deletes - # cache-snapshot-write-cold-duration = "10m" - - # CompactFullWriteColdDuration is the duration at which the engine - # will compact all TSM files in a shard if it hasn't received a - # write or delete - # compact-full-write-cold-duration = "4h" - - # The maximum number of concurrent full and level compactions that can run at one time. A - # value of 0 results in 50% of runtime.GOMAXPROCS(0) used at runtime. Any number greater - # than 0 limits compactions to that value. This setting does not apply - # to cache snapshotting. - # max-concurrent-compactions = 0 - - # CompactThroughput is the rate limit in bytes per second that we - # will allow TSM compactions to write to disk. Note that short bursts are allowed - # to happen at a possibly larger value, set by CompactThroughputBurst - # compact-throughput = "48m" - - # CompactThroughputBurst is the rate limit in bytes per second that we - # will allow TSM compactions to write to disk. - # compact-throughput-burst = "48m" - - # If true, then the mmap advise value MADV_WILLNEED will be provided to the kernel with respect to - # TSM files. This setting has been found to be problematic on some kernels, and defaults to off. - # It might help users who have slow disks in some cases. - # tsm-use-madv-willneed = false - - # Settings for the inmem index - - # The maximum series allowed per database before writes are dropped. This limit can prevent - # high cardinality issues at the database level. This limit can be disabled by setting it to - # 0. - # max-series-per-database = 1000000 - - # The maximum number of tag values per tag that are allowed before writes are dropped. This limit - # can prevent high cardinality tag values from being written to a measurement. This limit can be - # disabled by setting it to 0. - # max-values-per-tag = 100000 - - # Settings for the tsi1 index - - # The threshold, in bytes, when an index write-ahead log file will compact - # into an index file. Lower sizes will cause log files to be compacted more - # quickly and result in lower heap usage at the expense of write throughput. - # Higher sizes will be compacted less frequently, store more series in-memory, - # and provide higher write throughput. - # Valid size suffixes are k, m, or g (case insensitive, 1024 = 1k). - # Values without a size suffix are in bytes. - # max-index-log-file-size = "1m" - - # The size of the internal cache used in the TSI index to store previously - # calculated series results. Cached results will be returned quickly from the cache rather - # than needing to be recalculated when a subsequent query with a matching tag key/value - # predicate is executed. Setting this value to 0 will disable the cache, which may - # lead to query performance issues. - # This value should only be increased if it is known that the set of regularly used - # tag key/value predicates across all measurements for a database is larger than 100. An - # increase in cache size may lead to an increase in heap usage. - series-id-set-cache-size = 100 - -### -### [coordinator] -### -### Controls the clustering service configuration. -### - -[coordinator] - # The default time a write request will wait until a "timeout" error is returned to the caller. - # write-timeout = "10s" - - # The maximum number of concurrent queries allowed to be executing at one time. If a query is - # executed and exceeds this limit, an error is returned to the caller. This limit can be disabled - # by setting it to 0. - # max-concurrent-queries = 0 - - # The maximum time a query will is allowed to execute before being killed by the system. This limit - # can help prevent run away queries. Setting the value to 0 disables the limit. - # query-timeout = "0s" - - # The time threshold when a query will be logged as a slow query. This limit can be set to help - # discover slow or resource intensive queries. Setting the value to 0 disables the slow query logging. - # log-queries-after = "0s" - - # The maximum number of points a SELECT can process. A value of 0 will make - # the maximum point count unlimited. This will only be checked every second so queries will not - # be aborted immediately when hitting the limit. - # max-select-point = 0 - - # The maximum number of series a SELECT can run. A value of 0 will make the maximum series - # count unlimited. - # max-select-series = 0 - - # The maximum number of group by time bucket a SELECT can create. A value of zero will max the maximum - # number of buckets unlimited. - # max-select-buckets = 0 - -### -### [retention] -### -### Controls the enforcement of retention policies for evicting old data. -### - -[retention] - # Determines whether retention policy enforcement enabled. - # enabled = true - - # The interval of time when retention policy enforcement checks run. - # check-interval = "30m" - -### -### [shard-precreation] -### -### Controls the precreation of shards, so they are available before data arrives. -### Only shards that, after creation, will have both a start- and end-time in the -### future, will ever be created. Shards are never precreated that would be wholly -### or partially in the past. - -[shard-precreation] - # Determines whether shard pre-creation service is enabled. - # enabled = true - - # The interval of time when the check to pre-create new shards runs. - # check-interval = "10m" - - # The default period ahead of the endtime of a shard group that its successor - # group is created. - # advance-period = "30m" - -### -### Controls the system self-monitoring, statistics and diagnostics. -### -### The internal database for monitoring data is created automatically if -### if it does not already exist. The target retention within this database -### is called 'monitor' and is also created with a retention period of 7 days -### and a replication factor of 1, if it does not exist. In all cases the -### this retention policy is configured as the default for the database. - -[monitor] - # Whether to record statistics internally. - # store-enabled = true - - # The destination database for recorded statistics - # store-database = "_internal" - - # The interval at which to record statistics - # store-interval = "10s" - -### -### [http] -### -### Controls how the HTTP endpoints are configured. These are the primary -### mechanism for getting data into and out of InfluxDB. -### - -[http] - # Determines whether HTTP endpoint is enabled. - # enabled = true - - # Determines whether the Flux query endpoint is enabled. - # flux-enabled = false - - # Determines whether the Flux query logging is enabled. - # flux-log-enabled = false - - # The bind address used by the HTTP service. - # bind-address = ":8086" - - # Determines whether user authentication is enabled over HTTP/HTTPS. - # auth-enabled = false - - # The default realm sent back when issuing a basic auth challenge. - # realm = "InfluxDB" - - # Determines whether HTTP request logging is enabled. - # log-enabled = true - - # Determines whether the HTTP write request logs should be suppressed when the log is enabled. - # suppress-write-log = false - - # When HTTP request logging is enabled, this option specifies the path where - # log entries should be written. If unspecified, the default is to write to stderr, which - # intermingles HTTP logs with internal InfluxDB logging. - # - # If influxd is unable to access the specified path, it will log an error and fall back to writing - # the request log to stderr. - # access-log-path = "" - - # Filters which requests should be logged. Each filter is of the pattern NNN, NNX, or NXX where N is - # a number and X is a wildcard for any number. To filter all 5xx responses, use the string 5xx. - # If multiple filters are used, then only one has to match. The default is to have no filters which - # will cause every request to be printed. - # access-log-status-filters = [] - - # Determines whether detailed write logging is enabled. - # write-tracing = false - - # Determines whether the pprof endpoint is enabled. This endpoint is used for - # troubleshooting and monitoring. - # pprof-enabled = true - - # Enables authentication on pprof endpoints. Users will need admin permissions - # to access the pprof endpoints when this setting is enabled. This setting has - # no effect if either auth-enabled or pprof-enabled are set to false. - # pprof-auth-enabled = false - - # Enables a pprof endpoint that binds to localhost:6060 immediately on startup. - # This is only needed to debug startup issues. - # debug-pprof-enabled = false - - # Enables authentication on the /ping, /metrics, and deprecated /status - # endpoints. This setting has no effect if auth-enabled is set to false. - # ping-auth-enabled = false - - # Determines whether HTTPS is enabled. - # https-enabled = false - - # The SSL certificate to use when HTTPS is enabled. - # https-certificate = "/config/ssl/influxdb.pem" - - # Use a separate private key location. - # https-private-key = "" - - # The JWT auth shared secret to validate requests using JSON web tokens. - # shared-secret = "" - - # The default chunk size for result sets that should be chunked. - # max-row-limit = 0 - - # The maximum number of HTTP connections that may be open at once. New connections that - # would exceed this limit are dropped. Setting this value to 0 disables the limit. - # max-connection-limit = 0 - - # Enable http service over unix domain socket - # unix-socket-enabled = false - - # The path of the unix domain socket. - # bind-socket = "/var/run/influxdb.sock" - - # The maximum size of a client request body, in bytes. Setting this value to 0 disables the limit. - # max-body-size = 25000000 - - # The maximum number of writes processed concurrently. - # Setting this to 0 disables the limit. - # max-concurrent-write-limit = 0 - - # The maximum number of writes queued for processing. - # Setting this to 0 disables the limit. - # max-enqueued-write-limit = 0 - - # The maximum duration for a write to wait in the queue to be processed. - # Setting this to 0 or setting max-concurrent-write-limit to 0 disables the limit. - # enqueued-write-timeout = 0 - -### -### [logging] -### -### Controls how the logger emits logs to the output. -### - -[logging] - # Determines which log encoder to use for logs. Available options - # are auto, logfmt, and json. auto will use a more a more user-friendly - # output format if the output terminal is a TTY, but the format is not as - # easily machine-readable. When the output is a non-TTY, auto will use - # logfmt. - # format = "auto" - - # Determines which level of logs will be emitted. The available levels - # are error, warn, info, and debug. Logs that are equal to or above the - # specified level will be emitted. - # level = "info" - - # Suppresses the logo output that is printed when the program is started. - # The logo is always suppressed if STDOUT is not a TTY. - # suppress-logo = false - -### -### [subscriber] -### -### Controls the subscriptions, which can be used to fork a copy of all data -### received by the InfluxDB host. -### - -[subscriber] - # Determines whether the subscriber service is enabled. - # enabled = true - - # The default timeout for HTTP writes to subscribers. - # http-timeout = "30s" - - # Allows insecure HTTPS connections to subscribers. This is useful when testing with self- - # signed certificates. - # insecure-skip-verify = false - - # The path to the PEM encoded CA certs file. If the empty string, the default system certs will be used - # ca-certs = "" - - # The number of writer goroutines processing the write channel. - # write-concurrency = 40 - - # The number of in-flight writes buffered in the write channel. - # write-buffer-size = 1000 - - -### -### [[graphite]] -### -### Controls one or many listeners for Graphite data. -### - -[[graphite]] - # Determines whether the graphite endpoint is enabled. - # enabled = false - # database = "graphite" - # retention-policy = "" - # bind-address = ":2003" - # protocol = "tcp" - # consistency-level = "one" - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Batching - # will buffer points in memory if you have many coming in. - - # Flush if this many points get buffered - # batch-size = 5000 - - # number of batches that may be pending in memory - # batch-pending = 10 - - # Flush at least this often even if we haven't hit buffer limit - # batch-timeout = "1s" - - # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max. - # udp-read-buffer = 0 - - ### This string joins multiple matching 'measurement' values providing more control over the final measurement name. - # separator = "." - - ### Default tags that will be added to all metrics. These can be overridden at the template level - ### or by tags extracted from metric - # tags = ["region=us-east", "zone=1c"] - - ### Each template line requires a template pattern. It can have an optional - ### filter before the template and separated by spaces. It can also have optional extra - ### tags following the template. Multiple tags should be separated by commas and no spaces - ### similar to the line protocol format. There can be only one default template. - # templates = [ - # "*.app env.service.resource.measurement", - # # Default template - # "server.*", - # ] - -### -### [collectd] -### -### Controls one or many listeners for collectd data. -### - -[[collectd]] - # enabled = false - # bind-address = ":25826" - # database = "collectd" - # retention-policy = "" - # - # The collectd service supports either scanning a directory for multiple types - # db files, or specifying a single db file. - # typesdb = "/usr/local/share/collectd" - # - # security-level = "none" - # auth-file = "/etc/collectd/auth_file" - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Batching - # will buffer points in memory if you have many coming in. - - # Flush if this many points get buffered - # batch-size = 5000 - - # Number of batches that may be pending in memory - # batch-pending = 10 - - # Flush at least this often even if we haven't hit buffer limit - # batch-timeout = "10s" - - # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max. - # read-buffer = 0 - - # Multi-value plugins can be handled two ways. - # "split" will parse and store the multi-value plugin data into separate measurements - # "join" will parse and store the multi-value plugin as a single multi-value measurement. - # "split" is the default behavior for backward compatibility with previous versions of influxdb. - # parse-multivalue-plugin = "split" -### -### [opentsdb] -### -### Controls one or many listeners for OpenTSDB data. -### - -[[opentsdb]] - # enabled = false - # bind-address = ":4242" - # database = "opentsdb" - # retention-policy = "" - # consistency-level = "one" - # tls-enabled = false - # certificate= "/config/ssl/influxdb.pem" - - # Log an error for every malformed point. - # log-point-errors = true - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Only points - # metrics received over the telnet protocol undergo batching. - - # Flush if this many points get buffered - # batch-size = 1000 - - # Number of batches that may be pending in memory - # batch-pending = 5 - - # Flush at least this often even if we haven't hit buffer limit - # batch-timeout = "1s" - -### -### [[udp]] -### -### Controls the listeners for InfluxDB line protocol data via UDP. -### - -[[udp]] - # enabled = false - # bind-address = ":8089" - # database = "udp" - # retention-policy = "" - - # InfluxDB precision for timestamps on received points ("" or "n", "u", "ms", "s", "m", "h") - # precision = "" - - # These next lines control how batching works. You should have this enabled - # otherwise you could get dropped metrics or poor performance. Batching - # will buffer points in memory if you have many coming in. - - # Flush if this many points get buffered - # batch-size = 5000 - - # Number of batches that may be pending in memory - # batch-pending = 10 - - # Will flush at least this often even if we haven't hit buffer limit - # batch-timeout = "1s" - - # UDP Read buffer size, 0 means OS default. UDP listener will fail if set above OS max. - # read-buffer = 0 - -### -### [continuous_queries] -### -### Controls how continuous queries are run within InfluxDB. -### - -[continuous_queries] - # Determines whether the continuous query service is enabled. - # enabled = true - - # Controls whether queries are logged when executed by the CQ service. - # log-enabled = true - - # Controls whether queries are logged to the self-monitoring data store. - # query-stats-enabled = false - - # interval for how often continuous queries will be checked if they need to run - # run-interval = "1s" - -### -### [tls] -### -### Global configuration settings for TLS in InfluxDB. -### - -[tls] - # Determines the available set of cipher suites. See https://golang.org/pkg/crypto/tls/#pkg-constants - # for a list of available ciphers, which depends on the version of Go (use the query - # SHOW DIAGNOSTICS to see the version of Go used to build InfluxDB). If not specified, uses - # the default settings from Go's crypto/tls package. - # ciphers = [ - # "TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305", - # "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", - # ] - - # Minimum version of the tls protocol that will be negotiated. If not specified, uses the - # default settings from Go's crypto/tls package. - # min-version = "tls1.2" - - # Maximum version of the tls protocol that will be negotiated. If not specified, uses the - # default settings from Go's crypto/tls package. - # max-version = "tls1.2" diff --git a/archive/jailman/blueprints/influxdb/install.sh b/archive/jailman/blueprints/influxdb/install.sh deleted file mode 100755 index 0030e9f1168..00000000000 --- a/archive/jailman/blueprints/influxdb/install.sh +++ /dev/null @@ -1,31 +0,0 @@ -#!/usr/local/bin/bash -# This script installs the current release of InfluxDB - -##### -# -# Init and Mounts -# -##### - -# Initialise variables -# shellcheck disable=SC2154 -JAIL_IP="jail_${1}_ip4_addr" -JAIL_IP="${!JAIL_IP%/*}" -INCLUDES_PATH="${SCRIPT_DIR}/blueprints/influxdb/includes" - -# Mount and configure proper configuration location -# shellcheck disable=SC2154 -cp -rf "${INCLUDES_PATH}/influxd.conf" "/mnt/${global_dataset_config}/${1}/influxd.conf" -iocage exec "${1}" mkdir -p /config/db/data /config/db/meta /config/db/wal -iocage exec "${1}" chown -R influxd:influxd /config/db -iocage exec "${1}" sysrc influxd_conf="/config/influxd.conf" -iocage exec "${1}" sysrc influxd_enable="YES" - -# Start influxdb and wait for it to startup -iocage exec "${1}" service influxd start -sleep 15 - -# Done! -echo "Installation complete!" -echo "You may connect InfluxDB plugins to the InfluxDB jail at http://${JAIL_IP}:8086." -echo "" diff --git a/archive/jailman/blueprints/influxdb/readme.md b/archive/jailman/blueprints/influxdb/readme.md deleted file mode 100644 index 0711fe16bef..00000000000 --- a/archive/jailman/blueprints/influxdb/readme.md +++ /dev/null @@ -1,266 +0,0 @@ -# InfluxDB - -## Original README from the influxdb github: - -https://github.com/influxdata/influxdb - -# InfluxDB [![CircleCI](https://circleci.com/gh/influxdata/influxdb.svg?style=svg)](https://circleci.com/gh/influxdata/influxdb) - -[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://www.influxdata.com/slack) - -InfluxDB is an open source time series platform. This includes APIs for storing and querying data, processing it in the background for ETL or monitoring and alerting purposes, user dashboards, and visualizing and exploring the data and more. The master branch on this repo now represents the latest InfluxDB, which now includes functionality for Kapacitor (background processing) and Chronograf (the UI) all in a single binary. - -The list of InfluxDB Client Libraries that are compatible with the latest version can be found in [our documentation](https://v2.docs.influxdata.com/v2.0/reference/api/client-libraries/). - -If you are looking for the 1.x line of releases, there are branches for each minor version as well as a `master-1.x` branch that will contain the code for the next 1.x release. The master-1.x [working branch is here](https://github.com/influxdata/influxdb/tree/master-1.x). The [InfluxDB 1.x Go Client can be found here](https://github.com/influxdata/influxdb1-client). - -## State of the Project - -The latest InfluxDB 1.x is the stable release and recommended for production use. The InfluxDB that is on the master branch is currently in the beta stage. This means that it is still **NOT** recommended for production usage. There may be breaking API changes, breaking changes in the [Flux language](https://github.com/influxdata/flux), changes in the underlying storage format that will require you to delete all your data, and significant changes to the UI. The beta is intended for feature exploration and gathering feedback on the available feature set. It **SHOULD NOT** be used for performance testing, benchmarks, or other stress tests. - -Additional features will arrive during the beta period until we reach general availability (GA). We will be cutting versioned releases at least every two weeks starting in the first release. There will also be nightly builds based off the latest code in master. - -Once we close on the final feature set of what will be in the first GA release of InfluxDB in the 2.x line, we will move into the release candidate (RC) phase. At that point, we do not expect there to be breaking changes to the API or Flux language. We may still need to make a breaking change prior to GA due to some unforseen circumstance, but it would need to be extremely important and will be clearly communicated via the changelog and all available channels. - -Our current plans are to release RCs suitable for production usage, but we will re-evaluate in consultation with the community as the cycle progresses. During the RC period, we will focus on feedback from users, bug fixes, performance, and additive features (where time permits). - -### What you can expect in the Beta and RC Phases - -#### Beta - -**Releases every two weeks or as needed** - -Planned additions include: - -- Compatibility layer with 1.x including: 1.x HTTP Write API and HTTP Read API support for InfluxQL -- Import Bulk Data from 1.x - convert TSM from 1.x to 2.x -- Performance tuning, stability improvements, and fine tuning based on community feedback. -- Finalization of supported client libraries starting with JavaScript and Go. - -#### RC - -**As needed** - -Planned activities include: - -- Performance tuning, stability improvements, and fine-tuning based on community feedback. - -### What is **NOT** planned? - -- Migration of users/security permissions from InfluxDB v1.x to 2.x. ACTION REQUIRED: Re-establish users and permissions within the new unified security model which now spans the underlying database and user interface. -- Migration of Continuous Queries. ACTION REQUIRED: These will need to be re-implemented as Flux tasks. -- Direct support by InfluxDB for CollectD, StatsD, Graphite, or UDP. ACTION REQUIRED: Leverage Telegraf 1.9+ along with the InfluxDB v2.0 output plugin to translate these protocols/formats. - -## Installing from Source - -We have nightly and weekly versioned Docker images, Debian packages, RPM packages, and tarballs of InfluxDB available at the [InfluxData downloads page](https://portal.influxdata.com/downloads/). - -## Building From Source - -This project requires Go 1.13 and Go module support. - -Set `GO111MODULE=on` or build the project outside of your `GOPATH` for it to succeed. - -The project also requires a recent stable version of Rust. We recommend using [rustup](https://rustup.rs/) to install Rust. - -If you are getting an `error loading module requirements` error with `bzr executable file not found in $PATH”` on `make`, then you need to ensure you have `bazaar`, `protobuf`, and `yarn` installed. - -- OSX: `brew install bazaar yarn` -- Linux (Arch): `pacman -S bzr protobuf yarn` -- Linux (Ubuntu): `apt install bzr protobuf-compiler yarnpkg` - -**NB:** For RedHat, there are some extra steps: - -1. You must enable the [EPEL](https://fedoraproject.org/wiki/EPEL) -2. You must add the `yarn` [repository](https://yarnpkg.com/lang/en/docs/install/#centos-stable) - -For information about modules, please refer to the [wiki](https://github.com/golang/go/wiki/Modules). - -A successful `make` run results in two binaries, with platform-dependent paths: - -``` -$ make -... -env GO111MODULE=on go build -tags 'assets ' -o bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influx ./cmd/influx -env GO111MODULE=on go build -tags 'assets ' -o bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influxd ./cmd/influxd -``` - -`influxd` is the InfluxDB service. -`influx` is the CLI management tool. - -Start the service. -Logs to stdout by default: - -``` -$ bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influxd -``` - -## Getting Started - -For a complete getting started guide, please see our full [online documentation site](https://v2.docs.influxdata.com/v2.0/). - -To write and query data or use the API in any way, you'll need to first create a user, credentials, organization and bucket. -Everything in InfluxDB is organized under a concept of an organization. The API is designed to be multi-tenant. -Buckets represent where you store time series data. -They're synonymous with what was previously in InfluxDB 1.x a database and retention policy. - -The simplest way to get set up is to point your browser to [http://localhost:9999](http://localhost:9999) and go through the prompts. - -**Note**: Port 9999 will be used during the beta phases of development of InfluxDB v2.0. -This should allow a v2.0-beta instance to be run alongside a v1.x instance without interfering on port 8086. -InfluxDB will thereafter continue to use 8086. - -You can also get set up from the CLI using the subcommands `influx user`, `influx auth`, `influx org` and `influx bucket`, -or do it all in one breath with `influx setup`: - -``` -$ bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influx setup -Welcome to InfluxDB 2.0! -Please type your primary username: marty - -Please type your password: - -Please type your password again: - -Please type your primary organization name.: InfluxData - -Please type your primary bucket name.: telegraf - -Please type your retention period in hours. -Or press ENTER for infinite.: 72 - - -You have entered: - Username: marty - Organization: InfluxData - Bucket: telegraf - Retention Period: 72 hrs -Confirm? (y/n): y - -UserID Username Organization Bucket -033a3f2c5ccaa000 marty InfluxData Telegraf -Your token has been stored in /Users/marty/.influxdbv2/credentials -``` - -You may get into a development loop where `influx setup` becomes tedious. -Some added flags can help: - -``` -$ bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influx setup --username marty --password F1uxKapacit0r85 --org InfluxData --bucket telegraf --retention 168 --token where-were-going-we-dont-need-roads --force -``` - -`~/.influxdbv2/credentials` contains your auth token. -Most `influx` commands read the token from this file path by default. - -You may need the organization ID and bucket ID later: - -``` -$ influx org find -ID Name -033a3f2c708aa000 InfluxData -``` - -``` -$ influx bucket find -ID Name Retention Organization OrganizationID -033a3f2c710aa000 telegraf 72h0m0s InfluxData 033a3f2c708aa000 -``` - -Write to measurement `m`, with tag `v=2`, in bucket `telegraf`, which belongs to organization `InfluxData`: - -``` -$ bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influx write --org InfluxData --bucket telegraf --precision s "m v=2 $(date +%s)" -``` - -Write the same point using `curl`: - -``` -curl --header "Authorization: Token $(cat ~/.influxdbv2/credentials)" --data-raw "m v=2 $(date +%s)" "http://localhost:9999/api/v2/write?org=InfluxData&bucket=telegraf&precision=s" -``` - -Read that back with a simple Flux query: - -``` -$ bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influx query -o InfluxData 'from(bucket:"telegraf") |> range(start:-1h)' -Result: _result -Table: keys: [_start, _stop, _field, _measurement] - _start:time _stop:time _field:string _measurement:string _time:time _value:float ------------------------------- ------------------------------ ---------------------- ---------------------- ------------------------------ ---------------------------- -2019-12-30T22:19:39.043918000Z 2019-12-30T23:19:39.043918000Z v m 2019-12-30T23:17:02.000000000Z 2 -``` - -Use the fancy REPL: - -``` -$ bin/$(uname -s | tr '[:upper:]' '[:lower:]')/influx repl -o InfluxData -> from(bucket:"telegraf") |> range(start:-1h) -Result: _result -Table: keys: [_start, _stop, _field, _measurement] - _start:time _stop:time _field:string _measurement:string _time:time _value:float ------------------------------- ------------------------------ ---------------------- ---------------------- ------------------------------ ---------------------------- -2019-12-30T22:22:44.776351000Z 2019-12-30T23:22:44.776351000Z v m 2019-12-30T23:17:02.000000000Z 2 -> -``` - -## Introducing Flux - -Flux is an MIT-licensed data scripting language (previously named IFQL) used for querying time series data from InfluxDB. The source for Flux is [available on GitHub](https://github.com/influxdata/flux). Learn more about Flux from [CTO Paul Dix's presentation](https://speakerdeck.com/pauldix/flux-number-fluxlang-a-new-time-series-data-scripting-language). - -## Contributing to the Project - -InfluxDB is an [MIT licensed](LICENSE) open source project and we love our community. The fastest way to get something fixed is to open a PR. Check out our [contributing](CONTRIBUTING.md) guide if you're interested in helping out. Also, join us on our [Community Slack Workspace](https://influxdata.com/slack) if you have questions or comments for our engineering teams. - -## CI and Static Analysis - -### CI - -All pull requests will run through CI, which is currently hosted by Circle. -Community contributors should be able to see the outcome of this process by looking at the checks on their PR. -Please fix any issues to ensure a prompt review from members of the team. - -The InfluxDB project is used internally in a number of proprietary InfluxData products, and as such, PRs and changes need to be tested internally. -This can take some time, and is not really visible to community contributors. - -### Static Analysis - -This project uses the following static analysis tools. -Failure during the running of any of these tools results in a failed build. -Generally, code must be adjusted to satisfy these tools, though there are exceptions. - -- [go vet](https://golang.org/cmd/vet/) checks for Go code that should be considered incorrect. -- [go fmt](https://golang.org/cmd/gofmt/) checks that Go code is correctly formatted. -- [go mod tidy](https://tip.golang.org/cmd/go/#hdr-Add_missing_and_remove_unused_modules) ensures that the source code and go.mod agree. -- [staticcheck](http://next.staticcheck.io/docs/) checks for things like: unused code, code that can be simplified, code that is incorrect and code that will have performance issues. - -### staticcheck - -If your PR fails `staticcheck` it is easy to dig into why it failed, and also to fix the problem. -First, take a look at the error message in Circle under the `staticcheck` build section, e.g., - -``` -tsdb/tsm1/encoding.gen.go:1445:24: func BooleanValues.assertOrdered is unused (U1000) -tsdb/tsm1/encoding.go:172:7: receiver name should not be an underscore, omit the name if it is unused (ST1006) -``` - -Next, go and take a [look here](http://next.staticcheck.io/docs/checks) for some clarification on the error code that you have received, e.g., `U1000`. -The docs will tell you what's wrong, and often what you need to do to fix the issue. - -#### Generated Code - -Sometimes generated code will contain unused code or occasionally that will fail a different check. -`staticcheck` allows for [entire files](http://next.staticcheck.io/docs/#ignoring-problems) to be ignored, though it's not ideal. -A linter directive, in the form of a comment, must be placed within the generated file. -This is problematic because it will be erased if the file is re-generated. -Until a better solution comes about, below is the list of generated files that need an ignores comment. -If you re-generate a file and find that `staticcheck` has failed, please see this list below for what you need to put back: - -| File | Comment | -| :--------------------: | :--------------------------------------------------------------: | -| query/promql/promql.go | //lint:file-ignore SA6001 Ignore all unused code, it's generated | - -#### End-to-End Tests - -CI also runs end-to-end tests. These test the integration between the influx server the ui. You can run them locally in two steps: - -- Start the server in "testing mode" by running `make run-e2e`. -- Run the tests with `make e2e`. diff --git a/archive/jailman/blueprints/influxdb/update.sh b/archive/jailman/blueprints/influxdb/update.sh deleted file mode 100755 index 3a1fd682164..00000000000 --- a/archive/jailman/blueprints/influxdb/update.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for influxdb - -iocage exec "$1" service influxd stop -# InfluxDB is updated during PKG update, this file is mostly just a placeholder -iocage exec "$1" service influxd restart diff --git a/archive/jailman/blueprints/jackett/config.yml b/archive/jailman/blueprints/jackett/config.yml deleted file mode 100644 index 7b706ad165f..00000000000 --- a/archive/jailman/blueprints/jackett/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - jackett: - pkgs: mono diff --git a/archive/jailman/blueprints/jackett/includes/jackett.rc b/archive/jailman/blueprints/jackett/includes/jackett.rc deleted file mode 100644 index f8e899a28de..00000000000 --- a/archive/jailman/blueprints/jackett/includes/jackett.rc +++ /dev/null @@ -1,50 +0,0 @@ -#!/bin/sh - -# $FreeBSD$ -# -# PROVIDE: jackett -# REQUIRE: LOGIN -# KEYWORD: shutdown -# -# Add the following lines to /etc/rc.conf.local or /etc/rc.conf -# to enable this service: -# -# jackett_enable: Set to YES to enable jackett -# Default: NO -# jackett_user: The user account used to run the jackett daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run as root. -# Default: media -# jackett_group: The group account used to run the jackett daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run with group wheel. -# Default: media -# jackett_data_dir: Directory where jackett configuration -# data is stored. -# Default: /var/db/jackett - -. /etc/rc.subr -name=jackett -rcvar=${name}_enable -load_rc_config $name - -: ${jackett_enable:="NO"} -: ${jackett_user:="jackett"} -: ${jackett_group:="jackett"} -: ${jackett_data_dir:="/config"} - -command="/usr/sbin/daemon" -procname="/usr/local/bin/mono" -command_args="-p ${jackett_data_dir}/jackett.pid -f ${procname} /usr/local/share/Jackett/JackettConsole.exe -d ${jackett_data_dir}" - -start_precmd=jackett_precmd -jackett_precmd() { -export USER=${jackett_user} -if [ ! -d ${jackett_data_dir} ]; then -install -d -o ${jackett_user} -g ${jackett_group} ${jackett_data_dir} -fi - -export XDG_CONFIG_HOME=${jackett_data_dir} -} - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/jackett/install.sh b/archive/jailman/blueprints/jackett/install.sh deleted file mode 100755 index 51f22fc5854..00000000000 --- a/archive/jailman/blueprints/jackett/install.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for jackett - -iocage exec "$1" "fetch https://github.com/Jackett/Jackett/releases/download/v0.16.546/Jackett.Binaries.Mono.tar.gz -o /usr/local/share" -iocage exec "$1" "tar -xzvf /usr/local/share/Jackett.Binaries.Mono.tar.gz -C /usr/local/share" -iocage exec "$1" rm /usr/local/share/Jackett.Binaries.Mono.tar.gz -iocage exec "$1" "pw user add jackett -c jackett -u 818 -d /nonexistent -s /usr/bin/nologin" -iocage exec "$1" chown -R jackett:jackett /usr/local/share/Jackett /config -iocage exec "$1" mkdir /usr/local/etc/rc.d -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/jackett/includes/jackett.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/jackett -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/jackett -iocage exec "$1" sysrc "jackett_enable=YES" -iocage exec "$1" service jackett restart diff --git a/archive/jailman/blueprints/jackett/readme.md b/archive/jailman/blueprints/jackett/readme.md deleted file mode 100644 index ab0779f5ad4..00000000000 --- a/archive/jailman/blueprints/jackett/readme.md +++ /dev/null @@ -1,7 +0,0 @@ -## jackett - -Jackett is tool designed to combine and search multiple bittorrent trackers like a proxy. - -### Post-install - -Currently there are not relevant post-install steps, other than your own personal preferences for setting up Jacket. diff --git a/archive/jailman/blueprints/jackett/update.sh b/archive/jailman/blueprints/jackett/update.sh deleted file mode 100755 index f0c700dc764..00000000000 --- a/archive/jailman/blueprints/jackett/update.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for jackett - -iocage exec "$1" service jackett stop -#TODO insert code to update jacket itself here -iocage exec "$1" chown -R jackett:jackett /usr/local/share/Jackett /config -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/jackett/includes/jackett.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/jackett -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/jackett -iocage exec "$1" service jackett restart diff --git a/archive/jailman/blueprints/kms/config.yml b/archive/jailman/blueprints/kms/config.yml deleted file mode 100644 index d146e993801..00000000000 --- a/archive/jailman/blueprints/kms/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - kms: - pkgs: bash py37-tkinter py37-pip py37-sqlite3 git diff --git a/archive/jailman/blueprints/kms/includes/Activate_Office_2019_Pro.bat b/archive/jailman/blueprints/kms/includes/Activate_Office_2019_Pro.bat deleted file mode 100644 index c805d64069a..00000000000 --- a/archive/jailman/blueprints/kms/includes/Activate_Office_2019_Pro.bat +++ /dev/null @@ -1,7 +0,0 @@ -cd C:\Program Files\Microsoft Office\Office16 -cscript ospp.vbs /dstatus -cscript ospp.vbs /inpkey:VQ9DP-NVHPH-T9HJC-J9PDT-KTQRG -cscript ospp.vbs /sethst:192.168.10.43 -cscript ospp.vbs /setprt:1688 -cscript ospp.vbs /act -cscript ospp.vbs /dstatus diff --git a/archive/jailman/blueprints/kms/includes/Activate_Windows_10_Pro.bat b/archive/jailman/blueprints/kms/includes/Activate_Windows_10_Pro.bat deleted file mode 100644 index ed009038385..00000000000 --- a/archive/jailman/blueprints/kms/includes/Activate_Windows_10_Pro.bat +++ /dev/null @@ -1,4 +0,0 @@ -cscript slmgr.vbs /upk -cscript slmgr.vbs /ipk W269N-WFGWX-YVC9B-4J6C9-T83GX -cscript slmgr.vbs /skms 192.168.10.43:1688 -cscript slmgr.vbs /ato diff --git a/archive/jailman/blueprints/kms/includes/Activate_Windows_Server_2019_Standard.bat b/archive/jailman/blueprints/kms/includes/Activate_Windows_Server_2019_Standard.bat deleted file mode 100644 index 2d486f6aaaa..00000000000 --- a/archive/jailman/blueprints/kms/includes/Activate_Windows_Server_2019_Standard.bat +++ /dev/null @@ -1,6 +0,0 @@ -%windir%\system32\DISM.exe /Online /Get-TargetEditions -%windir%\system32\DISM /online /Set-Edition:ServerStandard /ProductKey:N69G4-B89J2-4G8F4-WWYCC-J464C /AcceptEula -cscript %windir%\system32\slmgr.vbs /upk -cscript %windir%\system32\slmgr.vbs /ipk N69G4-B89J2-4G8F4-WWYCC-J464C -cscript %windir%\system32\slmgr.vbs /skms 192.168.10.43:1688 -cscript %windir%\system32\slmgr.vbs /ato diff --git a/archive/jailman/blueprints/kms/includes/Readme.md b/archive/jailman/blueprints/kms/includes/Readme.md deleted file mode 100644 index c1915890f4d..00000000000 --- a/archive/jailman/blueprints/kms/includes/Readme.md +++ /dev/null @@ -1,11 +0,0 @@ -## Office 2019 pro - -All CMD commands are expected to be run from an elevated (administrator) command prompt (cmd) - -1. Download office 2019 deployment tool -2. Extract the tool -3. Copy Office-2019-Pro-VLK-Config.xml to folder you extracted the tool in -4. CMD: cd _Path to extracted tool and xml_ -5. CMD: setup /configure Office-2019-Pro-VLK-Config.xml -6. CMD: cd _path to this config file_ -7. CMD: Activate_Office_2019_Pro.bat diff --git a/archive/jailman/blueprints/kms/includes/Setup_Office_2019_Pro.txt b/archive/jailman/blueprints/kms/includes/Setup_Office_2019_Pro.txt deleted file mode 100644 index fb9ac95b44e..00000000000 --- a/archive/jailman/blueprints/kms/includes/Setup_Office_2019_Pro.txt +++ /dev/null @@ -1,7 +0,0 @@ -cd C:\Program Files\Microsoft Office\Office16 -cscript ospp.vbs /dstatus -cscript ospp.vbs /inpkey:NMMKJ-6RK4F-KMJVX-8D9MJ-6MWKP -cscript ospp.vbs /sethst:192.168.10.43 -cscript ospp.vbs /setprt:1688 -cscript ospp.vbs /act -cscript ospp.vbs /dstatus diff --git a/archive/jailman/blueprints/kms/includes/py_kms.rc b/archive/jailman/blueprints/kms/includes/py_kms.rc deleted file mode 100644 index 2f56c187cb7..00000000000 --- a/archive/jailman/blueprints/kms/includes/py_kms.rc +++ /dev/null @@ -1,38 +0,0 @@ -#!/bin/sh - -# $FreeBSD$ -# -# PROVIDE: py_kms -# REQUIRE: LOGIN -# KEYWORD: shutdown -# -# Add the following lines to /etc/rc.conf.local or /etc/rc.conf -# to enable this service: -# -# py-kms_enable: Set to YES to enable py-kms -# Default: NO -# py-kms_user: The user account used to run the py-kms daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run as root. -# Default: media -# py-kms_group: The group account used to run the py-kms daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run with group wheel. -# Default: media -# py-kms_data_dir: Directory where py-kms configuration -# data is stored. - -. /etc/rc.subr -name=py_kms -rcvar=${name}_enable -load_rc_config $name - -: ${py_kms_enable:="NO"} -: ${py_kms_user:="kms"} -: ${py_kms_group:="kms"} -: ${py_kms_data_dir:="/config"} - -command="/usr/local/bin/python3.7" -command_args="/usr/local/share/py-kms/pykms_Server.py 0.0.0.0 1688 -F ${py_kms_data_dir}/py-kms.log etrigan start --etrigan-pid ${py_kms_data_dir}/etrigan.pid" - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/kms/install.sh b/archive/jailman/blueprints/kms/install.sh deleted file mode 100755 index 9601eba767d..00000000000 --- a/archive/jailman/blueprints/kms/install.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for KMS - -iocage exec "$1" svn checkout https://github.com/SystemRage/py-kms/trunk/py-kms /usr/local/share/py-kms -iocage exec "$1" "pw user add kms -c kms -u 666 -d /nonexistent -s /usr/bin/nologin" -iocage exec "$1" chown -R kms:kms /usr/local/share/py-kms /config -iocage exec "$1" mkdir /usr/local/etc/rc.d -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/kms/includes/py_kms.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/py_kms -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/py_kms -iocage exec "$1" sysrc "py_kms_enable=YES" -iocage exec "$1" service py_kms start diff --git a/archive/jailman/blueprints/kms/readme.md b/archive/jailman/blueprints/kms/readme.md deleted file mode 100644 index f738c29420b..00000000000 --- a/archive/jailman/blueprints/kms/readme.md +++ /dev/null @@ -1,87 +0,0 @@ -# Py-KMS - -## Original README from the py-kms github: - -https://github.com/SystemRage/py-kms - -## History - -_py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife.info/members/183074-markedsword), which is a port of either the C##, C++, or .NET implementations of KMS Emulator. The original version was written by [CODYQX4](http://forums.mydigitallife.info/members/89933-CODYQX4) and is derived from the reverse-engineered code of Microsoft's official KMS. - -## Features - -- Responds to V4, V5, and V6 KMS requests. -- Supports activating: - - Windows Vista - - Windows 7 - - Windows 8 - - Windows 8.1 - - Windows 10 ( 1511 / 1607 / 1703 / 1709 / 1803 / 1809 / 1903 / 1909 ) - - Windows Server 2008 - - Windows Server 2008 R2 - - Windows Server 2012 - - Windows Server 2012 R2 - - Windows Server 2016 - - Windows Server 2019 - - Microsoft Office 2010 ( Volume License ) - - Microsoft Office 2013 ( Volume License ) - - Microsoft Office 2016 ( Volume License ) - - Microsoft Office 2019 ( Volume License ) -- It's written in Python: - - tested with Python 2.7.15rc1 - - tested with Python 3.6.7 - -## Dependencies - -- Python 3.x or Python 2.7.x or Python 2.6.x with the `argparse` module installed. -- Tkinter module. -- If the `tzlocal` module is installed, the "Request Time" in the verbose output will be converted into local time. Otherwise, it will be in UTC. -- It can use the `sqlite3` module so you can use the database function, storing activation data so it can be recalled again. -- Installation example on Ubuntu / Mint: - - `sudo apt-get update` - - for python3 - - `sudo apt-get install python3-tk python3-pip` - - `sudo pip3 install tzlocal pysqlite3` - - or for python2 - - `sudo apt-get install python-tk python-pip` - - `sudo pip install tzlocal pysqlite` - -## Usage - -- **NOTE**: Pay attention to how invoke scripts, if you want to run with python2 use `python...` while for python3 use `python3...`, also depending on the Python versions that resides in your PC. -- To start the server, execute `python pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is "0.0.0.0" ( all interfaces ) and the default _PORT_ is "1688". -- To run the client (only for testing purposes), use `python pykms_Client.py [IPADDRESS] [PORT]`, with the same defaults of `pykms_Server.py`. -- To show the help pages type: `python pykms_Server.py -h` and `python pykms_Client.py -h`. -- To generate a random HWID use `-w` option: `python pykms_Server.py -w RANDOM`. -- To get the HWID from any server use the client, for example type: `python pykms_Client.py 0.0.0.0 1688 -m Windows8.1 -V INFO`. -- To view a minimal set of logging information use `-V MINI` option, for example: `python pykms_Server.py -F /path/to/your/logfile.log -V MINI`. -- To redirect logging on stdout use `-F STDOUT` option, for example: `python pykms_Server.py -F STDOUT -V DEBUG`. -- You can create logfile and view logging information on stdout at the same time with `-F FILESTDOUT` option, for example: `python pykms_Server.py -F FILESTDOUT /path/to/your/logfile.log -V DEBUG`. -- Select timeout (seconds) for py-kms with `-t` option, for example `python pykms_Server.py -t 10` -- For launching py-kms GUI make executable `pykms_Server.py` file with `chmod +x /path/to/folder/py-kms/pykms_Server.py`, then simply run `pykms_Server.py` double-clicking. -- You can run py-kms deamonized (via [Etrigan](https://github.com/SystemRage/Etrigan)) using a command like: `python pykms_Server.py etrigan start` and stop it with: `python pykms_Server.py etrigan stop`. -- With Etrigan you have another way to launch py-kms GUI (specially suitable if you're using a virtualenv), so: `python pykms_Server.py etrigan start -g` - and stop the GUI with the same precedent command (or interact with EXIT button). - -## Docker - -![auto-docker](https://img.shields.io/docker/cloud/automated/pykmsorg/py-kms) -![status-docker](https://img.shields.io/docker/cloud/build/pykmsorg/py-kms) - -This projects has docker image support. You can find all available image configurations inside the docker folder. -There are three tags of the images available: - -- `latest`, currently the same like minimal... -- `minimal`, wich is based on the python3 minimal configuration of py-kms. _This image does NOT include SQLLite support!_ -- `python2`, which is fully configurable and equiped with SQLLite support and web interface. -- `python3`, which is like the `python2` tag - just with Python 3... - If you just want to use the image and don't want to build them yourself, you can use the official image at the docker hub (`pykmsorg/py-kms`). - To ensure that the image is always up-to-date you should check [watchtower](https://github.com/containrrr/watchtower) out! - -## Other Important Stuff - -Consult the [Wiki](https://github.com/SystemRage/py-kms/wiki) for more information about activation with _py-kms_ and to get GVLK keys. - -## License - -[![License](https://img.shields.io/badge/license-unlicense-lightgray.svg)](https://github.com/SystemRage/py-kms/blob/master/LICENSE) diff --git a/archive/jailman/blueprints/kms/update.sh b/archive/jailman/blueprints/kms/update.sh deleted file mode 100755 index bcfb8b6a71b..00000000000 --- a/archive/jailman/blueprints/kms/update.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for KMS - -iocage exec "$1" service py_kms stop -iocage exec "$1" svn checkout https://github.com/SystemRage/py-kms/trunk/py-kms /usr/local/share/py-kms -iocage exec "$1" chown -R kms:kms /usr/local/share/py-kms /config -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/kms/includes/py_kms.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/py_kms -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/py_kms -iocage exec "$1" service py_kms start diff --git a/archive/jailman/blueprints/lidarr/config.yml b/archive/jailman/blueprints/lidarr/config.yml deleted file mode 100644 index c4dddc3718b..00000000000 --- a/archive/jailman/blueprints/lidarr/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - lidarr: lidarr - pkgs: mono mediainfo sqlite3 diff --git a/archive/jailman/blueprints/lidarr/includes/lidarr.rc b/archive/jailman/blueprints/lidarr/includes/lidarr.rc deleted file mode 100644 index 7012db7552c..00000000000 --- a/archive/jailman/blueprints/lidarr/includes/lidarr.rc +++ /dev/null @@ -1,36 +0,0 @@ -#!/bin/sh - -# $FreeBSD$ -# -# PROVIDE: lidarr -# REQUIRE: LOGIN -# KEYWORD: shutdown -# -# Add the following lines to /etc/rc.conf to enable lidarr: -# lidarr_enable="YES" - -. /etc/rc.subr -name=lidarr -rcvar=${name}_enable -load_rc_config $name - -: ${lidarr_enable="NO"} -: ${lidarr_user:="lidarr"} -: ${lidarr_group:="lidarr"} -: ${lidarr_data_dir:="/config"} - -pidfile="${lidarr_data_dir}/lidarr.pid" -command="/usr/sbin/daemon" -procname="/usr/local/bin/mono" -command_args="-f ${procname} /usr/local/share/Lidarr/Lidarr.exe -- data=${lidarr_data_dir} --nobrowser" - -start_precmd=lidarr_precmd -lidarr_precmd() { -if [ ! -d ${lidarr_data_dir} ]; then -install -d -o ${lidarr_user} -g ${lidarr_group} ${lidarr_data_dir} -fi - -export XDG_CONFIG_HOME=${lidarr_data_dir} -} - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/lidarr/install.sh b/archive/jailman/blueprints/lidarr/install.sh deleted file mode 100755 index 4fdaec1f243..00000000000 --- a/archive/jailman/blueprints/lidarr/install.sh +++ /dev/null @@ -1,25 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for lidarr - -# Check if dataset for completed download and it parent dataset exist, create if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_downloads}" -createmount "$1" "${global_dataset_downloads}"/complete /mnt/fetched - -# Check if dataset for media library and the dataset for movies exist, create if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_media}" -createmount "$1" "${global_dataset_media}"/music /mnt/music - - -iocage exec "$1" "fetch https://github.com/lidarr/Lidarr/releases/download/v0.7.1.1381/Lidarr.master.0.7.1.1381.linux.tar.gz -o /usr/local/share" -iocage exec "$1" "tar -xzvf /usr/local/share/Lidarr.master.0.7.1.1381.linux.tar.gz -C /usr/local/share" -iocage exec "$1" "rm /usr/local/share/Lidarr.master.0.7.1.1381.linux.tar.gz" -iocage exec "$1" "pw user add lidarr -c lidarr -u 353 -d /nonexistent -s /usr/bin/nologin" -iocage exec "$1" chown -R lidarr:lidarr /usr/local/share/Lidarr /config -iocage exec "$1" mkdir /usr/local/etc/rc.d -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/lidarr/includes/lidarr.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/lidarr -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/lidarr -iocage exec "$1" sysrc "lidarr_enable=YES" -iocage exec "$1" service lidarr start diff --git a/archive/jailman/blueprints/lidarr/readme.md b/archive/jailman/blueprints/lidarr/readme.md deleted file mode 100644 index 56a7648e1aa..00000000000 --- a/archive/jailman/blueprints/lidarr/readme.md +++ /dev/null @@ -1,71 +0,0 @@ -# Lidarr - -## Original README from the lidarr github: - -https://github.com/lidarr/Lidarr - -# Lidarr - -[![Build Status](https://dev.azure.com/Lidarr/Lidarr/_apis/build/status/lidarr.Lidarr?branchName=develop)](https://dev.azure.com/Lidarr/Lidarr/_build/latest?definitionId=1&branchName=develop) -[![BrowserStack Status](https://automate.browserstack.com/badge.svg?badge_key=Z1I4SVZOMitOdENIMHpkMlN3djJiRVJkTzBpdUJ5Q2ZtWVhnYTFvYS9qcz0tLTM5THJZRkVCZlk0blp5cXFBK1BDYWc9PQ==--67f41b00af03ab78148d3d711f22ca42ab348a52)](https://automate.browserstack.com/public-build/Z1I4SVZOMitOdENIMHpkMlN3djJiRVJkTzBpdUJ5Q2ZtWVhnYTFvYS9qcz0tLTM5THJZRkVCZlk0blp5cXFBK1BDYWc9PQ==--67f41b00af03ab78148d3d711f22ca42ab348a52) -[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/lidarr.svg)](https://github.com/lidarr/Lidarr/wiki/Docker) -![Github Downloads](https://img.shields.io/github/downloads/lidarr/lidarr/total.svg) -[![Backers on Open Collective](https://opencollective.com/lidarr/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/lidarr/sponsors/badge.svg)](#sponsors) - -Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. - -## Major Features Include: - -- Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc. -- Automatically detects new tracks. -- Can scan your existing library and download any missing tracks. -- Can watch for better quality of the tracks you already have and do an automatic upgrade. -- Automatic failed download handling will try another release if one fails -- Manual search so you can pick any release or to see why a release was not downloaded automatically -- Fully configurable track renaming -- Full integration with SABnzbd and NZBGet -- Full integration with Kodi, Plex (notification, library update, metadata) -- Full support for specials and multi-album releases -- And a beautiful UI - -## Feature Requests - -[![Feature Requests](http://feathub.com/lidarr/Lidarr?format=svg)](http://feathub.com/lidarr/Lidarr) - -## Support - -[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60)](https://discord.gg/8Y7rDc9) -[![Reddit](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60)](https://www.reddit.com/r/lidarr) -[![GitHub](https://img.shields.io/badge/github-issues-red.svg?maxAge=60)](https://github.com/Lidarr/Lidarr/issues) -[![GitHub Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60)](https://github.com/Lidarr/Lidarr/wiki) - -## Contributors - -This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. - - -## Backers - -Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/lidarr#backer)] - - - -## Sponsors - -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/lidarr#sponsor)] - - - - - - - - - - - - -### License - -- [GNU GPL v3](http://www.gnu.org/licenses/gpl.html) -- Copyright 2010-2019 diff --git a/archive/jailman/blueprints/lidarr/update.sh b/archive/jailman/blueprints/lidarr/update.sh deleted file mode 100755 index c3cc596eb45..00000000000 --- a/archive/jailman/blueprints/lidarr/update.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for lidarr - -iocage exec "$1" service lidarr stop -#TODO insert code to update lidarr itself here -iocage exec "$1" chown -R lidarr:lidarr /usr/local/share/lidarr /config -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/lidarr/includes/lidarr.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/lidarr -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/lidarr -iocage exec "$1" service lidarr restart diff --git a/archive/jailman/blueprints/mariadb/config.yml b/archive/jailman/blueprints/mariadb/config.yml deleted file mode 100644 index 403cb8a9325..00000000000 --- a/archive/jailman/blueprints/mariadb/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - mariadb: - pkgs: mariadb104-server git php74-session php74-xml php74-ctype php74-openssl php74-filter php74-gd php74-json php74-mysqli php74-mbstring php74-zlib php74-zip php74-bz2 phpMyAdmin5-php74 php74-pdo_mysql php74-mysqli phpMyAdmin5-php74 diff --git a/archive/jailman/blueprints/mariadb/includes/Caddyfile b/archive/jailman/blueprints/mariadb/includes/Caddyfile deleted file mode 100644 index 2fcf7f58059..00000000000 --- a/archive/jailman/blueprints/mariadb/includes/Caddyfile +++ /dev/null @@ -1,11 +0,0 @@ -yourhostnamehere:80 JAIL-IP:80 { - root /usr/local/www/phpMyAdmin/ - fastcgi / 127.0.0.1:9000 php { - env PATH /bin - env modHeadersAvailable true - env front_controller_active true - connect_timeout 60s - read_timeout 3600s - send_timeout 300s - } -} diff --git a/archive/jailman/blueprints/mariadb/includes/caddy.rc b/archive/jailman/blueprints/mariadb/includes/caddy.rc deleted file mode 100644 index 25da8398939..00000000000 --- a/archive/jailman/blueprints/mariadb/includes/caddy.rc +++ /dev/null @@ -1,83 +0,0 @@ -#!/bin/sh -# shellcheck disable=1091,2223,2154,2034 -# -# PROVIDE: caddy -# REQUIRE: networking -# KEYWORD: shutdown - -# -# Add the following lines to /etc/rc.conf to enable caddy: -# caddy_enable (bool): Set to "NO" by default. -# Set it to "YES" to enable caddy -# -# caddy_cert_email (str): Set to "" by default. -# Defines the SSL certificate issuer email. By providing an -# email address you automatically agree to letsencrypt.org's -# general terms and conditions -# -# caddy_bin_path (str): Set to "/usr/local/bin/caddy" by default. -# Provides the path to the caddy server executable -# -# caddy_cpu (str): Set to "99%" by default. -# Configures, how much CPU capacity caddy may gain -# -# caddy_config_path (str): Set to "/usr/local/www/Caddyfile" by default. -# Defines the path for the configuration file caddy will load on boot -# -# caddy_user (str): Set to "root" by default. -# Defines the user that caddy will run on -# -# caddy_group (str): Set to "wheel" by default. -# Defines the group that caddy files will be attached to -# -# caddy_logfile (str) Set to "/var/log/caddy.log" by default. -# Defines where the process log file is written, this is not a web access log -# -# caddy_env (str) Set to "" by default. -# This allows environment variable to be set that may be required, for example when using "DNS Challenge" account credentials are required. -# e.g. (in your rc.conf) caddy_env="CLOUDFLARE_EMAIL=me@domain.com CLOUDFLARE_API_KEY=my_api_key" -# - -. /etc/rc.subr - -name="caddy" -rcvar="${name}_enable" - -load_rc_config ${name} - -: ${caddy_enable:="NO"} -: ${caddy_cert_email=""} -: ${caddy_bin_path="/usr/local/bin/caddy"} -: ${caddy_cpu="99%"} # was a bug for me that caused a crash within jails -: ${caddy_config_path="/usr/local/www/Caddyfile"} -: ${caddy_logfile="/var/log/caddy.log"} -: ${caddy_user="root"} -: ${caddy_group="wheel"} - -if [ "$caddy_cert_email" = "" ] -then - echo "rc variable \$caddy_cert_email is not set. Please provide a valid SSL certificate issuer email." - exit 1 -fi - -pidfile="/var/run/${name}.pid" -procname="${caddy_bin_path}" #enabled builtin pid checking for start / stop -command="/usr/sbin/daemon" -command_args="-p ${pidfile} /usr/bin/env ${caddy_env} ${procname} -cpu ${caddy_cpu} -log stdout -conf ${caddy_config_path} -agree -email ${caddy_cert_email} < /dev/null >> ${caddy_logfile} 2>&1" - -start_precmd="caddy_startprecmd" - -caddy_startprecmd() -{ - if [ ! -e "${pidfile}" ]; then - install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${pidfile}" - fi - - if [ ! -e "${caddy_logfile}" ]; then - install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${caddy_logfile}" - fi -} - -required_files="${caddy_config_path}" - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/mariadb/includes/config.inc.php b/archive/jailman/blueprints/mariadb/includes/config.inc.php deleted file mode 100644 index 817f0f499be..00000000000 --- a/archive/jailman/blueprints/mariadb/includes/config.inc.php +++ /dev/null @@ -1,156 +0,0 @@ -. - * - * @package PhpMyAdmin - */ -declare(strict_types=1); - -/** - * This is needed for cookie based authentication to encrypt password in - * cookie. Needs to be 32 chars long. - */ -$cfg['blowfish_secret'] = ''; /* YOU MUST FILL IN THIS FOR COOKIE AUTH! */ - -/** - * Servers configuration - */ -$i = 0; - -/** - * First server - */ -$i++; -/* Authentication type */ -/*$cfg['Servers'][$i]['auth_type'] = 'cookie';*/ -/* Server parameters */ -$cfg['Servers'][$i]['host'] = 'localhost'; -$cfg['Servers'][$i]['compress'] = false; -$cfg['Servers'][$i]['AllowNoPassword'] = false; -$cfg['Servers'][$i]['socket'] = '/config/mysql.sock'; -$cfg['Servers'][$i]['connect_type'] = 'socket'; -/** - * phpMyAdmin configuration storage settings. - */ - -/* User used to manipulate with storage */ -// $cfg['Servers'][$i]['controlhost'] = ''; -// $cfg['Servers'][$i]['controlport'] = ''; -// $cfg['Servers'][$i]['controluser'] = 'pma'; -// $cfg['Servers'][$i]['controlpass'] = 'pmapass'; - -/* Storage database and tables */ -// $cfg['Servers'][$i]['pmadb'] = 'phpmyadmin'; -// $cfg['Servers'][$i]['bookmarktable'] = 'pma__bookmark'; -// $cfg['Servers'][$i]['relation'] = 'pma__relation'; -// $cfg['Servers'][$i]['table_info'] = 'pma__table_info'; -// $cfg['Servers'][$i]['table_coords'] = 'pma__table_coords'; -// $cfg['Servers'][$i]['pdf_pages'] = 'pma__pdf_pages'; -// $cfg['Servers'][$i]['column_info'] = 'pma__column_info'; -// $cfg['Servers'][$i]['history'] = 'pma__history'; -// $cfg['Servers'][$i]['table_uiprefs'] = 'pma__table_uiprefs'; -// $cfg['Servers'][$i]['tracking'] = 'pma__tracking'; -// $cfg['Servers'][$i]['userconfig'] = 'pma__userconfig'; -// $cfg['Servers'][$i]['recent'] = 'pma__recent'; -// $cfg['Servers'][$i]['favorite'] = 'pma__favorite'; -// $cfg['Servers'][$i]['users'] = 'pma__users'; -// $cfg['Servers'][$i]['usergroups'] = 'pma__usergroups'; -// $cfg['Servers'][$i]['navigationhiding'] = 'pma__navigationhiding'; -// $cfg['Servers'][$i]['savedsearches'] = 'pma__savedsearches'; -// $cfg['Servers'][$i]['central_columns'] = 'pma__central_columns'; -// $cfg['Servers'][$i]['designer_settings'] = 'pma__designer_settings'; -// $cfg['Servers'][$i]['export_templates'] = 'pma__export_templates'; - -/** - * End of servers configuration - */ - -/** - * Directories for saving/loading files from server - */ -$cfg['UploadDir'] = ''; -$cfg['SaveDir'] = ''; - -/** - * Whether to display icons or text or both icons and text in table row - * action segment. Value can be either of 'icons', 'text' or 'both'. - * default = 'both' - */ -//$cfg['RowActionType'] = 'icons'; - -/** - * Defines whether a user should be displayed a "show all (records)" - * button in browse mode or not. - * default = false - */ -//$cfg['ShowAll'] = true; - -/** - * Number of rows displayed when browsing a result set. If the result - * set contains more rows, "Previous" and "Next". - * Possible values: 25, 50, 100, 250, 500 - * default = 25 - */ -//$cfg['MaxRows'] = 50; - -/** - * Disallow editing of binary fields - * valid values are: - * false allow editing - * 'blob' allow editing except for BLOB fields - * 'noblob' disallow editing except for BLOB fields - * 'all' disallow editing - * default = 'blob' - */ -//$cfg['ProtectBinary'] = false; - -/** - * Default language to use, if not browser-defined or user-defined - * (you find all languages in the locale folder) - * uncomment the desired line: - * default = 'en' - */ -//$cfg['DefaultLang'] = 'en'; -//$cfg['DefaultLang'] = 'de'; - -/** - * How many columns should be used for table display of a database? - * (a value larger than 1 results in some information being hidden) - * default = 1 - */ -//$cfg['PropertiesNumColumns'] = 2; - -/** - * Set to true if you want DB-based query history.If false, this utilizes - * JS-routines to display query history (lost by window close) - * - * This requires configuration storage enabled, see above. - * default = false - */ -//$cfg['QueryHistoryDB'] = true; - -/** - * When using DB-based query history, how many entries should be kept? - * default = 25 - */ -//$cfg['QueryHistoryMax'] = 100; - -/** - * Whether or not to query the user before sending the error report to - * the phpMyAdmin team when a JavaScript error occurs - * - * Available options - * ('ask' | 'always' | 'never') - * default = 'ask' - */ -//$cfg['SendErrorReports'] = 'always'; - -/** - * You can find more configuration options in the documentation - * in the doc/ folder or at . - */ diff --git a/archive/jailman/blueprints/mariadb/includes/my.cnf b/archive/jailman/blueprints/mariadb/includes/my.cnf deleted file mode 100644 index 9545f512a56..00000000000 --- a/archive/jailman/blueprints/mariadb/includes/my.cnf +++ /dev/null @@ -1,25 +0,0 @@ -# MySQL config file -[mysqld] -datadir=/config/db -socket=/config/mysql.sock -log_error=/config/mysql.err -innodb_file_per_table=1 -transaction_isolation = READ-COMMITTED -binlog_format = ROW - -symbolic-links=0 -innodb_doublewrite = 0 -innodb_checksum_algorithm = none -innodb_file_per_table=1 - -innodb_buffer_pool_size = 1G -innodb_log_buffer_size = 8M -innodb_open_files = 400 -innodb_io_capacity = 400 -innodb_flush_method = O_DIRECT -innodb_io_capacity = 4000 - -[client] -password=mypassword -port=3306 -socket=/config/mysql.sock diff --git a/archive/jailman/blueprints/mariadb/install.sh b/archive/jailman/blueprints/mariadb/install.sh deleted file mode 100755 index cf0d893156f..00000000000 --- a/archive/jailman/blueprints/mariadb/install.sh +++ /dev/null @@ -1,123 +0,0 @@ -#!/usr/local/bin/bash -# This script installs the current release of Mariadb and PhpMyAdmin into a created jail -##### -# -# Init and Mounts -# -##### - -# Initialise defaults -# shellcheck disable=SC2154 -JAIL_IP="jail_${1}_ip4_addr" -JAIL_IP="${!JAIL_IP%/*}" -INCLUDES_PATH="${SCRIPT_DIR}/blueprints/mariadb/includes" -# shellcheck disable=SC2154 -CERT_EMAIL="jail_${1}_cert_email" -CERT_EMAIL="${!CERT_EMAIL:-placeholder@email.fake}" -# shellcheck disable=SC2154 -DB_ROOT_PASSWORD="jail_${1}_db_root_password" -HOST_NAME="jail_${1}_host_name" -DL_FLAGS="" -DNS_ENV="" - -# Check that necessary variables were set by nextcloud-config -if [ -z "${JAIL_IP}" ]; then - echo 'Configuration error: The mariadb jail does NOT accept DHCP' - echo 'Please reinstall using a fixed IP adress' - exit 1 -fi - -# Make sure DB_PATH is empty -- if not, MariaDB/PostgreSQL will choke -# shellcheck disable=SC2154 -if [ "$(ls -A "/mnt/${global_dataset_config}/${1}/db")" ]; then - echo "Reinstall of mariadb detected... Continuing" - REINSTALL="true" -fi - -# Mount database dataset and set zfs preferences -iocage exec "${1}" rm -Rf /usr/local/etc/mysql/my.cnf -createmount "${1}" "${global_dataset_config}"/"${1}"/db /config/db -zfs set recordsize=16K "${global_dataset_config}"/"${1}"/db -zfs set primarycache=metadata "${global_dataset_config}"/"${1}"/db - -iocage exec "${1}" "pw groupadd -n mysql -g 88" -iocage exec "${1}" "pw useradd -n mysql -u 88 -d /nonexistent -s /usr/sbin/nologin -g mysql" - -iocage exec "${1}" chown -R mysql:mysql /config - -iocage exec "${1}" sysrc mysql_optfile=/config/my.cnf -iocage exec "${1}" sysrc mysql_dbdir=/config/db -iocage exec "${1}" sysrc mysql_pidfile=/config/mysql.pid -iocage exec "${1}" sysrc mysql_enable="YES" - -# Install includes fstab -iocage exec "${1}" mkdir -p /mnt/includes -iocage fstab -a "${1}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0 - -iocage exec "${1}" cp -f /mnt/includes/my.cnf /config/my.cnf -iocage exec "${1}" cp -f /mnt/includes/config.inc.php /usr/local/www/phpMyAdmin/config.inc.php -iocage exec "${1}" sed -i '' "s|mypassword|${!DB_ROOT_PASSWORD}|" /config/my.cnf -iocage exec "${1}" ln -s /config/my.cnf /usr/local/etc/mysql/my.cnf - -##### -# -# Install Caddy and PhpMyAdmin -# -##### - -fetch -o /tmp https://getcaddy.com -if ! iocage exec "${1}" bash -s personal "${DL_FLAGS}" < /tmp/getcaddy.com -then - echo "Failed to download/install Caddy" - exit 1 -fi - -# Copy and edit pre-written config files -echo "Copying Caddyfile for no SSL" -iocage exec "${1}" cp -f /mnt/includes/caddy.rc /usr/local/etc/rc.d/caddy -iocage exec "${1}" cp -f /mnt/includes/Caddyfile /usr/local/www/Caddyfile -# shellcheck disable=SC2154 -iocage exec "${1}" sed -i '' "s/yourhostnamehere/${!HOST_NAME}/" /usr/local/www/Caddyfile -iocage exec "${1}" sed -i '' "s/JAIL-IP/${JAIL_IP}/" /usr/local/www/Caddyfile - -iocage exec "${1}" sysrc caddy_enable="YES" -iocage exec "${1}" sysrc php_fpm_enable="YES" -iocage exec "${1}" sysrc caddy_cert_email="${CERT_EMAIL}" -iocage exec "${1}" sysrc caddy_env="${DNS_ENV}" - -iocage restart "${1}" -sleep 10 - -if [ "${REINSTALL}" == "true" ]; then - echo "Reinstall detected, skipping generaion of new config and database" -else - - # Secure database, set root password, create Nextcloud DB, user, and password - iocage exec "${1}" mysql -u root -e "DELETE FROM mysql.user WHERE User='';" - iocage exec "${1}" mysql -u root -e "DELETE FROM mysql.user WHERE User='root' AND Host NOT IN ('localhost', '127.0.0.1', '::1');" - iocage exec "${1}" mysql -u root -e "DROP DATABASE IF EXISTS test;" - iocage exec "${1}" mysql -u root -e "DELETE FROM mysql.db WHERE Db='test' OR Db='test\\_%';" - iocage exec "${1}" mysqladmin --user=root password "${!DB_ROOT_PASSWORD}" - iocage exec "${1}" mysqladmin reload -fi - -# Save passwords for later reference -iocage exec "${1}" echo "MariaDB root password is ${!DB_ROOT_PASSWORD}" > /root/"${1}"_db_password.txt - - -# Don't need /mnt/includes any more, so unmount it -iocage fstab -r "${1}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0 - -# Done! -echo "Installation complete!" -echo "Using your web browser, go to http://${!HOST_NAME} to log in" - -if [ "${REINSTALL}" == "true" ]; then - echo "You did a reinstall, please use your old database and account credentials" -else - echo "Database Information" - echo "--------------------" - echo "The MariaDB root password is ${!DB_ROOT_PASSWORD}" - fi -echo "" -echo "All passwords are saved in /root/${1}_db_password.txt" diff --git a/archive/jailman/blueprints/mariadb/readme.md b/archive/jailman/blueprints/mariadb/readme.md deleted file mode 100644 index d546c7a279c..00000000000 --- a/archive/jailman/blueprints/mariadb/readme.md +++ /dev/null @@ -1,89 +0,0 @@ -# MariaDB - -## Original README from the mariadb github: - -https://github.com/MariaDB/server/ - -## Code status: - -- [![Travis CI status](https://secure.travis-ci.org/MariaDB/server.png?branch=10.5)](https://travis-ci.org/MariaDB/server) travis-ci.org (10.5 branch) -- [![Appveyor CI status](https://ci.appveyor.com/api/projects/status/4u6pexmtpuf8jq66?svg=true)](https://ci.appveyor.com/project/rasmushoj/server) ci.appveyor.com - -## MariaDB: drop-in replacement for MySQL - -MariaDB is designed as a drop-in replacement of MySQL(R) with more -features, new storage engines, fewer bugs, and better performance. - -MariaDB is brought to you by the MariaDB Foundation and the MariaDB corporation. -Please read the CREDITS file for details about the MariaDB Foundation, -and who is developing MariaDB. - -MariaDB is developed by many of the original developers of MySQL who -now work for the MariaDB Corporation, the MariaDB Foundation and by -many people in the community. - -MySQL, which is the base of MariaDB, is a product and trademark of Oracle -Corporation, Inc. For a list of developers and other contributors, -see the Credits appendix. You can also run 'SHOW authors' to get a -list of active contributors. - -A description of the MariaDB project and a manual can be found at: - -https://mariadb.com/kb/en/ - -https://mariadb.com/kb/en/mariadb-vs-mysql-features/ - -https://mariadb.com/kb/en/mariadb-versus-mysql-compatibility/ - -https://mariadb.com/kb/en/library/new-and-old-releases/ - -https://mariadb.org/ - -As MariaDB is a full replacement of MySQL, the MySQL manual at -http://dev.mysql.com/doc is generally applicable. - -## Help - -More help is available from the Maria Discuss mailing list -https://launchpad.net/~maria-discuss -and the #maria IRC channel on Freenode. - -## Live QA for beginner contributors - -MariaDB has a dedicated time each week when we answer new contributor questions live on Zulip and IRC. -From 8:00 to 10:00 UTC on Mondays, and 10:00 to 12:00 UTC on Thursdays, -anyone can ask any questions they’d like, and a live developer will be available to assist. - -New contributors can ask questions any time, but we will provide immediate feedback during that interval. - -## Licensing - ---- - -NOTE: - -MariaDB is specifically available only under version 2 of the GNU -General Public License (GPLv2). (I.e. Without the "any later version" -clause.) This is inherited from MySQL. Please see the README file in -the MySQL distribution for more information. - -License information can be found in the COPYING file. Third party -license information can be found in the THIRDPARTY file. - ---- - -## Bug Reports - -Bug and/or error reports regarding MariaDB should be submitted at: -https://jira.mariadb.org - -For reporting security vulnerabilities see: -https://mariadb.org/about/security-policy/ - -Bugs in the MySQL code can also be submitted at: -https://bugs.mysql.com - -The code for MariaDB, including all revision history, can be found at: -https://github.com/MariaDB/server - ---- diff --git a/archive/jailman/blueprints/mariadb/update.sh b/archive/jailman/blueprints/mariadb/update.sh deleted file mode 100755 index 9d11402ccdc..00000000000 --- a/archive/jailman/blueprints/mariadb/update.sh +++ /dev/null @@ -1,37 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for mariadb - -# shellcheck disable=SC2154 -JAIL_IP="jail_${1}_ip4_addr" -JAIL_IP="${!JAIL_IP%/*}" -HOST_NAME="jail_${1}_host_name" -INCLUDES_PATH="${SCRIPT_DIR}/blueprints/mariadb/includes" - -# Install includes fstab -iocage exec "${1}" mkdir -p /mnt/includes -iocage fstab -a "${1}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0 - - -iocage exec "${1}" service caddy stop -iocage exec "${1}" service php-fpm stop - -fetch -o /tmp https://getcaddy.com -if ! iocage exec "${1}" bash -s personal "${DL_FLAGS}" < /tmp/getcaddy.com -then - echo "Failed to download/install Caddy" - exit 1 -fi - -# Copy and edit pre-written config files -echo "Copying Caddyfile for no SSL" -iocage exec "${1}" cp -f /mnt/includes/caddy /usr/local/etc/rc.d/ -iocage exec "${1}" cp -f /mnt/includes/Caddyfile /usr/local/www/Caddyfile -# shellcheck disable=SC2154 -iocage exec "${1}" sed -i '' "s/yourhostnamehere/${HOST_NAME}/" /usr/local/www/Caddyfile -iocage exec "${1}" sed -i '' "s/JAIL-IP/${JAIL_IP}/" /usr/local/www/Caddyfile - -# Don't need /mnt/includes any more, so unmount it -iocage fstab -r "${1}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0 - -iocage exec "${1}" service caddy start -iocage exec "${1}" service php-fpm start diff --git a/archive/jailman/blueprints/nextcloud/LICENSE b/archive/jailman/blueprints/nextcloud/LICENSE deleted file mode 100644 index 94a9ed024d3..00000000000 --- a/archive/jailman/blueprints/nextcloud/LICENSE +++ /dev/null @@ -1,674 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. - - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. - - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. - - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Use with the GNU Affero General Public License. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will -be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If the program does terminal interaction, make it output a short -notice like this when it starts in an interactive mode: - - Copyright (C) - This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, your program's commands -might be different; for a GUI interface, you would use an "about box". - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU GPL, see -. - - The GNU General Public License does not permit incorporating your program -into proprietary programs. If your program is a subroutine library, you -may consider it more useful to permit linking proprietary applications with -the library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. But first, please read -. diff --git a/archive/jailman/blueprints/nextcloud/config.yml b/archive/jailman/blueprints/nextcloud/config.yml deleted file mode 100644 index ba9424ed1f4..00000000000 --- a/archive/jailman/blueprints/nextcloud/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - nextcloud: - pkgs: nano sudo redis php74-ctype gnupg php74-dom php74-gd php74-iconv php74-json php74-mbstring php74-posix php74-simplexml php74-xmlreader php74-xmlwriter php74-zip php74-zlib php74-xml php74 php74-pecl-redis php74-session php74-xsl php74-filter php74-pecl-APCu php74-curl php74-fileinfo php74-bz2 php74-intl php74-openssl php74-ldap php74-ftp php74-imap php74-exif php74-gmp php74-pecl-memcache php74-pecl-imagick php74-pecl-smbclient perl5 p5-Locale-gettext help2man texinfo m4 autoconf php74-opcache php74-pcntl php74-bcmath php74-pecl-APCu diff --git a/archive/jailman/blueprints/nextcloud/includes/Caddyfile b/archive/jailman/blueprints/nextcloud/includes/Caddyfile deleted file mode 100644 index e6c0db8596f..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/Caddyfile +++ /dev/null @@ -1,127 +0,0 @@ -yourhostnamehere JAIL-IP { - - root /usr/local/www/nextcloud - log /var/log/nextcloud_access.log - errors /var/log/nextcloud_errors.log - - tls { - ca https://acme-staging-v02.api.letsencrypt.org/directory - DNS-PLACEHOLDER - } - - fastcgi / 127.0.0.1:9000 php { - env PATH /bin - env modHeadersAvailable true - env front_controller_active true - connect_timeout 60s - read_timeout 3600s - send_timeout 300s - } - - header / { - Strict-Transport-Security "max-age=15768000;" - X-Content-Type-Options "nosniff" - X-XSS-Protection "1; mode=block" - X-Robots-Tag "none" - X-Download-Options "noopen" - X-Permitted-Cross-Domain-Policies "none" - X-Frame-Options "SAMEORIGIN" - Referrer-Policy "no-referrer" - } - - header /core/fonts { - Cache-Control "max-age=604800" - } - - # checks for images - rewrite { - ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map - r ^/index.php/.*$ - to /{1} /index.php?{query} - } - - rewrite { - r ^/\.well-known/host-meta$ - to /public.php?service=host-meta&{query} - } - rewrite { - r ^/\.well-known/host-meta\.json$ - to /public.php?service=host-meta-json&{query} - } - rewrite { - r ^/\.well-known/webfinger$ - to /public.php?service=webfinger&{query} - } - - rewrite { - r ^/index.php/.*$ - to /index.php?{query} - } - - rewrite / { - if {path} not_starts_with /remote.php - if {path} not_starts_with /public.php - ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map .html .ttf - r ^/(.*)$ - to /{1} /index.php{uri} - } - - rewrite / { - if {path} not /core/img/favicon.ico - if {path} not /core/img/manifest.json - if {path} not_starts_with /remote.php - if {path} not_starts_with /public.php - if {path} not_starts_with /cron.php - if {path} not_starts_with /core/ajax/update.php - if {path} not_starts_with /status.php - if {path} not_starts_with /ocs/v1.php - if {path} not_starts_with /ocs/v2.php - if {path} not /robots.txt - if {path} not_starts_with /updater/ - if {path} not_starts_with /ocs-provider/ - if {path} not_starts_with /ocm-provider/ - if {path} not_starts_with /.well-known/ - to /index.php{uri} - } - - # client support (e.g. os x calendar / contacts) - redir /.well-known/carddav /remote.php/carddav 301 - redir /.well-known/caldav /remote.php/caldav 301 - - # remove trailing / as it causes errors with php-fpm - rewrite { - r ^/remote.php/(webdav|caldav|carddav|dav)(\/?)(\/?)$ - to /remote.php/{1} - } - - rewrite { - r ^/remote.php/(webdav|caldav|carddav|dav)/(.+?)(\/?)(\/?)$ - to /remote.php/{1}/{2} - } - - rewrite { - r ^/public.php/(dav|webdav|caldav|carddav)(\/?)(\/?)$ - to /public.php/{1} - } - - rewrite { - r ^/public.php/(dav|webdav|caldav|carddav)/(.+)(\/?)(\/?)$ - to /public.php/{1}/{2} - } - - # .htaccess / data / config / ... shouldn't be accessible from outside - status 404 { - /.htaccess - /data - /config - /db_structure - /.xml - /README - /3rdparty - /lib - /templates - /occ - /console.php - } - -} diff --git a/archive/jailman/blueprints/nextcloud/includes/Caddyfile-nossl b/archive/jailman/blueprints/nextcloud/includes/Caddyfile-nossl deleted file mode 100644 index a41da93de20..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/Caddyfile-nossl +++ /dev/null @@ -1,122 +0,0 @@ -yourhostnamehere:80 JAIL-IP:80 { - - root /usr/local/www/nextcloud - log /var/log/nextcloud_access.log - errors /var/log/nextcloud_errors.log - - fastcgi / 127.0.0.1:9000 php { - env PATH /bin - env modHeadersAvailable true - env front_controller_active true - connect_timeout 60s - read_timeout 3600s - send_timeout 300s - } - - header / { - Strict-Transport-Security "max-age=15768000;" - X-Content-Type-Options "nosniff" - X-XSS-Protection "1; mode=block" - X-Robots-Tag "none" - X-Download-Options "noopen" - X-Permitted-Cross-Domain-Policies "none" - X-Frame-Options "SAMEORIGIN" - Referrer-Policy "no-referrer" - } - - header /core/fonts { - Cache-Control "max-age=604800" - } - - # checks for images - rewrite { - ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map - r ^/index.php/.*$ - to /{1} /index.php?{query} - } - - rewrite { - r ^/\.well-known/host-meta$ - to /public.php?service=host-meta&{query} - } - rewrite { - r ^/\.well-known/host-meta\.json$ - to /public.php?service=host-meta-json&{query} - } - rewrite { - r ^/\.well-known/webfinger$ - to /public.php?service=webfinger&{query} - } - - rewrite { - r ^/index.php/.*$ - to /index.php?{query} - } - - rewrite / { - if {path} not_starts_with /remote.php - if {path} not_starts_with /public.php - ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map .html .ttf - r ^/(.*)$ - to /{1} /index.php{uri} - } - - rewrite / { - if {path} not /core/img/favicon.ico - if {path} not /core/img/manifest.json - if {path} not_starts_with /remote.php - if {path} not_starts_with /public.php - if {path} not_starts_with /cron.php - if {path} not_starts_with /core/ajax/update.php - if {path} not_starts_with /status.php - if {path} not_starts_with /ocs/v1.php - if {path} not_starts_with /ocs/v2.php - if {path} not /robots.txt - if {path} not_starts_with /updater/ - if {path} not_starts_with /ocs-provider/ - if {path} not_starts_with /ocm-provider/ - if {path} not_starts_with /.well-known/ - to /index.php{uri} - } - - # client support (e.g. os x calendar / contacts) - redir /.well-known/carddav /remote.php/carddav 301 - redir /.well-known/caldav /remote.php/caldav 301 - - # remove trailing / as it causes errors with php-fpm - rewrite { - r ^/remote.php/(webdav|caldav|carddav|dav)(\/?)(\/?)$ - to /remote.php/{1} - } - - rewrite { - r ^/remote.php/(webdav|caldav|carddav|dav)/(.+?)(\/?)(\/?)$ - to /remote.php/{1}/{2} - } - - rewrite { - r ^/public.php/(dav|webdav|caldav|carddav)(\/?)(\/?)$ - to /public.php/{1} - } - - rewrite { - r ^/public.php/(dav|webdav|caldav|carddav)/(.+)(\/?)(\/?)$ - to /public.php/{1}/{2} - } - - # .htaccess / data / config / ... shouldn't be accessible from outside - status 404 { - /.htaccess - /data - /config - /db_structure - /.xml - /README - /3rdparty - /lib - /templates - /occ - /console.php - } - -} diff --git a/archive/jailman/blueprints/nextcloud/includes/Caddyfile-selfsigned b/archive/jailman/blueprints/nextcloud/includes/Caddyfile-selfsigned deleted file mode 100644 index 0989ce66596..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/Caddyfile-selfsigned +++ /dev/null @@ -1,128 +0,0 @@ -http://yourhostnamehere http://JAIL-IP { - redir https://yourhostnamehere{uri} -} - -https://yourhostnamehere https://JAIL-IP { - - root /usr/local/www/nextcloud - log /var/log/nextcloud_access.log - errors /var/log/nextcloud_errors.log - - tls /config/ssl/fullchain.pem /config/ssl/privkey.pem - - fastcgi / 127.0.0.1:9000 php { - env PATH /bin - env modHeadersAvailable true - env front_controller_active true - connect_timeout 60s - read_timeout 3600s - send_timeout 300s - } - - header / { - Strict-Transport-Security "max-age=15768000;" - X-Content-Type-Options "nosniff" - X-XSS-Protection "1; mode=block" - X-Robots-Tag "none" - X-Download-Options "noopen" - X-Permitted-Cross-Domain-Policies "none" - X-Frame-Options "SAMEORIGIN" - Referrer-Policy "no-referrer" - } - - header /core/fonts { - Cache-Control "max-age=604800" - } - - # checks for images - rewrite { - ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map - r ^/index.php/.*$ - to /{1} /index.php?{query} - } - - rewrite { - r ^/\.well-known/host-meta$ - to /public.php?service=host-meta&{query} - } - rewrite { - r ^/\.well-known/host-meta\.json$ - to /public.php?service=host-meta-json&{query} - } - rewrite { - r ^/\.well-known/webfinger$ - to /public.php?service=webfinger&{query} - } - - rewrite { - r ^/index.php/.*$ - to /index.php?{query} - } - - rewrite / { - if {path} not_starts_with /remote.php - if {path} not_starts_with /public.php - ext .png .html .ttf .ico .jpg .jpeg .css .js .woff .woff2 .svg .gif .map .html .ttf - r ^/(.*)$ - to /{1} /index.php{uri} - } - - rewrite / { - if {path} not /core/img/favicon.ico - if {path} not /core/img/manifest.json - if {path} not_starts_with /remote.php - if {path} not_starts_with /public.php - if {path} not_starts_with /cron.php - if {path} not_starts_with /core/ajax/update.php - if {path} not_starts_with /status.php - if {path} not_starts_with /ocs/v1.php - if {path} not_starts_with /ocs/v2.php - if {path} not /robots.txt - if {path} not_starts_with /updater/ - if {path} not_starts_with /ocs-provider/ - if {path} not_starts_with /ocm-provider/ - if {path} not_starts_with /.well-known/ - to /index.php{uri} - } - - # client support (e.g. os x calendar / contacts) - redir /.well-known/carddav /remote.php/carddav 301 - redir /.well-known/caldav /remote.php/caldav 301 - - # remove trailing / as it causes errors with php-fpm - rewrite { - r ^/remote.php/(webdav|caldav|carddav|dav)(\/?)(\/?)$ - to /remote.php/{1} - } - - rewrite { - r ^/remote.php/(webdav|caldav|carddav|dav)/(.+?)(\/?)(\/?)$ - to /remote.php/{1}/{2} - } - - rewrite { - r ^/public.php/(dav|webdav|caldav|carddav)(\/?)(\/?)$ - to /public.php/{1} - } - - rewrite { - r ^/public.php/(dav|webdav|caldav|carddav)/(.+)(\/?)(\/?)$ - to /public.php/{1}/{2} - } - - # .htaccess / data / config / ... shouldn't be accessible from outside - status 404 { - /.htaccess - /data - /config - /db_structure - /.xml - /README - /3rdparty - /lib - /templates - /occ - /console.php - } - -} diff --git a/archive/jailman/blueprints/nextcloud/includes/caddy.rc b/archive/jailman/blueprints/nextcloud/includes/caddy.rc deleted file mode 100644 index dec2d148938..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/caddy.rc +++ /dev/null @@ -1,84 +0,0 @@ -#!/bin/sh -# shellcheck disable=1091,2223,2154,2034 -# -# PROVIDE: caddy -# REQUIRE: networking -# KEYWORD: shutdown - -# -# Add the following lines to /etc/rc.conf to enable caddy: -# caddy_enable (bool): Set to "NO" by default. -# Set it to "YES" to enable caddy -# -# caddy_cert_email (str): Set to "" by default. -# Defines the SSL certificate issuer email. By providing an -# email address you automatically agree to letsencrypt.org's -# general terms and conditions -# -# caddy_bin_path (str): Set to "/usr/local/bin/caddy" by default. -# Provides the path to the caddy server executable -# -# caddy_cpu (str): Set to "99%" by default. -# Configures, how much CPU capacity caddy may gain -# -# caddy_config_path (str): Set to "/usr/local/www/Caddyfile" by default. -# Defines the path for the configuration file caddy will load on boot -# -# caddy_user (str): Set to "root" by default. -# Defines the user that caddy will run on -# -# caddy_group (str): Set to "wheel" by default. -# Defines the group that caddy files will be attached to -# -# caddy_logfile (str) Set to "/var/log/caddy.log" by default. -# Defines where the process log file is written, this is not a web access log -# -# caddy_env (str) Set to "" by default. -# This allows environment variable to be set that may be required, for example when using "DNS Challenge" account credentials are required. -# e.g. (in your rc.conf) caddy_env="CLOUDFLARE_EMAIL=me@domain.com CLOUDFLARE_API_KEY=my_api_key" -# - -. /etc/rc.subr - -name="caddy" -rcvar="${name}_enable" - -load_rc_config ${name} - -: ${caddy_enable:="NO"} -: ${caddy_cert_email=""} -: ${caddy_bin_path="/usr/local/bin/caddy"} -: ${caddy_cpu="99%"} # was a bug for me that caused a crash within jails -: ${caddy_config_path="/usr/local/www/Caddyfile"} -: ${caddy_logfile="/var/log/caddy.log"} -: ${caddy_user="root"} -: ${caddy_group="wheel"} -: ${caddy_SNI_default=""} - -if [ "$caddy_cert_email" = "" ] -then - echo "rc variable \$caddy_cert_email is not set. Please provide a valid SSL certificate issuer email." - exit 1 -fi - -pidfile="/var/run/${name}.pid" -procname="${caddy_bin_path}" #enabled builtin pid checking for start / stop -command="/usr/sbin/daemon" -command_args="-p ${pidfile} /usr/bin/env ${caddy_env} ${procname} -cpu ${caddy_cpu} -log stdout -conf ${caddy_config_path} -agree -email ${caddy_cert_email} < /dev/null >> ${caddy_logfile} 2>&1" - -start_precmd="caddy_startprecmd" - -caddy_startprecmd() -{ - if [ ! -e "${pidfile}" ]; then - install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${pidfile}" - fi - - if [ ! -e "${caddy_logfile}" ]; then - install -o "${caddy_user}" -g "${caddy_group}" "/dev/null" "${caddy_logfile}" - fi -} - -required_files="${caddy_config_path}" - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/nextcloud/includes/my-system.cnf b/archive/jailman/blueprints/nextcloud/includes/my-system.cnf deleted file mode 100644 index 44ba3c280da..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/my-system.cnf +++ /dev/null @@ -1,4 +0,0 @@ -[mysqld] -innodb_file_per_table=1 -transaction_isolation = READ-COMMITTED -binlog_format = ROW diff --git a/archive/jailman/blueprints/nextcloud/includes/my.cnf b/archive/jailman/blueprints/nextcloud/includes/my.cnf deleted file mode 100644 index 77b7660a563..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/my.cnf +++ /dev/null @@ -1,3 +0,0 @@ -# MySQL client config file -[client] -password=mypassword diff --git a/archive/jailman/blueprints/nextcloud/includes/pgpass b/archive/jailman/blueprints/nextcloud/includes/pgpass deleted file mode 100644 index 6fdcbc63ad1..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/pgpass +++ /dev/null @@ -1,2 +0,0 @@ -*:*:*:root:mypassword -*:*:*:postgres:mypassword diff --git a/archive/jailman/blueprints/nextcloud/includes/php.ini b/archive/jailman/blueprints/nextcloud/includes/php.ini deleted file mode 100644 index 6dfddbb7835..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/php.ini +++ /dev/null @@ -1,1915 +0,0 @@ -[PHP] - -;;;;;;;;;;;;;;;;;;; -; About php.ini ; -;;;;;;;;;;;;;;;;;;; -; PHP's initialization file, generally called php.ini, is responsible for -; configuring many of the aspects of PHP's behavior. - -; PHP attempts to find and load this configuration from a number of locations. -; The following is a summary of its search order: -; 1. SAPI module specific location. -; 2. The PHPRC environment variable. (As of PHP 5.2.0) -; 3. A number of predefined registry keys on Windows (As of PHP 5.2.0) -; 4. Current working directory (except CLI) -; 5. The web server's directory (for SAPI modules), or directory of PHP -; (otherwise in Windows) -; 6. The directory from the --with-config-file-path compile time option, or the -; Windows directory (C:\windows or C:\winnt) -; See the PHP docs for more specific information. -; http://php.net/configuration.file - -; The syntax of the file is extremely simple. Whitespace and lines -; beginning with a semicolon are silently ignored (as you probably guessed). -; Section headers (e.g. [Foo]) are also silently ignored, even though -; they might mean something in the future. - -; Directives following the section heading [PATH=/www/mysite] only -; apply to PHP files in the /www/mysite directory. Directives -; following the section heading [HOST=www.example.com] only apply to -; PHP files served from www.example.com. Directives set in these -; special sections cannot be overridden by user-defined INI files or -; at runtime. Currently, [PATH=] and [HOST=] sections only work under -; CGI/FastCGI. -; http://php.net/ini.sections - -; Directives are specified using the following syntax: -; directive = value -; Directive names are *case sensitive* - foo=bar is different from FOO=bar. -; Directives are variables used to configure PHP or PHP extensions. -; There is no name validation. If PHP can't find an expected -; directive because it is not set or is mistyped, a default value will be used. - -; The value can be a string, a number, a PHP constant (e.g. E_ALL or M_PI), one -; of the INI constants (On, Off, True, False, Yes, No and None) or an expression -; (e.g. E_ALL & ~E_NOTICE), a quoted string ("bar"), or a reference to a -; previously set variable or directive (e.g. ${foo}) - -; Expressions in the INI file are limited to bitwise operators and parentheses: -; | bitwise OR -; ^ bitwise XOR -; & bitwise AND -; ~ bitwise NOT -; ! boolean NOT - -; Boolean flags can be turned on using the values 1, On, True or Yes. -; They can be turned off using the values 0, Off, False or No. - -; An empty string can be denoted by simply not writing anything after the equal -; sign, or by using the None keyword: - -; foo = ; sets foo to an empty string -; foo = None ; sets foo to an empty string -; foo = "None" ; sets foo to the string 'None' - -; If you use constants in your value, and these constants belong to a -; dynamically loaded extension (either a PHP extension or a Zend extension), -; you may only use these constants *after* the line that loads the extension. - -;;;;;;;;;;;;;;;;;;; -; About this file ; -;;;;;;;;;;;;;;;;;;; -; PHP comes packaged with two INI files. One that is recommended to be used -; in production environments and one that is recommended to be used in -; development environments. - -; php.ini-production contains settings which hold security, performance and -; best practices at its core. But please be aware, these settings may break -; compatibility with older or less security conscience applications. We -; recommending using the production ini in production and testing environments. - -; php.ini-development is very similar to its production variant, except it is -; much more verbose when it comes to errors. We recommend using the -; development version only in development environments, as errors shown to -; application users can inadvertently leak otherwise secure information. - -; This is php.ini-production INI file. - -;;;;;;;;;;;;;;;;;;; -; Quick Reference ; -;;;;;;;;;;;;;;;;;;; -; The following are all the settings which are different in either the production -; or development versions of the INIs with respect to PHP's default behavior. -; Please see the actual settings later in the document for more details as to why -; we recommend these changes in PHP's behavior. - -; display_errors -; Default Value: On -; Development Value: On -; Production Value: Off - -; display_startup_errors -; Default Value: Off -; Development Value: On -; Production Value: Off - -; error_reporting -; Default Value: E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED -; Development Value: E_ALL -; Production Value: E_ALL & ~E_DEPRECATED & ~E_STRICT - -; html_errors -; Default Value: On -; Development Value: On -; Production value: On - -; log_errors -; Default Value: Off -; Development Value: On -; Production Value: On - -; max_input_time -; Default Value: -1 (Unlimited) -; Development Value: 60 (60 seconds) -; Production Value: 60 (60 seconds) - -; output_buffering -; Default Value: Off -; Development Value: 4096 -; Production Value: 4096 - -; register_argc_argv -; Default Value: On -; Development Value: Off -; Production Value: Off - -; request_order -; Default Value: None -; Development Value: "GP" -; Production Value: "GP" - -; session.gc_divisor -; Default Value: 100 -; Development Value: 1000 -; Production Value: 1000 - -; session.sid_bits_per_character -; Default Value: 4 -; Development Value: 5 -; Production Value: 5 - -; short_open_tag -; Default Value: On -; Development Value: Off -; Production Value: Off - -; track_errors -; Default Value: Off -; Development Value: On -; Production Value: Off - -; variables_order -; Default Value: "EGPCS" -; Development Value: "GPCS" -; Production Value: "GPCS" - -;;;;;;;;;;;;;;;;;;;; -; php.ini Options ; -;;;;;;;;;;;;;;;;;;;; -; Name for user-defined php.ini (.htaccess) files. Default is ".user.ini" -;user_ini.filename = ".user.ini" - -; To disable this feature set this option to empty value -;user_ini.filename = - -; TTL for user-defined php.ini files (time-to-live) in seconds. Default is 300 seconds (5 minutes) -;user_ini.cache_ttl = 300 - -;;;;;;;;;;;;;;;;;;;; -; Language Options ; -;;;;;;;;;;;;;;;;;;;; - -; Enable the PHP scripting language engine under Apache. -; http://php.net/engine -engine = On - -; This directive determines whether or not PHP will recognize code between -; tags as PHP source which should be processed as such. It is -; generally recommended that should be used and that this feature -; should be disabled, as enabling it may result in issues when generating XML -; documents, however this remains supported for backward compatibility reasons. -; Note that this directive does not control the would work. -; http://php.net/syntax-highlighting -;highlight.string = #DD0000 -;highlight.comment = #FF9900 -;highlight.keyword = #007700 -;highlight.default = #0000BB -;highlight.html = #000000 - -; If enabled, the request will be allowed to complete even if the user aborts -; the request. Consider enabling it if executing long requests, which may end up -; being interrupted by the user or a browser timing out. PHP's default behavior -; is to disable this feature. -; http://php.net/ignore-user-abort -;ignore_user_abort = On - -; Determines the size of the realpath cache to be used by PHP. This value should -; be increased on systems where PHP opens many files to reflect the quantity of -; the file operations performed. -; http://php.net/realpath-cache-size -;realpath_cache_size = 4096k - -; Duration of time, in seconds for which to cache realpath information for a given -; file or directory. For systems with rarely changing files, consider increasing this -; value. -; http://php.net/realpath-cache-ttl -;realpath_cache_ttl = 120 - -; Enables or disables the circular reference collector. -; http://php.net/zend.enable-gc -zend.enable_gc = On - -; If enabled, scripts may be written in encodings that are incompatible with -; the scanner. CP936, Big5, CP949 and Shift_JIS are the examples of such -; encodings. To use this feature, mbstring extension must be enabled. -; Default: Off -;zend.multibyte = Off - -; Allows to set the default encoding for the scripts. This value will be used -; unless "declare(encoding=...)" directive appears at the top of the script. -; Only affects if zend.multibyte is set. -; Default: "" -;zend.script_encoding = - -;;;;;;;;;;;;;;;;; -; Miscellaneous ; -;;;;;;;;;;;;;;;;; - -; Decides whether PHP may expose the fact that it is installed on the server -; (e.g. by adding its signature to the Web server header). It is no security -; threat in any way, but it makes it possible to determine whether you use PHP -; on your server or not. -; http://php.net/expose-php -expose_php = On - -;;;;;;;;;;;;;;;;;;; -; Resource Limits ; -;;;;;;;;;;;;;;;;;;; - -; Maximum execution time of each script, in seconds -; http://php.net/max-execution-time -; Note: This directive is hardcoded to 0 for the CLI SAPI -max_execution_time = 3600 - -; Maximum amount of time each script may spend parsing request data. It's a good -; idea to limit this time on productions servers in order to eliminate unexpectedly -; long running scripts. -; Note: This directive is hardcoded to -1 for the CLI SAPI -; Default Value: -1 (Unlimited) -; Development Value: 60 (60 seconds) -; Production Value: 60 (60 seconds) -; http://php.net/max-input-time -max_input_time = 3600 - -; Maximum input variable nesting level -; http://php.net/max-input-nesting-level -;max_input_nesting_level = 64 - -; How many GET/POST/COOKIE input variables may be accepted -; max_input_vars = 1000 - -; Maximum amount of memory a script may consume (128MB) -; http://php.net/memory-limit -memory_limit = 512M - -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; -; Error handling and logging ; -;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; - -; This directive informs PHP of which errors, warnings and notices you would like -; it to take action for. The recommended way of setting values for this -; directive is through the use of the error level constants and bitwise -; operators. The error level constants are below here for convenience as well as -; some common settings and their meanings. -; By default, PHP is set to take action on all errors, notices and warnings EXCEPT -; those related to E_NOTICE and E_STRICT, which together cover best practices and -; recommended coding standards in PHP. For performance reasons, this is the -; recommend error reporting setting. Your production server shouldn't be wasting -; resources complaining about best practices and coding standards. That's what -; development servers and development settings are for. -; Note: The php.ini-development file has this setting as E_ALL. This -; means it pretty much reports everything which is exactly what you want during -; development and early testing. -; -; Error Level Constants: -; E_ALL - All errors and warnings (includes E_STRICT as of PHP 5.4.0) -; E_ERROR - fatal run-time errors -; E_RECOVERABLE_ERROR - almost fatal run-time errors -; E_WARNING - run-time warnings (non-fatal errors) -; E_PARSE - compile-time parse errors -; E_NOTICE - run-time notices (these are warnings which often result -; from a bug in your code, but it's possible that it was -; intentional (e.g., using an uninitialized variable and -; relying on the fact it is automatically initialized to an -; empty string) -; E_STRICT - run-time notices, enable to have PHP suggest changes -; to your code which will ensure the best interoperability -; and forward compatibility of your code -; E_CORE_ERROR - fatal errors that occur during PHP's initial startup -; E_CORE_WARNING - warnings (non-fatal errors) that occur during PHP's -; initial startup -; E_COMPILE_ERROR - fatal compile-time errors -; E_COMPILE_WARNING - compile-time warnings (non-fatal errors) -; E_USER_ERROR - user-generated error message -; E_USER_WARNING - user-generated warning message -; E_USER_NOTICE - user-generated notice message -; E_DEPRECATED - warn about code that will not work in future versions -; of PHP -; E_USER_DEPRECATED - user-generated deprecation warnings -; -; Common Values: -; E_ALL (Show all errors, warnings and notices including coding standards.) -; E_ALL & ~E_NOTICE (Show all errors, except for notices) -; E_ALL & ~E_NOTICE & ~E_STRICT (Show all errors, except for notices and coding standards warnings.) -; E_COMPILE_ERROR|E_RECOVERABLE_ERROR|E_ERROR|E_CORE_ERROR (Show only errors) -; Default Value: E_ALL & ~E_NOTICE & ~E_STRICT & ~E_DEPRECATED -; Development Value: E_ALL -; Production Value: E_ALL & ~E_DEPRECATED & ~E_STRICT -; http://php.net/error-reporting -error_reporting = E_ALL & ~E_DEPRECATED & ~E_STRICT - -; This directive controls whether or not and where PHP will output errors, -; notices and warnings too. Error output is very useful during development, but -; it could be very dangerous in production environments. Depending on the code -; which is triggering the error, sensitive information could potentially leak -; out of your application such as database usernames and passwords or worse. -; For production environments, we recommend logging errors rather than -; sending them to STDOUT. -; Possible Values: -; Off = Do not display any errors -; stderr = Display errors to STDERR (affects only CGI/CLI binaries!) -; On or stdout = Display errors to STDOUT -; Default Value: On -; Development Value: On -; Production Value: Off -; http://php.net/display-errors -display_errors = Off - -; The display of errors which occur during PHP's startup sequence are handled -; separately from display_errors. PHP's default behavior is to suppress those -; errors from clients. Turning the display of startup errors on can be useful in -; debugging configuration problems. We strongly recommend you -; set this to 'off' for production servers. -; Default Value: Off -; Development Value: On -; Production Value: Off -; http://php.net/display-startup-errors -display_startup_errors = Off - -; Besides displaying errors, PHP can also log errors to locations such as a -; server-specific log, STDERR, or a location specified by the error_log -; directive found below. While errors should not be displayed on productions -; servers they should still be monitored and logging is a great way to do that. -; Default Value: Off -; Development Value: On -; Production Value: On -; http://php.net/log-errors -log_errors = On - -; Set maximum length of log_errors. In error_log information about the source is -; added. The default is 1024 and 0 allows to not apply any maximum length at all. -; http://php.net/log-errors-max-len -log_errors_max_len = 1024 - -; Do not log repeated messages. Repeated errors must occur in same file on same -; line unless ignore_repeated_source is set true. -; http://php.net/ignore-repeated-errors -ignore_repeated_errors = Off - -; Ignore source of message when ignoring repeated messages. When this setting -; is On you will not log errors with repeated messages from different files or -; source lines. -; http://php.net/ignore-repeated-source -ignore_repeated_source = Off - -; If this parameter is set to Off, then memory leaks will not be shown (on -; stdout or in the log). This has only effect in a debug compile, and if -; error reporting includes E_WARNING in the allowed list -; http://php.net/report-memleaks -report_memleaks = On - -; This setting is on by default. -;report_zend_debug = 0 - -; Store the last error/warning message in $php_errormsg (boolean). Setting this value -; to On can assist in debugging and is appropriate for development servers. It should -; however be disabled on production servers. -; This directive is DEPRECATED. -; Default Value: Off -; Development Value: Off -; Production Value: Off -; http://php.net/track-errors -;track_errors = Off - -; Turn off normal error reporting and emit XML-RPC error XML -; http://php.net/xmlrpc-errors -;xmlrpc_errors = 0 - -; An XML-RPC faultCode -;xmlrpc_error_number = 0 - -; When PHP displays or logs an error, it has the capability of formatting the -; error message as HTML for easier reading. This directive controls whether -; the error message is formatted as HTML or not. -; Note: This directive is hardcoded to Off for the CLI SAPI -; Default Value: On -; Development Value: On -; Production value: On -; http://php.net/html-errors -html_errors = On - -; If html_errors is set to On *and* docref_root is not empty, then PHP -; produces clickable error messages that direct to a page describing the error -; or function causing the error in detail. -; You can download a copy of the PHP manual from http://php.net/docs -; and change docref_root to the base URL of your local copy including the -; leading '/'. You must also specify the file extension being used including -; the dot. PHP's default behavior is to leave these settings empty, in which -; case no links to documentation are generated. -; Note: Never use this feature for production boxes. -; http://php.net/docref-root -; Examples -;docref_root = "/phpmanual/" - -; http://php.net/docref-ext -;docref_ext = .html - -; String to output before an error message. PHP's default behavior is to leave -; this setting blank. -; http://php.net/error-prepend-string -; Example: -;error_prepend_string = "" - -; String to output after an error message. PHP's default behavior is to leave -; this setting blank. -; http://php.net/error-append-string -; Example: -;error_append_string = "" - -; Log errors to specified file. PHP's default behavior is to leave this value -; empty. -; http://php.net/error-log -; Example: -;error_log = php_errors.log -; Log errors to syslog (Event Log on Windows). -;error_log = syslog - -;windows.show_crt_warning -; Default value: 0 -; Development value: 0 -; Production value: 0 - -;;;;;;;;;;;;;;;;; -; Data Handling ; -;;;;;;;;;;;;;;;;; - -; The separator used in PHP generated URLs to separate arguments. -; PHP's default setting is "&". -; http://php.net/arg-separator.output -; Example: -;arg_separator.output = "&" - -; List of separator(s) used by PHP to parse input URLs into variables. -; PHP's default setting is "&". -; NOTE: Every character in this directive is considered as separator! -; http://php.net/arg-separator.input -; Example: -;arg_separator.input = ";&" - -; This directive determines which super global arrays are registered when PHP -; starts up. G,P,C,E & S are abbreviations for the following respective super -; globals: GET, POST, COOKIE, ENV and SERVER. There is a performance penalty -; paid for the registration of these arrays and because ENV is not as commonly -; used as the others, ENV is not recommended on productions servers. You -; can still get access to the environment variables through getenv() should you -; need to. -; Default Value: "EGPCS" -; Development Value: "GPCS" -; Production Value: "GPCS"; -; http://php.net/variables-order -variables_order = "GPCS" - -; This directive determines which super global data (G,P & C) should be -; registered into the super global array REQUEST. If so, it also determines -; the order in which that data is registered. The values for this directive -; are specified in the same manner as the variables_order directive, -; EXCEPT one. Leaving this value empty will cause PHP to use the value set -; in the variables_order directive. It does not mean it will leave the super -; globals array REQUEST empty. -; Default Value: None -; Development Value: "GP" -; Production Value: "GP" -; http://php.net/request-order -request_order = "GP" - -; This directive determines whether PHP registers $argv & $argc each time it -; runs. $argv contains an array of all the arguments passed to PHP when a script -; is invoked. $argc contains an integer representing the number of arguments -; that were passed when the script was invoked. These arrays are extremely -; useful when running scripts from the command line. When this directive is -; enabled, registering these variables consumes CPU cycles and memory each time -; a script is executed. For performance reasons, this feature should be disabled -; on production servers. -; Note: This directive is hardcoded to On for the CLI SAPI -; Default Value: On -; Development Value: Off -; Production Value: Off -; http://php.net/register-argc-argv -register_argc_argv = Off - -; When enabled, the ENV, REQUEST and SERVER variables are created when they're -; first used (Just In Time) instead of when the script starts. If these -; variables are not used within a script, having this directive on will result -; in a performance gain. The PHP directive register_argc_argv must be disabled -; for this directive to have any affect. -; http://php.net/auto-globals-jit -auto_globals_jit = On - -; Whether PHP will read the POST data. -; This option is enabled by default. -; Most likely, you won't want to disable this option globally. It causes $_POST -; and $_FILES to always be empty; the only way you will be able to read the -; POST data will be through the php://input stream wrapper. This can be useful -; to proxy requests or to process the POST data in a memory efficient fashion. -; http://php.net/enable-post-data-reading -;enable_post_data_reading = Off - -; Maximum size of POST data that PHP will accept. -; Its value may be 0 to disable the limit. It is ignored if POST data reading -; is disabled through enable_post_data_reading. -; http://php.net/post-max-size -post_max_size = 16G -upload_max_size = 16G - -; Automatically add files before PHP document. -; http://php.net/auto-prepend-file -auto_prepend_file = - -; Automatically add files after PHP document. -; http://php.net/auto-append-file -auto_append_file = - -; By default, PHP will output a media type using the Content-Type header. To -; disable this, simply set it to be empty. -; -; PHP's built-in default media type is set to text/html. -; http://php.net/default-mimetype -default_mimetype = "text/html" - -; PHP's default character set is set to UTF-8. -; http://php.net/default-charset -default_charset = "UTF-8" - -; PHP internal character encoding is set to empty. -; If empty, default_charset is used. -; http://php.net/internal-encoding -;internal_encoding = - -; PHP input character encoding is set to empty. -; If empty, default_charset is used. -; http://php.net/input-encoding -;input_encoding = - -; PHP output character encoding is set to empty. -; If empty, default_charset is used. -; See also output_buffer. -; http://php.net/output-encoding -;output_encoding = - -;;;;;;;;;;;;;;;;;;;;;;;;; -; Paths and Directories ; -;;;;;;;;;;;;;;;;;;;;;;;;; - -; UNIX: "/path1:/path2" -;include_path = ".:/php/includes" -; -; Windows: "\path1;\path2" -;include_path = ".;c:\php\includes" -; -; PHP's default setting for include_path is ".;/path/to/php/pear" -; http://php.net/include-path - -; The root of the PHP pages, used only if nonempty. -; if PHP was not compiled with FORCE_REDIRECT, you SHOULD set doc_root -; if you are running php as a CGI under any web server (other than IIS) -; see documentation for security issues. The alternate is to use the -; cgi.force_redirect configuration below -; http://php.net/doc-root -doc_root = - -; The directory under which PHP opens the script using /~username used only -; if nonempty. -; http://php.net/user-dir -user_dir = - -; Directory in which the loadable extensions (modules) reside. -; http://php.net/extension-dir -; extension_dir = "./" -; On windows: -; extension_dir = "ext" - -; Directory where the temporary files should be placed. -; Defaults to the system default (see sys_get_temp_dir) -; sys_temp_dir = "/tmp" - -; Whether or not to enable the dl() function. The dl() function does NOT work -; properly in multithreaded servers, such as IIS or Zeus, and is automatically -; disabled on them. -; http://php.net/enable-dl -enable_dl = Off - -; cgi.force_redirect is necessary to provide security running PHP as a CGI under -; most web servers. Left undefined, PHP turns this on by default. You can -; turn it off here AT YOUR OWN RISK -; **You CAN safely turn this off for IIS, in fact, you MUST.** -; http://php.net/cgi.force-redirect -;cgi.force_redirect = 1 - -; if cgi.nph is enabled it will force cgi to always sent Status: 200 with -; every request. PHP's default behavior is to disable this feature. -;cgi.nph = 1 - -; if cgi.force_redirect is turned on, and you are not running under Apache or Netscape -; (iPlanet) web servers, you MAY need to set an environment variable name that PHP -; will look for to know it is OK to continue execution. Setting this variable MAY -; cause security issues, KNOW WHAT YOU ARE DOING FIRST. -; http://php.net/cgi.redirect-status-env -;cgi.redirect_status_env = - -; cgi.fix_pathinfo provides *real* PATH_INFO/PATH_TRANSLATED support for CGI. PHP's -; previous behaviour was to set PATH_TRANSLATED to SCRIPT_FILENAME, and to not grok -; what PATH_INFO is. For more information on PATH_INFO, see the cgi specs. Setting -; this to 1 will cause PHP CGI to fix its paths to conform to the spec. A setting -; of zero causes PHP to behave as before. Default is 1. You should fix your scripts -; to use SCRIPT_FILENAME rather than PATH_TRANSLATED. -; http://php.net/cgi.fix-pathinfo -cgi.fix_pathinfo=1 - -; if cgi.discard_path is enabled, the PHP CGI binary can safely be placed outside -; of the web tree and people will not be able to circumvent .htaccess security. -; http://php.net/cgi.dicard-path -;cgi.discard_path=1 - -; FastCGI under IIS (on WINNT based OS) supports the ability to impersonate -; security tokens of the calling client. This allows IIS to define the -; security context that the request runs under. mod_fastcgi under Apache -; does not currently support this feature (03/17/2002) -; Set to 1 if running under IIS. Default is zero. -; http://php.net/fastcgi.impersonate -;fastcgi.impersonate = 1 - -; Disable logging through FastCGI connection. PHP's default behavior is to enable -; this feature. -;fastcgi.logging = 0 - -; cgi.rfc2616_headers configuration option tells PHP what type of headers to -; use when sending HTTP response code. If set to 0, PHP sends Status: header that -; is supported by Apache. When this option is set to 1, PHP will send -; RFC2616 compliant header. -; Default is zero. -; http://php.net/cgi.rfc2616-headers -;cgi.rfc2616_headers = 0 - -; cgi.check_shebang_line controls whether CGI PHP checks for line starting with #! -; (shebang) at the top of the running script. This line might be needed if the -; script support running both as stand-alone script and via PHP CGI<. PHP in CGI -; mode skips this line and ignores its content if this directive is turned on. -; http://php.net/cgi.check-shebang-line -;cgi.check_shebang_line=1 - -;;;;;;;;;;;;;;;; -; File Uploads ; -;;;;;;;;;;;;;;;; - -; Whether to allow HTTP file uploads. -; http://php.net/file-uploads -file_uploads = On - -; Temporary directory for HTTP uploaded files (will use system default if not -; specified). -; http://php.net/upload-tmp-dir -;upload_tmp_dir = - -; Maximum allowed size for uploaded files. -; http://php.net/upload-max-filesize -upload_max_filesize = 16G - -; Maximum number of files that can be uploaded via a single request -max_file_uploads = 20 - -;;;;;;;;;;;;;;;;;; -; Fopen wrappers ; -;;;;;;;;;;;;;;;;;; - -; Whether to allow the treatment of URLs (like http:// or ftp://) as files. -; http://php.net/allow-url-fopen -allow_url_fopen = On - -; Whether to allow include/require to open URLs (like http:// or ftp://) as files. -; http://php.net/allow-url-include -allow_url_include = Off - -; Define the anonymous ftp password (your email address). PHP's default setting -; for this is empty. -; http://php.net/from -;from="john@doe.com" - -; Define the User-Agent string. PHP's default setting for this is empty. -; http://php.net/user-agent -;user_agent="PHP" - -; Default timeout for socket based streams (seconds) -; http://php.net/default-socket-timeout -default_socket_timeout = 3600 - -; If your scripts have to deal with files from Macintosh systems, -; or you are running on a Mac and need to deal with files from -; unix or win32 systems, setting this flag will cause PHP to -; automatically detect the EOL character in those files so that -; fgets() and file() will work regardless of the source of the file. -; http://php.net/auto-detect-line-endings -;auto_detect_line_endings = Off - -;;;;;;;;;;;;;;;;;;;;;; -; Dynamic Extensions ; -;;;;;;;;;;;;;;;;;;;;;; - -; If you wish to have an extension loaded automatically, use the following -; syntax: -; -; extension=modulename -; -; For example: -; -; extension=mysqli -; -; When the extension library to load is not located in the default extension -; directory, You may specify an absolute path to the library file: -; -; extension=/path/to/extension/mysqli.so -; -; Note : The syntax used in previous PHP versions ('extension=.so' and -; 'extension='php_.dll') is supported for legacy reasons and may be -; deprecated in a future PHP major version. So, when it is possible, please -; move to the new ('extension=) syntax. -; -; Notes for Windows environments : -; -; - ODBC support is built in, so no dll is needed for it. -; - Many DLL files are located in the extensions/ (PHP 4) or ext/ (PHP 5+) -; extension folders as well as the separate PECL DLL download (PHP 5+). -; Be sure to appropriately set the extension_dir directive. -; -;extension=bz2 -;extension=curl -;extension=fileinfo -;extension=gd2 -;extension=gettext -;extension=gmp -;extension=intl -;extension=imap -;extension=interbase -;extension=ldap -;extension=mbstring -;extension=exif ; Must be after mbstring as it depends on it -;extension=mysqli -;extension=oci8_12c ; Use with Oracle Database 12c Instant Client -;extension=openssl -;extension=pdo_firebird -;extension=pdo_mysql -;extension=pdo_oci -;extension=pdo_odbc -;extension=pdo_pgsql -;extension=pdo_sqlite -;extension=pgsql -;extension=shmop - -; The MIBS data available in the PHP distribution must be installed. -; See http://www.php.net/manual/en/snmp.installation.php -;extension=snmp - -;extension=soap -;extension=sockets -;extension=sqlite3 -;extension=tidy -;extension=xmlrpc -;extension=xsl - -;;;;;;;;;;;;;;;;;;; -; Module Settings ; -;;;;;;;;;;;;;;;;;;; - -[CLI Server] -; Whether the CLI web server uses ANSI color coding in its terminal output. -cli_server.color = On - -[Date] -; Defines the default timezone used by the date functions -; http://php.net/date.timezone -date.timezone = mytimezone - -; http://php.net/date.default-latitude -;date.default_latitude = 31.7667 - -; http://php.net/date.default-longitude -;date.default_longitude = 35.2333 - -; http://php.net/date.sunrise-zenith -;date.sunrise_zenith = 90.583333 - -; http://php.net/date.sunset-zenith -;date.sunset_zenith = 90.583333 - -[filter] -; http://php.net/filter.default -;filter.default = unsafe_raw - -; http://php.net/filter.default-flags -;filter.default_flags = - -[iconv] -; Use of this INI entry is deprecated, use global input_encoding instead. -; If empty, default_charset or input_encoding or iconv.input_encoding is used. -; The precedence is: default_charset < intput_encoding < iconv.input_encoding -;iconv.input_encoding = - -; Use of this INI entry is deprecated, use global internal_encoding instead. -; If empty, default_charset or internal_encoding or iconv.internal_encoding is used. -; The precedence is: default_charset < internal_encoding < iconv.internal_encoding -;iconv.internal_encoding = - -; Use of this INI entry is deprecated, use global output_encoding instead. -; If empty, default_charset or output_encoding or iconv.output_encoding is used. -; The precedence is: default_charset < output_encoding < iconv.output_encoding -; To use an output encoding conversion, iconv's output handler must be set -; otherwise output encoding conversion cannot be performed. -;iconv.output_encoding = - -[intl] -;intl.default_locale = -; This directive allows you to produce PHP errors when some error -; happens within intl functions. The value is the level of the error produced. -; Default is 0, which does not produce any errors. -;intl.error_level = E_WARNING -;intl.use_exceptions = 0 - -[sqlite3] -;sqlite3.extension_dir = - -[Pcre] -;PCRE library backtracking limit. -; http://php.net/pcre.backtrack-limit -;pcre.backtrack_limit=100000 - -;PCRE library recursion limit. -;Please note that if you set this value to a high number you may consume all -;the available process stack and eventually crash PHP (due to reaching the -;stack size limit imposed by the Operating System). -; http://php.net/pcre.recursion-limit -;pcre.recursion_limit=100000 - -;Enables or disables JIT compilation of patterns. This requires the PCRE -;library to be compiled with JIT support. -;pcre.jit=1 - -[Pdo] -; Whether to pool ODBC connections. Can be one of "strict", "relaxed" or "off" -; http://php.net/pdo-odbc.connection-pooling -;pdo_odbc.connection_pooling=strict - -;pdo_odbc.db2_instance_name - -[Pdo_mysql] -; If mysqlnd is used: Number of cache slots for the internal result set cache -; http://php.net/pdo_mysql.cache_size -pdo_mysql.cache_size = 2000 - -; Default socket name for local MySQL connects. If empty, uses the built-in -; MySQL defaults. -; http://php.net/pdo_mysql.default-socket -pdo_mysql.default_socket= - -[Phar] -; http://php.net/phar.readonly -;phar.readonly = On - -; http://php.net/phar.require-hash -;phar.require_hash = On - -;phar.cache_list = - -[mail function] -; For Win32 only. -; http://php.net/smtp -SMTP = localhost -; http://php.net/smtp-port -smtp_port = 25 - -; For Win32 only. -; http://php.net/sendmail-from -;sendmail_from = me@example.com - -; For Unix only. You may supply arguments as well (default: "sendmail -t -i"). -; http://php.net/sendmail-path -;sendmail_path = - -; Force the addition of the specified parameters to be passed as extra parameters -; to the sendmail binary. These parameters will always replace the value of -; the 5th parameter to mail(). -;mail.force_extra_parameters = - -; Add X-PHP-Originating-Script: that will include uid of the script followed by the filename -mail.add_x_header = On - -; The path to a log file that will log all mail() calls. Log entries include -; the full path of the script, line number, To address and headers. -;mail.log = -; Log mail to syslog (Event Log on Windows). -;mail.log = syslog - -[ODBC] -; http://php.net/odbc.default-db -;odbc.default_db = Not yet implemented - -; http://php.net/odbc.default-user -;odbc.default_user = Not yet implemented - -; http://php.net/odbc.default-pw -;odbc.default_pw = Not yet implemented - -; Controls the ODBC cursor model. -; Default: SQL_CURSOR_STATIC (default). -;odbc.default_cursortype - -; Allow or prevent persistent links. -; http://php.net/odbc.allow-persistent -odbc.allow_persistent = On - -; Check that a connection is still valid before reuse. -; http://php.net/odbc.check-persistent -odbc.check_persistent = On - -; Maximum number of persistent links. -1 means no limit. -; http://php.net/odbc.max-persistent -odbc.max_persistent = -1 - -; Maximum number of links (persistent + non-persistent). -1 means no limit. -; http://php.net/odbc.max-links -odbc.max_links = -1 - -; Handling of LONG fields. Returns number of bytes to variables. 0 means -; passthru. -; http://php.net/odbc.defaultlrl -odbc.defaultlrl = 4096 - -; Handling of binary data. 0 means passthru, 1 return as is, 2 convert to char. -; See the documentation on odbc_binmode and odbc_longreadlen for an explanation -; of odbc.defaultlrl and odbc.defaultbinmode -; http://php.net/odbc.defaultbinmode -odbc.defaultbinmode = 1 - -;birdstep.max_links = -1 - -[Interbase] -; Allow or prevent persistent links. -ibase.allow_persistent = 1 - -; Maximum number of persistent links. -1 means no limit. -ibase.max_persistent = -1 - -; Maximum number of links (persistent + non-persistent). -1 means no limit. -ibase.max_links = -1 - -; Default database name for ibase_connect(). -;ibase.default_db = - -; Default username for ibase_connect(). -;ibase.default_user = - -; Default password for ibase_connect(). -;ibase.default_password = - -; Default charset for ibase_connect(). -;ibase.default_charset = - -; Default timestamp format. -ibase.timestampformat = "%Y-%m-%d %H:%M:%S" - -; Default date format. -ibase.dateformat = "%Y-%m-%d" - -; Default time format. -ibase.timeformat = "%H:%M:%S" - -[MySQLi] - -; Maximum number of persistent links. -1 means no limit. -; http://php.net/mysqli.max-persistent -mysqli.max_persistent = -1 - -; Allow accessing, from PHP's perspective, local files with LOAD DATA statements -; http://php.net/mysqli.allow_local_infile -;mysqli.allow_local_infile = On - -; Allow or prevent persistent links. -; http://php.net/mysqli.allow-persistent -mysqli.allow_persistent = On - -; Maximum number of links. -1 means no limit. -; http://php.net/mysqli.max-links -mysqli.max_links = -1 - -; If mysqlnd is used: Number of cache slots for the internal result set cache -; http://php.net/mysqli.cache_size -mysqli.cache_size = 2000 - -; Default port number for mysqli_connect(). If unset, mysqli_connect() will use -; the $MYSQL_TCP_PORT or the mysql-tcp entry in /etc/services or the -; compile-time value defined MYSQL_PORT (in that order). Win32 will only look -; at MYSQL_PORT. -; http://php.net/mysqli.default-port -mysqli.default_port = 3306 - -; Default socket name for local MySQL connects. If empty, uses the built-in -; MySQL defaults. -; http://php.net/mysqli.default-socket -mysqli.default_socket = - -; Default host for mysql_connect() (doesn't apply in safe mode). -; http://php.net/mysqli.default-host -mysqli.default_host = - -; Default user for mysql_connect() (doesn't apply in safe mode). -; http://php.net/mysqli.default-user -mysqli.default_user = - -; Default password for mysqli_connect() (doesn't apply in safe mode). -; Note that this is generally a *bad* idea to store passwords in this file. -; *Any* user with PHP access can run 'echo get_cfg_var("mysqli.default_pw") -; and reveal this password! And of course, any users with read access to this -; file will be able to reveal the password as well. -; http://php.net/mysqli.default-pw -mysqli.default_pw = - -; Allow or prevent reconnect -mysqli.reconnect = Off - -[mysqlnd] -; Enable / Disable collection of general statistics by mysqlnd which can be -; used to tune and monitor MySQL operations. -; http://php.net/mysqlnd.collect_statistics -mysqlnd.collect_statistics = On - -; Enable / Disable collection of memory usage statistics by mysqlnd which can be -; used to tune and monitor MySQL operations. -; http://php.net/mysqlnd.collect_memory_statistics -mysqlnd.collect_memory_statistics = Off - -; Records communication from all extensions using mysqlnd to the specified log -; file. -; http://php.net/mysqlnd.debug -;mysqlnd.debug = - -; Defines which queries will be logged. -; http://php.net/mysqlnd.log_mask -;mysqlnd.log_mask = 0 - -; Default size of the mysqlnd memory pool, which is used by result sets. -; http://php.net/mysqlnd.mempool_default_size -;mysqlnd.mempool_default_size = 16000 - -; Size of a pre-allocated buffer used when sending commands to MySQL in bytes. -; http://php.net/mysqlnd.net_cmd_buffer_size -;mysqlnd.net_cmd_buffer_size = 2048 - -; Size of a pre-allocated buffer used for reading data sent by the server in -; bytes. -; http://php.net/mysqlnd.net_read_buffer_size -;mysqlnd.net_read_buffer_size = 32768 - -; Timeout for network requests in seconds. -; http://php.net/mysqlnd.net_read_timeout -;mysqlnd.net_read_timeout = 31536000 - -; SHA-256 Authentication Plugin related. File with the MySQL server public RSA -; key. -; http://php.net/mysqlnd.sha256_server_public_key -;mysqlnd.sha256_server_public_key = - -[OCI8] - -; Connection: Enables privileged connections using external -; credentials (OCI_SYSOPER, OCI_SYSDBA) -; http://php.net/oci8.privileged-connect -;oci8.privileged_connect = Off - -; Connection: The maximum number of persistent OCI8 connections per -; process. Using -1 means no limit. -; http://php.net/oci8.max-persistent -;oci8.max_persistent = -1 - -; Connection: The maximum number of seconds a process is allowed to -; maintain an idle persistent connection. Using -1 means idle -; persistent connections will be maintained forever. -; http://php.net/oci8.persistent-timeout -;oci8.persistent_timeout = -1 - -; Connection: The number of seconds that must pass before issuing a -; ping during oci_pconnect() to check the connection validity. When -; set to 0, each oci_pconnect() will cause a ping. Using -1 disables -; pings completely. -; http://php.net/oci8.ping-interval -;oci8.ping_interval = 60 - -; Connection: Set this to a user chosen connection class to be used -; for all pooled server requests with Oracle 11g Database Resident -; Connection Pooling (DRCP). To use DRCP, this value should be set to -; the same string for all web servers running the same application, -; the database pool must be configured, and the connection string must -; specify to use a pooled server. -;oci8.connection_class = - -; High Availability: Using On lets PHP receive Fast Application -; Notification (FAN) events generated when a database node fails. The -; database must also be configured to post FAN events. -;oci8.events = Off - -; Tuning: This option enables statement caching, and specifies how -; many statements to cache. Using 0 disables statement caching. -; http://php.net/oci8.statement-cache-size -;oci8.statement_cache_size = 20 - -; Tuning: Enables statement prefetching and sets the default number of -; rows that will be fetched automatically after statement execution. -; http://php.net/oci8.default-prefetch -;oci8.default_prefetch = 100 - -; Compatibility. Using On means oci_close() will not close -; oci_connect() and oci_new_connect() connections. -; http://php.net/oci8.old-oci-close-semantics -;oci8.old_oci_close_semantics = Off - -[PostgreSQL] -; Allow or prevent persistent links. -; http://php.net/pgsql.allow-persistent -pgsql.allow_persistent = On - -; Detect broken persistent links always with pg_pconnect(). -; Auto reset feature requires a little overheads. -; http://php.net/pgsql.auto-reset-persistent -pgsql.auto_reset_persistent = Off - -; Maximum number of persistent links. -1 means no limit. -; http://php.net/pgsql.max-persistent -pgsql.max_persistent = -1 - -; Maximum number of links (persistent+non persistent). -1 means no limit. -; http://php.net/pgsql.max-links -pgsql.max_links = -1 - -; Ignore PostgreSQL backends Notice message or not. -; Notice message logging require a little overheads. -; http://php.net/pgsql.ignore-notice -pgsql.ignore_notice = 0 - -; Log PostgreSQL backends Notice message or not. -; Unless pgsql.ignore_notice=0, module cannot log notice message. -; http://php.net/pgsql.log-notice -pgsql.log_notice = 0 - -[bcmath] -; Number of decimal digits for all bcmath functions. -; http://php.net/bcmath.scale -bcmath.scale = 0 - -[browscap] -; http://php.net/browscap -;browscap = extra/browscap.ini - -[Session] -; Handler used to store/retrieve data. -; http://php.net/session.save-handler -session.save_handler = files - -; Argument passed to save_handler. In the case of files, this is the path -; where data files are stored. Note: Windows users have to change this -; variable in order to use PHP's session functions. -; -; The path can be defined as: -; -; session.save_path = "N;/path" -; -; where N is an integer. Instead of storing all the session files in -; /path, what this will do is use subdirectories N-levels deep, and -; store the session data in those directories. This is useful if -; your OS has problems with many files in one directory, and is -; a more efficient layout for servers that handle many sessions. -; -; NOTE 1: PHP will not create this directory structure automatically. -; You can use the script in the ext/session dir for that purpose. -; NOTE 2: See the section on garbage collection below if you choose to -; use subdirectories for session storage -; -; The file storage module creates files using mode 600 by default. -; You can change that by using -; -; session.save_path = "N;MODE;/path" -; -; where MODE is the octal representation of the mode. Note that this -; does not overwrite the process's umask. -; http://php.net/session.save-path -;session.save_path = "/tmp" - -; Whether to use strict session mode. -; Strict session mode does not accept uninitialized session ID and regenerate -; session ID if browser sends uninitialized session ID. Strict mode protects -; applications from session fixation via session adoption vulnerability. It is -; disabled by default for maximum compatibility, but enabling it is encouraged. -; https://wiki.php.net/rfc/strict_sessions -session.use_strict_mode = 0 - -; Whether to use cookies. -; http://php.net/session.use-cookies -session.use_cookies = 1 - -; http://php.net/session.cookie-secure -;session.cookie_secure = - -; This option forces PHP to fetch and use a cookie for storing and maintaining -; the session id. We encourage this operation as it's very helpful in combating -; session hijacking when not specifying and managing your own session id. It is -; not the be-all and end-all of session hijacking defense, but it's a good start. -; http://php.net/session.use-only-cookies -session.use_only_cookies = 1 - -; Name of the session (used as cookie name). -; http://php.net/session.name -session.name = PHPSESSID - -; Initialize session on request startup. -; http://php.net/session.auto-start -session.auto_start = 0 - -; Lifetime in seconds of cookie or, if 0, until browser is restarted. -; http://php.net/session.cookie-lifetime -session.cookie_lifetime = 0 - -; The path for which the cookie is valid. -; http://php.net/session.cookie-path -session.cookie_path = / - -; The domain for which the cookie is valid. -; http://php.net/session.cookie-domain -session.cookie_domain = - -; Whether or not to add the httpOnly flag to the cookie, which makes it inaccessible to browser scripting languages such as JavaScript. -; http://php.net/session.cookie-httponly -session.cookie_httponly = - -; Handler used to serialize data. php is the standard serializer of PHP. -; http://php.net/session.serialize-handler -session.serialize_handler = php - -; Defines the probability that the 'garbage collection' process is started -; on every session initialization. The probability is calculated by using -; gc_probability/gc_divisor. Where session.gc_probability is the numerator -; and gc_divisor is the denominator in the equation. Setting this value to 1 -; when the session.gc_divisor value is 100 will give you approximately a 1% chance -; the gc will run on any give request. -; Default Value: 1 -; Development Value: 1 -; Production Value: 1 -; http://php.net/session.gc-probability -session.gc_probability = 1 - -; Defines the probability that the 'garbage collection' process is started on every -; session initialization. The probability is calculated by using the following equation: -; gc_probability/gc_divisor. Where session.gc_probability is the numerator and -; session.gc_divisor is the denominator in the equation. Setting this value to 1 -; when the session.gc_divisor value is 100 will give you approximately a 1% chance -; the gc will run on any give request. Increasing this value to 1000 will give you -; a 0.1% chance the gc will run on any give request. For high volume production servers, -; this is a more efficient approach. -; Default Value: 100 -; Development Value: 1000 -; Production Value: 1000 -; http://php.net/session.gc-divisor -session.gc_divisor = 1000 - -; After this number of seconds, stored data will be seen as 'garbage' and -; cleaned up by the garbage collection process. -; http://php.net/session.gc-maxlifetime -session.gc_maxlifetime = 1440 - -; NOTE: If you are using the subdirectory option for storing session files -; (see session.save_path above), then garbage collection does *not* -; happen automatically. You will need to do your own garbage -; collection through a shell script, cron entry, or some other method. -; For example, the following script would is the equivalent of -; setting session.gc_maxlifetime to 1440 (1440 seconds = 24 minutes): -; find /path/to/sessions -cmin +24 -type f | xargs rm - -; Check HTTP Referer to invalidate externally stored URLs containing ids. -; HTTP_REFERER has to contain this substring for the session to be -; considered as valid. -; http://php.net/session.referer-check -session.referer_check = - -; Set to {nocache,private,public,} to determine HTTP caching aspects -; or leave this empty to avoid sending anti-caching headers. -; http://php.net/session.cache-limiter -session.cache_limiter = nocache - -; Document expires after n minutes. -; http://php.net/session.cache-expire -session.cache_expire = 180 - -; trans sid support is disabled by default. -; Use of trans sid may risk your users' security. -; Use this option with caution. -; - User may send URL contains active session ID -; to other person via. email/irc/etc. -; - URL that contains active session ID may be stored -; in publicly accessible computer. -; - User may access your site with the same session ID -; always using URL stored in browser's history or bookmarks. -; http://php.net/session.use-trans-sid -session.use_trans_sid = 0 - -; Set session ID character length. This value could be between 22 to 256. -; Shorter length than default is supported only for compatibility reason. -; Users should use 32 or more chars. -; http://php.net/session.sid-length -; Default Value: 32 -; Development Value: 26 -; Production Value: 26 -session.sid_length = 26 - -; The URL rewriter will look for URLs in a defined set of HTML tags. -;
is special; if you include them here, the rewriter will -; add a hidden field with the info which is otherwise appended -; to URLs. tag's action attribute URL will not be modified -; unless it is specified. -; Note that all valid entries require a "=", even if no value follows. -; Default Value: "a=href,area=href,frame=src,form=" -; Development Value: "a=href,area=href,frame=src,form=" -; Production Value: "a=href,area=href,frame=src,form=" -; http://php.net/url-rewriter.tags -session.trans_sid_tags = "a=href,area=href,frame=src,form=" - -; URL rewriter does not rewrite absolute URLs by default. -; To enable rewrites for absolute pathes, target hosts must be specified -; at RUNTIME. i.e. use ini_set() -; tags is special. PHP will check action attribute's URL regardless -; of session.trans_sid_tags setting. -; If no host is defined, HTTP_HOST will be used for allowed host. -; Example value: php.net,www.php.net,wiki.php.net -; Use "," for multiple hosts. No spaces are allowed. -; Default Value: "" -; Development Value: "" -; Production Value: "" -;session.trans_sid_hosts="" - -; Define how many bits are stored in each character when converting -; the binary hash data to something readable. -; Possible values: -; 4 (4 bits: 0-9, a-f) -; 5 (5 bits: 0-9, a-v) -; 6 (6 bits: 0-9, a-z, A-Z, "-", ",") -; Default Value: 4 -; Development Value: 5 -; Production Value: 5 -; http://php.net/session.hash-bits-per-character -session.sid_bits_per_character = 5 - -; Enable upload progress tracking in $_SESSION -; Default Value: On -; Development Value: On -; Production Value: On -; http://php.net/session.upload-progress.enabled -;session.upload_progress.enabled = On - -; Cleanup the progress information as soon as all POST data has been read -; (i.e. upload completed). -; Default Value: On -; Development Value: On -; Production Value: On -; http://php.net/session.upload-progress.cleanup -;session.upload_progress.cleanup = On - -; A prefix used for the upload progress key in $_SESSION -; Default Value: "upload_progress_" -; Development Value: "upload_progress_" -; Production Value: "upload_progress_" -; http://php.net/session.upload-progress.prefix -;session.upload_progress.prefix = "upload_progress_" - -; The index name (concatenated with the prefix) in $_SESSION -; containing the upload progress information -; Default Value: "PHP_SESSION_UPLOAD_PROGRESS" -; Development Value: "PHP_SESSION_UPLOAD_PROGRESS" -; Production Value: "PHP_SESSION_UPLOAD_PROGRESS" -; http://php.net/session.upload-progress.name -;session.upload_progress.name = "PHP_SESSION_UPLOAD_PROGRESS" - -; How frequently the upload progress should be updated. -; Given either in percentages (per-file), or in bytes -; Default Value: "1%" -; Development Value: "1%" -; Production Value: "1%" -; http://php.net/session.upload-progress.freq -;session.upload_progress.freq = "1%" - -; The minimum delay between updates, in seconds -; Default Value: 1 -; Development Value: 1 -; Production Value: 1 -; http://php.net/session.upload-progress.min-freq -;session.upload_progress.min_freq = "1" - -; Only write session data when session data is changed. Enabled by default. -; http://php.net/session.lazy-write -;session.lazy_write = On - -[Assertion] -; Switch whether to compile assertions at all (to have no overhead at run-time) -; -1: Do not compile at all -; 0: Jump over assertion at run-time -; 1: Execute assertions -; Changing from or to a negative value is only possible in php.ini! (For turning assertions on and off at run-time, see assert.active, when zend.assertions = 1) -; Default Value: 1 -; Development Value: 1 -; Production Value: -1 -; http://php.net/zend.assertions -zend.assertions = -1 - -; Assert(expr); active by default. -; http://php.net/assert.active -;assert.active = On - -; Throw an AssertationException on failed assertions -; http://php.net/assert.exception -;assert.exception = On - -; Issue a PHP warning for each failed assertion. (Overridden by assert.exception if active) -; http://php.net/assert.warning -;assert.warning = On - -; Don't bail out by default. -; http://php.net/assert.bail -;assert.bail = Off - -; User-function to be called if an assertion fails. -; http://php.net/assert.callback -;assert.callback = 0 - -; Eval the expression with current error_reporting(). Set to true if you want -; error_reporting(0) around the eval(). -; http://php.net/assert.quiet-eval -;assert.quiet_eval = 0 - -[COM] -; path to a file containing GUIDs, IIDs or filenames of files with TypeLibs -; http://php.net/com.typelib-file -;com.typelib_file = - -; allow Distributed-COM calls -; http://php.net/com.allow-dcom -;com.allow_dcom = true - -; autoregister constants of a components typlib on com_load() -; http://php.net/com.autoregister-typelib -;com.autoregister_typelib = true - -; register constants casesensitive -; http://php.net/com.autoregister-casesensitive -;com.autoregister_casesensitive = false - -; show warnings on duplicate constant registrations -; http://php.net/com.autoregister-verbose -;com.autoregister_verbose = true - -; The default character set code-page to use when passing strings to and from COM objects. -; Default: system ANSI code page -;com.code_page= - -[mbstring] -; language for internal character representation. -; This affects mb_send_mail() and mbstring.detect_order. -; http://php.net/mbstring.language -;mbstring.language = Japanese - -; Use of this INI entry is deprecated, use global internal_encoding instead. -; internal/script encoding. -; Some encoding cannot work as internal encoding. (e.g. SJIS, BIG5, ISO-2022-*) -; If empty, default_charset or internal_encoding or iconv.internal_encoding is used. -; The precedence is: default_charset < internal_encoding < iconv.internal_encoding -;mbstring.internal_encoding = - -; Use of this INI entry is deprecated, use global input_encoding instead. -; http input encoding. -; mbstring.encoding_traslation = On is needed to use this setting. -; If empty, default_charset or input_encoding or mbstring.input is used. -; The precedence is: default_charset < intput_encoding < mbsting.http_input -; http://php.net/mbstring.http-input -;mbstring.http_input = - -; Use of this INI entry is deprecated, use global output_encoding instead. -; http output encoding. -; mb_output_handler must be registered as output buffer to function. -; If empty, default_charset or output_encoding or mbstring.http_output is used. -; The precedence is: default_charset < output_encoding < mbstring.http_output -; To use an output encoding conversion, mbstring's output handler must be set -; otherwise output encoding conversion cannot be performed. -; http://php.net/mbstring.http-output -;mbstring.http_output = - -; enable automatic encoding translation according to -; mbstring.internal_encoding setting. Input chars are -; converted to internal encoding by setting this to On. -; Note: Do _not_ use automatic encoding translation for -; portable libs/applications. -; http://php.net/mbstring.encoding-translation -;mbstring.encoding_translation = Off - -; automatic encoding detection order. -; "auto" detect order is changed according to mbstring.language -; http://php.net/mbstring.detect-order -;mbstring.detect_order = auto - -; substitute_character used when character cannot be converted -; one from another -; http://php.net/mbstring.substitute-character -;mbstring.substitute_character = none - -; overload(replace) single byte functions by mbstring functions. -; mail(), ereg(), etc are overloaded by mb_send_mail(), mb_ereg(), -; etc. Possible values are 0,1,2,4 or combination of them. -; For example, 7 for overload everything. -; 0: No overload -; 1: Overload mail() function -; 2: Overload str*() functions -; 4: Overload ereg*() functions -; http://php.net/mbstring.func-overload -;mbstring.func_overload = 0 - -; enable strict encoding detection. -; Default: Off -;mbstring.strict_detection = On - -; This directive specifies the regex pattern of content types for which mb_output_handler() -; is activated. -; Default: mbstring.http_output_conv_mimetype=^(text/|application/xhtml\+xml) -;mbstring.http_output_conv_mimetype= - -[gd] -; Tell the jpeg decode to ignore warnings and try to create -; a gd image. The warning will then be displayed as notices -; disabled by default -; http://php.net/gd.jpeg-ignore-warning -;gd.jpeg_ignore_warning = 1 - -[exif] -; Exif UNICODE user comments are handled as UCS-2BE/UCS-2LE and JIS as JIS. -; With mbstring support this will automatically be converted into the encoding -; given by corresponding encode setting. When empty mbstring.internal_encoding -; is used. For the decode settings you can distinguish between motorola and -; intel byte order. A decode setting cannot be empty. -; http://php.net/exif.encode-unicode -;exif.encode_unicode = ISO-8859-15 - -; http://php.net/exif.decode-unicode-motorola -;exif.decode_unicode_motorola = UCS-2BE - -; http://php.net/exif.decode-unicode-intel -;exif.decode_unicode_intel = UCS-2LE - -; http://php.net/exif.encode-jis -;exif.encode_jis = - -; http://php.net/exif.decode-jis-motorola -;exif.decode_jis_motorola = JIS - -; http://php.net/exif.decode-jis-intel -;exif.decode_jis_intel = JIS - -[Tidy] -; The path to a default tidy configuration file to use when using tidy -; http://php.net/tidy.default-config -;tidy.default_config = /usr/local/lib/php/default.tcfg - -; Should tidy clean and repair output automatically? -; WARNING: Do not use this option if you are generating non-html content -; such as dynamic images -; http://php.net/tidy.clean-output -tidy.clean_output = Off - -[soap] -; Enables or disables WSDL caching feature. -; http://php.net/soap.wsdl-cache-enabled -soap.wsdl_cache_enabled=1 - -; Sets the directory name where SOAP extension will put cache files. -; http://php.net/soap.wsdl-cache-dir -soap.wsdl_cache_dir="/tmp" - -; (time to live) Sets the number of second while cached file will be used -; instead of original one. -; http://php.net/soap.wsdl-cache-ttl -soap.wsdl_cache_ttl=86400 - -; Sets the size of the cache limit. (Max. number of WSDL files to cache) -soap.wsdl_cache_limit = 5 - -[sysvshm] -; A default size of the shared memory segment -;sysvshm.init_mem = 10000 - -[ldap] -; Sets the maximum number of open links or -1 for unlimited. -ldap.max_links = -1 - -[dba] -;dba.default_handler= - -[opcache] -; Determines if Zend OPCache is enabled -opcache.enable=1 - -; Determines if Zend OPCache is enabled for the CLI version of PHP -opcache.enable_cli=1 - -; The OPcache shared memory storage size. -opcache.memory_consumption=128 - -; The amount of memory for interned strings in Mbytes. -opcache.interned_strings_buffer=8 - -; The maximum number of keys (scripts) in the OPcache hash table. -; Only numbers between 200 and 1000000 are allowed. -opcache.max_accelerated_files=10000 - -; The maximum percentage of "wasted" memory until a restart is scheduled. -;opcache.max_wasted_percentage=5 - -; When this directive is enabled, the OPcache appends the current working -; directory to the script key, thus eliminating possible collisions between -; files with the same name (basename). Disabling the directive improves -; performance, but may break existing applications. -;opcache.use_cwd=1 - -; When disabled, you must reset the OPcache manually or restart the -; webserver for changes to the filesystem to take effect. -;opcache.validate_timestamps=1 - -; How often (in seconds) to check file timestamps for changes to the shared -; memory storage allocation. ("1" means validate once per second, but only -; once per request. "0" means always validate) -opcache.revalidate_freq=1 - -; Enables or disables file search in include_path optimization -;opcache.revalidate_path=0 - -; If disabled, all PHPDoc comments are dropped from the code to reduce the -; size of the optimized code. -opcache.save_comments=1 - -; Allow file existence override (file_exists, etc.) performance feature. -;opcache.enable_file_override=0 - -; A bitmask, where each bit enables or disables the appropriate OPcache -; passes -;opcache.optimization_level=0xffffffff - -;opcache.inherited_hack=1 -;opcache.dups_fix=0 - -; The location of the OPcache blacklist file (wildcards allowed). -; Each OPcache blacklist file is a text file that holds the names of files -; that should not be accelerated. The file format is to add each filename -; to a new line. The filename may be a full path or just a file prefix -; (i.e., /var/www/x blacklists all the files and directories in /var/www -; that start with 'x'). Line starting with a ; are ignored (comments). -;opcache.blacklist_filename= - -; Allows exclusion of large files from being cached. By default all files -; are cached. -;opcache.max_file_size=0 - -; Check the cache checksum each N requests. -; The default value of "0" means that the checks are disabled. -;opcache.consistency_checks=0 - -; How long to wait (in seconds) for a scheduled restart to begin if the cache -; is not being accessed. -;opcache.force_restart_timeout=180 - -; OPcache error_log file name. Empty string assumes "stderr". -;opcache.error_log= - -; All OPcache errors go to the Web server log. -; By default, only fatal errors (level 0) or errors (level 1) are logged. -; You can also enable warnings (level 2), info messages (level 3) or -; debug messages (level 4). -;opcache.log_verbosity_level=1 - -; Preferred Shared Memory back-end. Leave empty and let the system decide. -;opcache.preferred_memory_model= - -; Protect the shared memory from unexpected writing during script execution. -; Useful for internal debugging only. -;opcache.protect_memory=0 - -; Allows calling OPcache API functions only from PHP scripts which path is -; started from specified string. The default "" means no restriction -;opcache.restrict_api= - -; Mapping base of shared memory segments (for Windows only). All the PHP -; processes have to map shared memory into the same address space. This -; directive allows to manually fix the "Unable to reattach to base address" -; errors. -;opcache.mmap_base= - -; Enables and sets the second level cache directory. -; It should improve performance when SHM memory is full, at server restart or -; SHM reset. The default "" disables file based caching. -;opcache.file_cache= - -; Enables or disables opcode caching in shared memory. -;opcache.file_cache_only=0 - -; Enables or disables checksum validation when script loaded from file cache. -;opcache.file_cache_consistency_checks=1 - -; Implies opcache.file_cache_only=1 for a certain process that failed to -; reattach to the shared memory (for Windows only). Explicitly enabled file -; cache is required. -;opcache.file_cache_fallback=1 - -; Enables or disables copying of PHP code (text segment) into HUGE PAGES. -; This should improve performance, but requires appropriate OS configuration. -;opcache.huge_code_pages=1 - -; Validate cached file permissions. -;opcache.validate_permission=0 - -; Prevent name collisions in chroot'ed environment. -;opcache.validate_root=0 - -[curl] -; A default value for the CURLOPT_CAINFO option. This is required to be an -; absolute path. -;curl.cainfo = - -[openssl] -; The location of a Certificate Authority (CA) file on the local filesystem -; to use when verifying the identity of SSL/TLS peers. Most users should -; not specify a value for this directive as PHP will attempt to use the -; OS-managed cert stores in its absence. If specified, this value may still -; be overridden on a per-stream basis via the "cafile" SSL stream context -; option. -;openssl.cafile= - -; If openssl.cafile is not specified or if the CA file is not found, the -; directory pointed to by openssl.capath is searched for a suitable -; certificate. This value must be a correctly hashed certificate directory. -; Most users should not specify a value for this directive as PHP will -; attempt to use the OS-managed cert stores in its absence. If specified, -; this value may still be overridden on a per-stream basis via the "capath" -; SSL stream context option. -;openssl.capath= - -; Local Variables: -; tab-width: 4 -; End: diff --git a/archive/jailman/blueprints/nextcloud/includes/redis.conf b/archive/jailman/blueprints/nextcloud/includes/redis.conf deleted file mode 100644 index 5df0230896c..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/redis.conf +++ /dev/null @@ -1,1052 +0,0 @@ -# Redis configuration file example. -# -# Note that in order to read the configuration file, Redis must be -# started with the file path as first argument: -# -# ./redis-server /path/to/redis.conf - -# Note on units: when memory size is needed, it is possible to specify -# it in the usual form of 1k 5GB 4M and so forth: -# -# 1k => 1000 bytes -# 1kb => 1024 bytes -# 1m => 1000000 bytes -# 1mb => 1024*1024 bytes -# 1g => 1000000000 bytes -# 1gb => 1024*1024*1024 bytes -# -# units are case insensitive so 1GB 1Gb 1gB are all the same. - -################################## INCLUDES ################################### - -# Include one or more other config files here. This is useful if you -# have a standard template that goes to all Redis servers but also need -# to customize a few per-server settings. Include files can include -# other files, so use this wisely. -# -# Notice option "include" won't be rewritten by command "CONFIG REWRITE" -# from admin or Redis Sentinel. Since Redis always uses the last processed -# line as value of a configuration directive, you'd better put includes -# at the beginning of this file to avoid overwriting config change at runtime. -# -# If instead you are interested in using includes to override configuration -# options, it is better to use include as the last line. -# -# include /path/to/local.conf -# include /path/to/other.conf - -################################## NETWORK ##################################### - -# By default, if no "bind" configuration directive is specified, Redis listens -# for connections from all the network interfaces available on the server. -# It is possible to listen to just one or multiple selected interfaces using -# the "bind" configuration directive, followed by one or more IP addresses. -# -# Examples: -# -# bind 192.168.1.100 10.0.0.1 -# bind 127.0.0.1 ::1 -# -# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the -# internet, binding to all the interfaces is dangerous and will expose the -# instance to everybody on the internet. So by default we uncomment the -# following bind directive, that will force Redis to listen only into -# the IPv4 lookback interface address (this means Redis will be able to -# accept connections only from clients running into the same computer it -# is running). -# -# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES -# JUST COMMENT THE FOLLOWING LINE. -# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -bind 127.0.0.1 - -# Protected mode is a layer of security protection, in order to avoid that -# Redis instances left open on the internet are accessed and exploited. -# -# When protected mode is on and if: -# -# 1) The server is not binding explicitly to a set of addresses using the -# "bind" directive. -# 2) No password is configured. -# -# The server only accepts connections from clients connecting from the -# IPv4 and IPv6 loopback addresses 127.0.0.1 and ::1, and from Unix domain -# sockets. -# -# By default protected mode is enabled. You should disable it only if -# you are sure you want clients from other hosts to connect to Redis -# even if no authentication is configured, nor a specific set of interfaces -# are explicitly listed using the "bind" directive. -protected-mode yes - -# Accept connections on the specified port, default is 6379 (IANA #815344). -# If port 0 is specified Redis will not listen on a TCP socket. -port 0 - -# TCP listen() backlog. -# -# In high requests-per-second environments you need an high backlog in order -# to avoid slow clients connections issues. Note that the Linux kernel -# will silently truncate it to the value of /proc/sys/net/core/somaxconn so -# make sure to raise both the value of somaxconn and tcp_max_syn_backlog -# in order to get the desired effect. -tcp-backlog 511 - -# Unix socket. -# -# Specify the path for the Unix socket that will be used to listen for -# incoming connections. There is no default, so Redis will not listen -# on a unix socket when not specified. -# -unixsocket /var/run/redis/redis.sock -unixsocketperm 770 - -# Close the connection after a client is idle for N seconds (0 to disable) -timeout 0 - -# TCP keepalive. -# -# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence -# of communication. This is useful for two reasons: -# -# 1) Detect dead peers. -# 2) Take the connection alive from the point of view of network -# equipment in the middle. -# -# On Linux, the specified value (in seconds) is the period used to send ACKs. -# Note that to close the connection the double of the time is needed. -# On other kernels the period depends on the kernel configuration. -# -# A reasonable value for this option is 300 seconds, which is the new -# Redis default starting with Redis 3.2.1. -tcp-keepalive 300 - -################################# GENERAL ##################################### - -# By default Redis does not run as a daemon. Use 'yes' if you need it. -# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. -daemonize yes - -# If you run Redis from upstart or systemd, Redis can interact with your -# supervision tree. Options: -# supervised no - no supervision interaction -# supervised upstart - signal upstart by putting Redis into SIGSTOP mode -# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET -# supervised auto - detect upstart or systemd method based on -# UPSTART_JOB or NOTIFY_SOCKET environment variables -# Note: these supervision methods only signal "process is ready." -# They do not enable continuous liveness pings back to your supervisor. -supervised no - -# If a pid file is specified, Redis writes it where specified at startup -# and removes it at exit. -# -# When the server runs non daemonized, no pid file is created if none is -# specified in the configuration. When the server is daemonized, the pid file -# is used even if not specified, defaulting to "/var/run/redis.pid". -# -# Creating a pid file is best effort: if Redis is not able to create it -# nothing bad happens, the server will start and run normally. -pidfile /var/run/redis/redis.pid - -# Specify the server verbosity level. -# This can be one of: -# debug (a lot of information, useful for development/testing) -# verbose (many rarely useful info, but not a mess like the debug level) -# notice (moderately verbose, what you want in production probably) -# warning (only very important / critical messages are logged) -loglevel notice - -# Specify the log file name. Also the empty string can be used to force -# Redis to log on the standard output. Note that if you use standard -# output for logging but daemonize, logs will be sent to /dev/null -logfile /var/log/redis/redis.log - -# To enable logging to the system logger, just set 'syslog-enabled' to yes, -# and optionally update the other syslog parameters to suit your needs. -# syslog-enabled no - -# Specify the syslog identity. -# syslog-ident redis - -# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. -# syslog-facility local0 - -# Set the number of databases. The default database is DB 0, you can select -# a different one on a per-connection basis using SELECT where -# dbid is a number between 0 and 'databases'-1 -databases 16 - -################################ SNAPSHOTTING ################################ -# -# Save the DB on disk: -# -# save -# -# Will save the DB if both the given number of seconds and the given -# number of write operations against the DB occurred. -# -# In the example below the behaviour will be to save: -# after 900 sec (15 min) if at least 1 key changed -# after 300 sec (5 min) if at least 10 keys changed -# after 60 sec if at least 10000 keys changed -# -# Note: you can disable saving completely by commenting out all "save" lines. -# -# It is also possible to remove all the previously configured save -# points by adding a save directive with a single empty string argument -# like in the following example: -# -# save "" - -save 900 1 -save 300 10 -save 60 10000 - -# By default Redis will stop accepting writes if RDB snapshots are enabled -# (at least one save point) and the latest background save failed. -# This will make the user aware (in a hard way) that data is not persisting -# on disk properly, otherwise chances are that no one will notice and some -# disaster will happen. -# -# If the background saving process will start working again Redis will -# automatically allow writes again. -# -# However if you have setup your proper monitoring of the Redis server -# and persistence, you may want to disable this feature so that Redis will -# continue to work as usual even if there are problems with disk, -# permissions, and so forth. -stop-writes-on-bgsave-error yes - -# Compress string objects using LZF when dump .rdb databases? -# For default that's set to 'yes' as it's almost always a win. -# If you want to save some CPU in the saving child set it to 'no' but -# the dataset will likely be bigger if you have compressible values or keys. -rdbcompression yes - -# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. -# This makes the format more resistant to corruption but there is a performance -# hit to pay (around 10%) when saving and loading RDB files, so you can disable it -# for maximum performances. -# -# RDB files created with checksum disabled have a checksum of zero that will -# tell the loading code to skip the check. -rdbchecksum yes - -# The filename where to dump the DB -dbfilename dump.rdb - -# The working directory. -# -# The DB will be written inside this directory, with the filename specified -# above using the 'dbfilename' configuration directive. -# -# The Append Only File will also be created inside this directory. -# -# Note that you must specify a directory here, not a file name. -dir /var/db/redis/ - -################################# REPLICATION ################################# - -# Master-Slave replication. Use slaveof to make a Redis instance a copy of -# another Redis server. A few things to understand ASAP about Redis replication. -# -# 1) Redis replication is asynchronous, but you can configure a master to -# stop accepting writes if it appears to be not connected with at least -# a given number of slaves. -# 2) Redis slaves are able to perform a partial resynchronization with the -# master if the replication link is lost for a relatively small amount of -# time. You may want to configure the replication backlog size (see the next -# sections of this file) with a sensible value depending on your needs. -# 3) Replication is automatic and does not need user intervention. After a -# network partition slaves automatically try to reconnect to masters -# and resynchronize with them. -# -# slaveof - -# If the master is password protected (using the "requirepass" configuration -# directive below) it is possible to tell the slave to authenticate before -# starting the replication synchronization process, otherwise the master will -# refuse the slave request. -# -# masterauth - -# When a slave loses its connection with the master, or when the replication -# is still in progress, the slave can act in two different ways: -# -# 1) if slave-serve-stale-data is set to 'yes' (the default) the slave will -# still reply to client requests, possibly with out of date data, or the -# data set may just be empty if this is the first synchronization. -# -# 2) if slave-serve-stale-data is set to 'no' the slave will reply with -# an error "SYNC with master in progress" to all the kind of commands -# but to INFO and SLAVEOF. -# -slave-serve-stale-data yes - -# You can configure a slave instance to accept writes or not. Writing against -# a slave instance may be useful to store some ephemeral data (because data -# written on a slave will be easily deleted after resync with the master) but -# may also cause problems if clients are writing to it because of a -# misconfiguration. -# -# Since Redis 2.6 by default slaves are read-only. -# -# Note: read only slaves are not designed to be exposed to untrusted clients -# on the internet. It's just a protection layer against misuse of the instance. -# Still a read only slave exports by default all the administrative commands -# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve -# security of read only slaves using 'rename-command' to shadow all the -# administrative / dangerous commands. -slave-read-only yes - -# Replication SYNC strategy: disk or socket. -# -# ------------------------------------------------------- -# WARNING: DISKLESS REPLICATION IS EXPERIMENTAL CURRENTLY -# ------------------------------------------------------- -# -# New slaves and reconnecting slaves that are not able to continue the replication -# process just receiving differences, need to do what is called a "full -# synchronization". An RDB file is transmitted from the master to the slaves. -# The transmission can happen in two different ways: -# -# 1) Disk-backed: The Redis master creates a new process that writes the RDB -# file on disk. Later the file is transferred by the parent -# process to the slaves incrementally. -# 2) Diskless: The Redis master creates a new process that directly writes the -# RDB file to slave sockets, without touching the disk at all. -# -# With disk-backed replication, while the RDB file is generated, more slaves -# can be queued and served with the RDB file as soon as the current child producing -# the RDB file finishes its work. With diskless replication instead once -# the transfer starts, new slaves arriving will be queued and a new transfer -# will start when the current one terminates. -# -# When diskless replication is used, the master waits a configurable amount of -# time (in seconds) before starting the transfer in the hope that multiple slaves -# will arrive and the transfer can be parallelized. -# -# With slow disks and fast (large bandwidth) networks, diskless replication -# works better. -repl-diskless-sync no - -# When diskless replication is enabled, it is possible to configure the delay -# the server waits in order to spawn the child that transfers the RDB via socket -# to the slaves. -# -# This is important since once the transfer starts, it is not possible to serve -# new slaves arriving, that will be queued for the next RDB transfer, so the server -# waits a delay in order to let more slaves arrive. -# -# The delay is specified in seconds, and by default is 5 seconds. To disable -# it entirely just set it to 0 seconds and the transfer will start ASAP. -repl-diskless-sync-delay 5 - -# Slaves send PINGs to server in a predefined interval. It's possible to change -# this interval with the repl_ping_slave_period option. The default value is 10 -# seconds. -# -# repl-ping-slave-period 10 - -# The following option sets the replication timeout for: -# -# 1) Bulk transfer I/O during SYNC, from the point of view of slave. -# 2) Master timeout from the point of view of slaves (data, pings). -# 3) Slave timeout from the point of view of masters (REPLCONF ACK pings). -# -# It is important to make sure that this value is greater than the value -# specified for repl-ping-slave-period otherwise a timeout will be detected -# every time there is low traffic between the master and the slave. -# -# repl-timeout 60 - -# Disable TCP_NODELAY on the slave socket after SYNC? -# -# If you select "yes" Redis will use a smaller number of TCP packets and -# less bandwidth to send data to slaves. But this can add a delay for -# the data to appear on the slave side, up to 40 milliseconds with -# Linux kernels using a default configuration. -# -# If you select "no" the delay for data to appear on the slave side will -# be reduced but more bandwidth will be used for replication. -# -# By default we optimize for low latency, but in very high traffic conditions -# or when the master and slaves are many hops away, turning this to "yes" may -# be a good idea. -repl-disable-tcp-nodelay no - -# Set the replication backlog size. The backlog is a buffer that accumulates -# slave data when slaves are disconnected for some time, so that when a slave -# wants to reconnect again, often a full resync is not needed, but a partial -# resync is enough, just passing the portion of data the slave missed while -# disconnected. -# -# The bigger the replication backlog, the longer the time the slave can be -# disconnected and later be able to perform a partial resynchronization. -# -# The backlog is only allocated once there is at least a slave connected. -# -# repl-backlog-size 1mb - -# After a master has no longer connected slaves for some time, the backlog -# will be freed. The following option configures the amount of seconds that -# need to elapse, starting from the time the last slave disconnected, for -# the backlog buffer to be freed. -# -# A value of 0 means to never release the backlog. -# -# repl-backlog-ttl 3600 - -# The slave priority is an integer number published by Redis in the INFO output. -# It is used by Redis Sentinel in order to select a slave to promote into a -# master if the master is no longer working correctly. -# -# A slave with a low priority number is considered better for promotion, so -# for instance if there are three slaves with priority 10, 100, 25 Sentinel will -# pick the one with priority 10, that is the lowest. -# -# However a special priority of 0 marks the slave as not able to perform the -# role of master, so a slave with priority of 0 will never be selected by -# Redis Sentinel for promotion. -# -# By default the priority is 100. -slave-priority 100 - -# It is possible for a master to stop accepting writes if there are less than -# N slaves connected, having a lag less or equal than M seconds. -# -# The N slaves need to be in "online" state. -# -# The lag in seconds, that must be <= the specified value, is calculated from -# the last ping received from the slave, that is usually sent every second. -# -# This option does not GUARANTEE that N replicas will accept the write, but -# will limit the window of exposure for lost writes in case not enough slaves -# are available, to the specified number of seconds. -# -# For example to require at least 3 slaves with a lag <= 10 seconds use: -# -# min-slaves-to-write 3 -# min-slaves-max-lag 10 -# -# Setting one or the other to 0 disables the feature. -# -# By default min-slaves-to-write is set to 0 (feature disabled) and -# min-slaves-max-lag is set to 10. - -# A Redis master is able to list the address and port of the attached -# slaves in different ways. For example the "INFO replication" section -# offers this information, which is used, among other tools, by -# Redis Sentinel in order to discover slave instances. -# Another place where this info is available is in the output of the -# "ROLE" command of a masteer. -# -# The listed IP and address normally reported by a slave is obtained -# in the following way: -# -# IP: The address is auto detected by checking the peer address -# of the socket used by the slave to connect with the master. -# -# Port: The port is communicated by the slave during the replication -# handshake, and is normally the port that the slave is using to -# list for connections. -# -# However when port forwarding or Network Address Translation (NAT) is -# used, the slave may be actually reachable via different IP and port -# pairs. The following two options can be used by a slave in order to -# report to its master a specific set of IP and port, so that both INFO -# and ROLE will report those values. -# -# There is no need to use both the options if you need to override just -# the port or the IP address. -# -# slave-announce-ip 5.5.5.5 -# slave-announce-port 1234 - -################################## SECURITY ################################### - -# Require clients to issue AUTH before processing any other -# commands. This might be useful in environments in which you do not trust -# others with access to the host running redis-server. -# -# This should stay commented out for backward compatibility and because most -# people do not need auth (e.g. they run their own servers). -# -# Warning: since Redis is pretty fast an outside user can try up to -# 150k passwords per second against a good box. This means that you should -# use a very strong password otherwise it will be very easy to break. -# -# requirepass foobared - -# Command renaming. -# -# It is possible to change the name of dangerous commands in a shared -# environment. For instance the CONFIG command may be renamed into something -# hard to guess so that it will still be available for internal-use tools -# but not available for general clients. -# -# Example: -# -# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 -# -# It is also possible to completely kill a command by renaming it into -# an empty string: -# -# rename-command CONFIG "" -# -# Please note that changing the name of commands that are logged into the -# AOF file or transmitted to slaves may cause problems. - -################################### LIMITS #################################### - -# Set the max number of connected clients at the same time. By default -# this limit is set to 10000 clients, however if the Redis server is not -# able to configure the process file limit to allow for the specified limit -# the max number of allowed clients is set to the current file limit -# minus 32 (as Redis reserves a few file descriptors for internal uses). -# -# Once the limit is reached Redis will close all the new connections sending -# an error 'max number of clients reached'. -# -# maxclients 10000 - -# Don't use more memory than the specified amount of bytes. -# When the memory limit is reached Redis will try to remove keys -# according to the eviction policy selected (see maxmemory-policy). -# -# If Redis can't remove keys according to the policy, or if the policy is -# set to 'noeviction', Redis will start to reply with errors to commands -# that would use more memory, like SET, LPUSH, and so on, and will continue -# to reply to read-only commands like GET. -# -# This option is usually useful when using Redis as an LRU cache, or to set -# a hard memory limit for an instance (using the 'noeviction' policy). -# -# WARNING: If you have slaves attached to an instance with maxmemory on, -# the size of the output buffers needed to feed the slaves are subtracted -# from the used memory count, so that network problems / resyncs will -# not trigger a loop where keys are evicted, and in turn the output -# buffer of slaves is full with DELs of keys evicted triggering the deletion -# of more keys, and so forth until the database is completely emptied. -# -# In short... if you have slaves attached it is suggested that you set a lower -# limit for maxmemory so that there is some free RAM on the system for slave -# output buffers (but this is not needed if the policy is 'noeviction'). -# -# maxmemory - -# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory -# is reached. You can select among five behaviors: -# -# volatile-lru -> remove the key with an expire set using an LRU algorithm -# allkeys-lru -> remove any key according to the LRU algorithm -# volatile-random -> remove a random key with an expire set -# allkeys-random -> remove a random key, any key -# volatile-ttl -> remove the key with the nearest expire time (minor TTL) -# noeviction -> don't expire at all, just return an error on write operations -# -# Note: with any of the above policies, Redis will return an error on write -# operations, when there are no suitable keys for eviction. -# -# At the date of writing these commands are: set setnx setex append -# incr decr rpush lpush rpushx lpushx linsert lset rpoplpush sadd -# sinter sinterstore sunion sunionstore sdiff sdiffstore zadd zincrby -# zunionstore zinterstore hset hsetnx hmset hincrby incrby decrby -# getset mset msetnx exec sort -# -# The default is: -# -# maxmemory-policy noeviction - -# LRU and minimal TTL algorithms are not precise algorithms but approximated -# algorithms (in order to save memory), so you can tune it for speed or -# accuracy. For default Redis will check five keys and pick the one that was -# used less recently, you can change the sample size using the following -# configuration directive. -# -# The default of 5 produces good enough results. 10 Approximates very closely -# true LRU but costs a bit more CPU. 3 is very fast but not very accurate. -# -# maxmemory-samples 5 - -############################## APPEND ONLY MODE ############################### - -# By default Redis asynchronously dumps the dataset on disk. This mode is -# good enough in many applications, but an issue with the Redis process or -# a power outage may result into a few minutes of writes lost (depending on -# the configured save points). -# -# The Append Only File is an alternative persistence mode that provides -# much better durability. For instance using the default data fsync policy -# (see later in the config file) Redis can lose just one second of writes in a -# dramatic event like a server power outage, or a single write if something -# wrong with the Redis process itself happens, but the operating system is -# still running correctly. -# -# AOF and RDB persistence can be enabled at the same time without problems. -# If the AOF is enabled on startup Redis will load the AOF, that is the file -# with the better durability guarantees. -# -# Please check http://redis.io/topics/persistence for more information. - -appendonly no - -# The name of the append only file (default: "appendonly.aof") - -appendfilename "appendonly.aof" - -# The fsync() call tells the Operating System to actually write data on disk -# instead of waiting for more data in the output buffer. Some OS will really flush -# data on disk, some other OS will just try to do it ASAP. -# -# Redis supports three different modes: -# -# no: don't fsync, just let the OS flush the data when it wants. Faster. -# always: fsync after every write to the append only log. Slow, Safest. -# everysec: fsync only one time every second. Compromise. -# -# The default is "everysec", as that's usually the right compromise between -# speed and data safety. It's up to you to understand if you can relax this to -# "no" that will let the operating system flush the output buffer when -# it wants, for better performances (but if you can live with the idea of -# some data loss consider the default persistence mode that's snapshotting), -# or on the contrary, use "always" that's very slow but a bit safer than -# everysec. -# -# More details please check the following article: -# http://antirez.com/post/redis-persistence-demystified.html -# -# If unsure, use "everysec". - -# appendfsync always -appendfsync everysec -# appendfsync no - -# When the AOF fsync policy is set to always or everysec, and a background -# saving process (a background save or AOF log background rewriting) is -# performing a lot of I/O against the disk, in some Linux configurations -# Redis may block too long on the fsync() call. Note that there is no fix for -# this currently, as even performing fsync in a different thread will block -# our synchronous write(2) call. -# -# In order to mitigate this problem it's possible to use the following option -# that will prevent fsync() from being called in the main process while a -# BGSAVE or BGREWRITEAOF is in progress. -# -# This means that while another child is saving, the durability of Redis is -# the same as "appendfsync none". In practical terms, this means that it is -# possible to lose up to 30 seconds of log in the worst scenario (with the -# default Linux settings). -# -# If you have latency problems turn this to "yes". Otherwise leave it as -# "no" that is the safest pick from the point of view of durability. - -no-appendfsync-on-rewrite no - -# Automatic rewrite of the append only file. -# Redis is able to automatically rewrite the log file implicitly calling -# BGREWRITEAOF when the AOF log size grows by the specified percentage. -# -# This is how it works: Redis remembers the size of the AOF file after the -# latest rewrite (if no rewrite has happened since the restart, the size of -# the AOF at startup is used). -# -# This base size is compared to the current size. If the current size is -# bigger than the specified percentage, the rewrite is triggered. Also -# you need to specify a minimal size for the AOF file to be rewritten, this -# is useful to avoid rewriting the AOF file even if the percentage increase -# is reached but it is still pretty small. -# -# Specify a percentage of zero in order to disable the automatic AOF -# rewrite feature. - -auto-aof-rewrite-percentage 100 -auto-aof-rewrite-min-size 64mb - -# An AOF file may be found to be truncated at the end during the Redis -# startup process, when the AOF data gets loaded back into memory. -# This may happen when the system where Redis is running -# crashes, especially when an ext4 filesystem is mounted without the -# data=ordered option (however this can't happen when Redis itself -# crashes or aborts but the operating system still works correctly). -# -# Redis can either exit with an error when this happens, or load as much -# data as possible (the default now) and start if the AOF file is found -# to be truncated at the end. The following option controls this behavior. -# -# If aof-load-truncated is set to yes, a truncated AOF file is loaded and -# the Redis server starts emitting a log to inform the user of the event. -# Otherwise if the option is set to no, the server aborts with an error -# and refuses to start. When the option is set to no, the user requires -# to fix the AOF file using the "redis-check-aof" utility before to restart -# the server. -# -# Note that if the AOF file will be found to be corrupted in the middle -# the server will still exit with an error. This option only applies when -# Redis will try to read more data from the AOF file but not enough bytes -# will be found. -aof-load-truncated yes - -################################ LUA SCRIPTING ############################### - -# Max execution time of a Lua script in milliseconds. -# -# If the maximum execution time is reached Redis will log that a script is -# still in execution after the maximum allowed time and will start to -# reply to queries with an error. -# -# When a long running script exceeds the maximum execution time only the -# SCRIPT KILL and SHUTDOWN NOSAVE commands are available. The first can be -# used to stop a script that did not yet called write commands. The second -# is the only way to shut down the server in the case a write command was -# already issued by the script but the user doesn't want to wait for the natural -# termination of the script. -# -# Set it to 0 or a negative value for unlimited execution without warnings. -lua-time-limit 5000 - -################################ REDIS CLUSTER ############################### -# -# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -# WARNING EXPERIMENTAL: Redis Cluster is considered to be stable code, however -# in order to mark it as "mature" we need to wait for a non trivial percentage -# of users to deploy it in production. -# ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ -# -# Normal Redis instances can't be part of a Redis Cluster; only nodes that are -# started as cluster nodes can. In order to start a Redis instance as a -# cluster node enable the cluster support uncommenting the following: -# -# cluster-enabled yes - -# Every cluster node has a cluster configuration file. This file is not -# intended to be edited by hand. It is created and updated by Redis nodes. -# Every Redis Cluster node requires a different cluster configuration file. -# Make sure that instances running in the same system do not have -# overlapping cluster configuration file names. -# -# cluster-config-file nodes-6379.conf - -# Cluster node timeout is the amount of milliseconds a node must be unreachable -# for it to be considered in failure state. -# Most other internal time limits are multiple of the node timeout. -# -# cluster-node-timeout 15000 - -# A slave of a failing master will avoid to start a failover if its data -# looks too old. -# -# There is no simple way for a slave to actually have a exact measure of -# its "data age", so the following two checks are performed: -# -# 1) If there are multiple slaves able to failover, they exchange messages -# in order to try to give an advantage to the slave with the best -# replication offset (more data from the master processed). -# Slaves will try to get their rank by offset, and apply to the start -# of the failover a delay proportional to their rank. -# -# 2) Every single slave computes the time of the last interaction with -# its master. This can be the last ping or command received (if the master -# is still in the "connected" state), or the time that elapsed since the -# disconnection with the master (if the replication link is currently down). -# If the last interaction is too old, the slave will not try to failover -# at all. -# -# The point "2" can be tuned by user. Specifically a slave will not perform -# the failover if, since the last interaction with the master, the time -# elapsed is greater than: -# -# (node-timeout * slave-validity-factor) + repl-ping-slave-period -# -# So for example if node-timeout is 30 seconds, and the slave-validity-factor -# is 10, and assuming a default repl-ping-slave-period of 10 seconds, the -# slave will not try to failover if it was not able to talk with the master -# for longer than 310 seconds. -# -# A large slave-validity-factor may allow slaves with too old data to failover -# a master, while a too small value may prevent the cluster from being able to -# elect a slave at all. -# -# For maximum availability, it is possible to set the slave-validity-factor -# to a value of 0, which means, that slaves will always try to failover the -# master regardless of the last time they interacted with the master. -# (However they'll always try to apply a delay proportional to their -# offset rank). -# -# Zero is the only value able to guarantee that when all the partitions heal -# the cluster will always be able to continue. -# -# cluster-slave-validity-factor 10 - -# Cluster slaves are able to migrate to orphaned masters, that are masters -# that are left without working slaves. This improves the cluster ability -# to resist to failures as otherwise an orphaned master can't be failed over -# in case of failure if it has no working slaves. -# -# Slaves migrate to orphaned masters only if there are still at least a -# given number of other working slaves for their old master. This number -# is the "migration barrier". A migration barrier of 1 means that a slave -# will migrate only if there is at least 1 other working slave for its master -# and so forth. It usually reflects the number of slaves you want for every -# master in your cluster. -# -# Default is 1 (slaves migrate only if their masters remain with at least -# one slave). To disable migration just set it to a very large value. -# A value of 0 can be set but is useful only for debugging and dangerous -# in production. -# -# cluster-migration-barrier 1 - -# By default Redis Cluster nodes stop accepting queries if they detect there -# is at least an hash slot uncovered (no available node is serving it). -# This way if the cluster is partially down (for example a range of hash slots -# are no longer covered) all the cluster becomes, eventually, unavailable. -# It automatically returns available as soon as all the slots are covered again. -# -# However sometimes you want the subset of the cluster which is working, -# to continue to accept queries for the part of the key space that is still -# covered. In order to do so, just set the cluster-require-full-coverage -# option to no. -# -# cluster-require-full-coverage yes - -# In order to setup your cluster make sure to read the documentation -# available at http://redis.io web site. - -################################## SLOW LOG ################################### - -# The Redis Slow Log is a system to log queries that exceeded a specified -# execution time. The execution time does not include the I/O operations -# like talking with the client, sending the reply and so forth, -# but just the time needed to actually execute the command (this is the only -# stage of command execution where the thread is blocked and can not serve -# other requests in the meantime). -# -# You can configure the slow log with two parameters: one tells Redis -# what is the execution time, in microseconds, to exceed in order for the -# command to get logged, and the other parameter is the length of the -# slow log. When a new command is logged the oldest one is removed from the -# queue of logged commands. - -# The following time is expressed in microseconds, so 1000000 is equivalent -# to one second. Note that a negative number disables the slow log, while -# a value of zero forces the logging of every command. -slowlog-log-slower-than 10000 - -# There is no limit to this length. Just be aware that it will consume memory. -# You can reclaim memory used by the slow log with SLOWLOG RESET. -slowlog-max-len 128 - -################################ LATENCY MONITOR ############################## - -# The Redis latency monitoring subsystem samples different operations -# at runtime in order to collect data related to possible sources of -# latency of a Redis instance. -# -# Via the LATENCY command this information is available to the user that can -# print graphs and obtain reports. -# -# The system only logs operations that were performed in a time equal or -# greater than the amount of milliseconds specified via the -# latency-monitor-threshold configuration directive. When its value is set -# to zero, the latency monitor is turned off. -# -# By default latency monitoring is disabled since it is mostly not needed -# if you don't have latency issues, and collecting data has a performance -# impact, that while very small, can be measured under big load. Latency -# monitoring can easily be enabled at runtime using the command -# "CONFIG SET latency-monitor-threshold " if needed. -latency-monitor-threshold 0 - -############################# EVENT NOTIFICATION ############################## - -# Redis can notify Pub/Sub clients about events happening in the key space. -# This feature is documented at http://redis.io/topics/notifications -# -# For instance if keyspace events notification is enabled, and a client -# performs a DEL operation on key "foo" stored in the Database 0, two -# messages will be published via Pub/Sub: -# -# PUBLISH __keyspace@0__:foo del -# PUBLISH __keyevent@0__:del foo -# -# It is possible to select the events that Redis will notify among a set -# of classes. Every class is identified by a single character: -# -# K Keyspace events, published with __keyspace@__ prefix. -# E Keyevent events, published with __keyevent@__ prefix. -# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... -# $ String commands -# l List commands -# s Set commands -# h Hash commands -# z Sorted set commands -# x Expired events (events generated every time a key expires) -# e Evicted events (events generated when a key is evicted for maxmemory) -# A Alias for g$lshzxe, so that the "AKE" string means all the events. -# -# The "notify-keyspace-events" takes as argument a string that is composed -# of zero or multiple characters. The empty string means that notifications -# are disabled. -# -# Example: to enable list and generic events, from the point of view of the -# event name, use: -# -# notify-keyspace-events Elg -# -# Example 2: to get the stream of the expired keys subscribing to channel -# name __keyevent@0__:expired use: -# -# notify-keyspace-events Ex -# -# By default all notifications are disabled because most users don't need -# this feature and the feature has some overhead. Note that if you don't -# specify at least one of K or E, no events will be delivered. -notify-keyspace-events "" - -############################### ADVANCED CONFIG ############################### - -# Hashes are encoded using a memory efficient data structure when they have a -# small number of entries, and the biggest entry does not exceed a given -# threshold. These thresholds can be configured using the following directives. -hash-max-ziplist-entries 512 -hash-max-ziplist-value 64 - -# Lists are also encoded in a special way to save a lot of space. -# The number of entries allowed per internal list node can be specified -# as a fixed maximum size or a maximum number of elements. -# For a fixed maximum size, use -5 through -1, meaning: -# -5: max size: 64 Kb <-- not recommended for normal workloads -# -4: max size: 32 Kb <-- not recommended -# -3: max size: 16 Kb <-- probably not recommended -# -2: max size: 8 Kb <-- good -# -1: max size: 4 Kb <-- good -# Positive numbers mean store up to _exactly_ that number of elements -# per list node. -# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), -# but if your use case is unique, adjust the settings as necessary. -list-max-ziplist-size -2 - -# Lists may also be compressed. -# Compress depth is the number of quicklist ziplist nodes from *each* side of -# the list to *exclude* from compression. The head and tail of the list -# are always uncompressed for fast push/pop operations. Settings are: -# 0: disable all list compression -# 1: depth 1 means "don't start compressing until after 1 node into the list, -# going from either the head or tail" -# So: [head]->node->node->...->node->[tail] -# [head], [tail] will always be uncompressed; inner nodes will compress. -# 2: [head]->[next]->node->node->...->node->[prev]->[tail] -# 2 here means: don't compress head or head->next or tail->prev or tail, -# but compress all nodes between them. -# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] -# etc. -list-compress-depth 0 - -# Sets have a special encoding in just one case: when a set is composed -# of just strings that happen to be integers in radix 10 in the range -# of 64 bit signed integers. -# The following configuration setting sets the limit in the size of the -# set in order to use this special memory saving encoding. -set-max-intset-entries 512 - -# Similarly to hashes and lists, sorted sets are also specially encoded in -# order to save a lot of space. This encoding is only used when the length and -# elements of a sorted set are below the following limits: -zset-max-ziplist-entries 128 -zset-max-ziplist-value 64 - -# HyperLogLog sparse representation bytes limit. The limit includes the -# 16 bytes header. When an HyperLogLog using the sparse representation crosses -# this limit, it is converted into the dense representation. -# -# A value greater than 16000 is totally useless, since at that point the -# dense representation is more memory efficient. -# -# The suggested value is ~ 3000 in order to have the benefits of -# the space efficient encoding without slowing down too much PFADD, -# which is O(N) with the sparse encoding. The value can be raised to -# ~ 10000 when CPU is not a concern, but space is, and the data set is -# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. -hll-sparse-max-bytes 3000 - -# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in -# order to help rehashing the main Redis hash table (the one mapping top-level -# keys to values). The hash table implementation Redis uses (see dict.c) -# performs a lazy rehashing: the more operation you run into a hash table -# that is rehashing, the more rehashing "steps" are performed, so if the -# server is idle the rehashing is never complete and some more memory is used -# by the hash table. -# -# The default is to use this millisecond 10 times every second in order to -# actively rehash the main dictionaries, freeing memory when possible. -# -# If unsure: -# use "activerehashing no" if you have hard latency requirements and it is -# not a good thing in your environment that Redis can reply from time to time -# to queries with 2 milliseconds delay. -# -# use "activerehashing yes" if you don't have such hard requirements but -# want to free memory asap when possible. -activerehashing yes - -# The client output buffer limits can be used to force disconnection of clients -# that are not reading data from the server fast enough for some reason (a -# common reason is that a Pub/Sub client can't consume messages as fast as the -# publisher can produce them). -# -# The limit can be set differently for the three different classes of clients: -# -# normal -> normal clients including MONITOR clients -# slave -> slave clients -# pubsub -> clients subscribed to at least one pubsub channel or pattern -# -# The syntax of every client-output-buffer-limit directive is the following: -# -# client-output-buffer-limit -# -# A client is immediately disconnected once the hard limit is reached, or if -# the soft limit is reached and remains reached for the specified number of -# seconds (continuously). -# So for instance if the hard limit is 32 megabytes and the soft limit is -# 16 megabytes / 10 seconds, the client will get disconnected immediately -# if the size of the output buffers reach 32 megabytes, but will also get -# disconnected if the client reaches 16 megabytes and continuously overcomes -# the limit for 10 seconds. -# -# By default normal clients are not limited because they don't receive data -# without asking (in a push way), but just after a request, so only -# asynchronous clients may create a scenario where data is requested faster -# than it can read. -# -# Instead there is a default limit for pubsub and slave clients, since -# subscribers and slaves receive data in a push fashion. -# -# Both the hard or the soft limit can be disabled by setting them to zero. -client-output-buffer-limit normal 0 0 0 -client-output-buffer-limit slave 256mb 64mb 60 -client-output-buffer-limit pubsub 32mb 8mb 60 - -# Redis calls an internal function to perform many background tasks, like -# closing connections of clients in timeout, purging expired keys that are -# never requested, and so forth. -# -# Not all tasks are performed with the same frequency, but Redis checks for -# tasks to perform according to the specified "hz" value. -# -# By default "hz" is set to 10. Raising the value will use more CPU when -# Redis is idle, but at the same time will make Redis more responsive when -# there are many keys expiring at the same time, and timeouts may be -# handled with more precision. -# -# The range is between 1 and 500, however a value over 100 is usually not -# a good idea. Most users should use the default of 10 and raise this up to -# 100 only in environments where very low latency is required. -hz 10 - -# When a child rewrites the AOF file, if the following option is enabled -# the file will be fsync-ed every 32 MB of data generated. This is useful -# in order to commit the file to the disk more incrementally and avoid -# big latency spikes. -aof-rewrite-incremental-fsync yes diff --git a/archive/jailman/blueprints/nextcloud/includes/remove-staging.sh b/archive/jailman/blueprints/nextcloud/includes/remove-staging.sh deleted file mode 100755 index 63c688916cb..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/remove-staging.sh +++ /dev/null @@ -1,5 +0,0 @@ -#!/usr/local/bin/bash -# Remove acme-staging CA from Caddyfile, so Caddy gets production certs - -sed -ri.bak 's/-staging//' /usr/local/www/Caddyfile -service caddy restart diff --git a/archive/jailman/blueprints/nextcloud/includes/www-crontab b/archive/jailman/blueprints/nextcloud/includes/www-crontab deleted file mode 100644 index 7592ab6c793..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/www-crontab +++ /dev/null @@ -1 +0,0 @@ -*/5 * * * * /usr/local/bin/php -f /usr/local/www/nextcloud/cron.php diff --git a/archive/jailman/blueprints/nextcloud/includes/www.conf b/archive/jailman/blueprints/nextcloud/includes/www.conf deleted file mode 100644 index e7287bbae97..00000000000 --- a/archive/jailman/blueprints/nextcloud/includes/www.conf +++ /dev/null @@ -1,417 +0,0 @@ -; Start a new pool named 'www'. -; the variable $pool can be used in any directive and will be replaced by the -; pool name ('www' here) -[www] - -; Per pool prefix -; It only applies on the following directives: -; - 'access.log' -; - 'slowlog' -; - 'listen' (unixsocket) -; - 'chroot' -; - 'chdir' -; - 'php_values' -; - 'php_admin_values' -; When not set, the global prefix (or /usr/local) applies instead. -; Note: This directive can also be relative to the global prefix. -; Default Value: none -;prefix = /path/to/pools/$pool - -; Unix user/group of processes -; Note: The user is mandatory. If the group is not set, the default user's group -; will be used. -user = www -group = www - -; The address on which to accept FastCGI requests. -; Valid syntaxes are: -; 'ip.add.re.ss:port' - to listen on a TCP socket to a specific IPv4 address on -; a specific port; -; '[ip:6:addr:ess]:port' - to listen on a TCP socket to a specific IPv6 address on -; a specific port; -; 'port' - to listen on a TCP socket to all addresses -; (IPv6 and IPv4-mapped) on a specific port; -; '/path/to/unix/socket' - to listen on a unix socket. -; Note: This value is mandatory. -listen = 127.0.0.1:9000 - -; Set listen(2) backlog. -; Default Value: 511 (-1 on FreeBSD and OpenBSD) -;listen.backlog = 511 - -; Set permissions for unix socket, if one is used. In Linux, read/write -; permissions must be set in order to allow connections from a web server. Many -; BSD-derived systems allow connections regardless of permissions. -; Default Values: user and group are set as the running user -; mode is set to 0660 -;listen.owner = www -;listen.group = www -;listen.mode = 0660 -; When POSIX Access Control Lists are supported you can set them using -; these options, value is a comma separated list of user/group names. -; When set, listen.owner and listen.group are ignored -;listen.acl_users = -;listen.acl_groups = - -; List of addresses (IPv4/IPv6) of FastCGI clients which are allowed to connect. -; Equivalent to the FCGI_WEB_SERVER_ADDRS environment variable in the original -; PHP FCGI (5.2.2+). Makes sense only with a tcp listening socket. Each address -; must be separated by a comma. If this value is left blank, connections will be -; accepted from any ip address. -; Default Value: any -;listen.allowed_clients = 127.0.0.1 - -; Specify the nice(2) priority to apply to the pool processes (only if set) -; The value can vary from -19 (highest priority) to 20 (lower priority) -; Note: - It will only work if the FPM master process is launched as root -; - The pool processes will inherit the master process priority -; unless it specified otherwise -; Default Value: no set -; process.priority = -19 - -; Choose how the process manager will control the number of child processes. -; Possible Values: -; static - a fixed number (pm.max_children) of child processes; -; dynamic - the number of child processes are set dynamically based on the -; following directives. With this process management, there will be -; always at least 1 children. -; pm.max_children - the maximum number of children that can -; be alive at the same time. -; pm.start_servers - the number of children created on startup. -; pm.min_spare_servers - the minimum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is less than this -; number then some children will be created. -; pm.max_spare_servers - the maximum number of children in 'idle' -; state (waiting to process). If the number -; of 'idle' processes is greater than this -; number then some children will be killed. -; ondemand - no children are created at startup. Children will be forked when -; new requests will connect. The following parameter are used: -; pm.max_children - the maximum number of children that -; can be alive at the same time. -; pm.process_idle_timeout - The number of seconds after which -; an idle process will be killed. -; Note: This value is mandatory. -pm = dynamic - -; The number of child processes to be created when pm is set to 'static' and the -; maximum number of child processes when pm is set to 'dynamic' or 'ondemand'. -; This value sets the limit on the number of simultaneous requests that will be -; served. Equivalent to the ApacheMaxClients directive with mpm_prefork. -; Equivalent to the PHP_FCGI_CHILDREN environment variable in the original PHP -; CGI. The below defaults are based on a server without much resources. Don't -; forget to tweak pm.* to fit your needs. -; Note: Used when pm is set to 'static', 'dynamic' or 'ondemand' -; Note: This value is mandatory. -pm.max_children = 10 - -; The number of child processes created on startup. -; Note: Used only when pm is set to 'dynamic' -; Default Value: min_spare_servers + (max_spare_servers - min_spare_servers) / 2 -pm.start_servers = 2 - -; The desired minimum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.min_spare_servers = 1 - -; The desired maximum number of idle server processes. -; Note: Used only when pm is set to 'dynamic' -; Note: Mandatory when pm is set to 'dynamic' -pm.max_spare_servers = 3 - -; The number of seconds after which an idle process will be killed. -; Note: Used only when pm is set to 'ondemand' -; Default Value: 10s -;pm.process_idle_timeout = 10s; - -; The number of requests each child process should execute before respawning. -; This can be useful to work around memory leaks in 3rd party libraries. For -; endless request processing specify '0'. Equivalent to PHP_FCGI_MAX_REQUESTS. -; Default Value: 0 -;pm.max_requests = 500 - -; The URI to view the FPM status page. If this value is not set, no URI will be -; recognized as a status page. It shows the following informations: -; pool - the name of the pool; -; process manager - static, dynamic or ondemand; -; start time - the date and time FPM has started; -; start since - number of seconds since FPM has started; -; accepted conn - the number of request accepted by the pool; -; listen queue - the number of request in the queue of pending -; connections (see backlog in listen(2)); -; max listen queue - the maximum number of requests in the queue -; of pending connections since FPM has started; -; listen queue len - the size of the socket queue of pending connections; -; idle processes - the number of idle processes; -; active processes - the number of active processes; -; total processes - the number of idle + active processes; -; max active processes - the maximum number of active processes since FPM -; has started; -; max children reached - number of times, the process limit has been reached, -; when pm tries to start more children (works only for -; pm 'dynamic' and 'ondemand'); -; Value are updated in real time. -; Example output: -; pool: www -; process manager: static -; start time: 01/Jul/2011:17:53:49 +0200 -; start since: 62636 -; accepted conn: 190460 -; listen queue: 0 -; max listen queue: 1 -; listen queue len: 42 -; idle processes: 4 -; active processes: 11 -; total processes: 15 -; max active processes: 12 -; max children reached: 0 -; -; By default the status page output is formatted as text/plain. Passing either -; 'html', 'xml' or 'json' in the query string will return the corresponding -; output syntax. Example: -; http://www.foo.bar/status -; http://www.foo.bar/status?json -; http://www.foo.bar/status?html -; http://www.foo.bar/status?xml -; -; By default the status page only outputs short status. Passing 'full' in the -; query string will also return status for each pool process. -; Example: -; http://www.foo.bar/status?full -; http://www.foo.bar/status?json&full -; http://www.foo.bar/status?html&full -; http://www.foo.bar/status?xml&full -; The Full status returns for each process: -; pid - the PID of the process; -; state - the state of the process (Idle, Running, ...); -; start time - the date and time the process has started; -; start since - the number of seconds since the process has started; -; requests - the number of requests the process has served; -; request duration - the duration in µs of the requests; -; request method - the request method (GET, POST, ...); -; request URI - the request URI with the query string; -; content length - the content length of the request (only with POST); -; user - the user (PHP_AUTH_USER) (or '-' if not set); -; script - the main script called (or '-' if not set); -; last request cpu - the %cpu the last request consumed -; it's always 0 if the process is not in Idle state -; because CPU calculation is done when the request -; processing has terminated; -; last request memory - the max amount of memory the last request consumed -; it's always 0 if the process is not in Idle state -; because memory calculation is done when the request -; processing has terminated; -; If the process is in Idle state, then informations are related to the -; last request the process has served. Otherwise informations are related to -; the current request being served. -; Example output: -; ************************ -; pid: 31330 -; state: Running -; start time: 01/Jul/2011:17:53:49 +0200 -; start since: 63087 -; requests: 12808 -; request duration: 1250261 -; request method: GET -; request URI: /test_mem.php?N=10000 -; content length: 0 -; user: - -; script: /home/fat/web/docs/php/test_mem.php -; last request cpu: 0.00 -; last request memory: 0 -; -; Note: There is a real-time FPM status monitoring sample web page available -; It's available in: /usr/local/share/php/fpm/status.html -; -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -;pm.status_path = /status - -; The ping URI to call the monitoring page of FPM. If this value is not set, no -; URI will be recognized as a ping page. This could be used to test from outside -; that FPM is alive and responding, or to -; - create a graph of FPM availability (rrd or such); -; - remove a server from a group if it is not responding (load balancing); -; - trigger alerts for the operating team (24/7). -; Note: The value must start with a leading slash (/). The value can be -; anything, but it may not be a good idea to use the .php extension or it -; may conflict with a real PHP file. -; Default Value: not set -;ping.path = /ping - -; This directive may be used to customize the response of a ping request. The -; response is formatted as text/plain with a 200 response code. -; Default Value: pong -;ping.response = pong - -; The access log file -; Default: not set -;access.log = log/$pool.access.log - -; The access log format. -; The following syntax is allowed -; %%: the '%' character -; %C: %CPU used by the request -; it can accept the following format: -; - %{user}C for user CPU only -; - %{system}C for system CPU only -; - %{total}C for user + system CPU (default) -; %d: time taken to serve the request -; it can accept the following format: -; - %{seconds}d (default) -; - %{miliseconds}d -; - %{mili}d -; - %{microseconds}d -; - %{micro}d -; %e: an environment variable (same as $_ENV or $_SERVER) -; it must be associated with embraces to specify the name of the env -; variable. Some exemples: -; - server specifics like: %{REQUEST_METHOD}e or %{SERVER_PROTOCOL}e -; - HTTP headers like: %{HTTP_HOST}e or %{HTTP_USER_AGENT}e -; %f: script filename -; %l: content-length of the request (for POST request only) -; %m: request method -; %M: peak of memory allocated by PHP -; it can accept the following format: -; - %{bytes}M (default) -; - %{kilobytes}M -; - %{kilo}M -; - %{megabytes}M -; - %{mega}M -; %n: pool name -; %o: output header -; it must be associated with embraces to specify the name of the header: -; - %{Content-Type}o -; - %{X-Powered-By}o -; - %{Transfert-Encoding}o -; - .... -; %p: PID of the child that serviced the request -; %P: PID of the parent of the child that serviced the request -; %q: the query string -; %Q: the '?' character if query string exists -; %r: the request URI (without the query string, see %q and %Q) -; %R: remote IP address -; %s: status (response code) -; %t: server time the request was received -; it can accept a strftime(3) format: -; %d/%b/%Y:%H:%M:%S %z (default) -; The strftime(3) format must be encapsuled in a %{}t tag -; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t -; %T: time the log has been written (the request has finished) -; it can accept a strftime(3) format: -; %d/%b/%Y:%H:%M:%S %z (default) -; The strftime(3) format must be encapsuled in a %{}t tag -; e.g. for a ISO8601 formatted timestring, use: %{%Y-%m-%dT%H:%M:%S%z}t -; %u: remote user -; -; Default: "%R - %u %t \"%m %r\" %s" -;access.format = "%R - %u %t \"%m %r%Q%q\" %s %f %{mili}d %{kilo}M %C%%" - -; The log file for slow requests -; Default Value: not set -; Note: slowlog is mandatory if request_slowlog_timeout is set -;slowlog = log/$pool.log.slow - -; The timeout for serving a single request after which a PHP backtrace will be -; dumped to the 'slowlog' file. A value of '0s' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -;request_slowlog_timeout = 0 - -; Depth of slow log stack trace. -; Default Value: 20 -;request_slowlog_trace_depth = 20 - -; The timeout for serving a single request after which the worker process will -; be killed. This option should be used when the 'max_execution_time' ini option -; does not stop script execution for some reason. A value of '0' means 'off'. -; Available units: s(econds)(default), m(inutes), h(ours), or d(ays) -; Default Value: 0 -;request_terminate_timeout = 0 - -; Set open file descriptor rlimit. -; Default Value: system defined value -;rlimit_files = 1024 - -; Set max core size rlimit. -; Possible Values: 'unlimited' or an integer greater or equal to 0 -; Default Value: system defined value -;rlimit_core = 0 - -; Chroot to this directory at the start. This value must be defined as an -; absolute path. When this value is not set, chroot is not used. -; Note: you can prefix with '$prefix' to chroot to the pool prefix or one -; of its subdirectories. If the pool prefix is not set, the global prefix -; will be used instead. -; Note: chrooting is a great security feature and should be used whenever -; possible. However, all PHP paths will be relative to the chroot -; (error_log, sessions.save_path, ...). -; Default Value: not set -;chroot = - -; Chdir to this directory at the start. -; Note: relative path can be used. -; Default Value: current directory or / when chroot -;chdir = /var/www - -; Redirect worker stdout and stderr into main error log. If not set, stdout and -; stderr will be redirected to /dev/null according to FastCGI specs. -; Note: on highloaded environement, this can cause some delay in the page -; process time (several ms). -; Default Value: no -;catch_workers_output = yes - -; Clear environment in FPM workers -; Prevents arbitrary environment variables from reaching FPM worker processes -; by clearing the environment in workers before env vars specified in this -; pool configuration are added. -; Setting to "no" will make all environment variables available to PHP code -; via getenv(), $_ENV and $_SERVER. -; Default Value: yes -;clear_env = no - -; Limits the extensions of the main script FPM will allow to parse. This can -; prevent configuration mistakes on the web server side. You should only limit -; FPM to .php extensions to prevent malicious users to use other extensions to -; execute php code. -; Note: set an empty value to allow all extensions. -; Default Value: .php -;security.limit_extensions = .php .php3 .php4 .php5 .php7 - -; Pass environment variables like LD_LIBRARY_PATH. All $VARIABLEs are taken from -; the current environment. -; Default Value: clean env -env[HOSTNAME] = $HOSTNAME -env[PATH] = /usr/local/bin:/usr/bin:/bin -env[TMP] = /tmp -env[TMPDIR] = /tmp -env[TEMP] = /tmp - -; Additional php.ini defines, specific to this pool of workers. These settings -; overwrite the values previously defined in the php.ini. The directives are the -; same as the PHP SAPI: -; php_value/php_flag - you can set classic ini defines which can -; be overwritten from PHP call 'ini_set'. -; php_admin_value/php_admin_flag - these directives won't be overwritten by -; PHP call 'ini_set' -; For php_*flag, valid values are on, off, 1, 0, true, false, yes or no. - -; Defining 'extension' will load the corresponding shared extension from -; extension_dir. Defining 'disable_functions' or 'disable_classes' will not -; overwrite previously defined php.ini values, but will append the new value -; instead. - -; Note: path INI options can be relative and will be expanded with the prefix -; (pool, global or /usr/local) - -; Default Value: nothing is defined by default except the values in php.ini and -; specified at startup with the -d argument -;php_admin_value[sendmail_path] = /usr/sbin/sendmail -t -i -f www@my.domain.com -;php_flag[display_errors] = off -;php_admin_value[error_log] = /var/log/fpm-php.www.log -;php_admin_flag[log_errors] = on -;php_admin_value[memory_limit] = 32M diff --git a/archive/jailman/blueprints/nextcloud/install.sh b/archive/jailman/blueprints/nextcloud/install.sh deleted file mode 100755 index 0beefb3feec..00000000000 --- a/archive/jailman/blueprints/nextcloud/install.sh +++ /dev/null @@ -1,319 +0,0 @@ -#!/usr/local/bin/bash -# This script installs the current release of Nextcloud into a create jail -# Based on the example by danb35: https://github.com/danb35/freenas-iocage-nextcloud - -# Initialise defaults -# General Defaults -JAIL_IP="jail_${1}_ip4_addr" -JAIL_IP="${!JAIL_IP%/*}" -HOST_NAME="jail_${1}_host_name" -TIME_ZONE="jail_${1}_time_zone" -INCLUDES_PATH="${SCRIPT_DIR}/blueprints/nextcloud/includes" - -# SSL/CERT Defaults -CERT_TYPE="jail_${1}_cert_type" -CERT_TYPE="${!CERT_TYPE:-SELFSIGNED_CERT}" -CERT_EMAIL="jail_${1}_cert_email" -CERT_EMAIL="${!CERT_EMAIL:-placeholder@email.fake}" -DNS_PLUGIN="jail_${1}_dns_plugin" -DNS_ENV="jail_${1}_dns_env" - -# Database Defaults -DB_TYPE="jail_${1}_db_type" -DB_TYPE="${!DB_TYPE:-mariadb}" -DB_JAIL="jail_${1}_db_jail" -# shellcheck disable=SC2154 -DB_HOST="jail_${!DB_JAIL}_ip4_addr" -DB_HOST="${!DB_HOST%/*}:3306" - -DB_PASSWORD="jail_${1}_db_password" - -DB_DATABASE="jail_${1}_db_database" -DB_DATABASE="${!DB_DATABASE:-$1}" - -DB_USER="jail_${1}_db_user" -DB_USER="${!DB_USER:-$DB_DATABASE}" - -ADMIN_PASSWORD="jail_${1}_admin_password" - -##### -# -# Input Sanity Check -# -##### - - -# Check that necessary variables were set by nextcloud-config -if [ -z "${JAIL_IP}" ]; then - echo 'Configuration error: The Nextcloud jail does NOT accept DHCP' - echo 'Please reinstall using a fixed IP adress' - exit 1 -fi - -if [ -z "${!ADMIN_PASSWORD}" ]; then - echo 'Configuration error: The Nextcloud jail requires a admin_password' - echo 'Please reinstall using a fixed IP adress' - exit 1 -fi - -if [ -z "${!DB_PASSWORD}" ]; then - echo 'Configuration error: The Nextcloud Jail needs a database password' - echo 'Please reinstall with a defifined: db_password' - exit 1 -fi - -# shellcheck disable=SC2154 -if [ -z "${!TIME_ZONE}" ]; then - echo 'Configuration error: !TIME_ZONE must be set' - exit 1 -fi -if [ -z "${!HOST_NAME}" ]; then - echo 'Configuration error: !HOST_NAME must be set' - exit 1 -fi - - - -if [ "$CERT_TYPE" != "STANDALONE_CERT" ] && [ "$CERT_TYPE" != "DNS_CERT" ] && [ "$CERT_TYPE" != "NO_CERT" ] && [ "$CERT_TYPE" != "SELFSIGNED_CERT" ]; then - echo 'Configuration error, cert_type options: STANDALONE_CERT, DNS_CERT, NO_CERT or SELFSIGNED_CERT' - exit 1 -fi - -if [ "$CERT_TYPE" == "DNS_CERT" ]; then - if [ -z "${!DNS_PLUGIN}" ] ; then - echo "DNS_PLUGIN must be set to a supported DNS provider." - echo "See https://caddyserver.com/docs under the heading of \"DNS Providers\" for list." - echo "Be sure to omit the prefix of \"tls.dns.\"." - exit 1 - elif [ -z "${!DNS_ENV}" ] ; then - echo "DNS_ENV must be set to a your DNS provider\'s authentication credentials." - echo "See https://caddyserver.com/docs under the heading of \"DNS Providers\" for more." - exit 1 - else - DL_FLAGS="tls.dns.${DNS_PLUGIN}" - DNS_SETTING="dns ${DNS_PLUGIN}" - fi -fi - -# Make sure DB_PATH is empty -- if not, MariaDB will choke -# shellcheck disable=SC2154 -if [ "$(ls -A "/mnt/${global_dataset_config}/${1}/config")" ]; then - echo "Reinstall of Nextcloud detected... " - REINSTALL="true" -fi - - -##### - # -# Fstab And Mounts -# -##### - -# Create and Mount Nextcloud, Config and Files -createmount "${1}" "${global_dataset_config}"/"${1}"/config /usr/local/www/nextcloud/config -createmount "${1}" "${global_dataset_config}"/"${1}"/themes /usr/local/www/nextcloud/themes -createmount "${1}" "${global_dataset_config}"/"${1}"/files /config/files - -# Install includes fstab -iocage exec "${1}" mkdir -p /mnt/includes -iocage fstab -a "${1}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0 - - -iocage exec "${1}" chown -R www:www /config/files -iocage exec "${1}" chmod -R 770 /config/files - - -##### -# -# Basic dependency install -# -##### - -if [ "${DB_TYPE}" = "mariadb" ]; then - iocage exec "${1}" pkg install -qy mariadb104-client php74-pdo_mysql php74-mysqli -fi - -fetch -o /tmp https://getcaddy.com -if ! iocage exec "${1}" bash -s personal "${DL_FLAGS}" < /tmp/getcaddy.com -then - echo "Failed to download/install Caddy" - exit 1 -fi - -iocage exec "${1}" sysrc redis_enable="YES" -iocage exec "${1}" sysrc php_fpm_enable="YES" - - -##### -# -# Install Nextcloud -# -##### - -FILE="latest-19.tar.bz2" -if ! iocage exec "${1}" fetch -o /tmp https://download.nextcloud.com/server/releases/"${FILE}" https://download.nextcloud.com/server/releases/"${FILE}".asc https://nextcloud.com/nextcloud.asc -then - echo "Failed to download Nextcloud" - exit 1 -fi -iocage exec "${1}" gpg --import /tmp/nextcloud.asc -if ! iocage exec "${1}" gpg --verify /tmp/"${FILE}".asc -then - echo "GPG Signature Verification Failed!" - echo "The Nextcloud download is corrupt." - exit 1 -fi -iocage exec "${1}" tar xjf /tmp/"${FILE}" -C /usr/local/www/ -iocage exec "${1}" chown -R www:www /usr/local/www/nextcloud/ -iocage exec "${1}" pw usermod www -G redis - - -# Generate and install self-signed cert, if necessary -if [ "$CERT_TYPE" == "SELFSIGNED_CERT" ] && [ ! -f "/mnt/${global_dataset_config}/${1}/ssl/privkey.pem" ]; then - echo "No ssl certificate present, generating self signed certificate" - if [ ! -d "/mnt/${global_dataset_config}/${1}/ssl" ]; then - echo "cert folder not existing... creating..." - iocage exec "${1}" mkdir /config/ssl - fi - openssl req -new -newkey rsa:4096 -days 3650 -nodes -x509 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=${!HOST_NAME}" -keyout "${INCLUDES_PATH}"/privkey.pem -out "${INCLUDES_PATH}"/fullchain.pem - iocage exec "${1}" cp /mnt/includes/privkey.pem /config/ssl/privkey.pem - iocage exec "${1}" cp /mnt/includes/fullchain.pem /config/ssl/fullchain.pem -fi - -# Copy and edit pre-written config files -iocage exec "${1}" cp -f /mnt/includes/php.ini /usr/local/etc/php.ini -iocage exec "${1}" cp -f /mnt/includes/redis.conf /usr/local/etc/redis.conf -iocage exec "${1}" cp -f /mnt/includes/www.conf /usr/local/etc/php-fpm.d/ - - -if [ "$CERT_TYPE" == "STANDALONE_CERT" ] && [ "$CERT_TYPE" == "DNS_CERT" ]; then - iocage exec "${1}" cp -f /mnt/includes/remove-staging.sh /root/ -fi - -if [ "$CERT_TYPE" == "NO_CERT" ]; then - echo "Copying Caddyfile for no SSL" - iocage exec "${1}" cp -f /mnt/includes/Caddyfile-nossl /usr/local/www/Caddyfile -elif [ "$CERT_TYPE" == "SELFSIGNED_CERT" ]; then - echo "Copying Caddyfile for self-signed cert" - iocage exec "${1}" cp -f /mnt/includes/Caddyfile-selfsigned /usr/local/www/Caddyfile -else - echo "Copying Caddyfile for Let's Encrypt cert" - iocage exec "${1}" cp -f /mnt/includes/Caddyfile /usr/local/www/ -fi - - -iocage exec "${1}" cp -f /mnt/includes/caddy.rc /usr/local/etc/rc.d/caddy - - -iocage exec "${1}" sed -i '' "s/yourhostnamehere/${!HOST_NAME}/" /usr/local/www/Caddyfile -iocage exec "${1}" sed -i '' "s/DNS-PLACEHOLDER/${DNS_SETTING}/" /usr/local/www/Caddyfile -iocage exec "${1}" sed -i '' "s/JAIL-IP/${JAIL_IP}/" /usr/local/www/Caddyfile -iocage exec "${1}" sed -i '' "s|mytimezone|${!TIME_ZONE}|" /usr/local/etc/php.ini - -iocage exec "${1}" sysrc caddy_enable="YES" -iocage exec "${1}" sysrc caddy_cert_email="${CERT_EMAIL}" -iocage exec "${1}" sysrc caddy_SNI_default="${!HOST_NAME}" -iocage exec "${1}" sysrc caddy_env="${!DNS_ENV}" - -iocage restart "${1}" - -if [ "${REINSTALL}" == "true" ]; then - echo "Reinstall detected, skipping generaion of new config and database" -else - - # Secure database, set root password, create Nextcloud DB, user, and password - if [ "${DB_TYPE}" = "mariadb" ]; then - iocage exec "mariadb" mysql -u root -e "CREATE DATABASE ${DB_DATABASE};" - iocage exec "mariadb" mysql -u root -e "GRANT ALL ON ${DB_DATABASE}.* TO ${DB_USER}@${JAIL_IP} IDENTIFIED BY '${!DB_PASSWORD}';" - iocage exec "mariadb" mysqladmin reload - fi - - - # Save passwords for later reference - iocage exec "${1}" echo "${DB_NAME} root password is ${DB_ROOT_PASSWORD}" > /root/"${1}"_db_password.txt - iocage exec "${1}" echo "Nextcloud database password is ${!DB_PASSWORD}" >> /root/"${1}"_db_password.txt - iocage exec "${1}" echo "Nextcloud Administrator password is ${!ADMIN_PASSWORD}" >> /root/"${1}"_db_password.txt - - # CLI installation and configuration of Nextcloud - if [ "${DB_TYPE}" = "mariadb" ]; then - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ maintenance:install --database=\"mysql\" --database-name=\"${DB_DATABASE}\" --database-user=\"${DB_USER}\" --database-pass=\"${!DB_PASSWORD}\" --database-host=\"${DB_HOST}\" --admin-user=\"admin\" --admin-pass=\"${!ADMIN_PASSWORD}\" --data-dir=\"/config/files\"" - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set mysql.utf8mb4 --type boolean --value=\"true\"" - fi - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ db:add-missing-indices" - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ db:convert-filecache-bigint --no-interaction" - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set logtimezone --value=\"${!TIME_ZONE}\"" - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set log_type --value="file"' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set logfile --value="/var/log/nextcloud.log"' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set loglevel --value="2"' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set logrotate_size --value="104847600"' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set memcache.local --value="\OC\Memcache\APCu"' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set redis host --value="/var/run/redis/redis.sock"' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set redis port --value=0 --type=integer' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set memcache.locking --value="\OC\Memcache\Redis"' - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set overwritehost --value=\"${!HOST_NAME}\"" - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set overwriteprotocol --value=\"https\"" - if [ "$CERT_TYPE" == "NO_CERT" ]; then - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set overwrite.cli.url --value=\"http://${!HOST_NAME}/\"" - else - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set overwrite.cli.url --value=\"https://${!HOST_NAME}/\"" - fi - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ config:system:set htaccess.RewriteBase --value="/"' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ maintenance:update:htaccess' - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set trusted_domains 1 --value=\"${!HOST_NAME}\"" - iocage exec "${1}" su -m www -c "php /usr/local/www/nextcloud/occ config:system:set trusted_domains 2 --value=\"${JAIL_IP}\"" - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ app:enable encryption' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ encryption:enable' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ encryption:disable' - iocage exec "${1}" su -m www -c 'php /usr/local/www/nextcloud/occ background:cron' - -fi - -iocage exec "${1}" touch /var/log/nextcloud.log -iocage exec "${1}" chown www /var/log/nextcloud.log -iocage exec "${1}" su -m www -c 'php -f /usr/local/www/nextcloud/cron.php' -iocage exec "${1}" crontab -u www /mnt/includes/www-crontab - -# Don't need /mnt/includes any more, so unmount it -iocage fstab -r "${1}" "${INCLUDES_PATH}" /mnt/includes nullfs rw 0 0 - -# Done! -echo "Installation complete!" -if [ "$CERT_TYPE" == "NO_CERT" ]; then - echo "Using your web browser, go to http://${!HOST_NAME} to log in" -else - echo "Using your web browser, go to https://${!HOST_NAME} to log in" -fi - -if [ "${REINSTALL}" == "true" ]; then - echo "You did a reinstall, please use your old database and account credentials" -else - - echo "Default user is admin, password is ${!ADMIN_PASSWORD}" - echo "" - - echo "Database Information" - echo "--------------------" - echo "Database user = ${DB_USER}" - echo "Database password = ${!DB_PASSWORD}" - echo "" - echo "All passwords are saved in /root/${1}_db_password.txt" -fi - -echo "" -if [ "$CERT_TYPE" == "STANDALONE_CERT" ] && [ "$CERT_TYPE" == "DNS_CERT" ]; then - echo "You have obtained your Let's Encrypt certificate using the staging server." - echo "This certificate will not be trusted by your browser and will cause SSL errors" - echo "when you connect. Once you've verified that everything else is working" - echo "correctly, you should issue a trusted certificate. To do this, run:" - echo "iocage exec ${1}/root/remove-staging.sh" - echo "" -elif [ "$CERT_TYPE" == "SELFSIGNED_CERT" ]; then - echo "You have chosen to create a self-signed TLS certificate for your Nextcloud" - echo "installation. This certificate will not be trusted by your browser and" - echo "will cause SSL errors when you connect. If you wish to replace this certificate" - echo "with one obtained elsewhere, the private key is located at:" - echo "/config/ssl/privkey.pem" - echo "The full chain (server + intermediate certificates together) is at:" - echo "/config/ssl/fullchain.pem" - echo "" -fi diff --git a/archive/jailman/blueprints/nextcloud/readme.md b/archive/jailman/blueprints/nextcloud/readme.md deleted file mode 100644 index 68824605b02..00000000000 --- a/archive/jailman/blueprints/nextcloud/readme.md +++ /dev/null @@ -1,93 +0,0 @@ -# Nextcloud - -## Original README from the Upstream Nextcloud-iocage install script: - -https://github.com/danb35/freenas-iocage-nextcloud - -# freenas-iocage-nextcloud - -Script to create an iocage jail on FreeNAS for the latest Nextcloud 18 release, including Caddy 1.0, MariaDB 10.3/PostgreSQL 10, and Let's Encrypt - -This script will create an iocage jail on FreeNAS 11.2-U7 or 11.3 with the latest release of Nextcloud 18, along with its dependencies. It will obtain a trusted certificate from Let's Encrypt for the system, install it, and configure it to renew automatically. It will create the Nextcloud database and generate a strong root password and user password for the database system. It will configure the jail to store the database and Nextcloud user data outside the jail, so it will not be lost in the event you need to rebuild the jail. - -## Status - -This script will work with FreeNAS 11.3, and it should also work with 11.2-U7. Due to the EOL status of FreeBSD 11.2, it is unlikely to work reliably with earlier releases of FreeNAS. - -## Usage - -### Prerequisites (Let's Encrypt) - -This script works best when your installation is able to obtain a certificate from [Let's Encrypt](https://letsencrypt.org/). When you use it this way, Caddy is able to handle all of the TLS-related configuration for you, obtain and renew certificates automatically, etc. In order for this to happen, you must meet the two requirements below: - -- First, you must own or control a real Internet domain name. This script obtains a TLS encryption certificate from Let's Encrypt, who will only issue for public domain names. Thus, domains like `cloud.local`, `mycloud.lan`, or `nextcloud.home` won't work. Domains can be very inexpensive, and in some cases, they can be free. [Freenom](https://www.freenom.com/), for example, provides domains for free if you jump through the right hoops. [EasyDNS](https://easydns.com/) is a fine domain registrar for paid domains, costing roughly US$15 per year (which varies slightly with the top-level domain). - -- Second, one of these two conditions must be met in order for Let's Encrypt to validate your control over the domain name: - - - You must be able and willing to open ports 80 and 443 from the entire Internet to the jail, and leave them open. If this applies, do it **before** running this script. - - DNS hosting for the domain name needs to be with a provider that Caddy supports, to automatically update the DNS records needed to prove your control over the domain. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for the supported providers, and what information you'll need in order to proceed. - -[Cloudflare](https://www.cloudflare.com/) provides DNS hosting at no cost, and it's well-supported by Caddy. Cloudflare doesn't directly provide Dynamic DNS service, but [DNS-O-Matic](https://dnsomatic.com/) is a Dynamic DNS provider that will interface with many DNS hosts including Cloudflare, and is also free of charge. So, even if you have a dynamic IP address (as most residential Internet users do), you don't have your own domain, and you aren't willing to pay for a domain or any other relevant service, and you aren't willing to open any ports from the Internet to your system, you can still get a trusted certificate from Let's Encrypt by following these steps: - -- Register a free domain with Freenom. Be sure to keep up with the renewal requirements. -- Sign up for a free account with Cloudflare, and activate it for free DNS service only on your domain. -- Tell Freenom to use Cloudflare for DNS for your domain. -- Sign up for a free account with DNS-O-Matic, and configure it to update your Cloudflare DNS. -- Set up FreeNAS (see [this thread](https://www.ixsystems.com/community/threads/dns-o-matic-dynamic-dns-configuration.10326/)), your router, or whatever you prefer to update DNS-O-Matic as your IP address changes. -- Set up this script to do DNS validation, tell it to use the cloudflare plugin, and give it your email address and Global API key. - -If you aren't able or willing to obtain a certificate from Let's Encrypt, this script also supports configuring Caddy with a self-signed certificate, or with no certificate (and thus no HTTPS) at all. - -### Prerequisites (Other) - -Although not required, it's recommended to create two datasets on your main storage pool: one named `files`, which will store the Nextcloud user data; and one called `db`, which will store the SQL database. For optimal performance, set the record size of the `db` dataset to 16 KB (under Advanced Settings in the FreeNAS web GUI). It's also recommended to cache only metadata on the `db` dataset; you can do this by running `zfs set primarycache=metadata poolname/db`. - -### Installation - -Download the repository to a convenient directory on your FreeNAS system by running `git clone https://github.com/danb35/freenas-iocage-nextcloud`. Then change into the new directory and create a file called `nextcloud-config`. It should look like this: - -``` -JAIL_IP="192.168.1.199" -DEFAULT_GW_IP="192.168.1.1" -POOL_PATH="/mnt/tank" -TIME_ZONE="America/New_York" -HOST_NAME="YOUR_FQDN" -STANDALONE_CERT=1 -CERT_EMAIL="me@example.com" -``` - -Many of the options are self-explanatory, and all should be adjusted to suit your needs, but only a few are mandatory. The mandatory options are: - -- JAIL_IP is the IP address for your jail -- DEFAULT_GW_IP is the address for your default gateway -- POOL_PATH is the path for your data pool. -- TIME_ZONE is the time zone of your location, in PHP notation--see the [PHP manual](http://php.net/manual/en/timezones.php) for a list of all valid time zones. -- HOST_NAME is the fully-qualified domain name you want to assign to your installation. You must own (or at least control) this domain, because Let's Encrypt will test that control. -- DNS_CERT, STANDALONE_CERT, SELFSIGNED_CERT, and NO_CERT determine which method will be used to generate a TLS certificate (or, in the case of NO_CERT, indicate that you don't want to use SSL at all). DNS_CERT and STANDALONE_CERT indicate use of DNS or HTTP validation for Let's Encrypt, respectively. One **and only one** of these must be set to 1. -- CERT_EMAIL is the email address Let's Encrypt will use to notify you of certificate expiration. This is mandatory regardless of whether you're using Let's Encrypt (Caddy won't start without it), but it's only used with Let's Encrypt. If you are **not** using one of the Let's Encrypt certificate options, you can set this to a dummy address as above. If you **are** using Let's Encrypt, though, it should be set to a valid address for the system admin. -- DNS_PLUGIN: If DNS_CERT is set, DNS_PLUGIN must contain the name of the DNS validation plugin you'll use with Caddy to validate domain control. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for the available plugins, but omit the leading "tls.dns.". For example, to use Cloudflare, set `DNS_PLUGIN="cloudflare"`. -- DNS_ENV: If DNS_CERT is set, DNS_ENV must contain the authentication credentials for your DNS provider. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for further details. For Cloudflare, you'd set `DNS_ENV="CLOUDFLARE_EMAIL=foo@bar.baz CLOUDFLARE_API_KEY=blah"`, using your the email address of your Cloudflare account and your Global API key--the newer API tokens aren't currently supported. - -In addition, there are some other options which have sensible defaults, but can be adjusted if needed. These are: - -- JAIL_NAME: The name of the jail, defaults to "nextcloud" -- DB_PATH, FILES_PATH, and PORTS_PATH: These are the paths to your database files, your data files, and the FreeBSD Ports collection. They default to $POOL_PATH/db, $POOL_PATH/files, and $POOL_PATH/portsnap, respectively. -- DATABASE: Which database management system to use. Default is "mariadb", but can be set to "pgsql" if you prefer to use PostgreSQL. -- INTERFACE: The network interface to use for the jail. Defaults to `vnet0`. -- VNET: Whether to use the iocage virtual network stack. Defaults to `on`. - -If you're going to open ports 80 and 443 from the outside world to your jail, do so before running the script, and set STANDALONE_CERT to 1. If not, but you use a DNS provider that's supported by Caddy, set DNS_CERT to 1. If neither of these is true, you won't be able to use this script without modification. - -It's also helpful if HOST_NAME resolves to your jail from **inside** your network. You'll probably need to configure this on your router. If it doesn't, you'll still be able to reach your Nextcloud installation via the jail's IP address, but you'll get certificate errors that way. - -### Execution - -Once you've downloaded the script and prepared the configuration file, run this script (`./nextcloud-jail.sh`). The script will run for several minutes. When it finishes, your jail will be created, Nextcloud will be installed and configured, and you'll be shown the randomly-generated password for the default user ("admin"). You can then log in and create users, add data, and generally do whatever else you like. - -### Obtaining a trusted Let's Encrypt cert - -This configuration generated by this script will obtain certs from a non-trusted certificate authority by default. This is to prevent you from exhausting the [Let's Encrypt rate limits](https://letsencrypt.org/docs/rate-limits/) while you're testing things out. Once you're sure things are working, you'll want to get a trusted cert instead. To do this, you can use a simple script that's included. As long as you haven't changed the default jail name, you can do this by running `iocage exec nextcloud /root/remove-staging.sh`. - -### To Do - -I'd appreciate any suggestions (or, better yet, pull requests) to improve the various config files I'm using. Most of them are adapted from the default configuration files that ship with the software in question, and have only been lightly edited to work in this application. But if there are changes to settings or organization that could improve performance, reliability, or security, I'd like to hear about them. diff --git a/archive/jailman/blueprints/nextcloud/update.sh b/archive/jailman/blueprints/nextcloud/update.sh deleted file mode 100755 index cf90b555ba6..00000000000 --- a/archive/jailman/blueprints/nextcloud/update.sh +++ /dev/null @@ -1,6 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for nextcloud - -echo "running nextcloud update" -iocage exec -f nextcloud su -m www -c "php /usr/local/www/nextcloud/updater/updater.phar --no-interaction" -iocage exec nextcloud service caddy restart diff --git a/archive/jailman/blueprints/organizr/config.yml b/archive/jailman/blueprints/organizr/config.yml deleted file mode 100644 index b2dfea6714c..00000000000 --- a/archive/jailman/blueprints/organizr/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - organizr: - pkgs: nginx php74 php74-filter php74-curl php74-hash php74-json php74-openssl php74-pdo php74-pdo_sqlite php74-session php74-simplexml php74-sqlite3 php74-zip git diff --git a/archive/jailman/blueprints/organizr/includes/custom/organizr.conf b/archive/jailman/blueprints/organizr/includes/custom/organizr.conf deleted file mode 100644 index 550685e2420..00000000000 --- a/archive/jailman/blueprints/organizr/includes/custom/organizr.conf +++ /dev/null @@ -1,145 +0,0 @@ -send_timeout 5m; -proxy_read_timeout 240; -proxy_send_timeout 240; -proxy_connect_timeout 240; -client_header_timeout 240; -client_body_timeout 240; - - -location / { - root /usr/local/www/Organizr; - index index.php index.html index.htm index.nginx-debian.html; - location ~ /auth-(.*) { - internal; - rewrite ^/auth-(.*) /api/?v1/auth&group=$1; - } - error_page 400 401 402 403 404 405 408 500 502 503 504 $scheme://$server_name/?error=$status; - location / {try_files $uri $uri/ =404;} - include custom/phpblock.conf; #PHP Block - } - - -location /transmission/ { - auth_request /auth-0; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass http://192.168.31.22:9091; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } - -location /sonarr/ { - auth_request /auth-0; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass http://192.168.31.23:8989; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } - -location /radarr/ { - auth_request /auth-0; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass http://192.168.31.24:7878; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } - - location /lidarr/ { - auth_request /auth-0; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass http://192.168.31.25:8686; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } - -location /jackett/ { - auth_request /auth-0; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass http://192.168.31.21:9117; - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection keep-alive; - proxy_cache_bypass $http_upgrade; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto $scheme; - proxy_set_header X-Forwarded-Host $http_host; -} - -location /plex/ { - auth_request /auth-4; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass https://192.168.30.27:32400/; - client_max_body_size 10m; - client_body_buffer_size 128k; - proxy_bind $server_addr; - proxy_buffers 32 4k; - #Timeout if the real server is dead - proxy_next_upstream error timeout invalid_header http_500 http_502 http_503; - # Advanced Proxy Config - send_timeout 5m; - proxy_read_timeout 240; - proxy_send_timeout 240; - proxy_connect_timeout 240; - proxy_hide_header X-Frame-Options; - # Basic Proxy Config - proxy_set_header Host $host:$server_port; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_set_header X-Forwarded-Proto https; - proxy_redirect http:// $scheme://; - proxy_http_version 1.1; - proxy_set_header Connection ""; - proxy_no_cache $cookie_session; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection "upgrade"; - } -if ($http_referer ~* /plex/) { - rewrite ^/web/(.*) /plex/web/$1? redirect; - } - -location /tautulli/ { - auth_request /auth-4; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass http://192.168.31.26:8181; - proxy_set_header Host $host; - proxy_set_header X-Forwarded-Host $server_name; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - proxy_read_timeout 90; - proxy_set_header X-Forwarded-Proto https; - proxy_set_header X-Forwarded-Ssl on; - #proxy_redirect ~^(http(?:s)?://)([^:/]+)(?::\d+)?(/.*)?$ $1$2:$server_port$3; - proxy_redirect off; -} - -location /ombi/ { - auth_request /auth-4; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass https://192.168.31.27:3579/; - proxy_http_version 1.1; - proxy_set_header Upgrade $http_upgrade; - proxy_set_header Connection keep-alive; - proxy_set_header Host $host; - proxy_cache_bypass $http_upgrade; - } - - location /grafana { - auth_request /auth-0; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass https://192.168.30.34/; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } - - location /bitwarden { - auth_request /auth-0; - add_header X-Frame-Options "SAMEORIGIN"; - proxy_pass https://bitwarden.schouten-lebbing.nl/; - proxy_set_header Host $host; - proxy_set_header X-Real-IP $remote_addr; - proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; - } diff --git a/archive/jailman/blueprints/organizr/includes/custom/phpblock.conf b/archive/jailman/blueprints/organizr/includes/custom/phpblock.conf deleted file mode 100644 index 314115dfd4c..00000000000 --- a/archive/jailman/blueprints/organizr/includes/custom/phpblock.conf +++ /dev/null @@ -1,9 +0,0 @@ -fastcgi_read_timeout 240; - -location ~ \.php$ { - fastcgi_split_path_info ^(.+\.php)(/.+)$; - fastcgi_pass unix:/var/run/php-fpm.sock; - fastcgi_index index.php; - fastcgi_param SCRIPT_FILENAME $request_filename; - include fastcgi_params; -} diff --git a/archive/jailman/blueprints/organizr/includes/nginx.conf b/archive/jailman/blueprints/organizr/includes/nginx.conf deleted file mode 100644 index f9d896385fd..00000000000 --- a/archive/jailman/blueprints/organizr/includes/nginx.conf +++ /dev/null @@ -1,25 +0,0 @@ -user www; -worker_processes 1; - -events { - worker_connections 1024; -} - -http { - include mime.types; - default_type application/octet-stream; - sendfile on; - keepalive_timeout 65; - server { - listen 80; - server_name localhost; - include custom/organizr.conf; - } - server { - listen 443 ssl; - server_name localhost; - include custom/organizr.conf; - ssl_certificate /config/ssl/Organizr-Cert.crt; # Replace with actually valid certificate - ssl_certificate_key /config/ssl/Organizr-Cert.key; # Replace with actually valid certificate - } -} diff --git a/archive/jailman/blueprints/organizr/install.sh b/archive/jailman/blueprints/organizr/install.sh deleted file mode 100755 index cc90cc4663c..00000000000 --- a/archive/jailman/blueprints/organizr/install.sh +++ /dev/null @@ -1,34 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for Organizr - -iocage exec "$1" sed -i '' -e 's?listen = 127.0.0.1:9000?listen = /var/run/php-fpm.sock?g' /usr/local/etc/php-fpm.d/www.conf -iocage exec "$1" sed -i '' -e 's/;listen.owner = www/listen.owner = www/g' /usr/local/etc/php-fpm.d/www.conf -iocage exec "$1" sed -i '' -e 's/;listen.group = www/listen.group = www/g' /usr/local/etc/php-fpm.d/www.conf -iocage exec "$1" sed -i '' -e 's/;listen.mode = 0660/listen.mode = 0600/g' /usr/local/etc/php-fpm.d/www.conf -iocage exec "$1" cp /usr/local/etc/php.ini-production /usr/local/etc/php.ini -iocage exec "$1" sed -i '' -e 's?;date.timezone =?date.timezone = "Universal"?g' /usr/local/etc/php.ini -iocage exec "$1" sed -i '' -e 's?;cgi.fix_pathinfo=1?cgi.fix_pathinfo=0?g' /usr/local/etc/php.ini -# shellcheck disable=SC2154 -mv /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/nginx/nginx.conf /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/nginx/nginx.conf.bak -cp "${SCRIPT_DIR}"/blueprints/organizr/includes/nginx.conf /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/nginx/nginx.conf -cp -Rf "${SCRIPT_DIR}"/blueprints/organizr/includes/custom /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/nginx/custom -# shellcheck disable=SC2154 -if [ ! -d "/mnt/${global_dataset_config}/$1/ssl" ]; then - echo "cert folder doesn't exist... creating..." - iocage exec "$1" mkdir /config/ssl -fi - -if [ -f "/mnt/${global_dataset_config}/$1/ssl/Organizr-Cert.crt" ]; then - echo "certificate exists... Skipping cert generation" -else - echo "No ssl certificate present, generating self signed certificate" - openssl req -new -newkey rsa:2048 -days 365 -nodes -x509 -subj "/C=US/ST=Denial/L=Springfield/O=Dis/CN=localhost" -keyout /mnt/"${global_dataset_config}"/"$1"/ssl/Organizr-Cert.key -out /mnt/"${global_dataset_config}"/"$1"/ssl/Organizr-Cert.crt -fi - -iocage exec "$1" git clone https://github.com/causefx/Organizr.git /usr/local/www/Organizr -iocage exec "$1" chown -R www:www /usr/local/www /config /usr/local/etc/nginx/nginx.conf /usr/local/etc/nginx/custom -iocage exec "$1" ln -s /config/config.php /usr/local/www/Organizr/api/config/config.php -iocage exec "$1" sysrc nginx_enable=YES -iocage exec "$1" sysrc php_fpm_enable=YES -iocage exec "$1" service nginx start -iocage exec "$1" service php-fpm start diff --git a/archive/jailman/blueprints/organizr/readme.md b/archive/jailman/blueprints/organizr/readme.md deleted file mode 100644 index b33f90edbe2..00000000000 --- a/archive/jailman/blueprints/organizr/readme.md +++ /dev/null @@ -1,104 +0,0 @@ -# Organizr - -## Original README from the Organizr github repo: - -https://github.com/causefx/Organizr - -

- -[![Percentage of issues still open](http://isitmaintained.com/badge/open/causefx/Organizr.svg)](http://isitmaintained.com/project/causefx/Organizr "Percentage of issues still open") -[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/causefx/Organizr.svg)](http://isitmaintained.com/project/causefx/Organizr "Average time to resolve an issue") -[![GitHub stars](https://img.shields.io/github/stars/causefx/Organizr.svg)](https://github.com/causefx/Organizr/stargazers) -[![GitHub forks](https://img.shields.io/github/forks/causefx/Organizr.svg)](https://github.com/causefx/Organizr/network) -[![Docker pulls](https://img.shields.io/docker/pulls/organizrtools/organizr-v2.svg)](https://hub.docker.com/r/organizrtools/organizr-v2) -[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://paypal.me/causefx) -[![Beerpay](https://beerpay.io/causefx/Organizr/badge.svg?style=beer-square)](https://beerpay.io/causefx/Organizr) [![Beerpay](https://beerpay.io/causefx/Organizr/make-wish.svg?style=flat-square)](https://beerpay.io/causefx/Organizr?focus=wish) - - - -Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. You can then work on your server with ease. Want to give users access to some Tabs? No problem, just enable user support and have them make an account. Want guests to be able to visit too? Enable Guest support for those tabs. - - - -- PHP 7.1.3+ -- [Official Site](https://organizr.app) - Will be refreshed soon! -- [Official Discord](https://organizr.app/discord) -- [See Wiki](https://github.com/causefx/Organizr/wiki) - Will be updated soon! -- [Docker](https://hub.docker.com/r/organizrtools/organizr-v2/) - - - - - -[![Organizr Overview](https://img.youtube.com/vi/LZL4smFB6wU/0.jpg)](https://www.youtube.com/watch?v=LZL4smFB6wU) - - - -- Login with Plex/Emby/LDAP or sFTP credentials -- Custom tabs for your services -- Fullscreen Support -- Pin/Unpin sidebar -- Mobile support -- Set default page on launch -- Upload new icons with ease -- Enable or disable iFrame for your tabs -- User management support: Create, delete and promote users from the user management console -- Unlimited User Groups -- Theme-able -- Personalise any theme: Customise the look and feel of Organizr with access to the colour palette -- Organizr login log viewer -- Fail2ban support (see wiki) -- Nginx Auth_Request support -- Protect new user account creation with registration password -- 'Forgot Password' support [receive an email with your new password, prerequisites: mail server setup] -- Multiple login support -- Keyboard shortcut support (Check help tab in settings) -- Gravatar Support -- Customise the top bar by adding your own site logo or site name -- Additional language support -- Quick access tabs [access your tabs quickly e.g. www.example.com/#Sonarr] -- Many more... - - - -[![Feature Requests](http://feathub.com/causefx/Organizr?format=svg)](http://feathub.com/causefx/Organizr) - - - -##### Usage - -``` -docker create \ - --name=organizr \ - -v :/config \ - -e PGID= -e PUID= \ - -p 80:80 \ - organizrtools/organizr-v2 -``` - -##### Parameters - -The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So `-p 8080:80` would expose port 80 from inside the container to be accessible from the host's IP on port 8080 and `http://192.168.x.x:8080` would show you what's running INSIDE the container on port 80. - -- `-p 80` - The port(s) -- `-v /config` - Mapping the config files for Organizr -- `-e PGID` Used for GroupID - see below for explanation -- `-e PUID` Used for UserID - see below for explanation - -##### Info - -- Shell access whilst the container is running: `docker exec -it organizr /bin/bash` -- To monitor the logs of the container in realtime: `docker logs -f organizr` -- Container version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizr` -- Image version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizrtools/docker-organizr-v2` - - - -

-

BrowserStack for allowing us to use their platform for testing

-

This project is supported by:

-

- - - -

diff --git a/archive/jailman/blueprints/organizr/update.sh b/archive/jailman/blueprints/organizr/update.sh deleted file mode 100755 index 37f794926e3..00000000000 --- a/archive/jailman/blueprints/organizr/update.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for Organizr - -iocage exec "$1" service nginx stop -iocage exec "$1" service php-fpm stop -# TODO setup cli update for Organizr here. -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/organizr/includes/nginx.conf /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/nginx/nginx.conf -iocage exec "$1" "cd /usr/local/www/Organizr && git pull" -iocage exec "$1" chown -R www:www /usr/local/www /config /usr/local/etc/nginx/nginx.conf /usr/local/etc/nginx/custom -iocage exec "$1" service nginx start -iocage exec "$1" service php-fpm start diff --git a/archive/jailman/blueprints/plex/config.yml b/archive/jailman/blueprints/plex/config.yml deleted file mode 100644 index 3249b98a995..00000000000 --- a/archive/jailman/blueprints/plex/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - plex: - pkgs: plexmediaserver diff --git a/archive/jailman/blueprints/plex/includes/FreeBSD.conf b/archive/jailman/blueprints/plex/includes/FreeBSD.conf deleted file mode 100644 index aac0d24822d..00000000000 --- a/archive/jailman/blueprints/plex/includes/FreeBSD.conf +++ /dev/null @@ -1,3 +0,0 @@ -FreeBSD: { - url: "pkg+http://pkg.FreeBSD.org/${ABI}/latest" -} diff --git a/archive/jailman/blueprints/plex/install.sh b/archive/jailman/blueprints/plex/install.sh deleted file mode 100755 index ecd62b096b8..00000000000 --- a/archive/jailman/blueprints/plex/install.sh +++ /dev/null @@ -1,51 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for plex - -iocage exec plex mkdir -p /usr/local/etc/pkg/repos - -# Change to to more frequent FreeBSD repo to stay up-to-date with plex more. -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/plex/includes/FreeBSD.conf /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/pkg/repos/FreeBSD.conf - - -# Check if datasets for media librarys exist, create them if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_media}" /mnt/media -createmount "$1" "${global_dataset_media}"/movies /mnt/media/movies -createmount "$1" "${global_dataset_media}"/music /mnt/media/music -createmount "$1" "${global_dataset_media}"/shows /mnt/media/shows - -# Create plex ramdisk if specified -# shellcheck disable=SC2154 -if [ -z "${plex_ramdisk}" ]; then - echo "no ramdisk specified for plex, continuing without ramdisk" -else - iocage fstab -a "$1" tmpfs /tmp_transcode tmpfs rw,size="${plex_ramdisk}",mode=1777 0 0 -fi - -iocage exec "$1" chown -R plex:plex /config - -# Force update pkg to get latest plex version -iocage exec "$1" pkg update -iocage exec "$1" pkg upgrade -y - -# Add plex user to video group for future hw-encoding support -iocage exec "$1" pw groupmod -n video -m plex - -# Run different install procedures depending on Plex vs Plex Beta -# shellcheck disable=SC2154 -if [ "$plex_beta" == "true" ]; then - echo "beta enabled in config.yml... using plex beta for install" - iocage exec "$1" sysrc "plexmediaserver_plexpass_enable=YES" - iocage exec "$1" sysrc plexmediaserver_plexpass_support_path="/config" - iocage exec "$1" chown -R plex:plex /usr/local/share/plexmediaserver-plexpass/ - iocage exec "$1" service plexmediaserver_plexpass restart -else - echo "beta disabled in config.yml... NOT using plex beta for install" - iocage exec "$1" sysrc "plexmediaserver_enable=YES" - iocage exec "$1" sysrc plexmediaserver_support_path="/config" - iocage exec "$1" chown -R plex:plex /usr/local/share/plexmediaserver/ - iocage exec "$1" service plexmediaserver restart -fi - -echo "Finished installing plex" diff --git a/archive/jailman/blueprints/plex/readme.md b/archive/jailman/blueprints/plex/readme.md deleted file mode 100644 index b35e8c38da7..00000000000 --- a/archive/jailman/blueprints/plex/readme.md +++ /dev/null @@ -1,15 +0,0 @@ -# Plex - -### Config Parameters: - -- beta: set to `true` if you want to run the plex beta (previously known as "plexpass"). Please note: This is not required for plexpass features - -For more information about plex, please see the Plex website: - -### Config Parameters: - -- ramdisk: Specify the `size` parameter to create a transcoding ramdisk under /tmp_transcode. Requires manual setting it un plex to be used for transcoding. (optional) - -# Original plex install script guide - -https://www.ixsystems.com/community/resources/fn11-3-iocage-jails-plex-tautulli-sonarr-radarr-lidarr-jackett-transmission-organizr.58/ diff --git a/archive/jailman/blueprints/plex/update.sh b/archive/jailman/blueprints/plex/update.sh deleted file mode 100755 index f159dabeae4..00000000000 --- a/archive/jailman/blueprints/plex/update.sh +++ /dev/null @@ -1,18 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for Plex - -# Run different update procedures depending on Plex vs Plex Beta -# shellcheck disable=SC2154 -if [ "$plex_plexpass" == "true" ]; then - echo "beta enabled in config.yml... using plex beta for update..." - iocage exec "$1" service plexmediaserver_plexpass stop - # Plex is updated using PKG already, this is mostly a placeholder - iocage exec "$1" chown -R plex:plex /usr/local/share/plexmediaserver-plexpass/ - iocage exec "$1" service plexmediaserver_plexpass restart -else - echo "beta disabled in config.yml... NOT using plex beta for update..." - iocage exec "$1" service plexmediaserver stop - # Plex is updated using PKG already, this is mostly a placeholder - iocage exec "$1" chown -R plex:plex /usr/local/share/plexmediaserver/ - iocage exec "$1" service plexmediaserver restart -fi diff --git a/archive/jailman/blueprints/radarr/config.yml b/archive/jailman/blueprints/radarr/config.yml deleted file mode 100644 index 2f82f8539ca..00000000000 --- a/archive/jailman/blueprints/radarr/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - radarr: - pkgs: mono mediainfo sqlite3 libgdiplus diff --git a/archive/jailman/blueprints/radarr/includes/radarr.rc b/archive/jailman/blueprints/radarr/includes/radarr.rc deleted file mode 100644 index af6d7bd150a..00000000000 --- a/archive/jailman/blueprints/radarr/includes/radarr.rc +++ /dev/null @@ -1,50 +0,0 @@ -#!/bin/sh - -# $FreeBSD$ -# -# PROVIDE: radarr -# REQUIRE: LOGIN -# KEYWORD: shutdown -# -# Add the following lines to /etc/rc.conf.local or /etc/rc.conf -# to enable this service: -# -# radarr_enable: Set to YES to enable radarr -# Default: NO -# radarr_user: The user account used to run the radarr daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run as root. -# Default: media -# radarr_group: The group account used to run the radarr daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run with group wheel. -# Default: media -# radarr_data_dir: Directory where radarr configuration -# data is stored. -# Default: /var/db/radarr - -. /etc/rc.subr -name=radarr -rcvar=${name}_enable -load_rc_config $name - -: ${radarr_enable:="NO"} -: ${radarr_user:="radarr"} -: ${radarr_group:="radarr"} -: ${radarr_data_dir:="/config"} - -pidfile="${radarr_data_dir}/nzbdrone.pid" -command="/usr/sbin/daemon" -procname="/usr/local/bin/mono" -command_args="-f ${procname} /usr/local/share/Radarr/Radarr.exe --data=${radarr_data_dir} --nobrowser" - -start_precmd=radarr_precmd -radarr_precmd() { -if [ ! -d ${radarr_data_dir} ]; then -install -d -o ${radarr_user} -g ${radarr_group} ${radarr_data_dir} -fi - -export XDG_CONFIG_HOME=${radarr_data_dir} -} - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/radarr/install.sh b/archive/jailman/blueprints/radarr/install.sh deleted file mode 100755 index 99442692307..00000000000 --- a/archive/jailman/blueprints/radarr/install.sh +++ /dev/null @@ -1,24 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for radarr - -# Check if dataset for completed download and it parent dataset exist, create if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_downloads}" -createmount "$1" "${global_dataset_downloads}"/complete /mnt/fetched - -# Check if dataset for media library and the dataset for movies exist, create if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_media}" -createmount "$1" "${global_dataset_media}"/movies /mnt/movies - -iocage exec "$1" "fetch https://github.com/Radarr/Radarr/releases/download/v0.2.0.1480/Radarr.develop.0.2.0.1480.linux.tar.gz -o /usr/local/share" -iocage exec "$1" "tar -xzvf /usr/local/share/Radarr.develop.0.2.0.1480.linux.tar.gz -C /usr/local/share" -iocage exec "$1" rm /usr/local/share/Radarr.develop.0.2.0.1480.linux.tar.gz -iocage exec "$1" "pw user add radarr -c radarr -u 352 -d /nonexistent -s /usr/bin/nologin" -iocage exec "$1" chown -R radarr:radarr /usr/local/share/Radarr /config -iocage exec "$1" mkdir /usr/local/etc/rc.d -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/radarr/includes/radarr.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/radarr -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/radarr -iocage exec "$1" sysrc "radarr_enable=YES" -iocage exec "$1" service radarr restart diff --git a/archive/jailman/blueprints/radarr/readme.md b/archive/jailman/blueprints/radarr/readme.md deleted file mode 100644 index a2ded7d8e10..00000000000 --- a/archive/jailman/blueprints/radarr/readme.md +++ /dev/null @@ -1,170 +0,0 @@ -# Radarr - -## Original README from the radarr github: - -https://github.com/Radarr/Radarr - -# Radarr - -

-Radarr -

- -**New UI Development:** For an overview of the new UI development see [DEVELOPMENT.md](https://github.com/Radarr/Radarr/blob/aphrodite/DEVELOPMENT.md). - -Radarr is an **independent** fork of [Sonarr](https://github.com/Sonarr/Sonarr) reworked for automatically downloading movies via Usenet and BitTorrent. - -The project was inspired by other Usenet/BitTorrent movie downloaders such as CouchPotato. - -See the [Roadmap blogpost](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html) for an overview of planned features. - -## Getting Started - -[![Installation](https://img.shields.io/badge/wiki-installation-brightgreen.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/Installation) -[![Docker](https://img.shields.io/badge/wiki-docker-1488C6.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/Docker) -[![Setup Guide](https://img.shields.io/badge/wiki-setup_guide-orange.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/Setup-Guide) -[![FAQ](https://img.shields.io/badge/wiki-FAQ-BF55EC.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki/FAQ) - -- [Install Radarr for your desired OS](https://github.com/Radarr/Radarr/wiki/Installation) _or_ use [Docker](https://github.com/Radarr/Radarr/wiki/Docker) -- _For Linux users_, run `radarr` and _optionally_ have [Radarr start automatically](https://github.com/Radarr/Radarr/wiki/Autostart-on-Linux) -- Connect to the UI through or in your web browser -- See the [Setup Guide](https://github.com/Radarr/Radarr/wiki/Setup-Guide) for further configuration - -## Downloads - -| Release Type | Branch: develop (stable) | Branch: nightly (semi-unstable) | Branch: aphrodite (very-unstable) | -| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| Binary Releases | [![GitHub Releases](https://img.shields.io/badge/downloads-releases-brightgreen.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/releases) | [![AppVeyor Builds](https://img.shields.io/badge/downloads-nightly-green.svg?maxAge=60&style=flat-square)](https://ci.appveyor.com/project/galli-leo/radarr-usby1/branch/develop/artifacts) | | -| Docker | [![Docker release](https://img.shields.io/badge/linuxserver-radarr:latest-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr) | [![Docker nightly](https://img.shields.io/badge/linuxserver-radarr:nightly-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr) | [![Docker aphrodite](https://img.shields.io/badge/linuxserver-radarr:preview-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr) | -| Docker | [![Docker release](https://img.shields.io/badge/hotio-radarr:latest-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/hotio/radarr) | [![Docker nightly](https://img.shields.io/badge/hotio-radarr:unstable-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/hotio/radarr) | [![Docker aphrodite](https://img.shields.io/badge/hotio-radarr:aphrodite-blue.svg?colorB=1488C6&maxAge=60&style=flat-square)](https://hub.docker.com/r/hotio/radarr) | - -## Support - -[![OpenCollective](https://opencollective.com/radarr/tiers/backer/badge.svg)](#backers) -[![OpenCollective](https://opencollective.com/radarr/tiers/flexible-sponsor/badge.svg)](#flexible-sponsors) -[![OpenCollective](https://opencollective.com/radarr/tiers/sponsor/badge.svg)](#sponsors) - -[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=flat-square)](https://discord.gg/AD3UP37) -[![Reddit](https://img.shields.io/badge/reddit-discussion-FF4500.svg?maxAge=60&style=flat-square)](https://www.reddit.com/r/radarr) -[![Feathub](https://img.shields.io/badge/feathub-requests-lightgrey.svg?maxAge=60&style=flat-square)](http://feathub.com/Radarr/Radarr) -[![GitHub](https://img.shields.io/badge/github-issues-red.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/issues) -[![GitHub Wiki](https://img.shields.io/badge/github-wiki-181717.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/wiki) - -## Status - -[![GitHub issues](https://img.shields.io/github/issues/radarr/radarr.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/issues) -[![GitHub pull requests](https://img.shields.io/github/issues-pr/radarr/radarr.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/pulls) -[![GNU GPL v3](https://img.shields.io/badge/license-GNU%20GPL%20v3-blue.svg?maxAge=60&style=flat-square)](http://www.gnu.org/licenses/gpl.html) -[![Copyright 2010-2017](https://img.shields.io/badge/copyright-2017-blue.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr) -[![Github Releases](https://img.shields.io/github/downloads/Radarr/Radarr/total.svg?maxAge=60&style=flat-square)](https://github.com/Radarr/Radarr/releases/) -[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/radarr.svg?maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/radarr/) -[![Changelog](https://img.shields.io/github/commit-activity/w/radarr/radarr.svg?style=flat-square)](/CHANGELOG.md#unreleased) - -| Service | Master | Develop | -| -------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------: | -| AppVeyor | [![AppVeyor](https://img.shields.io/appveyor/ci/galli-leo/Radarr/master.svg?maxAge=60&style=flat-square)](https://ci.appveyor.com/project/galli-leo/Radarr) | [![AppVeyor](https://img.shields.io/appveyor/ci/galli-leo/Radarr-usby1/develop.svg?maxAge=60&style=flat-square)](https://ci.appveyor.com/project/galli-leo/Radarr-usby1) | -| Travis | [![Travis](https://img.shields.io/travis/Radarr/Radarr/master.svg?maxAge=60&style=flat-square)](https://travis-ci.org/Radarr/Radarr) | [![Travis](https://img.shields.io/travis/Radarr/Radarr/develop.svg?maxAge=60&style=flat-square)](https://travis-ci.org/Radarr/Radarr) | - -### [Site and API Status](https://status.radarr.video) - -| API | Updates | Sites | -| ------------------------------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------------------: | -| [![API V2 (develop)](http://status.radarr.video/component/1/shield?style=flat-square)](https://api.radarr.video/v2/) | [![Update Server](http://status.radarr.video/component/4/shield?style=flat-square)](https://radarr.aeonlucid.com) | [![Radarr Mappings](http://status.radarr.video/component/6/shield?style=flat-square)](https://mappings.radarr.video/) | -| [![API Staging (nightly)](http://status.radarr.video/component/2/shield?style=flat-square)](https://staging.api.radarr.video/) | [![Github Updates](http://status.radarr.video/component/5/shield?style=flat-square)](https://api.github.com/v3/) | [![Main Site](http://status.radarr.video/component/7/shield?style=flat-square)](https://radarr.video/) | - -Radarr is currently undergoing rapid development and pull requests are actively added into the repository. - -## Features - -### Current Features - -- Adding new movies with lots of information, such as trailers, ratings, etc. -- Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc. -- Can watch for better quality of the movies you have and do an automatic upgrade. _eg. from DVD to Blu-Ray_ -- Automatic failed download handling will try another release if one fails -- Manual search so you can pick any release or to see why a release was not downloaded automatically -- Full integration with SABnzbd and NZBGet -- Automatically searching for releases as well as RSS Sync -- Automatically importing downloaded movies -- Recognizing Special Editions, Director's Cut, etc. -- Identifying releases with hardcoded subs -- All indexers supported by Sonarr also supported -- New PassThePopcorn Indexer -- QBittorrent, Deluge, rTorrent, Transmission and uTorrent download client (Other clients are coming) -- New TorrentPotato Indexer -- Torznab Indexer now supports Movies (Works well with [Jackett](https://github.com/Jackett/Jackett)) -- Scanning PreDB to know when a new release is available -- Importing movies from various online sources, such as IMDb Watchlists (A complete list can be found [here](https://github.com/Radarr/Radarr/issues/114)) -- Full integration with Kodi, Plex (notification, library update) -- And a beautiful UI -- Importing Metadata such as trailers or subtitles -- Adding metadata such as posters and information for Kodi and others to use -- Advanced customization for profiles, such that Radarr will always download the copy you want - -### Planned Features - -See the [Roadmap blogpost](https://blog.radarr.video/development/update/2018/11/11/roadmap-update.html) for an overview of planned features. - -#### [Feature Requests](http://feathub.com/Radarr/Radarr) - -## Configuring the Development Environment - -### Requirements - -- [Visual Studio Community 2019](https://www.visualstudio.com/vs/community/) or [Rider](http://www.jetbrains.com/rider/) -- [Git](https://git-scm.com/downloads) -- [Node.js](https://nodejs.org/en/download/) -- [Yarn](https://yarnpkg.com/) - -### Setup - -- Make sure all the required software mentioned above are installed -- Clone the repository into your development machine ([_info_](https://help.github.com/desktop/guides/contributing/working-with-your-remote-repository-on-github-or-github-enterprise)) -- Grab the submodules `git submodule init && git submodule update` -- Install the required Node Packages `yarn install` -- Start gulp to monitor your dev environment for any changes that need post processing using `yarn start` command. - -> **Notice** -> Gulp must be running at all times while you are working with Radarr client source files. - -### Build - -- To build run `sh build.sh` - -**Note:** Windows users must have bash available to do this. If you installed git, you should have a git bash utility that works. - -### Development - -- Open `Radarr.sln` in Visual Studio 2017 or run the build.sh script, if Mono is installed. Alternatively you can use Jetbrains Rider, since it works on all Platforms. -- Make sure `NzbDrone.Console` is set as the startup project -- Run `build.sh` before running - -## Supporters - -This project would not be possible without the support by these amazing folks. [**Become a sponsor or backer**](https://opencollective.com/radarr) to help us out! - -### Sponsors - -[![Sponsors](https://opencollective.com/radarr/tiers/sponsor.svg)](https://opencollective.com/radarr/order/3851) - -### Flexible Sponsors - -[![Flexible Sponsors](https://opencollective.com/radarr/tiers/flexible-sponsor.svg?avatarHeight=54)](https://opencollective.com/radarr/order/3856) - -### Backers - -[![Backers](https://opencollective.com/radarr/tiers/backer.svg?avatarHeight=48)](https://opencollective.com/radarr/order/3850) - -### JetBrains - -Thank you to [JetBrains JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools - -- [ReSharper ReSharper](http://www.jetbrains.com/resharper/) -- [WebStorm WebStorm](http://www.jetbrains.com/webstorm/) -- [Rider Rider](http://www.jetbrains.com/rider/) -- [dotTrace dotTrace](http://www.jetbrains.com/dottrace/) - -## License - -- [GNU GPL v3](http://www.gnu.org/licenses/gpl.html) -- Copyright 2010-2019 diff --git a/archive/jailman/blueprints/radarr/update.sh b/archive/jailman/blueprints/radarr/update.sh deleted file mode 100755 index 6a0edae84a2..00000000000 --- a/archive/jailman/blueprints/radarr/update.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for radarr - -iocage exec "$1" service radarr stop -#TODO insert code to update radarr itself here -iocage exec "$1" chown -R radarr:radarr /usr/local/share/Radarr /config -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/radarr/includes/radarr.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/radarr -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/radarr -iocage exec "$1" service radarr restart diff --git a/archive/jailman/blueprints/sonarr/config.yml b/archive/jailman/blueprints/sonarr/config.yml deleted file mode 100644 index 8d4d71d773a..00000000000 --- a/archive/jailman/blueprints/sonarr/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - sonarr: - pkgs: mono mediainfo sqlite3 diff --git a/archive/jailman/blueprints/sonarr/includes/sonarr.rc b/archive/jailman/blueprints/sonarr/includes/sonarr.rc deleted file mode 100644 index b50d44ad2b9..00000000000 --- a/archive/jailman/blueprints/sonarr/includes/sonarr.rc +++ /dev/null @@ -1,50 +0,0 @@ -#!/bin/sh - -# $FreeBSD$ -# -# PROVIDE: sonarr -# REQUIRE: LOGIN -# KEYWORD: shutdown -# -# Add the following lines to /etc/rc.conf.local or /etc/rc.conf -# to enable this service: -# -# sonarr_enable: Set to YES to enable sonarr -# Default: NO -# sonarr_user: The user account used to run the sonarr daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run as root. -# Default: media - # sonarr_group: The group account used to run the sonarr daemon. -# This is optional, however do not specifically set this to an -# empty string as this will cause the daemon to run with group wheel. -# Default: media -# sonarr_data_dir: Directory where sonarr configuration -# data is stored. -# Default: /var/db/sonarr - -. /etc/rc.subr -name=sonarr -rcvar=${name}_enable -load_rc_config $name - -: ${sonarr_enable:="NO"} -: ${sonarr_user:="sonarr"} -: ${sonarr_group:="sonarr"} -: ${sonarr_data_dir:="/config"} - -pidfile="${sonarr_data_dir}/nzbdrone.pid" -command="/usr/sbin/daemon" -procname="/usr/local/bin/mono" -command_args="-f ${procname} /usr/local/share/NzbDrone/NzbDrone.exe --data=${sonarr_data_dir} --nobrowser" - -start_precmd=sonarr_precmd -sonarr_precmd() { -if [ ! -d ${sonarr_data_dir} ]; then -install -d -o ${sonarr_user} -g ${sonarr_group} ${sonarr_data_dir} -fi - -export XDG_CONFIG_HOME=${sonarr_data_dir} -} - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/sonarr/install.sh b/archive/jailman/blueprints/sonarr/install.sh deleted file mode 100755 index faec9912808..00000000000 --- a/archive/jailman/blueprints/sonarr/install.sh +++ /dev/null @@ -1,24 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for sonarr - -# Check if dataset for completed download and it parent dataset exist, create if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_downloads}" -createmount "$1" "${global_dataset_downloads}"/complete /mnt/fetched - -# Check if dataset for media library and the dataset for tv shows exist, create if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_media}" -createmount "$1" "${global_dataset_media}"/shows /mnt/shows - -iocage exec "$1" "fetch http://download.sonarr.tv/v2/master/mono/NzbDrone.master.tar.gz -o /usr/local/share" -iocage exec "$1" "tar -xzvf /usr/local/share/NzbDrone.master.tar.gz -C /usr/local/share" -iocage exec "$1" rm /usr/local/share/NzbDrone.master.tar.gz -iocage exec "$1" "pw user add sonarr -c sonarr -u 351 -d /nonexistent -s /usr/bin/nologin" -iocage exec "$1" chown -R sonarr:sonarr /usr/local/share/NzbDrone /config -iocage exec "$1" mkdir /usr/local/etc/rc.d -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/sonarr/includes/sonarr.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/sonarr -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/sonarr -iocage exec "$1" sysrc "sonarr_enable=YES" -iocage exec "$1" service sonarr restart diff --git a/archive/jailman/blueprints/sonarr/readme.md b/archive/jailman/blueprints/sonarr/readme.md deleted file mode 100644 index b51ea8c8537..00000000000 --- a/archive/jailman/blueprints/sonarr/readme.md +++ /dev/null @@ -1,63 +0,0 @@ -# Sonarr - -## Original README from the sonarr github: - -https://github.com/Sonarr/Sonarr - -# Sonarr - -Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. - -## Major Features Include: - -- Support for major platforms: Windows, Linux, macOS, Raspberry Pi, etc. -- Automatically detects new episodes -- Can scan your existing library and download any missing episodes -- Can watch for better quality of the episodes you already have and do an automatic upgrade. _eg. from DVD to Blu-Ray_ -- Automatic failed download handling will try another release if one fails -- Manual search so you can pick any release or to see why a release was not downloaded automatically -- Fully configurable episode renaming -- Full integration with SABnzbd and NZBGet -- Full integration with Kodi, Plex (notification, library update, metadata) -- Full support for specials and multi-episode releases -- And a beautiful UI - -## Configuring Development Environment: - -### Requirements - -- [Visual Studio 2017](https://www.visualstudio.com/vs/) -- [Git](https://git-scm.com/downloads) -- [NodeJS](https://nodejs.org/en/download/) -- [Yarn](https://yarnpkg.com/) - -### Setup - -- Make sure all the required software mentioned above are installed -- Clone the repository into your development machine. [_info_](https://help.github.com/en/articles/working-with-forks) -- Grab the submodules `git submodule init && git submodule update` -- Install the required Node Packages `yarn` - -### Backend Development - -- Run `yarn build` to build the UI -- Open `Sonarr.sln` in Visual Studio -- Make sure `NzbDrone.Console` is set as the startup project -- Build `NzbDrone.Windows` and `NzbDrone.Mono` projects -- Build Solution - -### UI Development - -- Run `yarn watch` to build UI and rebuild automatically when changes are detected -- Run Sonarr.Console.exe (or debug in Visual Studio) - -### License - -- [GNU GPL v3](http://www.gnu.org/licenses/gpl.html) -- Copyright 2010-2019 - -### Sponsors - -- [JetBrains](http://www.jetbrains.com/) for providing us with free licenses to their great tools - - [ReSharper](http://www.jetbrains.com/resharper/) - - [TeamCity](http://www.jetbrains.com/teamcity/) diff --git a/archive/jailman/blueprints/sonarr/update.sh b/archive/jailman/blueprints/sonarr/update.sh deleted file mode 100755 index ef7114225a5..00000000000 --- a/archive/jailman/blueprints/sonarr/update.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for sonarr - -iocage exec "$1" service sonarr stop -#TODO insert code to update sonarr itself here -iocage exec "$1" chown -R sonarr:sonarr /usr/local/share/NzbDrone /config -# shellcheck disable=SC2154 -cp "${SCRIPT_DIR}"/blueprints/sonarr/includes/sonarr.rc /mnt/"${global_dataset_iocage}"/jails/"$1"/root/usr/local/etc/rc.d/sonarr -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/sonarr -iocage exec "$1" service sonarr restart diff --git a/archive/jailman/blueprints/tautulli/config.yml b/archive/jailman/blueprints/tautulli/config.yml deleted file mode 100644 index ed994127e78..00000000000 --- a/archive/jailman/blueprints/tautulli/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - tautulli: - pkgs: python37 py37-setuptools py37-sqlite3 py37-openssl py37-pycryptodomex python3 git diff --git a/archive/jailman/blueprints/tautulli/install.sh b/archive/jailman/blueprints/tautulli/install.sh deleted file mode 100755 index 82c5aa4ce67..00000000000 --- a/archive/jailman/blueprints/tautulli/install.sh +++ /dev/null @@ -1,12 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for Tautulli - -iocage exec "$1" ln -s /usr/local/bin/python3 /usr/local/bin/python -iocage exec "$1" git clone https://github.com/Tautulli/Tautulli.git /usr/local/share/Tautulli -iocage exec "$1" "pw user add tautulli -c tautulli -u 109 -d /nonexistent -s /usr/bin/nologin" -iocage exec "$1" chown -R tautulli:tautulli /usr/local/share/Tautulli /config -iocage exec "$1" cp /usr/local/share/Tautulli/init-scripts/init.freenas /usr/local/etc/rc.d/tautulli -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/tautulli -iocage exec "$1" sysrc "tautulli_enable=YES" -iocage exec "$1" sysrc "tautulli_flags=--datadir /config" -iocage exec "$1" service tautulli start diff --git a/archive/jailman/blueprints/tautulli/readme.md b/archive/jailman/blueprints/tautulli/readme.md deleted file mode 100644 index a59f1f45610..00000000000 --- a/archive/jailman/blueprints/tautulli/readme.md +++ /dev/null @@ -1,69 +0,0 @@ -# Tautulli - -## Original README from the tautulli github: - -https://github.com/Tautulli/Tautulli - -# Tautulli - -A python based web application for monitoring, analytics and notifications for [Plex Media Server](https://plex.tv). - -This project is based on code from [Headphones](https://github.com/rembo10/headphones) and [PlexWatchWeb](https://github.com/ecleese/plexWatchWeb). - -## Features - -- Responsive web design viewable on desktop, tablet and mobile web browsers. -- Themed to complement Plex/Web. -- Easy configuration setup (no separate web server required). -- Monitor current Plex Media Server activity. -- Fully customizable notifications for stream activity and recently added media. -- Top statistics on home page with configurable duration and measurement metric. -- Global watching history with search/filtering & dynamic column sorting. -- Full user list with general information and comparison stats. -- Individual user information including devices IP addresses. -- Complete library statistics and media file information. -- Rich analytics presented using Highcharts graphing. -- Beautiful content information pages. -- Full sync list data on all users syncing items from your library. -- And many more!! - -## Preview - -- [Full preview gallery available on our website](https://tautulli.com) - -![Tautulli Homepage](https://tautulli.com/images/screenshots/activity-compressed.jpg?v=2) - -## Installation & Support - -[![Python](https://img.shields.io/badge/python-v2.7.17-blue?style=flat-square)](https://python.org/downloads/release/python-2717/) -[![Docker Pulls](https://img.shields.io/docker/pulls/tautulli/tautulli?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli) -[![Docker Stars](https://img.shields.io/docker/stars/tautulli/tautulli?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli) - -| Status | Branch: `master` | Branch: `beta` | Branch: `nightly` | -| ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Release | [![Release@master](https://img.shields.io/github/v/release/Tautulli/Tautulli?style=flat-square)](https://github.com/Tautulli/Tautulli/releases/latest)
[![Release Date@master](https://img.shields.io/github/release-date/Tautulli/Tautulli?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/releases/latest) | [![Release@beta](https://img.shields.io/github/v/release/Tautulli/Tautulli?include_prereleases&style=flat-square)](https://github.com/Tautulli/Tautulli/releases)
[![Commits@nightly](https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/beta?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/commits/beta) | [![Last Commits@nightly](https://img.shields.io/github/last-commit/Tautulli/Tautulli/nightly?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/commits/nightly)
[![Commits@nightly](https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/nightly?style=flat-square&color=blue)](https://github.com/Tautulli/Tautulli/commits/nightly) | -| Docker | [![Docker@master](https://img.shields.io/badge/tautulli-tautulli:latest-blue?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli)
[![Docker Build@master](https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker%20Branch/master?style=flat-square)](https://github.com/Tautulli/Tautulli/actions?query=branch%3Amaster) | [![Docker@beta](https://img.shields.io/badge/tautulli-tautulli:beta-blue?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli)
[![Docker Build@beta](https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker%20Branch/beta?style=flat-square)](https://github.com/Tautulli/Tautulli/actions?query=branch%3Abeta) | [![Docker@nightly](https://img.shields.io/badge/tautulli-tautulli:nightly-blue?style=flat-square)](https://hub.docker.com/r/tautulli/tautulli)
[![Docker Build@nightly](https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker%20Branch/nightly?style=flat-square)](https://github.com/Tautulli/Tautulli/actions?query=branch%3Anightly) | - -[![Wiki](https://img.shields.io/badge/github-wiki-black?style=flat-square)](https://github.com/Tautulli/Tautulli-Wiki/wiki) -[![Discord](https://img.shields.io/discord/183396325142822912?label=discord&style=flat-square&color=7289DA)](https://tautulli.com/discord) -[![Reddit](https://img.shields.io/reddit/subreddit-subscribers/tautulli?label=reddit&style=flat-square&color=FF5700)](https://www.reddit.com/r/Tautulli/) -[![Plex Forums](https://img.shields.io/badge/plex%20forums-discussion-E5A00D?style=flat-square)](https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242) - -- Read the [Installation Guides](https://github.com/Tautulli/Tautulli-Wiki/wiki/Installation) for instructions to install Tautulli. -- The [Frequently Asked Questions](https://github.com/Tautulli/Tautulli-Wiki/wiki/Frequently-Asked-Questions) in the wiki can help you with common problems. -- Support is available on [Discord](https://tautulli.com/discord), [Reddit](https://www.reddit.com/r/Tautulli), or the [Plex Forums](https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242). - -## Issues & Feature Requests - -[![Issues](https://img.shields.io/badge/github-issues-red?style=flat-square)](https://github.com/Tautulli/Tautulli-Issues) -[![Feathub](https://img.shields.io/badge/feathub-requests-lightgrey?style=flat-square)](https://feathub.com/Tautulli/Tautulli) - -- Please see the [Issues Repository](https://github.com/Tautulli/Tautulli-Issues). - -## License - -[![License](https://img.shields.io/github/license/Tautulli/Tautulli?style=flat-square)](https://github.com/Tautulli/Tautulli/blob/master/LICENSE) - -This is free software under the GPL v3 open source license. Feel free to do with it what you wish, but any modification must be open sourced. A copy of the license is included. - -This software includes Highsoft software libraries which you may freely distribute for non-commercial use. Commerical users must licence this software, for more information visit https://shop.highsoft.com/faq/non-commercial#non-commercial-redistribution. diff --git a/archive/jailman/blueprints/tautulli/update.sh b/archive/jailman/blueprints/tautulli/update.sh deleted file mode 100755 index 43b7326b2a1..00000000000 --- a/archive/jailman/blueprints/tautulli/update.sh +++ /dev/null @@ -1,10 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for Tautulli - -iocage exec "$1" service tautulli stop -iocage exec "$1" ln -s /usr/local/bin/python3 /usr/local/bin/python -# Tautulli is updated through pkg, this is mostly just a placeholder -iocage exec "$1" chown -R tautulli:tautulli /usr/local/share/Tautulli /config -iocage exec "$1" cp /usr/local/share/Tautulli/init-scripts/init.freenas /usr/local/etc/rc.d/tautulli -iocage exec "$1" chmod u+x /usr/local/etc/rc.d/tautulli -iocage exec "$1" service tautulli restart diff --git a/archive/jailman/blueprints/transmission/config.yml b/archive/jailman/blueprints/transmission/config.yml deleted file mode 100644 index 8074709b5d6..00000000000 --- a/archive/jailman/blueprints/transmission/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - transmission: - pkgs: bash unzip unrar transmission diff --git a/archive/jailman/blueprints/transmission/install.sh b/archive/jailman/blueprints/transmission/install.sh deleted file mode 100755 index a22a570f9ad..00000000000 --- a/archive/jailman/blueprints/transmission/install.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for transmission - -# Check if dataset Downloads dataset exist, create if they do not. -# shellcheck disable=SC2154 -createmount "$1" "${global_dataset_downloads}" /mnt/downloads - -# Check if dataset Complete Downloads dataset exist, create if they do not. -createmount "$1" "${global_dataset_downloads}"/complete /mnt/downloads/complete - -# Check if dataset InComplete Downloads dataset exist, create if they do not. -createmount "$1" "${global_dataset_downloads}"/incomplete /mnt/downloads/incomplete - - -iocage exec "$1" chown -R transmission:transmission /config -iocage exec "$1" sysrc "transmission_enable=YES" -iocage exec "$1" sysrc "transmission_conf_dir=/config" -iocage exec "$1" sysrc "transmission_download_dir=/mnt/downloads/complete" -iocage exec "$1" service transmission restart diff --git a/archive/jailman/blueprints/transmission/readme.md b/archive/jailman/blueprints/transmission/readme.md deleted file mode 100644 index d9beec18096..00000000000 --- a/archive/jailman/blueprints/transmission/readme.md +++ /dev/null @@ -1,84 +0,0 @@ -# Transmission - -## Original README from the transmission github: - -https://github.com/transmission/transmission - -# Transmission - -## About - -Transmission is a fast, easy, and free BitTorrent client. It comes in several flavors: - -- A native Mac OS X GUI application -- GTK+ and Qt GUI applications for Linux, BSD, etc. -- A headless daemon for servers and routers -- A web UI for remote controlling any of the above - -Visit https://transmissionbt.com/ for more information. - -## Command line interface notes - -Transmission is fully supported in transmission-remote, the preferred cli client. - -Three standalone tools to examine, create, and edit .torrent files exist: transmission-show, transmission-create, and transmission-edit, respectively. - -Prior to development of transmission-remote, the standalone client transmission-cli was created. Limited to a single torrent at a time, transmission-cli is deprecated and exists primarily to support older hardware dependent upon it. In almost all instances, transmission-remote should be used instead. - -Different distributions may choose to package any or all of these tools in one or more separate packages. - -## Building - -Transmission has an Xcode project file (Transmission.xcodeproj) for building in Xcode. - -For a more detailed description, and dependencies, visit: https://github.com/transmission/transmission/wiki - -### Building a Transmission release from the command line - - $ tar xf transmission-2.92.tar.xz - $ cd transmission-2.92 - $ mkdir build - $ cd build - $ cmake .. - $ make - $ sudo make install - -### Building Transmission from the nightly builds - -Download a tarball from https://build.transmissionbt.com/job/trunk-linux/ and follow the steps from the previous section. - -If you're new to building programs from source code, this is typically easier than building from Git. - -### Building Transmission from Git (first time) - - $ git clone https://github.com/transmission/transmission Transmission - $ cd Transmission - $ git submodule update --init - $ mkdir build - $ cd build - $ cmake .. - $ make - $ sudo make install - -### Building Transmission from Git (updating) - - $ cd Transmission/build - $ make clean - $ git pull --rebase --prune - $ git submodule update - $ cmake .. - $ make - $ sudo make install - -## Contributing - -### Code Style - -You would want to setup your editor to make use of uncrustify.cfg and .jsbeautifyrc configuration files located in the root of this repository. - -If for some reason you are unwilling or unable to do so, there is a shell script which you could run either directly or via docker-compose: - - $ ./code_style.sh - or - $ docker-compose build --pull - $ docker-compose run --rm code_style diff --git a/archive/jailman/blueprints/transmission/update.sh b/archive/jailman/blueprints/transmission/update.sh deleted file mode 100755 index d58d7997cb1..00000000000 --- a/archive/jailman/blueprints/transmission/update.sh +++ /dev/null @@ -1,8 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for transmission - -iocage exec "$1" service transmission stop - -# Transmision is updated during PKG update, this file is mostly just a placeholder -iocage exec "$1" chown -R transmission:transmission /config -iocage exec "$1" service transmission restart diff --git a/archive/jailman/blueprints/unifi/config.yml b/archive/jailman/blueprints/unifi/config.yml deleted file mode 100644 index c5e3307d407..00000000000 --- a/archive/jailman/blueprints/unifi/config.yml +++ /dev/null @@ -1,3 +0,0 @@ -blueprint: - unifi: - pkgs: jq unifi5 diff --git a/archive/jailman/blueprints/unifi/includes/mongodb.conf b/archive/jailman/blueprints/unifi/includes/mongodb.conf deleted file mode 100644 index e3cfca8903e..00000000000 --- a/archive/jailman/blueprints/unifi/includes/mongodb.conf +++ /dev/null @@ -1,45 +0,0 @@ -# mongod.conf - -# for documentation of all options, see: -# http://docs.mongodb.org/manual/reference/configuration-options/ - -# where to write logging data. -systemLog: - destination: file - logAppend: true - path: /var/db/mongodb/mongod.log - -# Where and how to store data. -storage: - dbPath: /config/mongodb - journal: - enabled: true -# engine: -# mmapv1: -# wiredTiger: - -# how the process runs -processManagement: - fork: true # fork and run in background - pidFilePath: /var/db/mongodb/mongod.lock # location of pidfile - timeZoneInfo: /usr/share/zoneinfo - -# network interfaces -net: - port: 27017 - bindIp: 127.0.0.1 # Listen to local interface only, comment to listen on all interfaces. - - -#security: - -#operationProfiling: - -#replication: - -#sharding: - -## Enterprise-Only Options - -#auditLog: - -#snmp: diff --git a/archive/jailman/blueprints/unifi/includes/rc/mongod.rc b/archive/jailman/blueprints/unifi/includes/rc/mongod.rc deleted file mode 100644 index 25634a91b57..00000000000 --- a/archive/jailman/blueprints/unifi/includes/rc/mongod.rc +++ /dev/null @@ -1,64 +0,0 @@ -#!/bin/sh -# shellcheck disable=SC1091,SC2034,SC2223,SC2154,SC1090,SC2046,SC2086,SC2155,SC2181,SC2006 - -# PROVIDE: mongod -# REQUIRE: NETWORK ldconfig -# KEYWORD: shutdown -# -# Add the following lines to /etc/rc.conf.local or /etc/rc.conf -# to enable this service: -# -# mongod_enable (bool): Set to "NO" by default. -# Set it to "YES" to enable mongod. -# mongod_limits (bool): Set to "NO" by default. -# Set it to yes to run `limits -e -U mongodb` -# just before mongod starts. -# mongod_dbpath (str): Default to "/var/db/mongodb" -# Base database directory. -# mongod_flags (str): Custom additional arguments to be passed to mongod. -# Default to "--logpath ${mongod_dbpath}/mongod.log --logappend". -# mongod_config (str): Default to "/usr/local/etc/mongodb.conf" -# Path to config file -# - -. /etc/rc.subr - -name="mongod" -rcvar=mongod_enable - -load_rc_config $name - -: ${mongod_enable="NO"} -: ${mongod_limits="NO"} -: ${mongod_dbpath="/config/mongodb"} -: ${mongod_flags="--logpath ${mongod_dbpath}/mongod.log --logappend --setParameter=disabledSecureAllocatorDomains=\*"} -: ${mongod_user="mongodb"} -: ${mongod_group="mongodb"} -: ${mongod_config="/usr/local/etc/mongodb.conf"} - -pidfile="${mongod_dbpath}/mongod.lock" -command=/usr/local/bin/${name} -command_args="--config $mongod_config --dbpath $mongod_dbpath --fork >/dev/null 2>/dev/null" -start_precmd="${name}_prestart" - -mongod_create_dbpath() -{ - mkdir "${mongod_dbpath}" >/dev/null 2>/dev/null - [ $? -eq 0 ] && chown -R "${mongod_user}":"${mongod_group}" "${mongod_dbpath}" -} - -mongod_prestart() -{ - if [ ! -d "${mongod_dbpath}" ]; then - mongod_create_dbpath || return 1 - fi - if checkyesno mongod_limits; then - # TODO check this and clean this up - # Shellcheck disable=SC2046,SC2006 - eval `/usr/bin/limits -e -U ${mongod_user}` 2>/dev/null - else - return 0 - fi -} - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/unifi/includes/rc/unifi.rc b/archive/jailman/blueprints/unifi/includes/rc/unifi.rc deleted file mode 100644 index 82d5d12565d..00000000000 --- a/archive/jailman/blueprints/unifi/includes/rc/unifi.rc +++ /dev/null @@ -1,87 +0,0 @@ -#!/bin/sh -# shellcheck disable=SC1091,SC2034,SC2223,SC2154,SC1090,SC2046,SC2086,SC2155,SC2237 -# -# Created by: Mark Felder -# $FreeBSD: branches/2020Q2/net-mgmt/unifi5/files/unifi.in 512281 2019-09-18 17:37:59Z feld $ -# - -# PROVIDE: unifi -# REQUIRE: LOGIN -# KEYWORD: shutdown - -# -# Add the following line to /etc/rc.conf to enable `unifi': -# -# unifi_enable="YES" -# -# Other configuration settings for unifi that can be set in /etc/rc.conf: -# -# unifi_user (str) -# This is the user that unifi runs as -# Set to unifi by default -# -# unifi_group (str) -# This is the group that unifi runs as -# Set to unifi by default -# -# unifi_chdir (str) -# This is the directory that unifi chdirs into before starting -# Set to /usr/local/share/java/unifi by default -# -# unifi_java_home (str) -# The path to the base directory for the Java to use to run unifi -# Defaults to /usr/local/openjdk8 -# -# unifi_javaflags (str) -# Flags passed to Java to run unifi -# Set to "-Djava.awt.headless=true -Xmx1024M" by default -# - -. /etc/rc.subr -name=unifi - -rcvar=unifi_enable -load_rc_config ${name} - -: ${unifi_enable:=NO} -: ${unifi_user:=unifi} -: ${unifi_group:=unifi} -: ${unifi_chdir=/config/controller/unifi} -: ${unifi_java_home=/usr/local/openjdk8} -: ${unifi_javaflags="-Djava.awt.headless=true -Xmx1024M"} - -pidfile="/var/run/unifi/${name}.pid" -procname=${unifi_java_home}/bin/java -command=/usr/sbin/daemon -command_args="-f -p ${pidfile} ${unifi_java_home}/bin/java ${unifi_javaflags} com.ubnt.ace.Launcher start" -start_precmd=start_precmd -stop_precmd=stop_precmd -stop_postcmd=stop_postcmd - -export CLASSPATH=$(echo ${unifi_chdir}/lib/*.jar | tr ' ' ':') - -start_precmd() -{ - if [ ! -e /var/run/unifi ] ; then - install -d -o unifi -g unifi /var/run/unifi; - fi -} - -stop_precmd() -{ - if [ -r ${pidfile} ]; then - _UNIFIPID=$(check_pidfile ${pidfile} ${procname}) - export _UNIFI_CHILDREN=$(pgrep -P ${_UNIFIPID}) - fi -} - -stop_postcmd() -{ - if ! [ -z ${_UNIFI_CHILDREN} ]; then - echo "Cleaning up leftover child processes." - kill $sig_stop ${_UNIFI_CHILDREN} - wait_for_pids ${_UNIFI_CHILDREN} - fi -} - -run_rc_command "$1" diff --git a/archive/jailman/blueprints/unifi/includes/rc/unifi_poller.rc b/archive/jailman/blueprints/unifi/includes/rc/unifi_poller.rc deleted file mode 100644 index ff1ee599dd6..00000000000 --- a/archive/jailman/blueprints/unifi/includes/rc/unifi_poller.rc +++ /dev/null @@ -1,36 +0,0 @@ -#!/bin/sh -# shellcheck disable=SC1091,SC2034,SC2223,SC2154,SC1090,SC2046 -# -# FreeBSD rc.d startup script for unifi-poller. -# -# PROVIDE: unifi-poller -# REQUIRE: networking syslog -# KEYWORD: - -. /etc/rc.subr - -name="unifi_poller" -real_name="unifi-poller" -rcvar="unifi_poller_enable" -unifi_poller_command="/usr/local/bin/${real_name}" -unifi_poller_user="nobody" -unifi_poller_config="/config/up.conf" -pidfile="/var/run/${real_name}/pid" - -# This runs `daemon` as the `unifi_poller_user` user. -command="/usr/sbin/daemon" -command_args="-P ${pidfile} -r -t ${real_name} -T ${real_name} -l daemon ${unifi_poller_command} -c ${unifi_poller_config}" - -load_rc_config ${name} -: ${unifi_poller_enable:=no} - -# Make a place for the pid file. -mkdir -p $(dirname ${pidfile}) -chown -R $unifi_poller_user $(dirname ${pidfile}) - -# Suck in optional exported override variables. -# ie. add something like the following to this file: export UP_POLLER_DEBUG=true -[ -f "/usr/local/etc/defaults/${real_name}" ] && . "/usr/local/etc/defaults/${real_name}" - -# Go! -run_rc_command "$1" diff --git a/archive/jailman/blueprints/unifi/includes/up.conf b/archive/jailman/blueprints/unifi/includes/up.conf deleted file mode 100644 index 9ecb7f0b932..00000000000 --- a/archive/jailman/blueprints/unifi/includes/up.conf +++ /dev/null @@ -1,106 +0,0 @@ -# UniFi Poller v2 primary configuration file. TOML FORMAT # -########################################################### - -[poller] - # Turns on line numbers, microsecond logging, and a per-device log. - # The default is false, but I personally leave this on at home (four devices). - # This may be noisy if you have a lot of devices. It adds one line per device. - debug = false - - # Turns off per-interval logs. Only startup and error logs will be emitted. - # Recommend enabling debug with this setting for better error logging. - quiet = true - - # Load dynamic plugins. Advanced use; only sample mysql plugin provided by default. - plugins = [] - -#### OUTPUTS - - # If you don't use an output, you can disable it. - -[prometheus] - disable = true - # This controls on which ip and port /metrics is exported when mode is "prometheus". - # This has no effect in other modes. Must contain a colon and port. - http_listen = "0.0.0.0:9130" - report_errors = false - -[influxdb] - disable = false - # InfluxDB does not require auth by default, so the user/password are probably unimportant. - url = "dbip" - user = "influxdbuser" - pass = "influxdbpass" - # Be sure to create this database. - db = "unifidb" - # If your InfluxDB uses a valid SSL cert, set this to true. - verify_ssl = false - # The UniFi Controller only updates traffic stats about every 30 seconds. - # Setting this to something lower may lead to "zeros" in your data. - # If you're getting zeros now, set this to "1m" - interval = "30s" - -#### INPUTS - -[unifi] - # Setting this to true and providing default credentials allows you to skip - # configuring controllers in this config file. Instead you configure them in - # your prometheus.yml config. Prometheus then sends the controller URL to - # unifi-poller when it performs the scrape. This is useful if you have many, - # or changing controllers. Most people can leave this off. See wiki for more. - dynamic = false - -# The following section contains the default credentials/configuration for any -# dynamic controller (see above section), or the primary controller if you do not -# provide one and dynamic is disabled. In other words, you can just add your -# controller here and delete the following section. -[unifi.defaults] - #role = "main controller" - url = "https://127.0.0.1:8443" - user = "unifiuser" - pass = "unifipassword" - sites = ["all"] - save_ids = false - save_dpi = false - save_sites = true - verify_ssl = false - -# The following is optional and used for configurations with multiple controllers. - -# You may repeat the following section to poll multiple controllers. -#[[unifi.controller]] - # Friendly name used in dashboards. Uses URL if left empty; which is fine. - # Avoid changing this later because it will live forever in your database. - # Multiple controllers may share a role. This allows grouping during scrapes. - #role = "" - #url = "https://127.0.0.1:8443" - - # Make a read-only user in the UniFi Admin Settings, allow it access to all sites. - #user = "unifipoller" - #pass = "4BB9345C-2341-48D7-99F5-E01B583FF77F" - - # If the controller has more than one site, specify which sites to poll here. - # Set this to ["default"] to poll only the first site on the controller. - # A setting of ["all"] will poll all sites; this works if you only have 1 site too. - #sites = ["all"] - - # Enable collection of Intrusion Detection System Data (InfluxDB only). - # Only useful if IDS or IPS are enabled on one of the sites. - #save_ids = false - - # Enable collection of Deep Packet Inspection data. This data breaks down traffic - # types for each client and site, it powers a dedicated DPI dashboard. - # Enabling this adds roughly 150 data points per client. That's 6000 metrics for - # 40 clients. This adds a little bit of poller run time per interval and causes - # more API requests to your controller(s). Don't let these "cons" sway you: - # it's cool data. Please provide feedback on your experience with this feature. - #save_dpi = false - - # Enable collection of site data. This data powers the Network Sites dashboard. - # It's not valuable to everyone and setting this to false will save resources. - #save_sites = true - - # If your UniFi controller has a valid SSL certificate (like lets encrypt), - # you can enable this option to validate it. Otherwise, any SSL certificate is - # valid. If you don't know if you have a valid SSL cert, then you don't have one. - #verify_ssl = false diff --git a/archive/jailman/blueprints/unifi/install.sh b/archive/jailman/blueprints/unifi/install.sh deleted file mode 100755 index 1757df5c603..00000000000 --- a/archive/jailman/blueprints/unifi/install.sh +++ /dev/null @@ -1,119 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the install script for unifi-controller & unifi-poller - -# Initialize variables -# shellcheck disable=SC2154 -JAIL_IP="jail_${1}_ip4_addr" -JAIL_IP="${!JAIL_IP%/*}" - -# shellcheck disable=SC2154 -DB_JAIL="jail_${1}_db_jail" - -POLLER="jail_${1}_unifi_poller" - -# shellcheck disable=SC2154 -DB_IP="jail_${!DB_JAIL}_ip4_addr" -DB_IP="${!DB_IP%/*}" - -# shellcheck disable=SC2154 -DB_NAME="jail_${1}_up_db_name" -DB_NAME="${!DB_NAME:-$1}" - -# shellcheck disable=SC2154 -DB_USER="jail_${1}_up_db_user" -DB_USER="${!DB_USER:-$DB_NAME}" - -# shellcheck disable=SC2154 -DB_PASS="jail_${1}_up_db_password" - -# shellcheck disable=SC2154 -UP_USER="jail_${1}_up_user" -UP_USER="${!UP_USER:-$1}" - -# shellcheck disable=SC2154 -UP_PASS="jail_${1}_up_password" -INCLUDES_PATH="${SCRIPT_DIR}/blueprints/unifi/includes" - -if [ -z "${!DB_PASS}" ]; then - echo "up_db_password can't be empty" - exit 1 -fi - -if [ -z "${!DB_JAIL}" ]; then - echo "db_jail can't be empty" - exit 1 -fi - -if [ -z "${!UP_PASS}" ]; then - echo "up_password can't be empty" - exit 1 -fi - -# Enable persistent Unifi Controller data -iocage exec "${1}" mkdir -p /config/controller/mongodb -iocage exec "${1}" cp -Rp /usr/local/share/java/unifi /config/controller -iocage exec "${1}" chown -R mongodb:mongodb /config/controller/mongodb -# shellcheck disable=SC2154 -cp "${INCLUDES_PATH}"/mongodb.conf /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc -# shellcheck disable=SC2154 -cp "${INCLUDES_PATH}"/rc/mongod.rc /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.d/mongod -# shellcheck disable=SC2154 -cp "${INCLUDES_PATH}"/rc/unifi.rc /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.d/unifi -iocage exec "${1}" sysrc unifi_enable=YES -iocage exec "${1}" service unifi start - -# shellcheck disable=SC2154 -if [ "${!POLLER}" == true ]; then - # Check if influxdb container exists, create unifi database if it does, error if it is not. - echo "Checking if the database jail and database exist..." - if [[ -d /mnt/"${global_dataset_iocage}"/jails/"${!DB_JAIL}" ]]; then - DB_EXISTING=$(iocage exec "${!DB_JAIL}" curl -G http://"${DB_IP}":8086/query --data-urlencode 'q=SHOW DATABASES' | jq '.results [] | .series [] | .values []' | grep "$DB_NAME" | sed 's/"//g' | sed 's/^ *//g') - if [[ "$DB_NAME" == "$DB_EXISTING" ]]; then - echo "${!DB_JAIL} jail with database ${DB_NAME} already exists. Skipping database creation... " - else - echo "${!DB_JAIL} jail exists, but database ${DB_NAME} does not. Creating database ${DB_NAME}." - if [[ -z "${DB_USER}" ]] || [[ -z "${!DB_PASS}" ]]; then - echo "Database username and password not provided. Cannot create database without credentials. Exiting..." - exit 1 - else - # shellcheck disable=SC2027,2086 - iocage exec "${!DB_JAIL}" "curl -XPOST -u ${DB_USER}:${!DB_PASS} http://"${DB_IP}":8086/query --data-urlencode 'q=CREATE DATABASE ${DB_NAME}'" - echo "Database ${DB_NAME} created with username ${DB_USER} with password ${!DB_PASS}." - fi - fi - else - echo "Influxdb jail does not exist. Unifi-Poller requires Influxdb jail. Please install the Influxdb jail." - exit 1 - fi - - # Download and install Unifi-Poller - FILE_NAME=$(curl -s https://api.github.com/repos/unifi-poller/unifi-poller/releases/latest | jq -r ".assets[] | select(.name | contains(\"amd64.txz\")) | .name") - DOWNLOAD=$(curl -s https://api.github.com/repos/unifi-poller/unifi-poller/releases/latest | jq -r ".assets[] | select(.name | contains(\"amd64.txz\")) | .browser_download_url") - iocage exec "${1}" fetch -o /config "${DOWNLOAD}" - - # Install downloaded Unifi-Poller package, configure and enable - iocage exec "${1}" pkg install -qy /config/"${FILE_NAME}" - # shellcheck disable=SC2154 - cp "${INCLUDES_PATH}"/up.conf /mnt/"${global_dataset_config}"/"${1}" - # shellcheck disable=SC2154 - cp "${INCLUDES_PATH}"/rc/unifi_poller.rc /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.d/unifi_poller - chmod +x /mnt/"${global_dataset_iocage}"/jails/"${1}"/root/usr/local/etc/rc.d/unifi_poller - iocage exec "${1}" sed -i '' "s|influxdbuser|${DB_USER}|" /config/up.conf - iocage exec "${1}" sed -i '' "s|influxdbpass|${!DB_PASS}|" /config/up.conf - iocage exec "${1}" sed -i '' "s|unifidb|${DB_NAME}|" /config/up.conf - iocage exec "${1}" sed -i '' "s|unifiuser|${UP_USER}|" /config/up.conf - iocage exec "${1}" sed -i '' "s|unifipassword|${!UP_PASS}|" /config/up.conf - iocage exec "${1}" sed -i '' "s|dbip|http://${DB_IP}:8086|" /config/up.conf - - - iocage exec "${1}" sysrc unifi_poller_enable=YES - iocage exec "${1}" service unifi_poller start - - echo "Installation complete!" - echo "Unifi Controller is accessible at https://${JAIL_IP}:8443." - echo "Please login to the Unifi Controller and add ${UP_USER} as a read-only user." - echo "In Grafana, add Unifi-Poller as a data source." -else - echo "Installation complete!" - echo "Unifi Controller is accessible at https://${JAIL_IP}:8443." -fi diff --git a/archive/jailman/blueprints/unifi/readme.md b/archive/jailman/blueprints/unifi/readme.md deleted file mode 100644 index d767dc1d4e7..00000000000 --- a/archive/jailman/blueprints/unifi/readme.md +++ /dev/null @@ -1,151 +0,0 @@ -# Unifi Controller - -### Installation: - -- This jail requires an existing InfluxDB jail. InfluxDB may be created using the same install command, as long as influxdb is listed first. -- Once the script runs, a user must be created in the Unifi Controller software for your Unifi-Poller user. -- To view the data from Unifi-Poller, Grafana is required. Add the unifi InfluxDB database as a data source in Grafana. - -### Config Description - -- unifi_poller: boolean, true if you want to also install unifi-poller -- db_jail: This is the name of your influxdb database jail, should be influxdb. -- unifi_db_name: The name of the database that will be created in influxdb for Unifi Poller. -- unifi_db_user & unifi_db_password: The created database's credentials for Unifi Poller. -- up_user & up_password: The Unifi-Poller user credentials. This user must be created in the Unifi Controller web gui after install matching these credentials. This is for the connection between Unifi Controller & Unifi Poller - -### Unifi-Controller Post-Install - -After the script runs and the unifi jail is running, open the web gui of the unifi jail at port 8443 (i.e. https://192.168.2.250:8443). After completing the initial setup wizard, go to Admins --> Add New Admin. Select "Manually set and share the password", enter the username and password used for up_user & up_password. Uncheck 'Require the user to change their password'. Verify "Role" is set to 'Read Only'. Click Create. - -## Unifi Controller documentation can be found at https://www.ui.com/download/unifi/default/default/unifi-controller-v5-user-guide - -## Original README from the upstream Unifi-Poller Github. - -https://github.com/unifi-poller/unifi-poller - - - -[![discord](https://badgen.net/badge/icon/Discord?color=0011ff&label&icon=https://simpleicons.now.sh/discord/eee "Ubiquiti Discord")](https://discord.gg/KnyKYt2) -[![twitter](https://badgen.net/twitter/follow/TwitchCaptain?icon=https://simpleicons.now.sh/twitter/0099ff&label=TwitchCaptain&color=0116ff "TwitchCaptain @ Twitter")](https://twitter.com/TwitchCaptain) -[![grafana](https://badgen.net/https/golift.io/bd/grafana/dashboard-downloads/11310,10419,10414,10415,10416,10417,10418,11311,11312,11313,11314,11315?icon=https://simpleicons.now.sh/grafana/ED7F38&color=0011ff "Grafana Dashboard Downloads")](http://grafana.com/dashboards?search=unifi-poller) -[![pulls](https://badgen.net/docker/pulls/golift/unifi-poller?icon=https://simpleicons.now.sh/docker/38B1ED&label=pulls&color=0011ff "Docker Pulls")](https://hub.docker.com/r/golift/unifi-poller) -[![DLs](https://img.shields.io/github/downloads/unifi-poller/unifi-poller/total.svg?logo=github&color=0116ff "GitHub Downloads")](https://www.somsubhra.com/github-release-stats/?username=unifi-poller&repository=unifi-poller) - -[![unifi](https://badgen.net/badge/UniFi/5.12.x,5.13.x,UAP,USG,USW,UDM?list=|&icon=https://docs.golift.io/svg/ubiquiti_color.svg&color=0099ee "UniFi Products Supported")](https://github.com/golift/unifi) -[![builer](https://badgen.net/badge/go/Application%20Builder?label=&icon=https://docs.golift.io/svg/go.svg&color=0099ee "Go Application Builder")](https://github.com/golift/application-builder) -[![stars](https://badgen.net/github/stars/unifi-poller/unifi-poller?icon=https://simpleicons.now.sh/macys/fab&label=&color=0099ee "GitHub Stars")](https://github.com/unifi-poller/unifi-poller) -[![travis](https://badgen.net/travis/unifi-poller/unifi-poller?icon=travis&label=build "Travis Build")](https://travis-ci.org/unifi-poller/unifi-poller) - -Collect your UniFi controller data and report it to an InfluxDB instance, -or export it for Prometheus collection. -[Twelve Grafana Dashboards](http://grafana.com/dashboards?search=unifi-poller) -included; with screenshots. Six for InfluxDB and six for Prometheus. - -## Installation - -[See the Wiki!](https://github.com/unifi-poller/unifi-poller/wiki/Installation) -We have a special place for [Docker Users](https://github.com/unifi-poller/unifi-poller/wiki/Docker). -I'm willing to help if you have troubles. -Open an [Issue](https://github.com/unifi-poller/unifi-poller/issues) and -we'll figure out how to get things working for you. You can also get help in -the #unifi-poller channel on the [Ubiquiti Discord server](https://discord.gg/KnyKYt2). I've also -[provided a forum post](https://community.ui.com/questions/Unifi-Poller-Store-Unifi-Controller-Metrics-in-InfluxDB-without-SNMP/58a0ea34-d2b3-41cd-93bb-d95d3896d1a1) -you may use to get additional help. - -## Description - -[Ubiquiti](https://www.ui.com) makes networking devices like switches, gateways -(routers) and wireless access points. They have a line of equipment named -[UniFi](https://www.ui.com/products/#unifi) that uses a -[controller](https://www.ui.com/download/unifi/) to keep stats and simplify network -device configuration. This controller can be installed on Windows, macOS, FreeBSD, -Linux or Docker. Ubiquiti also provides a dedicated hardware device called a -[CloudKey](https://www.ui.com/unifi/unifi-cloud-key/) that runs the controller software. -More recently they've developed the Dream Machine; it's still in -beta / early access, but UniFi Poller can collect its data! - -UniFi Poller is a small Golang application that runs on Windows, macOS, FreeBSD, -Linux or Docker. In Influx-mode it polls a UniFi controller every 30 seconds for -measurements and exports the data to an Influx database. In Prometheus mode the -poller opens a web port and accepts Prometheus polling. It converts the UniFi -Controller API data into Prometheus exports on the fly. - -This application requires your controller to be running all the time. If you run -a UniFi controller, there's no excuse not to install -[Influx](https://github.com/unifi-poller/unifi-poller/wiki/InfluxDB) or -[Prometheus](https://prometheus.io), -[Grafana](https://github.com/unifi-poller/unifi-poller/wiki/Grafana) and this app. -You'll have a plethora of data at your fingertips and the ability to craft custom -graphs to slice the data any way you choose. Good luck! - -## Backstory - -I found a simple piece of code on GitHub that sorta did what I needed; -we all know that story. I wanted more data, so I added more data collection. -I probably wouldn't have made it this far if [Garrett](https://github.com/dewski/unifi) -hadn't written the original code I started with. Many props my man. -The original code pulled only the client data. This app now pulls data -for clients, access points, security gateways, dream machines and switches. - -I've been trying to get my UAP data into Grafana. Sure, google search that. -You'll find [this](https://community.ubnt.com/t5/UniFi-Wireless/Grafana-dashboard-for-UniFi-APs-now-available/td-p/1833532). -What if you don't want to deal with SNMP? -Well, here you go. I've replicated 400% of what you see on those SNMP-powered -dashboards with this Go app running on the same mac as my UniFi controller. -All without enabling SNMP nor trying to understand those OIDs. Mad props -to [waterside](https://community.ubnt.com/t5/user/viewprofilepage/user-id/303058) -for making this dashboard; it gave me a fantastic start to making my own dashboards. - -## Operation - -You can control this app with puppet, chef, saltstack, homebrew or a simple bash -script if you needed to. Packages are available for macOS, Linux, FreeBSD and Docker. -It works just fine on [Windows](https://github.com/unifi-poller/unifi-poller/wiki/Windows) too. -Most people prefer Docker, and this app is right at home in that environment. - -## What's it look like? - -There are 12 total dashboards available; the 6 InfluxDB dashboards are very similar -to the 6 Prometheus dashboards. Below you'll find screenshots of the first four dashboards. - -##### Client Dashboard (InfluxDB) - -![UniFi Clients Dashboard Image](https://grafana.com/api/dashboards/10418/images/7540/image) - -##### USG Dashboard (InfluxDB) - -![USG Dashboard Image](https://grafana.com/api/dashboards/10416/images/7543/image) - -##### UAP Dashboard (InfluxDB) - -![UAP Dashboard Image](https://grafana.com/api/dashboards/10415/images/7542/image) - -##### USW / Switch Dashboard (InfluxDB) - -You can drill down into specific sites, switches, and ports. Compare ports in different -sites side-by-side. So easy! This screenshot barely does it justice. -![USW Dashboard Image](https://grafana.com/api/dashboards/10417/images/7544/image) - -## Integrations - -The following fine folks are providing their services, completely free! These service -integrations are used for things like storage, building, compiling, distribution and -documentation support. This project succeeds because of them. Thank you! - -

- - - - - - - -

- -## Copyright & License - - - -- Copyright © 2018-2020 David Newhall II. -- See [LICENSE](LICENSE) for license information. diff --git a/archive/jailman/blueprints/unifi/update.sh b/archive/jailman/blueprints/unifi/update.sh deleted file mode 100755 index 9f712cd7676..00000000000 --- a/archive/jailman/blueprints/unifi/update.sh +++ /dev/null @@ -1,29 +0,0 @@ -#!/usr/local/bin/bash -# This file contains the update script for unifi -# Unifi Controller is updated through pkg, Unifi-Poller is not. This script updates Unifi-Poller - -POLLER="jail_${1}_unifi_poller" - -# shellcheck disable=SC2154 -if [ "${!POLLER}" == true ]; then - FILE_NAME=$(curl -s https://api.github.com/repos/unifi-poller/unifi-poller/releases/latest | jq -r ".assets[] | select(.name | contains(\"amd64.txz\")) | .name") - DOWNLOAD=$(curl -s https://api.github.com/repos/unifi-poller/unifi-poller/releases/latest | jq -r ".assets[] | select(.name | contains(\"amd64.txz\")) | .browser_download_url") - - # Check to see if there is an update. - # shellcheck disable=SC2154 - if [[ -f /mnt/"${global_dataset_config}"/"${1}"/"${FILE_NAME}" ]]; then - echo "Unifi-Poller is up to date." - exit 1 - else - # Download and install the package - iocage exec "${1}" fetch -o /config "${DOWNLOAD}" - iocage exec "${1}" pkg install -qy /config/"${FILE_NAME}" - - iocage exec "${1}" service unifi_poller restart - fi -else - echo "Skipping Unifi Poller for update, not installed" -fi - -iocage exec "${1}" service unifi restart -echo "Update complete!" diff --git a/archive/jailman/config.yml.example b/archive/jailman/config.yml.example deleted file mode 100644 index 42c082a3cfb..00000000000 --- a/archive/jailman/config.yml.example +++ /dev/null @@ -1,105 +0,0 @@ -global: - # Config file syntax version (not same as script version) - version: 1.2 - # Relevant dataset paths, please use the ZFS dataset syntax such as: tank/apps - dataset: - # dataset for internal jail config files - config: tank/apps - # Media library dataset - media: tank/media - # Parent downloads dataset - # (is going to contain: Complete and Incomplete datasets for downloads) - downloads: tank/downloads - jails: - # jail version to install - version: 11.3-RELEASE - # Global pkgs to install in all jails. - # Please use standard space delimited pkg install syntax. - pkgs: curl ca_root_nss bash - -jail: - plex: - blueprint: plex - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - beta: false - - lidarr: - blueprint: lidarr - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - sonarr: - blueprint: sonarr - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - radarr: - blueprint: radarr - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - kms: - blueprint: kms - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - jackett: - blueprint: jackett - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - organizr: - blueprint: organizr - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - tautulli: - blueprint: tautulli - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - transmission: - blueprint: transmission - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - - - nextcloud: - blueprint: nextcloud - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - time_zone: Europe/Amsterdam - host_name: cloud.example.com - db_jail: "mariadb" - admin_password: "PUTYOUROWNADMINPASSWORDHERE" - db_password: "PLEASEALSOPUTYOURPASSWORDHEREADIFFERNTONE" - - mariadb: - blueprint: mariadb - ip4_addr: 192.168.1.98/24 - gateway: 192.168.1.1 - db_root_password: ReplaceThisWithYourOwnRootPAssword - host_name: mariadb.local.example - - bitwarden: - blueprint: bitwarden - ip4_addr: 192.168.1.97/24 - gateway: 192.168.1.1 - db_jail: "mariadb" - db_password: "YourDBPasswordHerePLEASE" - admin_token: "PUTYOURADMINTOKENHEREANDREMOVETHIS" - - influxdb: - blueprint: influxdb - ip4_addr: 192.168.1.250/24 - gateway: 192.168.1.1 - - unifi: - blueprint: unifi - ip4_addr: 192.168.1.251/24 - gateway: 192.168.1.1 - unifi_poller: true - db_jail: influxdb - up_db_password: unifi-poller - up_password: upoller diff --git a/archive/jailman/docs/CODE_OF_CONDUCT.md b/archive/jailman/docs/CODE_OF_CONDUCT.md deleted file mode 100644 index fe93daa5ec9..00000000000 --- a/archive/jailman/docs/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,71 +0,0 @@ -# Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender, level of experience, -education, socio-economic status, nationality, personal appearance, race, -religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community - -Examples of unacceptable behavior by participants include: - -- The use of sexual imagery and unwelcome sexual advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic - address, without explicit permission - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at jailman@schouten-lebbing.nl. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/archive/jailman/docs/CONTRIBUTING.md b/archive/jailman/docs/CONTRIBUTING.md deleted file mode 100644 index 549a4d124d1..00000000000 --- a/archive/jailman/docs/CONTRIBUTING.md +++ /dev/null @@ -1,98 +0,0 @@ -# Contribution and Review Guidelines - -This project welcomes any and all input, but we need to have a few quality guidelines. These guidelines will be examplained here, in this document. - -### GIT Guidelines - ---- - -#### New to GIT - -If you have never used git before, you can look up our general reference on our wiki. - -#### Git and You - -GIT is a fantastic system, but while using it we have a few guidelines to keep it fantastic for everyone. - -- Submit complete PR's. -- Add [DNM] if you do not want your PR merged yet. -- Always try and fill in the whole form, even for small PR's. -- Don't close when a reviewer requests changes (just push the changes or ask for help). -- Explain what you did in your PR. -- Be thorough. -- If you can add screenshots to clarify. -- Always try to add "Fixes #000" (where 000 is the Issue your PR fixes) -- found something you want to fix yourself? Please do make an issue too. - -### Structure Guidelines - ---- - -#### Naming scheme - -File and folder names are important and making mistakes in them may give conflicts an/or annoyance in the future. Remember, your garbage needs to be cleaned by someone sometime in the future! For that reason, we have a few guidelines in regards to naming files and folder. - -- Always start files and folders WITHOUT a Capital. - -#### Inclusion of files and folders - -Although GIT is quite friendly in what it accepts in terms of files and folder changes in a commit, a reviewer's or bugfixer's time is not unlimited. For that reason, we have a few specific guidelines in regards to the inclusion of files and folders in your PR. - -- Only include files you actually changed. -- Try not to include multiple changes in one PR -- Want to change the formatting of multiple files too? Make a separate PR. - -_Always include the following files when creating a new jail_ - -- install.sh -- update.sh -- readme.md -- config.yml - -### Code Guidelines - ---- - -#### Your code, your style, my review - -Here at jailman, we value people having their own style. But your code needs to be reviewable and editable by others too. For that reason, we have a few basic coding guidelines - -- **Always** explain regex in a comment within your code. -- Write simple code and don't try to impress. -- We will run (Basic) automated reformating of code once in a while. -- Document your changes in your code and if need be, on the wiki. -- All PR's should be able to pass our automated shellcheck. -- It's okey to add shellcheck ignores, but only AFTER you checked the warning! - -#### jail requirements - -- Jails should always save user-specific data in a persistant location. Which is the location specified in the config.yml file under "config:", which is automatically mounted to every jail under /config. There should be no user specific data in the jail itself -- Jails should not require the user to edit any config file themselves. All config changes should be automated -- Jails should not use default passwords, the user should always be forced(!) to put credentials in config.yml manually - -### Review Guidelines - ---- - -Even us review gods need some guidelines once in a while. - -- Let people learn from their mistakes -- Review instead of merging without comments -- Abide by these guidelines in your review -- Tests exist for a reason. Don't merge with test-failures - -### Todo vs Feature vs bug: - ---- - -Please take note of the difference between a TODO and Feature - -- Bug: An unexpected behavior of the script or a crash. Including, but not limited to, errors and warnings. -- Todo: When you come across something that needs tweaking/adding during development, is not an unexpected behavior -- Feature: When you, out of personal preference, want something added or changed. - -### That's it! - ---- - -Someone will come along and review the changes. If everything looks good then they will merge it with the main repo. If you need any help don't be afraid to ask in the discord channel: [https://discord.gg/tFcTpBp](https://discord.gg/tFcTpBp) diff --git a/archive/jailman/docs/blueprints/General b/archive/jailman/docs/blueprints/General deleted file mode 100644 index f12d6cb1dcc..00000000000 --- a/archive/jailman/docs/blueprints/General +++ /dev/null @@ -1,5 +0,0 @@ -## General Info - -Blueprints are the blueprint on which your created jails are going to be based. - -More info TBD diff --git a/archive/jailman/docs/config options.md b/archive/jailman/docs/config options.md deleted file mode 100644 index 43398172585..00000000000 --- a/archive/jailman/docs/config options.md +++ /dev/null @@ -1,51 +0,0 @@ -## Config Options - -There are a lot of possibly configuration options in config.yml. -For jail specific config options, please see the wiki documentation for your specific jail. This page only list general and global config options, that are the same for every jail. - -## Global config options - -Global options apply to every jail. Use and change with caution. - -### dataset - -All config options under "dataset" change dataset creation and linking. The indentation and "dataset" flag are not optional. -All Datasets are auto-created if they do not exist already, no need to worry about creating them! - -- config: The dataset that is going to contain the persistant data for every jail. For example: Nextcloud user files for nextcloud or the actual database for mariadb. -- iocage: The dataset containing the iocage config. In FreeNAS often `poolname/iocage` -- media: The dataset that is going to contain all media files for plex, Sonarr, Radarr etc. Such as movies and music. Music, Movie etc. sub-datasets are auto-created. -- downloads: The dataset containging temporary download files. These are moved to media when finished. complete, incomplete etc. sub-datasets are auto-created. - -## jails - -All config options under "jails" change default jail settings that are the same for every created jail. The indentation and "jails" flag are not optional. - -- version: the current to-be-installed version for jails -- pkgs: packages that are installed to all created jails - -## (hidden) Auto created datasets - -Some datasets are auto created and can not be changed from the config file. This is done to ease troubleshooting. - -- `media/music` created as a sub-dataset of media, contains music -- `media/movies` created as a sub-dataset of media, contains movies -- `media/shows` created as a sub-dataset of media, contains tv-shows -- `downloads/complete` created as a sub-dataset of downloads, contains completed downloads -- `downloads/incomplete` created as a sub-dataset of downloads, contains not-yet-completed downloads - -## General config options - -### Networking - -Please be aware that dhcp is not actively supported, many of the jails depend on having a fixed IP-adress in the config file. -Some also depend on other jails having a fixed IP in the config file. Use of DHCP is on your own risk and might not work. - -- ip4_addr: To set a static IP (recommended), enter the desired ip address here. Leave blank (or remove the line) for DHCP. -- gateway: Set the gateway IP for static IP setup. Leave blank (or remove the line) for DHCP. - -### Advanced - -- interfaces: Set the "interfaces" flag for iocage. Example: `vnet0:bridge0` (optional) -- dhcp: Set to "on" to force DHCP (not required for DHCP, see above) -- pkgs: Override the to-be-install packages for this jail (might break now or break updates) diff --git a/archive/jailman/docs/index.md b/archive/jailman/docs/index.md deleted file mode 100644 index 32a08016de6..00000000000 --- a/archive/jailman/docs/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Introduction - -Welcome to Jailam. An open source effort to create an easy management tool for Freenas Jails. - -As this project is in its early stages, this wiki will serve the purpose of providing a foundation and a almost (not) up-to-date scripting reference to the underlying structure of jailman. diff --git a/archive/jailman/docs/migration/v1.1.x to v1.2.x.md b/archive/jailman/docs/migration/v1.1.x to v1.2.x.md deleted file mode 100644 index 7b3dbd717c8..00000000000 --- a/archive/jailman/docs/migration/v1.1.x to v1.2.x.md +++ /dev/null @@ -1,56 +0,0 @@ -## v1.1.x to v1.2.x - -With v1.2 we made it possible to run multiple jails of the same type. -This is done by seperating jails (your individual installs) from blueprints (our designs). - -Due to this change, the config file has been changed and thus you need to adapt your config file. - -### Jails - -All your jails need to be indented by 2 spaces under a main group "jails" like this: - -`jail: - plex: - blueprint: plex - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - beta: false` - -Also note: -Where previously we used `plex: plex`, we can now just use `plex:` - -### Blueprints - -Every jail now requires a blueprint to be defined. for example: -v1.1.x -` - -plex: plex -ip4_addr: 192.168.1.99/24 -gateway: 192.168.1.1 -plexpass: false -` - -In v1.2.x becomes: -`jail: - plex: - blueprint: plex - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - beta: false` - -### Plex - -Due to community feedback in v1.2.x "plexpass" has been renamed to "beta". - -### pkgs - -pkgs are removed from jail config in v1.2.x and are now part of the blueprint. This way we can keep them up-to-date for you. - -### Documentation - -All jails now have wiki documentation pages and all basic jail values have been documented - -### Other changes - -Some other minor changes in config file values have been done, please refer to the example document and compare your config to the example diff --git a/archive/jailman/global.sh b/archive/jailman/global.sh deleted file mode 100755 index 9d4b257ab8a..00000000000 --- a/archive/jailman/global.sh +++ /dev/null @@ -1,146 +0,0 @@ -#!/usr/local/bin/bash -# shellcheck disable=SC1003 - -# yml Parser function -# Based on https://gist.github.com/pkuczynski/8665367 -# -# This function is very picky and complex. Ignore with shellcheck for now. -# shellcheck disable=SC2086,SC2155 -parse_yaml() { - local prefix=${2} - local s='[[:space:]]*' w='[a-zA-Z0-9_]*' fs=$(echo @|tr @ '\034') - sed -ne "s|^\($s\)\($w\)$s:$s\"\(.*\)\"$s\$|\1$fs\2$fs\3|p" \ - -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p" "${1}" | - awk -F$fs '{ - indent = length($1)/2; - vname[indent] = $2; - for (i in vname) {if (i > indent) {delete vname[i]}} - if (length($3) > 0) { - vn=""; for (i=0; i /dev/null 2>&1 - git update-index -q --refresh > /dev/null 2>&1 - CHANGED=$(git diff --name-only "$1") - if [ -n "$CHANGED" ]; - then - echo "script requires update" - git reset --hard > /dev/null 2>&1 - git pull > /dev/null 2>&1 - echo "script updated, please restart the script manually" - exit 1 - else - echo "script up-to-date" - fi -fi -} - -jailcreate() { -echo "Checking config..." -blueprintpkgs="blueprint_${2}_pkgs" -blueprintports="blueprint_${2}_ports" -jailinterfaces="jail_${1}_interfaces" -jailip4="jail_${1}_ip4_addr" -jailgateway="jail_${1}_gateway" -jaildhcp="jail_${1}_dhcp" -setdhcp=${!jaildhcp} - -if [ -z "${!jailinterfaces}" ]; then - jailinterfaces="vnet0:bridge0" -else - jailinterfaces=${!jailinterfaces} -fi - -if [ -z "${setdhcp}" ] && [ -z "${!jailip4}" ] && [ -z "${!jailgateway}" ]; then - echo 'no network settings specified in config.yml, defaulting to dhcp="on"' - setdhcp="on" -fi - -echo "Creating jail for $1" -# shellcheck disable=SC2154 -pkgs="$(sed 's/[^[:space:]]\{1,\}/"&"/g;s/ /,/g' <<<"${global_jails_pkgs} ${!blueprintpkgs}")" -echo '{"pkgs":['"${pkgs}"']}' > /tmp/pkg.json -if [ "${setdhcp}" == "on" ] -then - # shellcheck disable=SC2154 - if ! iocage create -n "${1}" -p /tmp/pkg.json -r "${global_jails_version}" interfaces="${jailinterfaces}" dhcp="on" vnet="on" allow_raw_sockets="1" boot="on" -b - then - echo "Failed to create jail" - exit 1 - fi -else - # shellcheck disable=SC2154 - if ! iocage create -n "${1}" -p /tmp/pkg.json -r "${global_jails_version}" interfaces="${jailinterfaces}" ip4_addr="vnet0|${!jailip4}" defaultrouter="${!jailgateway}" vnet="on" allow_raw_sockets="1" boot="on" -b - then - echo "Failed to create jail" - exit 1 - fi -fi - -rm /tmp/pkg.json -echo "creating jail config directory" -# shellcheck disable=SC2154 -createmount "${1}" "${global_dataset_config}" || exit 1 -createmount "${1}" "${global_dataset_config}"/"${1}" /config || exit 1 - -# Create and Mount portsnap -createmount "${1}" "${global_dataset_config}"/portsnap || exit 1 -createmount "${1}" "${global_dataset_config}"/portsnap/db /var/db/portsnap || exit 1 -createmount "${1}" "${global_dataset_config}"/portsnap/ports /usr/ports || exit 1 -if [ "${!blueprintports}" == "true" ] -then - echo "Mounting and fetching ports" - iocage exec "${1}" "if [ -z /usr/ports ]; then portsnap fetch extract; else portsnap auto; fi" -else - echo "Ports not enabled for blueprint, skipping" -fi - -echo "Jail creation completed for ${1}" - -} - -# $1 = jail name -# $2 = Dataset -# $3 = Target mountpoint -# $4 = fstab prefernces -createmount() { - if [ -z "$2" ] ; then - echo "ERROR: No Dataset specified to create and/or mount" - exit 1 - else - if [ ! -d "/mnt/$2" ]; then - echo "Dataset does not exist... Creating... $2" - zfs create "${2}" || exit 1 - else - echo "Dataset already exists, skipping creation of $2" - fi - - if [ -n "$1" ] && [ -n "$3" ]; then - iocage exec "${1}" mkdir -p "${3}" - if [ -n "${4}" ]; then - iocage fstab -a "${1}" /mnt/"${2}" "${3}" "${4}" || exit 1 - else - iocage fstab -a "${1}" /mnt/"${2}" "${3}" nullfs rw 0 0 || exit 1 - fi - else - echo "No Jail Name or Mount target specified, not mounting dataset" - fi - - fi -} -export -f createmount diff --git a/archive/jailman/jailman.sh b/archive/jailman/jailman.sh deleted file mode 100755 index 63bea3ebb27..00000000000 --- a/archive/jailman/jailman.sh +++ /dev/null @@ -1,230 +0,0 @@ -#!/usr/local/bin/bash - -# Important defines: -# shellcheck disable=SC2046 -SCRIPT_NAME=$(basename $(test -L "${BASH_SOURCE[0]}" && readlink "${BASH_SOURCE[0]}" || echo "${BASH_SOURCE[0]}")); -SCRIPT_DIR=$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd); -export SCRIPT_NAME -export SCRIPT_DIR - -echo "Working directory for jailman.sh is: ${SCRIPT_DIR}" - -#Includes -# shellcheck source=global.sh -source "${SCRIPT_DIR}/global.sh" - -# Check for root privileges -if ! [ "$(id -u)" = 0 ]; then - echo "This script must be run with root privileges" - exit 1 -fi - -# Auto Update -gitupdate $(git for-each-ref --format='%(upstream:short)' "$(git symbolic-ref -q HEAD)") || exit 1 - -# If no option is given, point to the help menu -if [ $# -eq 0 ] -then -echo "Missing options!" - echo "(run $0 -h for help)" - echo "" - exit 0 -fi - -# Go through the options and put the jails requested in an array -unset -v sub -while getopts ":i:r:u:d:g:h" opt - do - #Shellcheck on wordsplitting will be disabled. Wordsplitting can't happen, because it's already split using OPTIND. - case $opt in - i ) installjails=("$OPTARG") - # shellcheck disable=SC2046 - until [[ $(eval "echo \${$OPTIND}") =~ ^-.* ]] || [ -z $(eval "echo \${$OPTIND}") ]; do - # shellcheck disable=SC2207 - installjails+=($(eval "echo \${$OPTIND}")) - OPTIND=$((OPTIND + 1)) - done - ;; - r ) redojails=("$OPTARG") - # shellcheck disable=SC2046 - until [[ $(eval "echo \${$OPTIND}") =~ ^-.* ]] || [ -z $(eval "echo \${$OPTIND}") ]; do - # shellcheck disable=SC2207 - redojails+=($(eval "echo \${$OPTIND}")) - OPTIND=$((OPTIND + 1)) - done - ;; - u ) updatejails=("$OPTARG") - # shellcheck disable=SC2046 - until [[ $(eval "echo \${$OPTIND}") =~ ^-.* ]] || [ -z $(eval "echo \${$OPTIND}") ]; do - # shellcheck disable=SC2207 - updatejails+=($(eval "echo \${$OPTIND}")) - OPTIND=$((OPTIND + 1)) - done - ;; - d ) destroyjails=("$OPTARG") - # shellcheck disable=SC2046 - until [[ $(eval "echo \${$OPTIND}") =~ ^-.* ]] || [ -z $(eval "echo \${$OPTIND}") ]; do - # shellcheck disable=SC2207 - destroyjails+=($(eval "echo \${$OPTIND}")) - OPTIND=$((OPTIND + 1)) - done - ;; - g ) upgradejails=("$OPTARG") - # shellcheck disable=SC2046 - until [[ $(eval "echo \${$OPTIND}") =~ ^-.* ]] || [ -z $(eval "echo \${$OPTIND}") ]; do - # shellcheck disable=SC2207 - upgradejails+=($(eval "echo \${$OPTIND}")) - OPTIND=$((OPTIND + 1)) - done - ;; - h ) - echo "Usage:" - echo "$0 -i " - echo "$0 -r " - echo "$0 -u " - echo "$0 -d " - echo "$0 -g " - echo "" - echo " -i to install jails, listed by name, space seperated like this: jackett plex sonarr" - echo " -r to reinstall jails, listed by name, space seperated like this: jackett plex sonarr" - echo " -u to update jails, listed by name, space seperated like this: jackett plex sonarr" - echo " -d to destroy jails, listed by name, space seperated like this: jackett plex sonarrt" - echo " -g to upgrade jails, listed by name, space seperated like this: jackett plex sonarr" - echo " -h help (this output)" - exit 0 - ;; - ? ) echo "Error: Invalid option was specified -$OPTARG" - exit 0 - ;; - esac -done - -# auto detect iocage install location -global_dataset_iocage=$(zfs get -H -o value mountpoint $(iocage get -p)/iocage) -global_dataset_iocage=${global_dataset_iocage#/mnt/} -export global_dataset_iocage - -# Parse the Config YAML -# shellcheck disable=SC2046 -for configpath in "${SCRIPT_DIR}"/blueprints/*/config.yml; do ! eval $(parse_yaml "${configpath}"); done -eval "$(parse_yaml config.yml)" - -# shellcheck disable=SC2154 -if [ "${global_version}" != "1.2" ]; then - echo "You are using old config.yml synatx." - echo "Please check the wiki for required changes" - exit 1 -fi - -# Check and Execute requested jail destructions -if [ ${#destroyjails[@]} -eq 0 ]; then - echo "No jails to destroy" -else - # shellcheck disable=SC2124,SC2145 - echo "jails to destroy ${destroyjails[@]}" - for jail in "${destroyjails[@]}" - do - echo "destroying $jail" - iocage destroy -f "${jail}" - done - -fi - -# Check and Execute requested jail Installs -if [ ${#installjails[@]} -eq 0 ]; then - echo "No jails to install" -else - # shellcheck disable=SC2124,SC2145 - echo "jails to install ${installjails[@]}" - for jail in "${installjails[@]}" - do - blueprint=jail_${jail}_blueprint - if [ -z "${!blueprint}" ] - then - echo "Config for ${jail} in config.yml incorrect. Please check your config." - exit 1 - elif [ -f "${SCRIPT_DIR}/blueprints/${!blueprint}/install.sh" ] - then - echo "Installing $jail" - jailcreate "${jail}" "${!blueprint}" && "${SCRIPT_DIR}"/blueprints/"${!blueprint}"/install.sh "${jail}" - else - echo "Missing blueprint ${!blueprint} for $jail in ${SCRIPT_DIR}/blueprints/${!blueprint}/install.sh" - exit 1 - fi - done -fi - -# Check and Execute requested jail Reinstalls -if [ ${#redojails[@]} -eq 0 ]; then - echo "No jails to ReInstall" -else - # shellcheck disable=SC2124,SC2145 - echo "jails to reinstall ${redojails[@]}" - for jail in "${redojails[@]}" - do - blueprint=jail_${jail}_blueprint - if [ -z "${!blueprint}" ] - then - echo "Config for ${jail} in config.yml incorrect. Please check your config." - exit 1 - elif [ -f "${SCRIPT_DIR}/blueprints/${!blueprint}/install.sh" ] - then - echo "Reinstalling $jail" - iocage destroy -f "${jail}" && jailcreate "${jail}" "${!blueprint}" && "${SCRIPT_DIR}"/blueprints/"${!blueprint}"/install.sh "${jail}" - else - echo "Missing blueprint ${!blueprint} for $jail in ${SCRIPT_DIR}/blueprints/${!blueprint}/install.sh" - exit 1 - fi - done -fi - - -# Check and Execute requested jail Updates -if [ ${#updatejails[@]} -eq 0 ]; then - echo "No jails to Update" -else - # shellcheck disable=SC2124,SC2145 - echo "jails to update ${updatejails[@]}" - for jail in "${updatejails[@]}" - do - blueprint=jail_${jail}_blueprint - if [ -z "${!blueprint}" ] - then - echo "Config for ${jail} in config.yml incorrect. Please check your config." - exit 1 - elif [ -f "${SCRIPT_DIR}/blueprints/${!blueprint}/update.sh" ] - then - echo "Updating $jail" - iocage update "${jail}" - iocage exec "${jail}" "pkg update && pkg upgrade -y" && "${SCRIPT_DIR}"/blueprints/"${!blueprint}"/update.sh "${jail}" - iocage restart "${jail}" - iocage start "${jail}" - else - echo "Missing blueprint ${!blueprint} for $jail in ${SCRIPT_DIR}/blueprints/${!blueprint}/install.sh" - exit 1 - fi - done -fi - -# Check and Execute requested jail Upgrades -if [ ${#upgradejails[@]} -eq 0 ]; then - echo "No jails to Upgrade" -else - # shellcheck disable=SC2124,SC2145 - echo "jails to update ${upgradejails[@]}" - for jail in "${upgradejails[@]}" - do - blueprint=jail_${jail}_blueprint - if [ -z "${!blueprint}" ] - then - echo "Config for ${jail} in config.yml incorrect. Please check your config." - exit 1 - elif [ -f "${SCRIPT_DIR}/blueprints/${!blueprint}/update.sh" ] - then - echo "Currently Upgrading is not yet included in this script." - else - echo "Currently Upgrading is not yet included in this script." - exit 1 - fi - done -fi diff --git a/archive/jailman/mkdocs.yml b/archive/jailman/mkdocs.yml deleted file mode 100644 index 2b82a74eb33..00000000000 --- a/archive/jailman/mkdocs.yml +++ /dev/null @@ -1,23 +0,0 @@ -# Project Information -site_name: JailMan -site_description: "Project Design and Documentation for development" -site_author: "Ornias1993" -site_url: "https://ornias1993.github.io/jailman/" - -# Repository -repo_name: "ornias1993/jailman" -repo_url: "https://github.com/Ornias1993/jailman/" -edit_uri: "edit/dev/docs/" - -theme: - name: "material" - features: - - tabs - language: "en" - -markdown_extensions: - - admonition - - codehilite: - guess_lang: false - - toc: - permalink: true diff --git a/archive/jailman/website/CNAME b/archive/jailman/website/CNAME deleted file mode 100644 index f6ac5079213..00000000000 --- a/archive/jailman/website/CNAME +++ /dev/null @@ -1 +0,0 @@ -jailmanager.org \ No newline at end of file diff --git a/archive/jailman/website/_config.yml b/archive/jailman/website/_config.yml deleted file mode 100644 index 3190c1e94c4..00000000000 --- a/archive/jailman/website/_config.yml +++ /dev/null @@ -1,7 +0,0 @@ -theme: jekyll-theme-cayman -title: Jail Manager -description: The home of JailMan -show_downloads: true -github: - zip_url: https://github.com/jailmanager/jailman/zipball/master - tar_url: https://github.com/jailmanager/jailman/tarball/master \ No newline at end of file diff --git a/archive/jailman/website/index.md b/archive/jailman/website/index.md deleted file mode 100644 index 1ec9513da46..00000000000 --- a/archive/jailman/website/index.md +++ /dev/null @@ -1,26 +0,0 @@ -## Welcome to Jail Manager - -Jail Manager is the community that maintains JailMan. - -### JailMan -JailMan is a one-line iocage jail management and deployment tool for FreeNAS and FreeBSD. -If you are interested in using JailMan, please visit us on github [github](https://github.com/jailmanager/jailman/) - -### Supported operating systems - -While we always aim to improve, we have a limited capacity to support older or newer operating systems. Our focus is the current version of FreeNAS and, the future, TrueNAS CORE. -That being said: We do look forward to support more operating systems like FreeBSD and Linux. - -### Roadmap - -While we can't make promises due to the nature of opensource development, we aim to release frequent bugfixes aka minor releases (1.2.x releases) and less frequent major releases that will also change the way you interact with JailMan. - -Our current roadmap is as follows: - -- Next Minor release (1.2.3): Before 15-07-2020 -- Next Major release (1.3.0): Before 01-09-2020 - - -### Support or Contact - -Having trouble with JailMan? Check out our [Wiki](https://wiki.jailmanager.org) or [github](https://github.com/jailmanager/jailman/) and we’ll help you sort it out. diff --git a/archive/jailman/wiki/.github/workflows/deploy.yml b/archive/jailman/wiki/.github/workflows/deploy.yml deleted file mode 100644 index dda117691ca..00000000000 --- a/archive/jailman/wiki/.github/workflows/deploy.yml +++ /dev/null @@ -1,19 +0,0 @@ -name: Publish Wiki via GitHub Pages -on: - push: - branches: - - master - -jobs: - build: - name: Deploy Wiki - runs-on: ubuntu-latest - steps: - - name: Checkout master - uses: actions/checkout@50fbc622fc4ef5163becd7fab6573eac35f8462e # v1 - with: - ref: "master" - - name: Deploy docs - uses: mhausenblas/mkdocs-deploy-gh-pages@master - env: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/archive/jailman/wiki/.gitignore b/archive/jailman/wiki/.gitignore deleted file mode 100644 index 6b544e77282..00000000000 --- a/archive/jailman/wiki/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -/config.yml -/tmp/ diff --git a/archive/jailman/wiki/CNAME b/archive/jailman/wiki/CNAME deleted file mode 100644 index fb580e6bf24..00000000000 --- a/archive/jailman/wiki/CNAME +++ /dev/null @@ -1 +0,0 @@ -wiki2.jailmanager.org diff --git a/archive/jailman/wiki/LICENSE b/archive/jailman/wiki/LICENSE deleted file mode 100644 index 3c91742b82e..00000000000 --- a/archive/jailman/wiki/LICENSE +++ /dev/null @@ -1,25 +0,0 @@ -BSD 2-Clause License - -Copyright (c) 2020, Kjeld Schouten-Lebbing -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/archive/jailman/wiki/LICENSE.BSD2 b/archive/jailman/wiki/LICENSE.BSD2 deleted file mode 100644 index c739456913e..00000000000 --- a/archive/jailman/wiki/LICENSE.BSD2 +++ /dev/null @@ -1,25 +0,0 @@ -BSD 2-Clause License - -Copyright (c) 2019, Kjeld Schouten-Lebbing -All rights reserved. - -Redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -1. Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - -2. Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" -AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE -IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/archive/jailman/wiki/LICENSE.GPLV2 b/archive/jailman/wiki/LICENSE.GPLV2 deleted file mode 100644 index d159169d105..00000000000 --- a/archive/jailman/wiki/LICENSE.GPLV2 +++ /dev/null @@ -1,339 +0,0 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 - - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause 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. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -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 -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE 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. - - 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 -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision 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, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. diff --git a/archive/jailman/wiki/content/CNAME b/archive/jailman/wiki/content/CNAME deleted file mode 100644 index fb580e6bf24..00000000000 --- a/archive/jailman/wiki/content/CNAME +++ /dev/null @@ -1 +0,0 @@ -wiki2.jailmanager.org diff --git a/archive/jailman/wiki/content/CODE_OF_CONDUCT.md b/archive/jailman/wiki/content/CODE_OF_CONDUCT.md deleted file mode 100644 index fe93daa5ec9..00000000000 --- a/archive/jailman/wiki/content/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,71 +0,0 @@ -# Code of Conduct - -## Our Pledge - -In the interest of fostering an open and welcoming environment, we as -contributors and maintainers pledge to making participation in our project and -our community a harassment-free experience for everyone, regardless of age, body -size, disability, ethnicity, sex characteristics, gender, level of experience, -education, socio-economic status, nationality, personal appearance, race, -religion, or sexual identity and orientation. - -## Our Standards - -Examples of behavior that contributes to creating a positive environment -include: - -- Being respectful of differing viewpoints and experiences -- Gracefully accepting constructive criticism -- Focusing on what is best for the community - -Examples of unacceptable behavior by participants include: - -- The use of sexual imagery and unwelcome sexual advances -- Trolling, insulting/derogatory comments, and personal or political attacks -- Public or private harassment -- Publishing others' private information, such as a physical or electronic - address, without explicit permission - -## Our Responsibilities - -Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. - -Project maintainers have the right and responsibility to remove, edit, or -reject comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, -threatening, offensive, or harmful. - -## Scope - -This Code of Conduct applies both within project spaces and in public spaces -when an individual is representing the project or its community. Examples of -representing a project or community include using an official project e-mail -address, posting via an official social media account, or acting as an appointed -representative at an online or offline event. Representation of a project may be -further defined and clarified by project maintainers. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team at jailman@schouten-lebbing.nl. All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and appropriate to the circumstances. The project team is -obligated to maintain confidentiality with regard to the reporter of an incident. -Further details of specific enforcement policies may be posted separately. - -Project maintainers who do not follow or enforce the Code of Conduct in good -faith may face temporary or permanent repercussions as determined by other -members of the project's leadership. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, -available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html - -[homepage]: https://www.contributor-covenant.org - -For answers to common questions about this code of conduct, see -https://www.contributor-covenant.org/faq diff --git a/archive/jailman/wiki/content/CONTRIBUTING.md b/archive/jailman/wiki/content/CONTRIBUTING.md deleted file mode 100644 index 3b3ddb8f0ca..00000000000 --- a/archive/jailman/wiki/content/CONTRIBUTING.md +++ /dev/null @@ -1,113 +0,0 @@ -# Contribution and Review Guidelines - -This project welcomes any and all input, but we need to have a few quality guidelines. These guidelines will be examplained here, in this document. - -### GIT Guidelines - ---- - -#### New to GIT - -If you have never used git before, you can look up our general reference on our wiki. - -#### Git and You - -GIT is a fantastic system, but while using it we have a few guidelines to keep it fantastic for everyone. - -- Submit complete PR's. -- Add [DNM] if you do not want your PR merged yet. -- Always try and fill in the whole form, even for small PR's. -- Don't close when a reviewer requests changes (just push the changes or ask for help). -- Explain what you did in your PR. -- Be thorough. -- If you can add screenshots to clarify. -- Always try to add "Fixes #000" (where 000 is the Issue your PR fixes) -- found something you want to fix yourself? Please do make an issue too. - -### Structure Guidelines - ---- - -#### Naming scheme - -File and folder names are important and making mistakes in them may give conflicts an/or annoyance in the future. Remember, your garbage needs to be cleaned by someone sometime in the future! For that reason, we have a few guidelines in regards to naming files and folder. - -- Always start files and folders WITHOUT a Capital. - -#### Inclusion of files and folders - -Although GIT is quite friendly in what it accepts in terms of files and folder changes in a commit, a reviewer's or bugfixer's time is not unlimited. For that reason, we have a few specific guidelines in regards to the inclusion of files and folders in your PR. - -- Only include files you actually changed. -- Try not to include multiple changes in one PR -- Want to change the formatting of multiple files too? Make a separate PR. - -_Always include the following files when creating a new jail_ - -- install.sh -- update.sh -- readme.md -- config.yml - -### Code Guidelines - ---- - -#### Your code, your style, my review - -Here at jailman, we value people having their own style. But your code needs to be reviewable and editable by others too. For that reason, we have a few basic coding guidelines - -- **Always** explain regex in a comment within your code. -- Write simple code and don't try to impress. -- We will run (Basic) automated reformating of code once in a while. -- Document your changes in your code and if need be, on the wiki. -- All PR's should be able to pass our automated shellcheck. -- It's okey to add shellcheck ignores, but only AFTER you checked the warning! - -#### jail requirements - -- Jails should always save user-specific data in a persistant location. Which is the location specified in the config.yml file under "config:", which is automatically mounted to every jail under /config. There should be no user specific data in the jail itself -- Jails should not require the user to edit any config file themselves. All config changes should be automated -- Jails should not use default passwords, the user should always be forced(!) to put credentials in config.yml manually - -#### Variable style - -Here at JailMan we use a consistant style for variables. We also automated the process of loading the variables from the config file into your plugin, therefore you need to list all variables and required variables into the config.yml file in your plugin folder. - -The following variables do not need to be included in your plugin config.yml, because they are always loaded: - -ip4_addr -host_name -gateway - -The style requirements for your plugin variables are as follows: -Simple variables: clear names, no references to other jails. (ex. `admin_token` ) -Referencing another jail: prefix `link_` suffix a clear description of the jail you are linking. Preferably a plugin name. (ex. `link_mariadb` ) -For referencing settings for specific applications or other plugins: prefix: `$pluginname_` or `$application_` where $plugin and $application are the names of the plugin/application the value is used for. (ex. `mariadb_database`) - -### Review Guidelines - ---- - -Even us review gods need some guidelines once in a while. - -- Let people learn from their mistakes -- Review instead of merging without comments -- Abide by these guidelines in your review -- Tests exist for a reason. Don't merge with test-failures - -### Todo vs Feature vs bug: - ---- - -Please take note of the difference between a TODO and Feature - -- Bug: An unexpected behavior of the script or a crash. Including, but not limited to, errors and warnings. -- Todo: When you come across something that needs tweaking/adding during development, is not an unexpected behavior -- Feature: When you, out of personal preference, want something added or changed. - -### That's it! - ---- - -Someone will come along and review the changes. If everything looks good then they will merge it with the main repo. If you need any help don't be afraid to ask in the discord channel: [https://discord.gg/tFcTpBp](https://discord.gg/tFcTpBp) diff --git a/archive/jailman/wiki/content/SECURITY.md b/archive/jailman/wiki/content/SECURITY.md deleted file mode 100644 index 361a7bde5b1..00000000000 --- a/archive/jailman/wiki/content/SECURITY.md +++ /dev/null @@ -1,17 +0,0 @@ -# Security Policy - -## Supported Versions - -| Version | TrueNAS version | Supported with updates | -| ------- | --------------- | ---------------------- | -| 1.3.0 | 12.0 | NOT RELEASED YET | -| 1.2.x | 11.3U2-3 | :white_check_mark: | -| 1.1.x | 11.3U1-2 | :x: | -| 1.0.x | 11.3U1 | :x: | - -## Reporting a Vulnerability - -If you find any security issue, please email the project maintainer. - -Currently the Project Maintainer is: -[Ornias1993](https://github.com/Ornias1993) diff --git a/archive/jailman/wiki/content/SUPPORT.md b/archive/jailman/wiki/content/SUPPORT.md deleted file mode 100644 index e69de29bb2d..00000000000 diff --git a/archive/jailman/wiki/content/config options.md b/archive/jailman/wiki/content/config options.md deleted file mode 100644 index ff6d3245a98..00000000000 --- a/archive/jailman/wiki/content/config options.md +++ /dev/null @@ -1,52 +0,0 @@ -## Config Options - -There are a lot of possibly configuration options in config.yml. -For jail specific config options, please see the wiki documentation for your specific jail. This page only list general and global config options, that are the same for every jail. - -## Global config options - -Global options apply to every jail. Use and change with caution. - -### dataset - -All config options under "dataset" change dataset creation and linking. The indentation and "dataset" flag are not optional. -All Datasets are auto-created if they do not exist already, no need to worry about creating them! - -- config: The dataset that is going to contain the persistant data for every jail. For example: Nextcloud user files for nextcloud or the actual database for mariadb. -- iocage: The dataset containing the iocage config. In FreeNAS often `poolname/iocage` -- media: The dataset that is going to contain all media files for plex, Sonarr, Radarr etc. Such as movies and music. Music, Movie etc. sub-datasets are auto-created. -- downloads: The dataset containging temporary download files. These are moved to media when finished. complete, incomplete etc. sub-datasets are auto-created. - -## jails - -All config options under "jails" change default jail settings that are the same for every created jail. The indentation and "jails" flag are not optional. - -- version: the current to-be-installed version for jails -- pkgs: packages that are installed to all created jails - -## (hidden) Auto created datasets - -Some datasets are auto created and can not be changed from the config file. This is done to ease troubleshooting. - -- `media/music` created as a sub-dataset of media, contains music -- `media/movies` created as a sub-dataset of media, contains movies -- `media/shows` created as a sub-dataset of media, contains tv-shows -- `downloads/complete` created as a sub-dataset of downloads, contains completed downloads -- `downloads/incomplete` created as a sub-dataset of downloads, contains not-yet-completed downloads - -## General config options - -### Networking - -Please be aware that dhcp is not actively supported, many of the jails depend on having a fixed IP-adress in the config file. -Some also depend on other jails having a fixed IP in the config file. Use of DHCP is on your own risk and might not work. - -- ip4_addr: To set a static IP (recommended), enter the desired ip address here. Leave blank (or remove the line) for DHCP. -- gateway: Set the gateway IP for static IP setup. Leave blank (or remove the line) for DHCP. - -### Advanced - -- interfaces: Set the "interfaces" flag for iocage. Example: `vnet0:bridge0` (optional) -- dhcp: Set to "on" to force DHCP (not required for DHCP, see above) -- pkgs: Override the to-be-install packages for this jail (might break now or break updates) -- custom_iocage: Adds additional custom options to iocage create (NOT actively supported, use on your own risk) diff --git a/archive/jailman/wiki/content/development/functions.md b/archive/jailman/wiki/content/development/functions.md deleted file mode 100644 index 9ad4069155d..00000000000 --- a/archive/jailman/wiki/content/development/functions.md +++ /dev/null @@ -1,47 +0,0 @@ -# Custom Functions - -## Intro - -With Jailman we have a number of functions that are custom. This document lists them and explains their use. Currently all custom functions are inculded in ./includes/global.sh - -## parse_yaml - -This functions parses the yml config files. It does not support lists however and we highly advice not using indentations other than 2 spaces either. -It's only input is a yml file and it should be called as the argument of an eval statement. - -## gitupdate - -This function triggers an update based on the branch it is given. -Currently only called in jailman.sh and it is fed the remote/branch combo it is currently on. - -## jailcreate - -This function creates the actual jail based on a plugin. -It takes the jail name, looks up the plugin and proceeds accordingly. -It also creates things like basic mount points and such. while also checking if all required vars are filled. - -Currently only used in jailman.sh - -## initplugin - -This function turns all config.yml variables for the jail inputed as $1 into local variables. This is not required (as variables are also available as `${!jail\_$1_varname}`), but makes it easier for less experienced plugin creators to start working with Jailman -It takes only the Jailname as input. - -## exitplugin - -This script does the "success" processing for an installation. It takes the name of the jail and a message (preferable a connection instruction), creates the "INSTALLED" file, does the last checks and outputs the successmessages -No additional scripting besides `echo`'s should be done after executing this script. - -## createmount - -This function creates a dataset and mounts said dataset to a specific folder in a jail, while also creating required subfolders if needed. -It's easier to use and update than mounting folders manually, so it's the only allowed way to do so, unless very specific config is required (such as database datasets) -It has the following input options: - -# $1 = jail name - -# $2 = Dataset - -# $3 = Target mountpoint - -# $4 = fstab prefernces diff --git a/archive/jailman/wiki/content/development/linked_configs.md b/archive/jailman/wiki/content/development/linked_configs.md deleted file mode 100644 index 9683cd0ceb7..00000000000 --- a/archive/jailman/wiki/content/development/linked_configs.md +++ /dev/null @@ -1,19 +0,0 @@ -# Linking Jail Configs - -## Intro - -To keep things simple, you can easily link jail configs together, for example you can make the settings of your MariaDB jail accessable to your nextcloud jail. -This can be done using a variable with the name: `link_$Name`, where $Name is just a description and the value in config.yml would be the actual jail to connect to. - -For example: -`link_testjail: thisismytestjail` - -Would link "thisismytestjail" to your current jail. - -## using linked jails - -Once setup one can reach all the variables of the linked jail using the following syntax: -`link_$Name_$variable` - -For example if we want the ipv4 address of the jail we linked earlier, during the install of another jail, we would do: -`${link_testjail_ip4_addr}` diff --git a/archive/jailman/wiki/content/index.md b/archive/jailman/wiki/content/index.md deleted file mode 100644 index 3391afacd39..00000000000 --- a/archive/jailman/wiki/content/index.md +++ /dev/null @@ -1,136 +0,0 @@ -# Introduction - -**Jailman is a collection of shell scripts designed to make it easier to install all sorts of iocage Jails on FreeNAS.** - ---- - -[![GitHub last commit](https://img.shields.io/github/last-commit/jailmanager/jailman/dev.svg)](https://github.com/jailmanager/jailman/commits/dev) [![GitHub Release](https://img.shields.io/github/release/jailmanager/jailman.svg)](https://github.com/jailmanager/jailman/releases/latest) [![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://github.com/jailmanager/jailman/blob/master/docs/LICENSE.GPLV2) [![License](https://img.shields.io/badge/License-BSD%202--Clause-orange.svg)](https://github.com/jailmanager/jailman/blob/master/docs/LICENSE.BSD2) - -There are a lot of great scripts out there to create all sorts of custom jails on FreeNAS. Sadly enough, they all take their own approach to configuration, which lead to a lot of time wasted configuring all sorts of different scripts. - -We do not aim to be some sort of XKCD like "solution to replace all solutions", but aim to simply improve, iterate and integrate the great work others have already put forward. - -The goal of this project is to be able to install, update, reinstall, upgrade and delete most of your services by just running a single command using a single config file. While doing this we aim for a "docker like" scenario, where the jail is completely disposable and all configuration is saved outside of the jail. - -## Getting started - -### Installing - -- Get into FreeNAS using the in-gui console or SSH. - Run the following commands to install jailman: -- `git clone https://github.com/jailmanager/jailman.git` -- `cd jailman` -- `cp config.yml.example config.yml` -- edit config.yml to reflect your personal settings (optional, see "use") -- Run one of the commands under "How-To Use" - -### Updating - -This script includes an autoupdate feature which checks if changes to the script has been posted to github. - -## How-To Use - -Replace $jailname with the name of the jail you want to install. -For supported jails, please see this readme or config.yml.example - -- First: CD into the directory you downloaded jailman into (see above) - example: - `cd /root/jailman` - -- Install: - `./jailman.sh -i $jailname` - Example: - `./jailman.sh -i sonarr` - -- ReInstall: - `./jailman.sh -r $jailname` - Example: - `./jailman.sh -r sonarr` - -- Update: - `./jailman.sh -u $jailname` - Example: - `./jailman.sh -u sonarr` - -- Destroy - `./jailman.sh -d $jailname` - Example: - `./jailman.sh -d sonarr` - -You can also do multiple jails in one pass: -Example: -`jailman.sh -i sonarr radarr lidarr` - -This installs the jail, creates the config dataset if needed, installs all packages and sets them up for you. -Only thing you need to do is do the setup of the packages in their respective GUI. -All settings for the applications inside the jails are persistent across reinstalls, so don't worry reinstalling! - -config.yml.example includes basic configuration for all jails. -Basic means: The same setup as a FreeNAS plugin would've, DHCP on bridge0. - -### Currently Supported Services - -#### General - -- organizr -- py-kms -- nextcloud (currently broken, fix ready for 1.3.0) -- bitwarden -- unifi controller - -#### Backend - -- mariadb -- influxdb - -#### Downloads - -- transmission -- jackett - -#### Media - -- plex -- tautulli -- sonarr -- radarr -- lidarr - -## Get involved - -### Preparing your own copy of JailMan - -Getting involved with JailMan and creating your own Jails, is really simple although experience with Bash, BSD and iocage is highly recommended. - -- Fork the JailMan Repository and clone your own fork to disk. -- Create a new branch, starting from the dev branch (with all current development changes) -- Open Jailman.sh and `BRANCH="dev"`into your own branch. - -### Making changes - -To add a jail, you need 4 things: - -- A jailfolder under jails/ -- an install script in the jail folder, named `install.sh` -- an update script in the jail folder, named `update.sh` -- an entry in `config.yml` with the name of your jail - -All jails created by JailMan start with their own persistant data folder in a seperate dataset, mounted under `/config`. -You can safely use this, or create additional datasets and mount those. - -To make your experience making changes to Jailman as easy as possible, we already made some convenience functions in global.sh, those are available to your jail install and update scripts from the start! - -But above all: Have fun building it! - -## LICENCE - -This work is dual licenced under GPLv2 and BSD-2 clause - -### Sub-Licences - -Some sub-modules available under "jails" might be licenced under a different licence. -Please be aware of this and take note of any LICENCE files signaling a differently licenced sub-module. - ---- - -![built-with-resentment](http://forthebadge.com/images/badges/built-with-resentment.svg) ![contains-technical-debt](http://forthebadge.com/images/badges/contains-technical-debt.svg) diff --git a/archive/jailman/wiki/content/migration/v1.1.x to v1.2.x.md b/archive/jailman/wiki/content/migration/v1.1.x to v1.2.x.md deleted file mode 100644 index a9135681fe1..00000000000 --- a/archive/jailman/wiki/content/migration/v1.1.x to v1.2.x.md +++ /dev/null @@ -1,56 +0,0 @@ -## v1.1.x to v1.2.x - -With v1.2 we made it possible to run multiple jails of the same type. -This is done by seperating jails (your individual installs) from plugins (our designs). - -Due to this change, the config file has been changed and thus you need to adapt your config file. - -### Jails - -All your jails need to be indented by 2 spaces under a main group "jails" like this: - -`jail: - plex: - plugin: plex - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - beta: false` - -Also note: -Where previously we used `plex: plex`, we can now just use `plex:` - -### plugins - -Every jail now requires a plugin to be defined. for example: -v1.1.x -` - -plex: plex -ip4_addr: 192.168.1.99/24 -gateway: 192.168.1.1 -plexpass: false -` - -In v1.2.x becomes: -`jail: - plex: - plugin: plex - ip4_addr: 192.168.1.99/24 - gateway: 192.168.1.1 - beta: false` - -### Plex - -Due to community feedback in v1.2.x "plexpass" has been renamed to "beta". - -### pkgs - -pkgs are removed from jail config in v1.2.x and are now part of the plugin. This way we can keep them up-to-date for you. - -### Documentation - -All jails now have wiki documentation pages and all basic jail values have been documented - -### Other changes - -Some other minor changes in config file values have been done, please refer to the example document and compare your config to the example diff --git a/archive/jailman/wiki/content/migration/v1.2.x to v1.3.x.md b/archive/jailman/wiki/content/migration/v1.2.x to v1.3.x.md deleted file mode 100644 index 178ccd097e0..00000000000 --- a/archive/jailman/wiki/content/migration/v1.2.x to v1.3.x.md +++ /dev/null @@ -1,59 +0,0 @@ -# v1.2.x to v1.3.x - -With v1.3.0 all our code has been completely redesigned and rewriten. -While we tried to minimize the effects on the user, there are some consequences. - -Please read this document completely before migrating. -We are **NOT** responsible if you ignore anything from this document. - -### Plugin backend - -With v1.3.0 we started to use plugins as a backend for jailman. -Besides the plugins now being visable in the TrueNAS UI and the renaming of "blueprints" to "plugins" this should not have any significant changes to the user experience. - -However: This means all our previous jails are now not compatible with jailman anymore. A reinstall is required. -As all our jails save their data in persistent storage, it would not have any side effects to just reinstall all your jails. -You can still use jailman.sh -d $jail or jailman.sh -r $jail to remove or reinstall the old jails. - -However, please always make sure you create a snapshot before doing any possible destructive operations! - -#### Persistence warning on Organizr - -Due to bad design choices from the organizr team, we can't be 100% sure our current setup is persistent. -While we do our best, we currently can't give guarantees about it - -### Different reinstall detection. - -With v1.3.0 we simplyfied reinstall detection. -If a install finishes alright, it now adds a file called "INSTALLED" to the persistent config directory (by default: /apps/$jailname). As long as this file is present it will allways try to reinstall. -As your current persistent config directories do not contain this file, all reinstalls will fail. -You can easily fix this by manually add a filled named `INSTALLED` to all the persistent config directories. - -### SSL - -With v1.3.0 we centralised all SSL to a traefik proxy. Traefik is a great utility to keep track of all SSL certificates and guarantees a more solid experience. -This also means we do **NOT** offer any SSL-setup ourselves anymore, but in return we fully integrated traefik into the config.yml file... so you can generate your certificates even faster than before. - -We have a limited amount of developers and by using traefik, we can focus on things that mater: Stability and functionality, instead of working custom SSL config for every jail. - -### Config file format - -Because we simplified the internal config file structure, the config.yml structure has been simplified. -Some options have been removed and the "jail" main category has been removed. - -An example what this means: - -``` -jail: - sonarrjail: - blueprint: sonarr -``` - -Will become: - -``` -sonarrjail: - plugin: sonarr -``` - -Where there will be NO spaces in front of the jailname anymore. diff --git a/archive/jailman/wiki/content/plugins/General b/archive/jailman/wiki/content/plugins/General deleted file mode 100644 index f12d6cb1dcc..00000000000 --- a/archive/jailman/wiki/content/plugins/General +++ /dev/null @@ -1,5 +0,0 @@ -## General Info - -Blueprints are the blueprint on which your created jails are going to be based. - -More info TBD diff --git a/archive/jailman/wiki/content/plugins/bazarr.md b/archive/jailman/wiki/content/plugins/bazarr.md deleted file mode 100644 index 3af74aa187d..00000000000 --- a/archive/jailman/wiki/content/plugins/bazarr.md +++ /dev/null @@ -1,15 +0,0 @@ -# Bazarr - -Bazarr is a companion application to Sonarr and Radarr. It manages and downloads subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you. - -Be aware that Bazarr doesn't scan disk to detect series and movies: It only takes care of the series and movies that are indexed in Sonarr and Radarr. - -Thanks to the folks at OpenSubtitles for their logo that was an inspiration for ours. - -**For more information about Bazarr, please checkout:** - -https://github.com/morpheus65535/bazarr - -## Known issues - -- The Bazarr installer might throw SSL errors if your TrueNAS "date and time" settings are incorrect, these errors break the installation process. diff --git a/archive/jailman/wiki/content/plugins/bitwarden.md b/archive/jailman/wiki/content/plugins/bitwarden.md deleted file mode 100644 index be8a95bbfa2..00000000000 --- a/archive/jailman/wiki/content/plugins/bitwarden.md +++ /dev/null @@ -1,14 +0,0 @@ -# Bitwarden_RS - -This is a Bitwarden server API implementation written in Rust compatible with [upstream Bitwarden clients](https://bitwarden.com/#download)\*, perfect for self-hosted deployment where running the official resource-heavy service might not be ideal. - -**For more information about Bitwarden_RS, please checkout:** -https://github.com/dani-garcia/bitwarden_rs - -## Configuration Parameters - -- admin_token: Long (preferable random) password to be used to open the Bitwarden_rs admin interface. Admin interface is disabled when empty -- link_mariadb: MariaDB jail to be used for storing the database. -- mariadb_database: The name of the database used for (encrypted) credential storage. defaults to the jail name. Will be created on first install. -- mariadb_user: The name of the database user to be used for (encrypted) credential storage. defaults to the database name. Will be created on first install. -- mariadb_password: The password of the database user to be used for (encrypted) credential storage. defaults to the database name. diff --git a/archive/jailman/wiki/content/plugins/forked_daapd.md b/archive/jailman/wiki/content/plugins/forked_daapd.md deleted file mode 100644 index cc96c45bdce..00000000000 --- a/archive/jailman/wiki/content/plugins/forked_daapd.md +++ /dev/null @@ -1,12 +0,0 @@ -# forked-dappd - -This plugin installs forked-daapd with a current version of ffmpeg. -As it compiles ffmepg from sources the initialisation takes a while (~25 minutes -on a Xeon E3-1230 v5 @ 3.40GHz). - -#### Configuration parameters - -- itunes_media: Path to your itunes media that will be mounted in the jail. (ex. /mnt/tank/media/music/itunes/) - -`forked-daapd` needs to know the location of your iTunes Library. Add a `itunes_media:` -section to your `config.yaml` with the path to your itunes library as value. diff --git a/archive/jailman/wiki/content/plugins/grafana.md b/archive/jailman/wiki/content/plugins/grafana.md deleted file mode 100644 index 94d74dbd9a4..00000000000 --- a/archive/jailman/wiki/content/plugins/grafana.md +++ /dev/null @@ -1,12 +0,0 @@ -# Grafana - -Grafana allows you to query, visualize, alert on and understand your metrics no matter where they are stored. Create, explore, and share dashboards with your team and foster a data driven culture: - -**For more information about Grafana, please checkout:** -https://grafana.com - -#### Configuration Parameters - -- password (req): The password for the default admin account (admin). Required. -- link_influxdb (opt): set to the name of the influxdb jail to set as datasource, if desired. -- link_unifi (opt): set to the name of the Unifi jail with Unifi Poller to automatically get its data from influxdb. (requires link_influxdb) diff --git a/archive/jailman/wiki/content/plugins/influxdb.md b/archive/jailman/wiki/content/plugins/influxdb.md deleted file mode 100644 index 22d08c19597..00000000000 --- a/archive/jailman/wiki/content/plugins/influxdb.md +++ /dev/null @@ -1,6 +0,0 @@ -# InfluxDB - -InfluxDB is an open source time series platform. This includes APIs for storing and querying data, processing it in the background for ETL or monitoring and alerting purposes, user dashboards, and visualizing and exploring the data and more. The master branch on this repo now represents the latest InfluxDB, which now includes functionality for Kapacitor (background processing) and Chronograf (the UI) all in a single binary. - -**For more information about InfluxDB, please checkout:** -https://github.com/influxdata/influxdb diff --git a/archive/jailman/wiki/content/plugins/jackett.md b/archive/jailman/wiki/content/plugins/jackett.md deleted file mode 100644 index dc666a580ed..00000000000 --- a/archive/jailman/wiki/content/plugins/jackett.md +++ /dev/null @@ -1,10 +0,0 @@ -## jackett - -Jackett is tool designed to combine and search multiple bittorrent trackers like a proxy. - -**For more information about Jackett, please checkout:** -https://github.com/Jackett/Jackett - -### Post-install - -Currently there are not relevant post-install steps, other than your own personal preferences for setting up Jacket. diff --git a/archive/jailman/wiki/content/plugins/kms.md b/archive/jailman/wiki/content/plugins/kms.md deleted file mode 100644 index 60cf769107b..00000000000 --- a/archive/jailman/wiki/content/plugins/kms.md +++ /dev/null @@ -1,6 +0,0 @@ -# Py-KMS - -_py-kms_ is a port of node-kms created by [cyrozap](http://forums.mydigitallife.info/members/183074-markedsword), which is a port of either the C##, C++, or .NET implementations of KMS Emulator. The original version was written by [CODYQX4](http://forums.mydigitallife.info/members/89933-CODYQX4) and is derived from the reverse-engineered code of Microsoft's official KMS. - -**For more information about Py-KMS, please checkout:** -https://github.com/SystemRage/py-kms diff --git a/archive/jailman/wiki/content/plugins/lazylibrarian.md b/archive/jailman/wiki/content/plugins/lazylibrarian.md deleted file mode 100644 index f283d3c59f8..00000000000 --- a/archive/jailman/wiki/content/plugins/lazylibrarian.md +++ /dev/null @@ -1,4 +0,0 @@ -# Plugin Template - -This Repository contains a templatate to base your plugin on. -Please be aware: When submitting your plugin, this readme gets added to the Wiki diff --git a/archive/jailman/wiki/content/plugins/lidarr.md b/archive/jailman/wiki/content/plugins/lidarr.md deleted file mode 100644 index 30d524a2e93..00000000000 --- a/archive/jailman/wiki/content/plugins/lidarr.md +++ /dev/null @@ -1,7 +0,0 @@ -# Lidarr - -Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. - -**For more information about Lidarr, please checkout:** - -https://github.com/lidarr/Lidarr diff --git a/archive/jailman/wiki/content/plugins/mariadb.md b/archive/jailman/wiki/content/plugins/mariadb.md deleted file mode 100644 index e3613845dad..00000000000 --- a/archive/jailman/wiki/content/plugins/mariadb.md +++ /dev/null @@ -1,12 +0,0 @@ -# MariaDB - -MariaDB is designed as a drop-in replacement of MySQL(R) with more -features, new storage engines, fewer bugs, and better performance. - -**For more information about MariaDB, please checkout:** -https://github.com/MariaDB/server/ - -## Configuration Parameters: - -cert_email: Currently not used, but required due to a caddy bug. -root_password: The root password used for MariaDB diff --git a/archive/jailman/wiki/content/plugins/nextcloud.md b/archive/jailman/wiki/content/plugins/nextcloud.md deleted file mode 100644 index 69462856b25..00000000000 --- a/archive/jailman/wiki/content/plugins/nextcloud.md +++ /dev/null @@ -1,19 +0,0 @@ -# Nextcloud - -Nextcloud is the most deployed on-premises file share and collaboration platform. Access & collaborate across your devices. - -**For more information about Nextcloud, please checkout:** -https://nextcloud.com/ - -## Configuration parameters: - -- time_zone: Is the time zone of your location, in PHP notation--see the [PHP manual](http://php.net/manual/en/timezones.php) for a list of all valid time zones. -- cert_type: DNS_CERT, STANDALONE_CERT, SELFSIGNED_CERT, and NO_CERT determine which method will be used to generate a TLS certificate (or, in the case of NO_CERT, indicate that you don't want to use SSL at all). DNS_CERT and STANDALONE_CERT indicate use of DNS or HTTP validation for Let's Encrypt, respectively. -- cert_email: The email address Let's Encrypt will use to notify you of certificate expiration. This is mandatory regardless of whether you're using Let's Encrypt (Caddy won't start without it), but it's only used with Let's Encrypt. If you are **not** using one of the Let's Encrypt certificate options, you can set this to a dummy address as above. If you **are** using Let's Encrypt, though, it should be set to a valid address for the system admin. -- dns_plugin: If DNS_CERT is set, DNS_PLUGIN must contain the name of the DNS validation plugin you'll use with Caddy to validate domain control. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for the available plugins, but omit the leading "tls.dns.". For example, to use Cloudflare, set `DNS_PLUGIN="cloudflare"`. -- dns_env: If DNS_CERT is set, DNS_ENV must contain the authentication credentials for your DNS provider. See the [Caddy documentation](https://caddyserver.com/docs) under the heading of "DNS Providers" for further details. For Cloudflare, you'd set `DNS_ENV="CLOUDFLARE_EMAIL=foo@bar.baz CLOUDFLARE_API_KEY=blah"`, using your the email address of your Cloudflare account and your Global API key--the newer API tokens aren't currently supported. -- link_mariadb: The name of the MariaDB database jail you want to use. -- mariadb_password: The Password for the mariadb database user you want to use. Will be created on first install. -- mariadb_user: The name for the mariadb database user you want to use. Will be created on first install. Will default to the database name. -- mariadb_database: The name of the mariadb database you want to use. Will be created on first install. Will default to the jail name. -- admin_password: The password for the default Nextcloud admin user you want to create. Not created on reinstall. diff --git a/archive/jailman/wiki/content/plugins/organizr.md b/archive/jailman/wiki/content/plugins/organizr.md deleted file mode 100644 index 2a40ebc363e..00000000000 --- a/archive/jailman/wiki/content/plugins/organizr.md +++ /dev/null @@ -1,6 +0,0 @@ -# Organizr - -Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. You can then work on your server with ease. Want to give users access to some Tabs? No problem, just enable user support and have them make an account. Want guests to be able to visit too? Enable Guest support for those tabs. - -**For more information about Organizr, please checkout:** -https://github.com/causefx/Organizr diff --git a/archive/jailman/wiki/content/plugins/plex.md b/archive/jailman/wiki/content/plugins/plex.md deleted file mode 100644 index b4c85233f76..00000000000 --- a/archive/jailman/wiki/content/plugins/plex.md +++ /dev/null @@ -1,16 +0,0 @@ -# Plex - -Plex gives you one place to find and access all the media that matters to you. From personal media on your own server, to podcasts, web shows, and news, to streaming music, you can enjoy it all in one app, on any device. - -**For more information about Plex, please checkout:** -https://plex.tv - -#### Advanced config parameters: - -- ramdisk: Specify the `size` parameter to create a transcoding ramdisk under /tmp_transcode. Requires manual setting it un plex to be used for transcoding. (optional) - -#### Experimental config parameters: - -These parameters are either not fully tested or expected to break with short-term OS updates. They are included in the release however, because they are suspected to become stable eventually. - -- hw_transcode: set this to "true" to enable hardware transcoding on compatible systems, to "false" to disable or, preferable, just leave it out to disable diff --git a/archive/jailman/wiki/content/plugins/radarr.md b/archive/jailman/wiki/content/plugins/radarr.md deleted file mode 100644 index a6aef8a5e24..00000000000 --- a/archive/jailman/wiki/content/plugins/radarr.md +++ /dev/null @@ -1,7 +0,0 @@ -# Radarr - -Radarr is an **independent** fork of [Sonarr](https://github.com/Sonarr/Sonarr) reworked for automatically downloading movies via Usenet and BitTorrent. - -**For more information about Radarr, please checkout:** - -https://github.com/Radarr/Radarr diff --git a/archive/jailman/wiki/content/plugins/sabnzbd.md b/archive/jailman/wiki/content/plugins/sabnzbd.md deleted file mode 100644 index d23deec12de..00000000000 --- a/archive/jailman/wiki/content/plugins/sabnzbd.md +++ /dev/null @@ -1,6 +0,0 @@ -# Sabnzbd - -plugin for Sabnzbd news reader. - -**For more information about Sabnzbd, please checkout:** -https://github.com/sabnzbd/sabnzbd diff --git a/archive/jailman/wiki/content/plugins/sabnzbd3.md b/archive/jailman/wiki/content/plugins/sabnzbd3.md deleted file mode 100644 index d5751fd7e01..00000000000 --- a/archive/jailman/wiki/content/plugins/sabnzbd3.md +++ /dev/null @@ -1,7 +0,0 @@ -# Sabnzbd v3 - -SABnzbd is a multi-platform binary newsgroup downloader. The program works in the background and simplifies the downloading verifying and extracting of files from Usenet. -V3. is the newest (beta) version of Sabnzbd - -**For more information about Sabnzbd, please checkout:** -https://sabnzbd.org/ diff --git a/archive/jailman/wiki/content/plugins/sonarr.md b/archive/jailman/wiki/content/plugins/sonarr.md deleted file mode 100644 index 5b4114c769f..00000000000 --- a/archive/jailman/wiki/content/plugins/sonarr.md +++ /dev/null @@ -1,7 +0,0 @@ -# Sonarr - -Sonarr is a PVR for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. - -**For more information about Sonarr, please checkout:** - -https://github.com/Sonarr/Sonarr diff --git a/archive/jailman/wiki/content/plugins/tautulli.md b/archive/jailman/wiki/content/plugins/tautulli.md deleted file mode 100644 index f3840a1075a..00000000000 --- a/archive/jailman/wiki/content/plugins/tautulli.md +++ /dev/null @@ -1,6 +0,0 @@ -# Tautulli - -A python based web application for monitoring, analytics and notifications for [Plex Media Server](https://plex.tv). - -**For more information about Tautulli, please checkout:** -https://github.com/Tautulli/Tautulli diff --git a/archive/jailman/wiki/content/plugins/template.md b/archive/jailman/wiki/content/plugins/template.md deleted file mode 100644 index f283d3c59f8..00000000000 --- a/archive/jailman/wiki/content/plugins/template.md +++ /dev/null @@ -1,4 +0,0 @@ -# Plugin Template - -This Repository contains a templatate to base your plugin on. -Please be aware: When submitting your plugin, this readme gets added to the Wiki diff --git a/archive/jailman/wiki/content/plugins/traefik.md b/archive/jailman/wiki/content/plugins/traefik.md deleted file mode 100644 index e18b8be9745..00000000000 --- a/archive/jailman/wiki/content/plugins/traefik.md +++ /dev/null @@ -1,98 +0,0 @@ -# Traefik - -Traefik is a reverse proxy, this means it sits in-between your servers and the internet. Often these reverse proxies also, just like traefik, function as SSL endpoints, this means they encrypt the traffic comming from/to your servers. - -Standalone without docker Traefik is quite a challenge to setup right. JailMan tries to make it as easy as possible for your, by doing most of the groundwork and tweaking for you. -This also means we don't support all features of traefik. We use traefik as a central reverse proxy and ssl termination endpoint for all our jails. Nothing more, Nothing less. - -To make things as streamlined as possible we had to make choices. Hence we only support DNS-verification for certificate generation. No http(s) verification is included. - -**For more information about Traefik, please checkout:** -https://containo.us/traefik/ - -## Configuration Parameters - -Traefik requires a little more variables to setup in config.yml than other jails. -Here is the list of configuration parameters: - -- dns_provider: The DNS provider you are using to verify ownership of the domain. This is required to get a letsencrypt certificate. We only support DNS-verification for certificate generation. -- domain_name: The domain name you want to use to connect to traefik. Needs to be accessable at the DNS provider (cert_provider) with the DNS credentials (cert_env) provided. -- cert_email: The email adress to link to the Lets Encrypt certificate -- dashboard: set to "true" to enable the dashboard. -- cert_env: For DNS verification we need login credentials and need to write those in a way Traefik understands. You can find the requirements for your DNS provider at the traefik website: https://docs.traefik.io/https/acme/ - You will need to use 2 spaces(!) in front and enter them below this configuration option. Like this: - -``` - cert_env: - CF_API_EMAIL: fake@email.adress - CF_API_KEY: ftyhsfgufsgusfgjhsfghjsgfhj -``` - -### Advanced settings - -These settings are normally not required or normally used, but might come in handy for advanced users. - -- cert_staging: Set this to "true" if you want to test it out using the Lets Encrypt staging server. Set it to "false" or (preferable) just leave it out to use the production server. -- cert_wildcard_domain: If you want to generate wildcard certificates, please enter the domain name here, without `*.` (ex. `test.testdomain.com`) -- cert_strict_sni: set to "true" to enable strict SNI checking, set to false or (preferably) just leave it out to disable strict-SNI checking. -- link_influxdb: This links traefik to a influxdb jail to store metrics data (influxdb_password required) -- influxdb_password: this sets up a password to use for the influxdb database -- traefik_auth_basic: Add basic authentication to the traefik dashboard itself (if used on the traefik jail) or another jail (if used on another jail) -- traefik_forward_auth: Add forwarded authentication to the traefik dashboard itself (if used on the traefik jail) or another jail (if used on another jail) - -## Installing - -To make traefik as easy as possible to install, we advice to base your config.yml settings on the following example: - -``` -traefikjail: - blueprint: traefik - ip4_addr: 192.168.1.200/24 - gateway: 192.168.1.1 - dashboard: true - traefik_auth_basic: user:password user2:pass2 - domain_name: traefik.test.placeholder.net - dns_provider: cloudflare - cert_staging: true - cert_email: fake@email.net - cert_wildcard_domain: test.placeholder.net - # Please follow the guide here: https://docs.traefik.io/https/acme/ - # and enter your DNS providers environment variables below (2 spaces indent) of cert_env - cert_env: - CF_API_EMAIL: fake@email.adress - CF_API_KEY: ftyhsfgufsgusfgjhsfghjsgfhj - link_influxdb: influxdbjail - influxdb_password: traefikmetricspass -``` - -## Usages - -To add a jail to traefik, you will need a domain name (which can be accessed using the cert_env settings on traefik). -If you have the domain name configured correctly on traefik, just add the following config parameter to the other jail (not traefik), where $traefikjail is the name of your traefik-jail: - -``` - domain_name: myjail.test.com - traefik_proxy: $traefikjail -``` - -## Security - -If you want to add security to a jail, there are two opions: basic_auth or forward_auth. -**basic_auth:** -Basic_auth uses a simpel username and passowrd prompt before it allows anyone to open the site. It can be enabled by adding the following config parameter in addition to traefik_proxy. - -``` - traefik_basic_auth: user1:password1 user2:password2 - -``` - -**forward_auth:** -forward_auth checks if you already have access (http not-403) to another website. It's more advanced to setup, but it (for example) enables you to easily add central authentication to jails using organizr. -The following is an example config, using an organizr jail. It needs to be added in addition to traefik_proxy: - -``` - traefik_auth_forward: https://organizr.testdomain.com/api/?v1/auth&group=1 - -``` - -Although the web interface shows port 9080 and 9443, Traefik is actually also listening on the (more common) port 80 and 443, also known as normal (without port in the URL) http and https ports. diff --git a/archive/jailman/wiki/content/plugins/transmission.md b/archive/jailman/wiki/content/plugins/transmission.md deleted file mode 100644 index ccdcd295e79..00000000000 --- a/archive/jailman/wiki/content/plugins/transmission.md +++ /dev/null @@ -1,6 +0,0 @@ -# Transmission - -Transmission is a fast, easy, and free BitTorrent client. - -**For more information about Transmission, please checkout:** -https://github.com/transmission/transmission diff --git a/archive/jailman/wiki/content/plugins/unifi.md b/archive/jailman/wiki/content/plugins/unifi.md deleted file mode 100644 index 9d6c94235d9..00000000000 --- a/archive/jailman/wiki/content/plugins/unifi.md +++ /dev/null @@ -1,27 +0,0 @@ -# Unifi Controller - -The UniFi® Controller is a wireless network managementsoftware solution from Ubiquiti Networks™. It allows you tomanage multiple wireless networks using a web browser. - -**For more information about Unifi Controller, please checkout:** -https://www.ui.com - -**For more information about Unifi Poller, please checkout:** -https://github.com/unifi-poller/unifi-poller - -### Installation: - -- This jail requires an existing InfluxDB jail. InfluxDB may be created using the same install command, as long as influxdb is listed first. -- Once the script runs, a user must be created in the Unifi Controller software for your Unifi-Poller user. -- To view the data from Unifi-Poller, Grafana is required. Add the unifi InfluxDB database as a data source in Grafana. - -### Config Description - -- unifi_poller: boolean, true if you want to also install unifi-poller -- link_influxdb: This is the name of your influxdb database jail, should be influxdb. -- influxdb_database: The name of the database that will be created in influxdb for Unifi Poller. -- influxdb_user & influxdb_password: The created database's credentials for Unifi Poller. -- poller_user & poller_password: The Unifi-Poller user credentials. This user must be created in the Unifi Controller web gui after install matching these credentials. This is for the connection between Unifi Controller & Unifi Poller - -### Unifi-Controller Post-Install - -After the script runs and the unifi jail is running, open the web gui of the unifi jail at port 8443 (i.e. https://192.168.2.250:8443). After completing the initial setup wizard, go to Admins --> Add New Admin. Select "Manually set and share the password", enter the username and password used for up_user & up_password. Uncheck 'Require the user to change their password'. Verify "Role" is set to 'Read Only'. Click Create. diff --git a/archive/jailman/wiki/mkdocs.yml b/archive/jailman/wiki/mkdocs.yml deleted file mode 100644 index 2ae00edd7cf..00000000000 --- a/archive/jailman/wiki/mkdocs.yml +++ /dev/null @@ -1,24 +0,0 @@ -# Project Information -site_name: JailMan -site_description: "Project Documentation for JailManager" -site_author: "JailManager Team" -docs_dir: content/ -site_url: "https://wiki2.jailmanager.org" - -# Repository -repo_name: "jailmanager/jailman" -repo_url: "https://github.com/jailmanager/jailman" -edit_uri: "edit/content/" - -theme: - name: "material" - features: - - tabs - language: "en" - -markdown_extensions: - - admonition - - codehilite: - guess_lang: false - - toc: - permalink: true diff --git a/archive/kubelet-cert-approver.yaml b/archive/kubelet-cert-approver.yaml deleted file mode 100644 index 27dec086ef7..00000000000 --- a/archive/kubelet-cert-approver.yaml +++ /dev/null @@ -1,188 +0,0 @@ -apiVersion: v1 -kind: ServiceAccount -metadata: - annotations: - meta.helm.sh/release-name: kubelet-csr-approver - meta.helm.sh/release-namespace: kube-system - labels: - app.kubernetes.io/instance: kubelet-csr-approver - app.kubernetes.io/managed-by: Helm - app.kubernetes.io/name: kubelet-csr-approver - app.kubernetes.io/version: v1.2.1 - helm.sh/chart: kubelet-csr-approver-1.2.1 - name: kubelet-csr-approver - namespace: kube-system ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: ClusterRole -metadata: - annotations: - meta.helm.sh/release-name: kubelet-csr-approver - meta.helm.sh/release-namespace: kube-system - labels: - app.kubernetes.io/managed-by: Helm - name: kubelet-csr-approver -rules: - - apiGroups: - - coordination.k8s.io - resources: - - leases - verbs: - - create - - get - - update - - apiGroups: - - "" - resources: - - events - verbs: - - create - - apiGroups: - - certificates.k8s.io - resources: - - certificatesigningrequests - verbs: - - get - - list - - watch - - apiGroups: - - certificates.k8s.io - resources: - - certificatesigningrequests/approval - verbs: - - update - - apiGroups: - - certificates.k8s.io - resourceNames: - - kubernetes.io/kubelet-serving - resources: - - signers - verbs: - - approve ---- -apiVersion: rbac.authorization.k8s.io/v1 -kind: ClusterRoleBinding -metadata: - annotations: - meta.helm.sh/release-name: kubelet-csr-approver - meta.helm.sh/release-namespace: kube-system - labels: - app.kubernetes.io/managed-by: Helm - name: kubelet-csr-approver - namespace: kube-system -roleRef: - apiGroup: rbac.authorization.k8s.io - kind: ClusterRole - name: kubelet-csr-approver -subjects: - - kind: ServiceAccount - name: kubelet-csr-approver - namespace: kube-system ---- -apiVersion: v1 -kind: Service -metadata: - annotations: - meta.helm.sh/release-name: kubelet-csr-approver - meta.helm.sh/release-namespace: kube-system - prometheus.io/port: "8080" - prometheus.io/scrape: "true" - labels: - app.kubernetes.io/instance: kubelet-csr-approver - app.kubernetes.io/managed-by: Helm - app.kubernetes.io/name: kubelet-csr-approver - app.kubernetes.io/version: v1.2.1 - helm.sh/chart: kubelet-csr-approver-1.2.1 - name: kubelet-csr-approver - namespace: kube-system -spec: - ports: - - name: metrics - port: 8080 - protocol: TCP - targetPort: metrics - selector: - app.kubernetes.io/instance: kubelet-csr-approver - app.kubernetes.io/managed-by: Helm - app.kubernetes.io/name: kubelet-csr-approver - type: ClusterIP ---- -apiVersion: apps/v1 -kind: Deployment -metadata: - annotations: - meta.helm.sh/release-name: kubelet-csr-approver - meta.helm.sh/release-namespace: kube-system - labels: - app.kubernetes.io/instance: kubelet-csr-approver - app.kubernetes.io/managed-by: Helm - app.kubernetes.io/name: kubelet-csr-approver - app.kubernetes.io/version: v1.2.1 - helm.sh/chart: kubelet-csr-approver-1.2.1 - name: kubelet-csr-approver - namespace: kube-system -spec: - replicas: 1 - selector: - matchLabels: - app.kubernetes.io/instance: kubelet-csr-approver - app.kubernetes.io/managed-by: Helm - app.kubernetes.io/name: kubelet-csr-approver - template: - metadata: - annotations: - meta.helm.sh/release-name: kubelet-csr-approver - meta.helm.sh/release-namespace: kube-system - labels: - app.kubernetes.io/instance: kubelet-csr-approver - app.kubernetes.io/managed-by: Helm - app.kubernetes.io/name: kubelet-csr-approver - spec: - containers: - - args: - - -metrics-bind-address - - :8080 - - -health-probe-bind-address - - :8081 - - -leader-election - env: - - name: ALLOWED_DNS_NAMES - value: "1" - image: ghcr.io/postfinance/kubelet-csr-approver:v1.2.1 - imagePullPolicy: IfNotPresent - livenessProbe: - httpGet: - path: /healthz - port: 8081 - name: kubelet-csr-approver - ports: - - containerPort: 8080 - name: metrics - protocol: TCP - resources: - limits: - cpu: 500m - memory: 128Mi - requests: - cpu: 100m - memory: 64Mi - securityContext: - allowPrivilegeEscalation: false - capabilities: - drop: - - all - privileged: false - readOnlyRootFilesystem: true - runAsGroup: 65532 - runAsNonRoot: true - runAsUser: 65532 - seccompProfile: - type: RuntimeDefault - securityContext: {} - serviceAccountName: kubelet-csr-approver - tolerations: - - effect: NoSchedule - key: node-role.kubernetes.io/control-plane - operator: Equal - name: wget - restartPolicy: Never diff --git a/archive/removereleases.py b/archive/scripts/removereleases.py similarity index 100% rename from archive/removereleases.py rename to archive/scripts/removereleases.py diff --git a/charts/incubator/spegel/.helmignore b/charts/incubator/spegel/.helmignore deleted file mode 100644 index feb7464da6f..00000000000 --- a/charts/incubator/spegel/.helmignore +++ /dev/null @@ -1,32 +0,0 @@ -# Patterns to ignore when building packages. -# This supports shell glob matching, relative path matching, and -# negation (prefixed with !). Only one pattern per line. -.DS_Store -# Common VCS dirs -.git/ -.gitignore -.bzr/ -.bzrignore -.hg/ -.hgignore -.svn/ -# Common backup files -*.swp -*.bak -*.tmp -*~ -# Various IDEs -.project -.idea/ -*.tmproj -.vscode/ -# OWNERS file for Kubernetes -OWNERS -# helm-docs templates -*.gotmpl -# docs folder -/docs -# icon -icon.png -icon.webp -icon-small.webp diff --git a/charts/incubator/spegel/icon.webp b/charts/incubator/spegel/icon.webp deleted file mode 100644 index c876cb18cc1..00000000000 Binary files a/charts/incubator/spegel/icon.webp and /dev/null differ diff --git a/charts/incubator/spegel/templates/NOTES.txt b/charts/incubator/spegel/templates/NOTES.txt deleted file mode 100644 index efcb74cb772..00000000000 --- a/charts/incubator/spegel/templates/NOTES.txt +++ /dev/null @@ -1 +0,0 @@ -{{- include "tc.v1.common.lib.chart.notes" $ -}} diff --git a/archive/charts/system/spegel/.helmignore b/charts/system/spegel/.helmignore similarity index 100% rename from archive/charts/system/spegel/.helmignore rename to charts/system/spegel/.helmignore diff --git a/charts/incubator/spegel/Chart.yaml b/charts/system/spegel/Chart.yaml similarity index 100% rename from charts/incubator/spegel/Chart.yaml rename to charts/system/spegel/Chart.yaml diff --git a/charts/incubator/spegel/README.md b/charts/system/spegel/README.md similarity index 100% rename from charts/incubator/spegel/README.md rename to charts/system/spegel/README.md diff --git a/charts/incubator/spegel/ci/ci-values.yaml b/charts/system/spegel/ci/ci-values.yaml similarity index 100% rename from charts/incubator/spegel/ci/ci-values.yaml rename to charts/system/spegel/ci/ci-values.yaml diff --git a/charts/incubator/spegel/dashboard.json b/charts/system/spegel/dashboard.json similarity index 100% rename from charts/incubator/spegel/dashboard.json rename to charts/system/spegel/dashboard.json diff --git a/archive/charts/system/spegel/icon.webp b/charts/system/spegel/icon.webp similarity index 100% rename from archive/charts/system/spegel/icon.webp rename to charts/system/spegel/icon.webp diff --git a/archive/charts/system/spegel/templates/NOTES.txt b/charts/system/spegel/templates/NOTES.txt similarity index 100% rename from archive/charts/system/spegel/templates/NOTES.txt rename to charts/system/spegel/templates/NOTES.txt diff --git a/charts/incubator/spegel/templates/_args.tpl b/charts/system/spegel/templates/_args.tpl similarity index 100% rename from charts/incubator/spegel/templates/_args.tpl rename to charts/system/spegel/templates/_args.tpl diff --git a/charts/incubator/spegel/templates/common.yaml b/charts/system/spegel/templates/common.yaml similarity index 100% rename from charts/incubator/spegel/templates/common.yaml rename to charts/system/spegel/templates/common.yaml diff --git a/charts/incubator/spegel/values.yaml b/charts/system/spegel/values.yaml similarity index 100% rename from charts/incubator/spegel/values.yaml rename to charts/system/spegel/values.yaml