13 Commits

Author SHA1 Message Date
Asif Bacchus 8efaed6bb7 fixed incorrect spacing after stamp to resolve logwatch errs 2019-01-30 11:57:10 -07:00
Asif Bacchus ec36c5ca12 fixed incorrectly quoted variables causing cmd errors 2019-01-30 11:50:25 -07:00
Asif Bacchus 3b7722ab56 quoted all variable expansions to handle spaces properly 2019-01-30 10:13:36 -07:00
Asif Bacchus 26c5fc1f4f cleared up sample notation for remote server 2019-01-30 09:59:02 -07:00
Asif Bacchus b5b52a3025 updated readme to clarify ssh vs borg key passwd 2019-01-30 09:58:41 -07:00
Asif Bacchus 2dce78adbe updated sample PHP paths for version 7.2 in xtraLocations 2019-01-30 09:14:00 -07:00
Asif Bacchus abb2a3983d removed confusing ssh/repo notation in sample nc_borg file 2019-01-30 09:13:15 -07:00
Asif Bacchus 4dc34aa23d removed confusing ssh/repo password references in script 2019-01-30 09:11:51 -07:00
Asif Bacchus b8f96227cc replaced all ${stamp} with [$(stamp)] 2018-10-28 05:24:47 -06:00
Asif Bacchus 9e704bd440 removed static stamp var and replaced with dynamic function 2018-10-28 05:23:43 -06:00
Asif Bacchus 1755144a85 Added /root/.ssh/ to inclusions sample file to include SSH keys 2018-10-23 06:07:48 -06:00
Asif Bacchus 181d0e8a29 added GNU3+ license 2018-10-23 05:42:11 -06:00
Asif Bacchus 2e0138cf8a readme: proofreading and layout changes 2018-10-23 05:40:44 -06:00
5 changed files with 346 additions and 156 deletions
+126
View File
@@ -0,0 +1,126 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright © 2007 Free Software Foundation, Inc. <http s ://fsf.org/>
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.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 <http s ://www.gnu.org/licenses/>.
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:
<program> Copyright (C) <year> <name of author>
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 <http s ://www.gnu.org/licenses/>.
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 <http s ://www.gnu.org/philosophy/why-not-lgpl.html>.
+105 -46
View File
@@ -10,7 +10,7 @@ This script automates the following tasks:
- Optionally copies a 503 error page to your webserver so users know when your - Optionally copies a 503 error page to your webserver so users know when your
server is unavailable due to backups being performed. The 503 file is removed server is unavailable due to backups being performed. The 503 file is removed
when the backup is completed so users can login again when the backup is completed so users can login again
- Dumps mySQL database and adds it to the backup - Dumps the NextCloud mySQL database and adds it to the backup
- Handles entering and exiting NextCloud's maintenance mode to 'lock' accounts - Handles entering and exiting NextCloud's maintenance mode to 'lock' accounts
so changes are not made during the backup process so changes are not made during the backup process
- Allows you to specify additional files you want backed up - Allows you to specify additional files you want backed up
@@ -26,22 +26,26 @@ This script automates the following tasks:
- [Why this script must be run as root](#why-this-script-must-be-run-as-root) - [Why this script must be run as root](#why-this-script-must-be-run-as-root)
- [Script parameters](#script-parameters) - [Script parameters](#script-parameters)
- [Required parameters](#required-parameters) - [Required parameters](#required-parameters)
- [NextCloud data directory: -d _/path/to/data/_](#nextcloud-data-directory--d-_pathtodata_) - [NextCloud data directory: -d _/path/to/data/_](#nextcloud-data-directory--d-pathtodata)
- [NextCloud webroot: -n _/path/to/nextcloud/_](#nextcloud-webroot--n-_pathtonextcloud_) - [NextCloud webroot: -n _/path/to/nextcloud/_](#nextcloud-webroot--n-pathtonextcloud)
- [webuser account: -w _accountName_](#webuser-account--w-_accountname_) - [webuser account: -w _accountName_](#webuser-account--w-accountname)
- [Optional parameters](#optional-parameters) - [Optional parameters](#optional-parameters)
- [Path to 503 error page: -5 _/path/to/filename.html_](#path-to-503-error-page--5-_pathtofilenamehtml_) - [Path to 503 error page: -5 _/path/to/filename.html_](#path-to-503-error-page--5-pathtofilenamehtml)
- [Path to borg details file: -b _/path/to/filename.file_](#path-to-borg-details-file--b-_pathtofilenamefile_) - [Path to borg details file: -b _/path/to/filename.file_](#path-to-borg-details-file--b-pathtofilenamefile)
- [Desired log file location: -l _/path/to/filename.file_](#desired-log-file-location--l-_pathtofilenamefile_) - [Desired log file location: -l _/path/to/filename.file_](#desired-log-file-location--l-pathtofilenamefile)
- [Path to SQL details file: -s _/path/to/filename.file_](#path-to-sql-details-file--s-_pathtofilenamefile_) - [Path to SQL details file: -s _/path/to/filename.file_](#path-to-sql-details-file--s-pathtofilenamefile)
- [Verbose output from borg: -v (no arguments)](#verbose-output-from-borg--v-no-arguments) - [Verbose output from borg: -v (no arguments)](#verbose-output-from-borg--v-no-arguments)
- [Path to webroot: -w _/path/to/webroot/_](#path-to-webroot--w-_pathtowebroot_) - [Path to webroot: -w _/path/to/webroot/_](#path-to-webroot--w-pathtowebroot)
- [Borg details file](#borg-details-file) - [Borg details file](#borg-details-file)
- [Protect your borg details file](#protect-your-borg-details-file) - [Protect your borg details file](#protect-your-borg-details-file)
- [borg specific entries (lines 1-4)](#borg-specific-entries-lines-1-4) - [borg specific entries (lines 1-4)](#borg-specific-entries-lines-1-4)
- [Line 1: Path to borg base directory](#line-1-path-to-borg-base-directory)
- [Line 2: Path to SSH key for remote server](#line-2-path-to-ssh-key-for-remote-server)
- [Line 3: Connection string to remote repo](#line-3-connection-string-to-remote-repo)
- [Line 4: Password for borg repo/repo key](#line-4-password-for-borg-reporepo-key)
- [additional files/directories to backup](#additional-filesdirectories-to-backup) - [additional files/directories to backup](#additional-filesdirectories-to-backup)
- [exclusion patterns](#exclusion-patterns) - [exclusion patterns](#exclusion-patterns)
- [purge timeframe options](#purge-timeframe-options) - [prune timeframe options](#prune-timeframe-options)
- [borg remote location](#borg-remote-location) - [borg remote location](#borg-remote-location)
- [Examples](#examples) - [Examples](#examples)
- [SQL details file](#sql-details-file) - [SQL details file](#sql-details-file)
@@ -71,19 +75,19 @@ Remember to make the script executable!
chmod +x backup.sh chmod +x backup.sh
``` ```
In addition, you can rename this script file to anything you like. The log file In addition, you can rename the script file to anything you like. The log file
will use that same name by default when naming itself and any mention of this will use that same name by default when naming itself and any mention of this
file in the logs will automatically use whatever name you choose to give it. file in the logs will automatically use whatever name you choose to give it.
## Environment notes ## Environment notes
The script is designed to be easy to use but still be flexible enough to The script is designed to be easy to use but still be flexible enough to
accommodate a wide range of NextCloud setups. I have tested it with accommodate a wide range of NextCloud setups. I have tested it with NextCloud
NextCloud 13 and 14 using a standard LEMP setup (Debian Stretch, NGINX, mariaDB 13 and 14 using a standard LEMP setup (Debian Stretch, NGINX, mariaDB & PHP7).
& PHP7). The script accepts several parameters to provide it with the settings The script accepts several parameters to provide it with the settings it
it requires to function. In addition, it reads external files for SQL and borg requires to function. In addition, it reads external plain-text files for SQL
settings so you don't have to weed through the script code to supply things and borg settings so you don't have to weed through the script code to supply
like passwords. things like passwords.
## Why this script must be run as root ## Why this script must be run as root
@@ -99,7 +103,7 @@ You can run the script with the *'-?'* parameter to access the built-in help
which explains the parameters. However, the following is a more detailed which explains the parameters. However, the following is a more detailed
explanation of each parameter and how to use them. explanation of each parameter and how to use them.
**Note that any parameters needing a directory (webroot, nextcloud root, etc.) **Note that any parameters needing a directory (webroot, nextcloud root, etc.)
can be entered with or without the trailing / since it's stripped by the script can be entered with or without the trailing '/' since it's stripped by the script
anyways.** anyways.**
General usage: General usage:
@@ -143,7 +147,8 @@ unavailable' while being backed up. A sample 503 page is included for you.
If you remove the default file or the one you specify is missing, a warning will If you remove the default file or the one you specify is missing, a warning will
be issued by the script but, it will continue executing. More details on the be issued by the script but, it will continue executing. More details on the
503 notification can be found later in the [503 functionality](#503-functionality) section of this 503 notification can be found later in the [503 functionality](#503-functionality) section of this
document. **Default: _scriptpath/503.html_** document.\
**Default: _scriptpath/503.html_**
#### Path to borg details file: -b _/path/to/filename.file_ #### Path to borg details file: -b _/path/to/filename.file_
@@ -151,22 +156,22 @@ This is a text file that lays out various borg options such as repo name,
password, additional files to include, exclusion patters, etc. A sample file is password, additional files to include, exclusion patters, etc. A sample file is
included for your reference. More details, including the *required order* of included for your reference. More details, including the *required order* of
entries can be found later in this document in the [borg details file](#borg-details-file) entries can be found later in this document in the [borg details file](#borg-details-file)
section. section.\
**Default: _scriptpath/nc_borg.details_** **Default: _scriptpath/nc_borg.details_**
#### Desired log file location: -l _/path/to/filename.file_ #### Desired log file location: -l _/path/to/filename.file_
If you have a particular place and filename you'd like this script use for it's If you have a particular place and filename you'd like this script to use for
log, then you can specify it using this parameter. I would recommend it's log, then you can specify it using this parameter. I would recommend
*'/var/log/backup.log'*. By default, the script will name the log file *'/var/log/backup.log'*. By default, the script will name the log file
*scriptname*.log and will save it in the same directory as the script itself. *scriptname*.log and will save it in the same directory as the script itself.\
**Default: _scriptpath/scriptname.log_** **Default: _scriptpath/scriptname.log_**
#### Path to SQL details file: -s _/path/to/filename.file_ #### Path to SQL details file: -s _/path/to/filename.file_
This is a text file containing the details needed to connect to NextCloud's SQL This is a text file containing the details needed to connect to NextCloud's SQL
database. More information about the *required order* of entries can be found database. More information about the *required order* of entries can be found
later in this document in the [sql details file](#sql-details-file) section. later in this document in the [sql details file](#sql-details-file) section.\
**Default: _scriptpath/nc_sql.details_** **Default: _scriptpath/nc_sql.details_**
#### Verbose output from borg: -v (no arguments) #### Verbose output from borg: -v (no arguments)
@@ -194,18 +199,18 @@ document.
## Borg details file ## Borg details file
This file contains all the data needed to access your borg remote data repo. This file contains all the data needed to access your borg remote data repo.
Each line must contain specific information in a specific order or needs to be Each line must contain specific information in a specific order or *needs to be
blank if that data is not required. The sample file includes this data and blank if that data is not required*. The sample file includes this data and
example entries. The file must have the following information in the following example entries. The file must have the following information in the following
order: order:
1. path to borg base directory **(required)** 1. path to borg base directory **(required)**
2. path to ssh private key for repo **(required)** 2. path to ssh private key for remote server **(required)**
3. connection string to remote repo **(required)** 3. connection string to remote repo **(required)**
4. password for ssh key/repo **(required)** 4. password for borg repo/repo key **(required)**
5. path to file listing additional files/directories to backup 5. path to file listing additional files/directories to backup
6. path to file containing borg-specific exclusion patterns 6. path to file containing borg-specific exclusion patterns
7. purge timeframe options 7. prune timeframe options
8. location of borg remote instance 8. location of borg remote instance
### Protect your borg details file ### Protect your borg details file
@@ -225,10 +230,59 @@ chmod 600 nc_borg.details # restrict access to root only (read/write)
If you need help with these options, then you should consult the borg If you need help with these options, then you should consult the borg
documentation or search my blog at documentation or search my blog at
[https://mytechiethoughts.com](https://mytechiethoughts.com) for borg. This is [https://mytechiethoughts.com](https://mytechiethoughts.com) for borg. Here's a
especially true if you want to understand why an SSH key and passphrase are very brief overview:
preferred and why just a passphrase on it's own presents problems automating
borg backups. #### Line 1: Path to borg base directory
This is primary directory on your local system where your borg configuration is
located, **NOT* the path to your borg binary. The base directory contains the
borg configuration, cache, security files and keys.
#### Line 2: Path to SSH key for remote server
This is the SSH key used to connect to your remote (backup) server where your
borg repo is located. **This is NOT your borg repo key!**
> Please note: If you are planning on executing this script via cron or some
> other form of automation, it is *highly recommended* that you use an SSH key
> **without** a password! SSH is designed such that passwords cannot simply be
> passed to it via environment variables, etc. so this is something not easily
> automated by a script such as this for security reasons. As such, your
> computer will sit and wait for you to enter the password and will NOT execute
> the actual backup portion of the script until the SSH key password is provided.
>
> If you really want/need to use an SSH key password, you will have to look into
> somethign like GNOME keyring or SSH-agent to provide a secure automated way to
> provide that password to SSH and allow this script to continue.
>
> In practice, SSH keys without passwords are still quite safe since the key
> must still be known in order to connect and most keys are quite long. In
> addition, they key only connects to the remote server, your actual information
> within the borg repository is still encrypted and secured with both a key and
> password.
#### Line 3: Connection string to remote repo
This is the full server and path required to connect to your borg repo on the
remote server. Very often it is the in the form of:
```
user@servername.tld:repo-name/
```
for rsync.net it is in the following form:
```
username@server-number.rsync.net:repo-name/
```
#### Line 4: Password for borg repo/repo key
This is the password needed to access and decrypt your *borg repo*. Assuming
you set up your borg repo using recommended practices, this will actually be the
password for your *borg repo private key*. **This is NOT your SSH key
password!**
### additional files/directories to backup ### additional files/directories to backup
@@ -259,15 +313,15 @@ what files you'd like borg to ignore during the backup. The sample file,
*'excludeLocations.borg'* contains a list of directories to exclude assuming a *'excludeLocations.borg'* contains a list of directories to exclude assuming a
standard NextCloud install -- the previews directory and the cache directory. standard NextCloud install -- the previews directory and the cache directory.
You need to run *'borg help patterns'* for help on how to specify any additional You need to run *'borg help patterns'* for help on how to specify any additional
exclusion patterns since the format is not your standard BASH format and only exclusion patterns since the format is not standard BASH format and only
sometimes uses standard regex. sometimes uses standard regex.
If you leave this line blank, the script will note it is not processing any If you leave this line blank, the script will note it is not processing any
exclusions and will proceed with backing up all files specified. exclusions and will proceed with backing up all files specified.
### purge timeframe options ### prune timeframe options
Here you can let borg purge know how you want to manage your backup history. Here you can let borg prune know how you want to manage your backup history.
Consult the borg documentation and then copy the relevant options directly into Consult the borg documentation and then copy the relevant options directly into
this line including any spaces, etc. The example file contains the following as this line including any spaces, etc. The example file contains the following as
a staring point: a staring point:
@@ -284,8 +338,8 @@ backups and then an infinite amount of end-of-month backups.
If you're using rsync, then just have this say *'borg1'*. If you are using If you're using rsync, then just have this say *'borg1'*. If you are using
another provider, you'll have to reference their locally installed copy of borg another provider, you'll have to reference their locally installed copy of borg
relative to your repo path. You can also leave this blank if your provider does relative to your home directory. You can also leave this blank if your provider
not run borg locally but your backups/restores will be slower. does not run borg locally but your backups/restores will be slower.
### Examples ### Examples
@@ -296,7 +350,7 @@ backups made in the last 14 days.
```Ini ```Ini
/var/borgbackup /var/borgbackup
/var/borgbackup/SSHprivate.key /var/borgbackup/SSHprivate.key
myuser@server001.rsync.net:NCBackup/ myuser@usw-s001.rsync.net:NCBackup/
myPaSsWoRd myPaSsWoRd
/root/NCscripts/xtraLocations.borg /root/NCscripts/xtraLocations.borg
/root/NCscripts/excludeLocations.borg /root/NCscripts/excludeLocations.borg
@@ -310,7 +364,7 @@ end-of-week
```Ini ```Ini
/var/borgbackup /var/borgbackup
/root/keys/rsyncPrivate.key /root/keys/rsyncPrivate.key
myuser@server001.rsync.net:myBackup/ myuser@usw-s001.rsync.net:myBackup/
PaSsWoRd PaSsWoRd
/var/borgbackup/include.list /var/borgbackup/include.list
@@ -401,7 +455,7 @@ server {
return 503; return 503;
} }
... ...
error_page 530 @backup error_page 503 @backup
location @backup { location @backup {
root /usr/share/nginx/html; root /usr/share/nginx/html;
rewrite ^(.*)$ /503.html break; rewrite ^(.*)$ /503.html break;
@@ -410,11 +464,11 @@ server {
``` ```
This tells NGINX that if it finds the file *'503.html'* at the path This tells NGINX that if it finds the file *'503.html'* at the path
*'/usr/share/nginx/html'* (webroot) then return an error code 503. Next, *'/usr/share/nginx/html'* (webroot) then return an error code 503. When it
rewrite any url to *'domain.tld/503.html'* and thus, display the custom 503 encounters an error 503, rewrite any url to *'domain.tld/503.html'* and thus,
error page. On the other hand, if it can't find 503.html at the path specified display the custom 503 error page. On the other hand, if it can't find 503.html
(i.e. the script has deleted it because the backup is completed), then go about at the path specified (i.e. the script has deleted it because the backup is
business as usual. completed), then go about business as usual.
#### Apache #### Apache
@@ -506,6 +560,11 @@ level as follows:
A detailed breakdown of the files and all options are included in a separate A detailed breakdown of the files and all options are included in a separate
readme in the *'/etc/logwatch'* folder of this git archive. readme in the *'/etc/logwatch'* folder of this git archive.
If you don't really care how it works, then you can just copy the
*/etc/logwatch* folder to the appropriate Logwatch configuration directory for
your system. The file directory layout in this git archive is already correct
for Debian/Ubuntu systems. You will have to update the log-group file to
reflect the path to your script's log file.
### Remember to rotate your logs ### Remember to rotate your logs
The log file generated by this script is fairly detailed so it can grow quite The log file generated by this script is fairly detailed so it can grow quite
+85 -81
View File
@@ -12,7 +12,6 @@ lit="\e[93m"
op="\e[39m" op="\e[39m"
info="\e[96m" info="\e[96m"
note="\e[95m" note="\e[95m"
stamp="[`date +%Y-%m-%d` `date +%H:%M:%S`]"
### Functions ### ### Functions ###
@@ -90,6 +89,11 @@ function scriptHelp {
exit 1 exit 1
} }
### generate dynamic timestamps
function stamp {
echo `date +%F" "%T`
}
### quit -- exit the script after logging any errors, warnings, etc. ### quit -- exit the script after logging any errors, warnings, etc.
function quit { function quit {
# list generated warnings, if any # list generated warnings, if any
@@ -106,7 +110,7 @@ function quit {
fi fi
if [ -z "${exitError}" ]; then if [ -z "${exitError}" ]; then
# exit cleanly # exit cleanly
echo -e "${note}${stamp} --- ${scriptName} completed" \ echo -e "${note}[$(stamp)] --- ${scriptName} completed" \
"---${normal}" >> "$logFile" "---${normal}" >> "$logFile"
exit 0 exit 0
else else
@@ -147,7 +151,7 @@ function checkExist {
### ncMaint - pass requested mode change type to NextCloud occ ### ncMaint - pass requested mode change type to NextCloud occ
function ncMaint { function ncMaint {
sudo -u ${webUser} php ${ncRoot}/occ maintenance:mode --$1 \ sudo -u "${webUser}" php "${ncRoot}/occ" maintenance:mode --"$1" \
>> "$logFile" 2>&1 >> "$logFile" 2>&1
maintResult="$?" maintResult="$?"
return "$maintResult" return "$maintResult"
@@ -162,10 +166,10 @@ function cleanup {
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "0" ]; then if [ "$checkResult" = "0" ]; then
# directory still exists # directory still exists
exitWarn+=("${stamp}_111") exitWarn+=("[$(stamp)]_111")
else else
# directory removed # directory removed
echo -e "${op}${stamp} Removed SQL temp directory${normal}" \ echo -e "${op}[$(stamp)] Removed SQL temp directory${normal}" \
>> "$logFile" >> "$logFile"
fi fi
@@ -173,21 +177,21 @@ function cleanup {
# check value of 'clean503' to see if this is necessary (=1) otherwise, skip # check value of 'clean503' to see if this is necessary (=1) otherwise, skip
if [ "$clean503" = "1" ]; then if [ "$clean503" = "1" ]; then
# proceed with cleanup # proceed with cleanup
echo -e "${op}${stamp} Removing 503 error page..." >> "$logFile" echo -e "${op}[$(stamp)] Removing 503 error page..." >> "$logFile"
rm -f "$webroot/$err503File" >> "$logFile" 2>&1 rm -f "$webroot/$err503File" >> "$logFile" 2>&1
# verify file is actually gone # verify file is actually gone
checkExist ff "$webroot/$err503File" checkExist ff "$webroot/$err503File"
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "0" ]; then if [ "$checkResult" = "0" ]; then
# file still exists # file still exists
exitWarn+=("${stamp}_5030") exitWarn+=("[$(stamp)]_5030")
else else
# file removed # file removed
echo -e "${info}${stamp} -- [INFO] 503 page removed from webroot" \ echo -e "${info}[$(stamp)] -- [INFO] 503 page removed from webroot" \
"--${normal}" >> "$logFile" "--${normal}" >> "$logFile"
fi fi
else else
echo -e "${op}${stamp} 503 error page never copied to webroot," \ echo -e "${op}[$(stamp)] 503 error page never copied to webroot," \
"nothing to cleanup" >> "$logFile" "nothing to cleanup" >> "$logFile"
fi fi
@@ -195,10 +199,10 @@ function cleanup {
ncMaint off ncMaint off
# check if successful # check if successful
if [ "$maintResult" = "0" ]; then if [ "$maintResult" = "0" ]; then
echo -e "${info}${stamp} -- [INFO] NextCloud now in regular" \ echo -e "${info}[$(stamp)] -- [INFO] NextCloud now in regular" \
"operating mode --${normal}" >> "$logFile" "operating mode --${normal}" >> "$logFile"
else else
exitError+=("${stamp}_101") exitError+=("[$(stamp)]_101")
quit quit
fi fi
} }
@@ -273,7 +277,7 @@ warningExplain[5032]="The specified webroot (-w parameter) could not be found"
warningExplain[5033]="No 503 error page could be found. If not using the default located in the script directory, then check your -5 parameter" warningExplain[5033]="No 503 error page could be found. If not using the default located in the script directory, then check your -5 parameter"
warningExplain[5035]="Error copying 503 error page to webroot" warningExplain[5035]="Error copying 503 error page to webroot"
warn503="Web users will NOT be informed the server is down!" warn503="Web users will NOT be informed the server is down!"
warningExplain[2111]="No password used for SSH keys or access to remote borg repo. This is an insecure configuration" warningExplain[2111]="No password used for access to remote borg repo. This is an insecure configuration"
warningExplain[2112]="No remote borg instance specified. Operations will be slower in this configuration" warningExplain[2112]="No remote borg instance specified. Operations will be slower in this configuration"
warningExplain[2113]="The specified file containing extra files for inclusion in borgbackup could not be found" warningExplain[2113]="The specified file containing extra files for inclusion in borgbackup could not be found"
warningExplain[2114]="The specified file containing exclusion patterns for borgbackup could not be found. Backup was performed as though NO exclusions were defined" warningExplain[2114]="The specified file containing exclusion patterns for borgbackup could not be found. Backup was performed as though NO exclusions were defined"
@@ -377,8 +381,8 @@ if [ -z "$webUser" ]; then
exit 1 exit 1
# Check if supplied webUser account exists # Check if supplied webUser account exists
elif [ -n "$webUser" ]; then elif [ -n "$webUser" ]; then
user_exists=$(id -u $webUser > /dev/null 2>&1; echo $?) user_exists=$(id -u "$webUser" > /dev/null 2>&1; echo $?)
if [ $user_exists -ne 0 ]; then if [ "$user_exists" -ne 0 ]; then
echo -e "\n${err}The supplied webuser account (-u parameter) does not" \ echo -e "\n${err}The supplied webuser account (-u parameter) does not" \
"exist.${normal}\n" "exist.${normal}\n"
exit 1 exit 1
@@ -425,9 +429,9 @@ fi
### Log start of script operations ### Log start of script operations
echo -e "${note}${stamp}--- Start $scriptName execution ---${normal}" \ echo -e "${note}[$(stamp)] --- Start $scriptName execution ---${normal}" \
>> "$logFile" >> "$logFile"
echo -e "${info}${stamp}-- [INFO] Log file located at ${lit}${logFile}${info}" \ echo -e "${info}[$(stamp)] -- [INFO] Log file located at ${lit}${logFile}${info}" \
"--${normal}" >> "$logFile" "--${normal}" >> "$logFile"
@@ -438,7 +442,7 @@ export logFile="$logFile"
### Create sqlDump temporary directory and sqlDumpFile name ### Create sqlDump temporary directory and sqlDumpFile name
sqlDumpDir=$( mktemp -d ) sqlDumpDir=$( mktemp -d )
sqlDumpFile="backup-`date +%Y%m%d_%H%M%S`.sql" sqlDumpFile="backup-`date +%Y%m%d_%H%M%S`.sql"
echo -e "${info}${stamp} -- [INFO] mySQL dump file will be stored" \ echo -e "${info}[$(stamp)] -- [INFO] mySQL dump file will be stored" \
"at: ${lit}${sqlDumpDir}/${sqlDumpFile}${normal}" >> "$logFile" "at: ${lit}${sqlDumpDir}/${sqlDumpFile}${normal}" >> "$logFile"
@@ -451,9 +455,9 @@ echo -e "${info}${stamp} -- [INFO] mySQL dump file will be stored" \
## Check if webroot has been specified, if not, skip this entire section since there is nowhere to copy the 503 file. ## Check if webroot has been specified, if not, skip this entire section since there is nowhere to copy the 503 file.
if [ -z "$webroot" ]; then if [ -z "$webroot" ]; then
# no webroot path provided # no webroot path provided
echo -e "${info}${stamp} -- [INFO] ${warn503} --${normal}" \ echo -e "${info}[$(stamp)] -- [INFO] ${warn503} --${normal}" \
>> "$logFile" >> "$logFile"
exitWarn+=("${stamp}_5031") exitWarn+=("[$(stamp)]_5031")
clean503=0 clean503=0
else else
# verify webroot actually exists # verify webroot actually exists
@@ -461,41 +465,41 @@ else
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "1" ]; then if [ "$checkResult" = "1" ]; then
# webroot directory specified could not be found # webroot directory specified could not be found
echo -e "${info}${stamp} -- [INFO] ${warn503} --${normal}" \ echo -e "${info}[$(stamp)] -- [INFO] ${warn503} --${normal}" \
>> "$logFile" >> "$logFile"
exitWarn+=("{$stamp}_5032") exitWarn+=("{$stamp}_5032")
clean503=0 clean503=0
else else
# webroot exists # webroot exists
echo -e "${op}${stamp} Using webroot: ${lit}${webroot}${normal}" \ echo -e "${op}[$(stamp)] Using webroot: ${lit}${webroot}${normal}" \
>> "$logFile" >> "$logFile"
# Verify 503 file existance at given path # Verify 503 file existance at given path
checkExist ff "$err503Path" checkExist ff "$err503Path"
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "1" ]; then if [ "$checkResult" = "1" ]; then
# 503 file could not be found # 503 file could not be found
echo -e "${info}${stamp} -- [INFO] ${warn503} --${normal}" \ echo -e "${info}[$(stamp)] -- [INFO] ${warn503} --${normal}" \
>> "$logFile" >> "$logFile"
exitWarn+=("${stamp}_5033") exitWarn+=("[$(stamp)]_5033")
clean503=0 clean503=0
else else
# 503 file exists and webroot is valid. Let's copy it! # 503 file exists and webroot is valid. Let's copy it!
echo -e "${op}${stamp} ${err503File} found at ${lit}${err503Path}" \ echo -e "${op}[$(stamp)] ${err503File} found at ${lit}${err503Path}" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
echo -e "${op}${stamp} Copying 503 error page to webroot..." \ echo -e "${op}[$(stamp)] Copying 503 error page to webroot..." \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
cp "${err503Path}" "$webroot/" >> "$logFile" 2>&1 cp "${err503Path}" "$webroot/" >> "$logFile" 2>&1
copyResult="$?" copyResult="$?"
# verify copy was successful # verify copy was successful
if [ "$copyResult" = "1" ]; then if [ "$copyResult" = "1" ]; then
# copy was unsuccessful # copy was unsuccessful
echo -e "${info}${stamp} -- [INFO] ${warn503} --${normal}" \ echo -e "${info}[$(stamp)] -- [INFO] ${warn503} --${normal}" \
>> "$logFile" >> "$logFile"
exitWarn+=("${stamp}_5035") exitWarn+=("[$(stamp)]_5035")
clean503=0 clean503=0
else else
# copy was successful # copy was successful
echo -e "${info}${stamp} -- [INFO] 503 error page" \ echo -e "${info}[$(stamp)] -- [INFO] 503 error page" \
"successfully copied to webroot --${normal}" >> "$logFile" "successfully copied to webroot --${normal}" >> "$logFile"
clean503=1 clean503=1
fi fi
@@ -510,10 +514,10 @@ fi
ncMaint on ncMaint on
# check if successful # check if successful
if [ "$maintResult" = "0" ]; then if [ "$maintResult" = "0" ]; then
echo -e "${info}${stamp} -- [INFO] NextCloud now in maintenance mode --" \ echo -e "${info}[$(stamp)] -- [INFO] NextCloud now in maintenance mode --" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
else else
exitError+=("${stamp}_100") exitError+=("[$(stamp)]_100")
cleanup cleanup
quit quit
fi fi
@@ -524,23 +528,23 @@ mapfile -t sqlParams < "$sqlDetails"
### Dump SQL ### Dump SQL
echo -e "${op}${stamp} Dumping NextCloud SQL database...${normal}" >> "$logFile" echo -e "${op}[$(stamp)] Dumping NextCloud SQL database...${normal}" >> "$logFile"
mysqldump --single-transaction -h"${sqlParams[0]}" -u"${sqlParams[1]}" \ mysqldump --single-transaction -h"${sqlParams[0]}" -u"${sqlParams[1]}" \
-p"${sqlParams[2]}" "${sqlParams[3]}" > "${sqlDumpDir}/${sqlDumpFile}" \ -p"${sqlParams[2]}" "${sqlParams[3]}" > "${sqlDumpDir}/${sqlDumpFile}" \
2>> "$logFile" 2>> "$logFile"
# verify # verify
dumpResult="$?" dumpResult="$?"
if [ "$dumpResult" = "0" ]; then if [ "$dumpResult" = "0" ]; then
echo -e "${ok}${stamp} -- [SUCCESS] SQL dumped successfully --${normal}" \ echo -e "${ok}[$(stamp)] -- [SUCCESS] SQL dumped successfully --${normal}" \
>> "$logFile" >> "$logFile"
else else
exitError+=("${stamp}_200") exitError+=("[$(stamp)]_200")
cleanup cleanup
quit quit
fi fi
### Call borgbackup to copy actual files ### Call borgbackup to copy actual files
echo -e "${op}${stamp} Pre-backup tasks completed, calling borgbackup..." \ echo -e "${op}[$(stamp)] Pre-backup tasks completed, calling borgbackup..." \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
## Get borgbackup settings and repo details ## Get borgbackup settings and repo details
@@ -549,10 +553,10 @@ mapfile -t borgConfig < "$borgDetails"
## check if any required borg configuration variables in defintion file are ## check if any required borg configuration variables in defintion file are
## empty and exit with error, otherwise, map array items to variables ## empty and exit with error, otherwise, map array items to variables
# check: borg base directory # check: borg base directory
echo -e "${op}${stamp} Verifying supplied borg configuration variables..." \ echo -e "${op}[$(stamp)] Verifying supplied borg configuration variables..." \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
if [ -z "${borgConfig[0]}" ]; then if [ -z "${borgConfig[0]}" ]; then
exitError+=("${stamp}_210") exitError+=("[$(stamp)]_210")
cleanup cleanup
quit quit
else else
@@ -561,16 +565,16 @@ else
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "1" ]; then if [ "$checkResult" = "1" ]; then
# borg base directory specified could not be found # borg base directory specified could not be found
exitError+=("${stamp}_210") exitError+=("[$(stamp)]_210")
cleanup cleanup
quit quit
fi fi
echo -e "${op}${stamp} Borg base dir... OK${normal}" >> "$logFile" echo -e "${op}[$(stamp)] Borg base dir... OK${normal}" >> "$logFile"
export BORG_BASE_DIR="${borgConfig[0]%/}" export BORG_BASE_DIR="${borgConfig[0]%/}"
fi fi
# check: path to SSH keyfile # check: path to SSH keyfile
if [ -z "${borgConfig[1]}" ]; then if [ -z "${borgConfig[1]}" ]; then
exitError+=("${stamp}_211") exitError+=("[$(stamp)]_211")
cleanup cleanup
quit quit
else else
@@ -578,28 +582,28 @@ else
checkResult="$?" checkResult="$?"
if [ "$checkResult" = 1 ]; then if [ "$checkResult" = 1 ]; then
# SSH keyfile specified could not be found # SSH keyfile specified could not be found
exitError+=("${stamp}_211") exitError+=("[$(stamp)]_211")
cleanup cleanup
quit quit
fi fi
echo -e "${op}${stamp} Borg SSH key... OK${normal}" >> "$logFile" echo -e "${op}[$(stamp)] Borg SSH key... OK${normal}" >> "$logFile"
export BORG_RSH="ssh -i ${borgConfig[1]}" export BORG_RSH="ssh -i ${borgConfig[1]}"
fi fi
# check: name of borg repo # check: name of borg repo
if [ -z "${borgConfig[2]}" ]; then if [ -z "${borgConfig[2]}" ]; then
exitError+=("${stamp}_212") exitError+=("[$(stamp)]_212")
cleanup cleanup
quit quit
else else
echo -e "${op}${stamp} Borg REPO name... OK${normal}" >> "$logFile" echo -e "${op}[$(stamp)] Borg REPO name... OK${normal}" >> "$logFile"
export BORG_REPO="${borgConfig[2]}" export BORG_REPO="${borgConfig[2]}"
fi fi
# repo password # repo password
if [ -n "${borgConfig[3]}" ]; then if [ -n "${borgConfig[3]}" ]; then
echo -e "${op}${stamp} Borg SSH/REPO password... OK${normal}" >> "$logFile" echo -e "${op}[$(stamp)] Borg REPO password... OK${normal}" >> "$logFile"
export BORG_PASSPHRASE="${borgConfig[3]}" export BORG_PASSPHRASE="${borgConfig[3]}"
else else
exitWarn+=("${stamp}_2111") exitWarn+=("[$(stamp)]_2111")
# if the password was omitted by mistake, export a dummy password so borg # if the password was omitted by mistake, export a dummy password so borg
# fails with an error instead of sitting and waiting for input # fails with an error instead of sitting and waiting for input
export BORG_PASSPHRASE="DummyPasswordSoBorgFails" export BORG_PASSPHRASE="DummyPasswordSoBorgFails"
@@ -612,31 +616,31 @@ borgExclude="${borgConfig[5]}"
borgPrune="${borgConfig[6]}" borgPrune="${borgConfig[6]}"
# export: borg remote path (if not blank) # export: borg remote path (if not blank)
if [ -n "${borgConfig[7]}" ]; then if [ -n "${borgConfig[7]}" ]; then
echo -e "${op}${stamp} Borg REMOTE path... OK${normal}" >> "$logFile" echo -e "${op}[$(stamp)] Borg REMOTE path... OK${normal}" >> "$logFile"
export BORG_REMOTE_PATH="${borgConfig[7]}" export BORG_REMOTE_PATH="${borgConfig[7]}"
else else
exitWarn+=("${stamp}_2112") exitWarn+=("[$(stamp)]_2112")
fi fi
## If borgXtra exists, map contents to an array variable ## If borgXtra exists, map contents to an array variable
if [ -n "$borgXtra" ]; then if [ -n "$borgXtra" ]; then
echo -e "${op}${stamp} Processing referenced extra files list for" \ echo -e "${op}[$(stamp)] Processing referenced extra files list for" \
"borgbackup to include in backup${normal}" >> "$logFile" "borgbackup to include in backup${normal}" >> "$logFile"
checkExist ff "$borgXtra" checkExist ff "$borgXtra"
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "0" ]; then if [ "$checkResult" = "0" ]; then
echo -e "${op}${stamp} Found ${lit}${borgXtra}${normal}" >> "$logFile" echo -e "${op}[$(stamp)] Found ${lit}${borgXtra}${normal}" >> "$logFile"
mapfile -t xtraFiles < "$borgXtra" mapfile -t xtraFiles < "$borgXtra"
echo -e "${op}${stamp} Processed extra files list for inclusion in" \ echo -e "${op}[$(stamp)] Processed extra files list for inclusion in" \
"borgbackup${normal}" >> "$logFile" "borgbackup${normal}" >> "$logFile"
else else
exitWarn+=("${stamp}_2113") exitWarn+=("[$(stamp)]_2113")
fi fi
else else
# no extra locations specified # no extra locations specified
echo -e "${op}${stamp} No additional locations specified for backup." \ echo -e "${op}[$(stamp)] No additional locations specified for backup." \
"Only NextCloud data files will be backed up${normal}" >> "$logFile" "Only NextCloud data files will be backed up${normal}" >> "$logFile"
exitWarn+=("${stamp}_2116") exitWarn+=("[$(stamp)]_2116")
fi fi
## Check if borgExclude exists since borg will throw an error if it's missing ## Check if borgExclude exists since borg will throw an error if it's missing
@@ -644,16 +648,16 @@ if [ -n "$borgExclude" ]; then
checkExist ff "$borgExclude" checkExist ff "$borgExclude"
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "0" ]; then if [ "$checkResult" = "0" ]; then
echo -e "${op}${stamp} Found ${lit}${borgExclude}${normal}" \ echo -e "${op}[$(stamp)] Found ${lit}${borgExclude}${normal}" \
>> "$logFile" >> "$logFile"
else else
# file not found, unset the variable so it's like it was not specified # file not found, unset the variable so it's like it was not specified
# in the first place and continue with backup # in the first place and continue with backup
unset borgExclude unset borgExclude
exitWarn+=("${stamp}_2114") exitWarn+=("[$(stamp)]_2114")
fi fi
else else
echo -e "${op}${stamp} Exclusion pattern file not specified." \ echo -e "${op}[$(stamp)] Exclusion pattern file not specified." \
"No exclusions will be processed${normal}" >> "$logFile" "No exclusions will be processed${normal}" >> "$logFile"
fi fi
@@ -664,13 +668,13 @@ fi
## the 'noexec' option for security. Thus, we will use/create a 'tmp' folder ## the 'noexec' option for security. Thus, we will use/create a 'tmp' folder
## within the BORG_BASE_DIR and instruct python to use that instead of /tmp ## within the BORG_BASE_DIR and instruct python to use that instead of /tmp
# check if BORG_BASE_DIR/tmp exists, if not, create it # check if BORG_BASE_DIR/tmp exists, if not, create it
echo -e "${op}${stamp} Checking for tmp directory at ${lit}${BORG_BASE_DIR}" \ echo -e "${op}[$(stamp)] Checking for tmp directory at ${lit}${BORG_BASE_DIR}" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
checkExist fd "$BORG_BASE_DIR/tmp" checkExist fd "$BORG_BASE_DIR/tmp"
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "1" ]; then if [ "$checkResult" = "1" ]; then
# folder not found # folder not found
echo -e "${op}${stamp} tmp folder not found... creating${lit}" \ echo -e "${op}[$(stamp)] tmp folder not found... creating${lit}" \
"${BORG_BASE_DIR}/tmp${normal}" >> "$logFile" "${BORG_BASE_DIR}/tmp${normal}" >> "$logFile"
mkdir "$BORG_BASE_DIR/tmp" 2>> "$logFile" mkdir "$BORG_BASE_DIR/tmp" 2>> "$logFile"
# verify folder created # verify folder created
@@ -678,17 +682,17 @@ if [ "$checkResult" = "1" ]; then
checkResult="$?" checkResult="$?"
if [ "$checkResult" = "0" ]; then if [ "$checkResult" = "0" ]; then
# folder exists # folder exists
echo -e "${op}${stamp} tmp folder created within borg base directory" \ echo -e "${op}[$(stamp)] tmp folder created within borg base directory" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
else else
# problem creating folder and script will exit # problem creating folder and script will exit
exitError+=("${stamp}_215") exitError+=("[$(stamp)]_215")
cleanup cleanup
quit quit
fi fi
else else
# folder found # folder found
echo -e "${op}${stamp} tmp folder found within borg base directory" \ echo -e "${op}[$(stamp)] tmp folder found within borg base directory" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
fi fi
# export TMPDIR environment variable # export TMPDIR environment variable
@@ -699,74 +703,74 @@ export TMPDIR="${BORG_BASE_DIR}/tmp"
# commandline depends on whether borgExclude is empty or not # commandline depends on whether borgExclude is empty or not
if [ -z "$borgExclude" ]; then if [ -z "$borgExclude" ]; then
# borgExclude is empty # borgExclude is empty
echo -e "${info}${stamp} --[INFO] Executing borg without exclusions --" \ echo -e "${info}[$(stamp)] --[INFO] Executing borg without exclusions --" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
borg --show-rc create ${borgCreateParams} ::`date +%Y-%m-%d_%H%M%S` \ borg --show-rc create ${borgCreateParams} ::`date +%Y-%m-%d_%H%M%S` \
${xtraFiles[@]} \ "${xtraFiles[@]}" \
${sqlDumpDir} ${ncDataDir} \ "${sqlDumpDir}" "${ncDataDir}" \
2>> "$logFile" 2>> "$logFile"
else else
# borgExclude is not empty # borgExclude is not empty
echo -e "${info}${stamp} --[INFO] Executing borg with exclusions --" \ echo -e "${info}[$(stamp)] --[INFO] Executing borg with exclusions --" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
borg --show-rc create ${borgCreateParams} --exclude-from ${borgExclude} \ borg --show-rc create ${borgCreateParams} --exclude-from "${borgExclude}" \
::`date +%Y-%m-%d_%H%M%S` \ ::`date +%Y-%m-%d_%H%M%S` \
${xtraFiles[@]} \ "${xtraFiles[@]}" \
${sqlDumpDir} ${ncDataDir} \ "${sqlDumpDir}" "${ncDataDir}" \
2>> "$logFile" 2>> "$logFile"
fi fi
## Check status of borg operation ## Check status of borg operation
borgResult="$?" borgResult="$?"
if [ "$borgResult" -eq 0 ]; then if [ "$borgResult" -eq 0 ]; then
echo -e "${ok}${stamp} -- [SUCCESS] Borg backup completed successfully --" \ echo -e "${ok}[$(stamp)] -- [SUCCESS] Borg backup completed successfully --" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
elif [ "$borgResult" -eq 1 ]; then elif [ "$borgResult" -eq 1 ]; then
exitWarn+=("${stamp}_2200") exitWarn+=("[$(stamp)]_2200")
elif [ "$borgResult" -ge 2 ]; then elif [ "$borgResult" -ge 2 ]; then
exitError+=("${stamp}_220") exitError+=("[$(stamp)]_220")
cleanup cleanup
quit quit
else else
exitWarn+=("${stamp}_2201") exitWarn+=("[$(stamp)]_2201")
fi fi
## Generate and execute borg prune ## Generate and execute borg prune
# command depends on whether or not parameters have been defined # command depends on whether or not parameters have been defined
if [ -n "$borgPrune" ]; then if [ -n "$borgPrune" ]; then
# parameters defined # parameters defined
echo -e "${info}${stamp} --[INFO] Executing borg prune operation --" \ echo -e "${info}[$(stamp)] --[INFO] Executing borg prune operation --" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
borg prune --show-rc -v ${borgPruneParams} ${borgPrune} \ borg prune --show-rc -v ${borgPruneParams} ${borgPrune} \
2>> "$logFile" 2>> "$logFile"
# check return-status # check return-status
pruneResult="$?" pruneResult="$?"
if [ "$pruneResult" -eq 0 ]; then if [ "$pruneResult" -eq 0 ]; then
echo -e "${ok}${stamp} -- [SUCCESS] Borg prune completed successfully" \ echo -e "${ok}[$(stamp)] -- [SUCCESS] Borg prune completed successfully" \
"--${normal}" >> "$logFile" "--${normal}" >> "$logFile"
elif [ "$pruneResult" -eq 1 ]; then elif [ "$pruneResult" -eq 1 ]; then
exitWarn+=("${stamp}_2210") exitWarn+=("[$(stamp)]_2210")
elif [ "$pruneResult" -ge 2 ]; then elif [ "$pruneResult" -ge 2 ]; then
exitError+=("${stamp}_221") exitError+=("[$(stamp)]_221")
else else
exitWarn+=("${stamp}_2212") exitWarn+=("[$(stamp)]_2212")
fi fi
else else
# parameters not defined... skip pruning # parameters not defined... skip pruning
exitWarn+=("${stamp}_2115") exitWarn+=("[$(stamp)]_2115")
fi fi
### borgbackup completed ### borgbackup completed
echo -e "${op}${stamp} Borgbackup completed... begin cleanup" \ echo -e "${op}[$(stamp)] Borgbackup completed... begin cleanup" \
"${normal}" >> "$logFile" "${normal}" >> "$logFile"
### Exit script ### Exit script
echo -e "${bold}${op}${stamp} ***Normal exit process***${normal}" \ echo -e "${bold}${op}[$(stamp)] ***Normal exit process***${normal}" \
>> "$logFile" >> "$logFile"
cleanup cleanup
echo -e "${bold}${ok}${stamp} -- [SUCCESS] All processes completed" \ echo -e "${bold}${ok}[$(stamp)] -- [SUCCESS] All processes completed" \
"successfully --${normal}" >> "$logFile" "successfully --${normal}" >> "$logFile"
quit quit
+3 -3
View File
@@ -1,7 +1,7 @@
<path to borgbackup base directory> /var/borgbackup <path to borgbackup base directory> /var/borgbackup
<path to SSH private key for repo> /var/borgbackup/sshPrivate.key <path to SSH private key for remote server> /var/borgbackup/sshPrivate.key
<connection string to remote repo> user@server-number.rsync.net:repoName/ <connection string to remote repo> user@servername.tld:repoName/
<password for SSH key/repo> pAsSwOrd <password for repo> pAsSwOrd
<path to file listing extra files> /root/NCscripts/xtraLocations.borg <path to file listing extra files> /root/NCscripts/xtraLocations.borg
<path to file with exclusions> /root/NCscripts/excludeLocations.borg <path to file with exclusions> /root/NCscripts/excludeLocations.borg
<purge timeframe options> --keep-within=7d --keep-daily=30 --keep-weekly=12 --keep-monthly=-1 <purge timeframe options> --keep-within=7d --keep-daily=30 --keep-weekly=12 --keep-monthly=-1
+5 -4
View File
@@ -22,11 +22,12 @@
/etc/fail2ban/jail.d/ /etc/fail2ban/jail.d/
/root/.bashrc /root/.bashrc
/root/NCscripts/ /root/NCscripts/
/root/.ssh/
/etc/mysql/my.cnf /etc/mysql/my.cnf
/etc/nginx/ /etc/nginx/
/etc/php/7.0/cli/php.ini /etc/php/7.2/cli/php.ini
/etc/php/7.0/fpm/php-fpm.conf /etc/php/7.2/fpm/php-fpm.conf
/etc/php/7.0/fpm/php.ini /etc/php/7.2/fpm/php.ini
/etc/php/7.0/fpm/pool.d/www.conf /etc/php/7.2/fpm/pool.d/www.conf
/etc/redis/redis.conf /etc/redis/redis.conf
/usr/share/nginx/html/ /usr/share/nginx/html/