From 4f269e28ebce61139fb9c09fe0bd545402190ffe Mon Sep 17 00:00:00 2001 From: RPRX <63339210+rprx@users.noreply.github.com> Date: Wed, 25 Nov 2020 05:26:10 +0000 Subject: [PATCH] Add files via upload --- LICENSE | 674 +++++++++++++++++++++++++++++++++++++++++ README.md | 41 ++- install-dat-release.sh | 74 +++++ install-release.sh | 596 ++++++++++++++++++++++++++++++++++++ 4 files changed, 1383 insertions(+), 2 deletions(-) create mode 100644 LICENSE create mode 100644 install-dat-release.sh create mode 100644 install-release.sh diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +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/README.md b/README.md index cc38500..12a3a1b 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,39 @@ -# X-ray-install -Easiest way to install & upgrade X-ray. +# Xray-install + +Bash script for installing Xray in operating systems such as CentOS / Debian / OpenSUSE that support systemd. + +[Filesystem Hierarchy Standard (FHS)](https://en.wikipedia.org/wiki/Filesystem_Hierarchy_Standard) + +``` +installed: /usr/local/bin/xray +installed: /usr/local/etc/xray/*.json + +installed: /usr/local/share/xray/geoip.dat +installed: /usr/local/share/xray/geosite.dat + +installed: /var/log/xray/access.log +installed: /var/log/xray/error.log + +installed: /etc/systemd/system/xray.service +installed: /etc/systemd/system/xray@.service +``` + +## Usage + +### Install & Upgrade Xray-core and .dat files + +``` +# bash <(curl -L https://raw.githubusercontent.com/XTLS/Xray-install/main/install-release.sh) +``` + +### Update geoip.dat and geosite.dat only + +``` +# bash <(curl -L https://raw.githubusercontent.com/XTLS/Xray-install/main/install-dat-release.sh) +``` + +### Remove Xray, except json and logs + +``` +# bash <(curl -L https://raw.githubusercontent.com/XTLS/Xray-install/main/install-release.sh) --remove +``` diff --git a/install-dat-release.sh b/install-dat-release.sh new file mode 100644 index 0000000..9ade6a5 --- /dev/null +++ b/install-dat-release.sh @@ -0,0 +1,74 @@ +#!/bin/bash + +# This Bash script to install the latest release of geoip.dat and geosite.dat: + +# https://github.com/v2fly/geoip +# https://github.com/v2fly/domain-list-community + +# Depends on cURL, please solve it yourself + +# You may plan to execute this Bash script regularly: + +# install -m 755 install-dat-release.sh /usr/local/bin/install-dat-release + +# 0 0 * * * /usr/local/bin/install-dat-release > /dev/null 2>&1 + +# You can modify it to /usr/local/lib/xray +XRAY="/usr/local/share/xray" +DOWNLOAD_LINK_GEOIP="https://github.com/v2fly/geoip/releases/latest/download/geoip.dat" +DOWNLOAD_LINK_GEOSITE="https://github.com/v2fly/domain-list-community/releases/latest/download/dlc.dat" +file_ip='geoip.dat' +file_dlc='dlc.dat' +file_site='geosite.dat' +dir_tmp="$(mktemp -d)" + +curl() { + $(type -P curl) -L -q --retry 5 --retry-delay 10 --retry-max-time 60 "$@" +} + +check_if_running_as_root() { + # If you want to run as another user, please modify $UID to be owned by this user + if [[ "$UID" -ne '0' ]]; then + echo "error: You must run this script as root!" + exit 1 + fi +} + +download_files() { + if ! curl -R -H 'Cache-Control: no-cache' -o "${dir_tmp}/${2}" "${1}"; then + echo 'error: Download failed! Please check your network or try again.' + exit 1 + fi + if ! curl -R -H 'Cache-Control: no-cache' -o "${dir_tmp}/${2}.sha256sum" "${1}.sha256sum"; then + echo 'error: Download failed! Please check your network or try again.' + exit 1 + fi +} + +check_sum() { + ( + cd "${dir_tmp}" || exit + for i in "${dir_tmp}"/*.sha256sum; do + if ! sha256sum -c "${i}"; then + echo 'error: Check failed! Please check your network or try again.' + exit 1 + fi + done + ) +} + +install_file() { + install -m 644 "${dir_tmp}"/${file_dlc} "${XRAY}"/${file_site} + install -m 644 "${dir_tmp}"/${file_ip} "${XRAY}"/${file_ip} + rm -r "${dir_tmp}" +} + +main() { + check_if_running_as_root + download_files $DOWNLOAD_LINK_GEOIP $file_ip + download_files $DOWNLOAD_LINK_GEOSITE $file_dlc + check_sum + install_file +} + +main "$@" diff --git a/install-release.sh b/install-release.sh new file mode 100644 index 0000000..cb1b400 --- /dev/null +++ b/install-release.sh @@ -0,0 +1,596 @@ +#!/bin/bash + +# The files installed by the script conform to the Filesystem Hierarchy Standard: +# https://wiki.linuxfoundation.org/lsb/fhs + +# The URL of the script project is: +# https://github.com/XTLS/Xray-install + +# The URL of the script is: +# https://raw.githubusercontent.com/XTLS/Xray-install/main/install-release.sh + +# If the script executes incorrectly, go to: +# https://github.com/XTLS/Xray-install/issues + +# You can set this variable whatever you want in shell session right before running this script by issuing: +# export DAT_PATH='/usr/local/share/xray' +DAT_PATH=${DAT_PATH:-/usr/local/share/xray} + +# You can set this variable whatever you want in shell session right before running this script by issuing: +# export JSON_PATH='/usr/local/etc/xray' +JSON_PATH=${JSON_PATH:-/usr/local/etc/xray} + +# Set this variable only if you are starting xray with multiple configuration files: +# export JSONS_PATH='/usr/local/etc/xray' + +# Set this variable only if you want this script to check all the systemd unit file: +# export check_all_service_files='yes' + +curl() { + $(type -P curl) -L -q --retry 5 --retry-delay 10 --retry-max-time 60 "$@" +} + +systemd_cat_config() { + if systemd-analyze --help | grep -qw 'cat-config'; then + systemd-analyze --no-pager cat-config "$@" + echo + else + echo "${aoi}~~~~~~~~~~~~~~~~" + cat "$@" "$1".d/* + echo "${aoi}~~~~~~~~~~~~~~~~" + echo "${red}warning: ${green}The systemd version on the current operating system is too low." + echo "${red}warning: ${green}Please consider to upgrade the systemd or the operating system.${reset}" + echo + fi +} + +check_if_running_as_root() { + # If you want to run as another user, please modify $UID to be owned by this user + if [[ "$UID" -ne '0' ]]; then + echo "error: You must run this script as root!" + exit 1 + fi +} + +identify_the_operating_system_and_architecture() { + if [[ "$(uname)" == 'Linux' ]]; then + case "$(uname -m)" in + 'i386' | 'i686') + MACHINE='32' + ;; + 'amd64' | 'x86_64') + MACHINE='64' + ;; + 'armv5tel') + MACHINE='arm32-v5' + ;; + 'armv6l') + MACHINE='arm32-v6' + ;; + 'armv7' | 'armv7l') + MACHINE='arm32-v7a' + ;; + 'armv8' | 'aarch64') + MACHINE='arm64-v8a' + ;; + 'mips') + MACHINE='mips32' + ;; + 'mipsle') + MACHINE='mips32le' + ;; + 'mips64') + MACHINE='mips64' + ;; + 'mips64le') + MACHINE='mips64le' + ;; + 'ppc64') + MACHINE='ppc64' + ;; + 'ppc64le') + MACHINE='ppc64le' + ;; + 'riscv64') + MACHINE='riscv64' + ;; + 's390x') + MACHINE='s390x' + ;; + *) + echo "error: The architecture is not supported." + exit 1 + ;; + esac + if [[ ! -f '/etc/os-release' ]]; then + echo "error: Don't use outdated Linux distributions." + exit 1 + fi + # Do not combine this judgment condition with the following judgment condition. + ## Be aware of Linux distribution like Gentoo, which kernel supports switch between Systemd and OpenRC. + if [[ -f /.dockerenv ]] || grep -q 'docker\|lxc' /proc/1/cgroup && [[ "$(type -P systemctl)" ]]; then + true + elif [[ -d /run/systemd/system ]] || grep -q systemd <(ls -l /sbin/init); then + true + else + echo "error: Only Linux distributions using systemd are supported." + exit 1 + fi + if [[ "$(type -P apt)" ]]; then + PACKAGE_MANAGEMENT_INSTALL='apt -y --no-install-recommends install' + PACKAGE_MANAGEMENT_REMOVE='apt purge' + package_provide_tput='ncurses-bin' + elif [[ "$(type -P dnf)" ]]; then + PACKAGE_MANAGEMENT_INSTALL='dnf -y install' + PACKAGE_MANAGEMENT_REMOVE='dnf remove' + package_provide_tput='ncurses' + elif [[ "$(type -P yum)" ]]; then + PACKAGE_MANAGEMENT_INSTALL='yum -y install' + PACKAGE_MANAGEMENT_REMOVE='yum remove' + package_provide_tput='ncurses' + elif [[ "$(type -P zypper)" ]]; then + PACKAGE_MANAGEMENT_INSTALL='zypper install -y --no-recommends' + PACKAGE_MANAGEMENT_REMOVE='zypper remove' + package_provide_tput='ncurses-utils' + elif [[ "$(type -P pacman)" ]]; then + PACKAGE_MANAGEMENT_INSTALL='pacman -Syu --noconfirm' + PACKAGE_MANAGEMENT_REMOVE='pacman -Rsn' + package_provide_tput='ncurses' + else + echo "error: The script does not support the package manager in this operating system." + exit 1 + fi + else + echo "error: This operating system is not supported." + exit 1 + fi +} + +## Demo function for processing parameters +judgment_parameters() { + while [[ "$#" -gt '0' ]]; do + case "$1" in + '--remove') + if [[ "$#" -gt '1' ]]; then + echo 'error: Please enter the correct parameters.' + exit 1 + fi + REMOVE='1' + ;; + '--version') + VERSION="${2:?error: Please specify the correct version.}" + break + ;; + '-c' | '--check') + CHECK='1' + break + ;; + '-f' | '--force') + FORCE='1' + break + ;; + '-h' | '--help') + HELP='1' + break + ;; + '-l' | '--local') + LOCAL_INSTALL='1' + LOCAL_FILE="${2:?error: Please specify the correct local file.}" + break + ;; + '-p' | '--proxy') + if [[ -z "${2:?error: Please specify the proxy server address.}" ]]; then + exit 1 + fi + PROXY="$2" + shift + ;; + *) + echo "$0: unknown option -- -" + exit 1 + ;; + esac + shift + done +} + +install_software() { + package_name="$1" + file_to_detect="$2" + type -P "$file_to_detect" > /dev/null 2>&1 && return + if ${PACKAGE_MANAGEMENT_INSTALL} "$package_name"; then + echo "info: $package_name is installed." + else + echo "error: Installation of $package_name failed, please check your network." + exit 1 + fi +} + +get_version() { + # 0: Install or update Xray. + # 1: Installed or no new version of Xray. + # 2: Install the specified version of Xray. + if [[ -n "$VERSION" ]]; then + RELEASE_VERSION="v${VERSION#v}" + return 2 + fi + # Determine the version number for Xray installed from a local file + if [[ -f '/usr/local/bin/xray' ]]; then + VERSION="$(/usr/local/bin/xray -version | awk 'NR==1 {print $2}')" + CURRENT_VERSION="v${VERSION#v}" + if [[ "$LOCAL_INSTALL" -eq '1' ]]; then + RELEASE_VERSION="$CURRENT_VERSION" + return + fi + fi + # Get Xray release version number + TMP_FILE="$(mktemp)" + if ! curl -x "${PROXY}" -sS -H "Accept: application/vnd.github.v3+json" -o "$TMP_FILE" 'https://api.github.com/repos/XTLS/Xray-core/releases/latest'; then + "rm" "$TMP_FILE" + echo 'error: Failed to get release list, please check your network.' + exit 1 + fi + RELEASE_LATEST="$(sed 'y/,/\n/' "$TMP_FILE" | grep 'tag_name' | awk -F '"' '{print $4}')" + "rm" "$TMP_FILE" + RELEASE_VERSION="v${RELEASE_LATEST#v}" + # Compare Xray version numbers + if [[ "$RELEASE_VERSION" != "$CURRENT_VERSION" ]]; then + RELEASE_VERSIONSION_NUMBER="${RELEASE_VERSION#v}" + RELEASE_MAJOR_VERSION_NUMBER="${RELEASE_VERSIONSION_NUMBER%%.*}" + RELEASE_MINOR_VERSION_NUMBER="$(echo "$RELEASE_VERSIONSION_NUMBER" | awk -F '.' '{print $2}')" + RELEASE_MINIMUM_VERSION_NUMBER="${RELEASE_VERSIONSION_NUMBER##*.}" + # shellcheck disable=SC2001 + CURRENT_VERSIONSION_NUMBER="$(echo "${CURRENT_VERSION#v}" | sed 's/-.*//')" + CURRENT_MAJOR_VERSION_NUMBER="${CURRENT_VERSIONSION_NUMBER%%.*}" + CURRENT_MINOR_VERSION_NUMBER="$(echo "$CURRENT_VERSIONSION_NUMBER" | awk -F '.' '{print $2}')" + CURRENT_MINIMUM_VERSION_NUMBER="${CURRENT_VERSIONSION_NUMBER##*.}" + if [[ "$RELEASE_MAJOR_VERSION_NUMBER" -gt "$CURRENT_MAJOR_VERSION_NUMBER" ]]; then + return 0 + elif [[ "$RELEASE_MAJOR_VERSION_NUMBER" -eq "$CURRENT_MAJOR_VERSION_NUMBER" ]]; then + if [[ "$RELEASE_MINOR_VERSION_NUMBER" -gt "$CURRENT_MINOR_VERSION_NUMBER" ]]; then + return 0 + elif [[ "$RELEASE_MINOR_VERSION_NUMBER" -eq "$CURRENT_MINOR_VERSION_NUMBER" ]]; then + if [[ "$RELEASE_MINIMUM_VERSION_NUMBER" -gt "$CURRENT_MINIMUM_VERSION_NUMBER" ]]; then + return 0 + else + return 1 + fi + else + return 1 + fi + else + return 1 + fi + elif [[ "$RELEASE_VERSION" == "$CURRENT_VERSION" ]]; then + return 1 + fi +} + +download_xray() { + DOWNLOAD_LINK="https://github.com/XTLS/Xray-core/releases/download/$RELEASE_VERSION/Xray-linux-$MACHINE.zip" + echo "Downloading Xray archive: $DOWNLOAD_LINK" + if ! curl -x "${PROXY}" -R -H 'Cache-Control: no-cache' -o "$ZIP_FILE" "$DOWNLOAD_LINK"; then + echo 'error: Download failed! Please check your network or try again.' + return 1 + fi + echo "Downloading verification file for Xray archive: $DOWNLOAD_LINK.dgst" + if ! curl -x "${PROXY}" -sSR -H 'Cache-Control: no-cache' -o "$ZIP_FILE.dgst" "$DOWNLOAD_LINK.dgst"; then + echo 'error: Download failed! Please check your network or try again.' + return 1 + fi + if [[ "$(cat "$ZIP_FILE".dgst)" == 'Not Found' ]]; then + echo 'error: This version does not support verification. Please replace with another version.' + return 1 + fi + + # Verification of Xray archive + for LISTSUM in 'md5' 'sha1' 'sha256' 'sha512'; do + SUM="$(${LISTSUM}sum "$ZIP_FILE" | sed 's/ .*//')" + CHECKSUM="$(grep ${LISTSUM^^} "$ZIP_FILE".dgst | grep "$SUM" -o -a | uniq)" + if [[ "$SUM" != "$CHECKSUM" ]]; then + echo 'error: Check failed! Please check your network or try again.' + return 1 + fi + done +} + +decompression() { + if ! unzip -q "$1" -d "$TMP_DIRECTORY"; then + echo 'error: Xray decompression failed.' + "rm" -r "$TMP_DIRECTORY" + echo "removed: $TMP_DIRECTORY" + exit 1 + fi + echo "info: Extract the Xray package to $TMP_DIRECTORY and prepare it for installation." +} + +install_file() { + NAME="$1" + if [[ "$NAME" == 'xray' ]]; then + install -m 755 "${TMP_DIRECTORY}/$NAME" "/usr/local/bin/$NAME" + elif [[ "$NAME" == 'geoip.dat' ]] || [[ "$NAME" == 'geosite.dat' ]]; then + install -m 644 "${TMP_DIRECTORY}/$NAME" "${DAT_PATH}/$NAME" + fi +} + +install_xray() { + # Install Xray binary to /usr/local/bin/ and $DAT_PATH + install_file xray + install -d "$DAT_PATH" + # If the file exists, geoip.dat and geosite.dat will not be installed or updated + if [[ ! -f "${DAT_PATH}/.undat" ]]; then + install_file geoip.dat + install_file geosite.dat + fi + + # Install Xray configuration file to $JSON_PATH + # shellcheck disable=SC2153 + if [[ -z "$JSONS_PATH" ]] && [[ ! -d "$JSON_PATH" ]]; then + install -d "$JSON_PATH" + echo "{}" > "${JSON_PATH}/config.json" + CONFIG_NEW='1' + fi + + # Install Xray configuration file to $JSONS_PATH + if [[ -n "$JSONS_PATH" ]] && [[ ! -d "$JSONS_PATH" ]]; then + install -d "$JSONS_PATH" + for BASE in 00_log 01_api 02_dns 03_routing 04_policy 05_inbounds 06_outbounds 07_transport 08_stats 09_reverse; do + echo '{}' > "${JSONS_PATH}/${BASE}.json" + done + CONFDIR='1' + fi + + # Used to store Xray log files + if [[ ! -d '/var/log/xray/' ]]; then + if id nobody | grep -qw 'nogroup'; then + install -d -m 700 -o nobody -g nogroup /var/log/xray/ + install -m 600 -o nobody -g nogroup /dev/null /var/log/xray/access.log + install -m 600 -o nobody -g nogroup /dev/null /var/log/xray/error.log + else + install -d -m 700 -o nobody -g nobody /var/log/xray/ + install -m 600 -o nobody -g nobody /dev/null /var/log/xray/access.log + install -m 600 -o nobody -g nobody /dev/null /var/log/xray/error.log + fi + LOG='1' + fi +} + +install_startup_service_file() { + install -m 644 "${TMP_DIRECTORY}/systemd/system/xray.service" /etc/systemd/system/xray.service + install -m 644 "${TMP_DIRECTORY}/systemd/system/xray@.service" /etc/systemd/system/xray@.service + mkdir -p '/etc/systemd/system/xray.service.d' + mkdir -p '/etc/systemd/system/xray@.service.d/' + if [[ -n "$JSONS_PATH" ]]; then + "rm" '/etc/systemd/system/xray.service.d/10-donot_touch_single_conf.conf' \ + '/etc/systemd/system/xray@.service.d/10-donot_touch_single_conf.conf' + echo "# In case you have a good reason to do so, duplicate this file in the same directory and make your customizes there. +# Or all changes you made will be lost! # Refer: https://www.freedesktop.org/software/systemd/man/systemd.unit.html +[Service] +ExecStart= +ExecStart=/usr/local/bin/xray -confdir $JSONS_PATH" | + tee '/etc/systemd/system/xray.service.d/10-donot_touch_multi_conf.conf' > \ + '/etc/systemd/system/xray@.service.d/10-donot_touch_multi_conf.conf' + else + "rm" '/etc/systemd/system/xray.service.d/10-donot_touch_multi_conf.conf' \ + '/etc/systemd/system/xray@.service.d/10-donot_touch_multi_conf.conf' + echo "# In case you have a good reason to do so, duplicate this file in the same directory and make your customizes there. +# Or all changes you made will be lost! # Refer: https://www.freedesktop.org/software/systemd/man/systemd.unit.html +[Service] +ExecStart= +ExecStart=/usr/local/bin/xray -config ${JSON_PATH}/config.json" > \ + '/etc/systemd/system/xray.service.d/10-donot_touch_single_conf.conf' + echo "# In case you have a good reason to do so, duplicate this file in the same directory and make your customizes there. +# Or all changes you made will be lost! # Refer: https://www.freedesktop.org/software/systemd/man/systemd.unit.html +[Service] +ExecStart= +ExecStart=/usr/local/bin/xray -config ${JSON_PATH}/%i.json" > \ + '/etc/systemd/system/xray@.service.d/10-donot_touch_single_conf.conf' + fi + echo "info: Systemd service files have been installed successfully!" + echo "${red}warning: ${green}The following are the actual parameters for the xray service startup." + echo "${red}warning: ${green}Please make sure the configuration file path is correctly set.${reset}" + systemd_cat_config /etc/systemd/system/xray.service + # shellcheck disable=SC2154 + if [[ x"${check_all_service_files:0:1}" = x'y' ]]; then + echo + echo + systemd_cat_config /etc/systemd/system/xray@.service + fi + systemctl daemon-reload + SYSTEMD='1' +} + +start_xray() { + if [[ -f '/etc/systemd/system/xray.service' ]]; then + if systemctl start "${XRAY_CUSTOMIZE:-xray}"; then + echo 'info: Start the Xray service.' + else + echo 'error: Failed to start Xray service.' + exit 1 + fi + fi +} + +stop_xray() { + XRAY_CUSTOMIZE="$(systemctl list-units | grep 'xray@' | awk -F ' ' '{print $1}')" + if [[ -z "$XRAY_CUSTOMIZE" ]]; then + local xray_daemon_to_stop='xray.service' + else + local xray_daemon_to_stop="$XRAY_CUSTOMIZE" + fi + if ! systemctl stop "$xray_daemon_to_stop"; then + echo 'error: Stopping the Xray service failed.' + exit 1 + fi + echo 'info: Stop the Xray service.' +} + +check_update() { + if [[ -f '/etc/systemd/system/xray.service' ]]; then + get_version + local get_ver_exit_code=$? + if [[ "$get_ver_exit_code" -eq '0' ]]; then + echo "info: Found the latest release of Xray $RELEASE_VERSION . (Current release: $CURRENT_VERSION)" + elif [[ "$get_ver_exit_code" -eq '1' ]]; then + echo "info: No new version. The current version of Xray is $CURRENT_VERSION ." + fi + exit 0 + else + echo 'error: Xray is not installed.' + exit 1 + fi +} + +remove_xray() { + if systemctl list-unit-files | grep -qw 'xray'; then + if [[ -n "$(pidof xray)" ]]; then + stop_xray + fi + if ! ("rm" -r '/usr/local/bin/xray' \ + "$DAT_PATH" \ + '/etc/systemd/system/xray.service' \ + '/etc/systemd/system/xray@.service' \ + '/etc/systemd/system/xray.service.d' \ + '/etc/systemd/system/xray@.service.d'); then + echo 'error: Failed to remove Xray.' + exit 1 + else + echo 'removed: /usr/local/bin/xray' + echo "removed: $DAT_PATH" + echo 'removed: /etc/systemd/system/xray.service' + echo 'removed: /etc/systemd/system/xray@.service' + echo 'removed: /etc/systemd/system/xray.service.d' + echo 'removed: /etc/systemd/system/xray@.service.d' + echo 'Please execute the command: systemctl disable xray' + echo "You may need to execute a command to remove dependent software: $PACKAGE_MANAGEMENT_REMOVE curl unzip" + echo 'info: Xray has been removed.' + echo 'info: If necessary, manually delete the configuration and log files.' + if [[ -n "$JSONS_PATH" ]]; then + echo "info: e.g., $JSONS_PATH and /var/log/xray/ ..." + else + echo "info: e.g., $JSON_PATH and /var/log/xray/ ..." + fi + exit 0 + fi + else + echo 'error: Xray is not installed.' + exit 1 + fi +} + +# Explanation of parameters in the script +show_help() { + echo "usage: $0 [--remove | --version number | -c | -f | -h | -l | -p]" + echo ' [-p address] [--version number | -c | -f]' + echo ' --remove Remove Xray' + echo ' --version Install the specified version of Xray, e.g., --version v1.0.0' + echo ' -c, --check Check if Xray can be updated' + echo ' -f, --force Force installation of the latest version of Xray' + echo ' -h, --help Show help' + echo ' -l, --local Install Xray from a local file' + echo ' -p, --proxy Download through a proxy server, e.g., -p http://127.0.0.1:8118 or -p socks5://127.0.0.1:1080' + exit 0 +} + +main() { + check_if_running_as_root + identify_the_operating_system_and_architecture + judgment_parameters "$@" + + install_software "$package_provide_tput" 'tput' + red=$(tput setaf 1) + green=$(tput setaf 2) + aoi=$(tput setaf 6) + reset=$(tput sgr0) + + # Parameter information + [[ "$HELP" -eq '1' ]] && show_help + [[ "$CHECK" -eq '1' ]] && check_update + [[ "$REMOVE" -eq '1' ]] && remove_xray + + # Two very important variables + TMP_DIRECTORY="$(mktemp -d)" + ZIP_FILE="${TMP_DIRECTORY}/Xray-linux-$MACHINE.zip" + + # Install Xray from a local file, but still need to make sure the network is available + if [[ "$LOCAL_INSTALL" -eq '1' ]]; then + echo 'warn: Install Xray from a local file, but still need to make sure the network is available.' + echo -n 'warn: Please make sure the file is valid because we cannot confirm it. (Press any key) ...' + read -r + install_software 'unzip' 'unzip' + decompression "$LOCAL_FILE" + else + # Normal way + install_software 'curl' 'curl' + get_version + NUMBER="$?" + if [[ "$NUMBER" -eq '0' ]] || [[ "$FORCE" -eq '1' ]] || [[ "$NUMBER" -eq 2 ]]; then + echo "info: Installing Xray $RELEASE_VERSION for $(uname -m)" + download_xray + if [[ "$?" -eq '1' ]]; then + "rm" -r "$TMP_DIRECTORY" + echo "removed: $TMP_DIRECTORY" + exit 1 + fi + install_software 'unzip' 'unzip' + decompression "$ZIP_FILE" + elif [[ "$NUMBER" -eq '1' ]]; then + echo "info: No new version. The current version of Xray is $CURRENT_VERSION ." + exit 0 + fi + fi + + # Determine if Xray is running + if systemctl list-unit-files | grep -qw 'xray'; then + if [[ -n "$(pidof xray)" ]]; then + stop_xray + XRAY_RUNNING='1' + fi + fi + install_xray + install_startup_service_file + echo 'installed: /usr/local/bin/xray' + # If the file exists, the content output of installing or updating geoip.dat and geosite.dat will not be displayed + if [[ ! -f "${DAT_PATH}/.undat" ]]; then + echo "installed: ${DAT_PATH}/geoip.dat" + echo "installed: ${DAT_PATH}/geosite.dat" + fi + if [[ "$CONFIG_NEW" -eq '1' ]]; then + echo "installed: ${JSON_PATH}/config.json" + fi + if [[ "$CONFDIR" -eq '1' ]]; then + echo "installed: ${JSON_PATH}/00_log.json" + echo "installed: ${JSON_PATH}/01_api.json" + echo "installed: ${JSON_PATH}/02_dns.json" + echo "installed: ${JSON_PATH}/03_routing.json" + echo "installed: ${JSON_PATH}/04_policy.json" + echo "installed: ${JSON_PATH}/05_inbounds.json" + echo "installed: ${JSON_PATH}/06_outbounds.json" + echo "installed: ${JSON_PATH}/07_transport.json" + echo "installed: ${JSON_PATH}/08_stats.json" + echo "installed: ${JSON_PATH}/09_reverse.json" + fi + if [[ "$LOG" -eq '1' ]]; then + echo 'installed: /var/log/xray/' + echo 'installed: /var/log/xray/access.log' + echo 'installed: /var/log/xray/error.log' + fi + if [[ "$SYSTEMD" -eq '1' ]]; then + echo 'installed: /etc/systemd/system/xray.service' + echo 'installed: /etc/systemd/system/xray@.service' + fi + "rm" -r "$TMP_DIRECTORY" + echo "removed: $TMP_DIRECTORY" + if [[ "$LOCAL_INSTALL" -eq '1' ]]; then + get_version + fi + echo "info: Xray $RELEASE_VERSION is installed." + echo "You may need to execute a command to remove dependent software: $PACKAGE_MANAGEMENT_REMOVE curl unzip" + if [[ "$XRAY_RUNNING" -eq '1' ]]; then + start_xray + else + echo 'Please execute the command: systemctl enable xray; systemctl start xray' + fi +} + +main "$@"