├── .env.example ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.yml │ └── feature_request.yml └── workflows │ ├── close_bot.yml │ └── markdown_issue_check.yml ├── .gitignore ├── LICENSE ├── README.md ├── install-files ├── klipper-backup-filewatch.service ├── klipper-backup-on-boot.service └── moonraker.conf ├── install.sh ├── script.sh └── utils ├── filewatch.sh ├── utils.func └── v1convert.sh /.env.example: -------------------------------------------------------------------------------- 1 | github_token=ghp_xxxxxxxxxxxxxxxx 2 | github_username=USERNAME 3 | github_repository=REPOSITORY 4 | branch_name=main 5 | commit_username="" 6 | commit_email="" 7 | 8 | # All information regarding .env can be found here: 9 | # https://klipperbackup.xyz/configuration/ 10 | 11 | # Backup paths 12 | # Note: script.sh starts its search in $HOME which is /home/{username}/ 13 | # The array accepts folders or files like the following example 14 | # 15 | # backupPaths=( \ 16 | # "printer_data/config/*" \ 17 | # "printer_data/config/printer.cfg" \ 18 | # ) 19 | # 20 | # Using the above example the script will search for `/home/{username}/printer_data/config/*` and `/home/{username}/printer_data/config/printer.cfg` 21 | # When backing up a folder you should always have `/*` at the end of the path so that files insde the folder are properly searched 22 | 23 | backupPaths=( \ 24 | "printer_data/config/*" \ 25 | ) 26 | 27 | # Array of strings in .gitignore pattern git format https://git-scm.com/docs/gitignore#_pattern_format for files that should not be uploaded to the remote repo 28 | # New additions must be enclosed in double quotes and should follow the pattern format as noted in the above link 29 | exclude=( \ 30 | "*.swp" \ 31 | "*.tmp" \ 32 | "printer-[0-9]*_[0-9]*.cfg" \ 33 | "*.bak" \ 34 | "*.bkp" \ 35 | "*.csv" \ 36 | "*.zip" \ 37 | ) -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Bug report 2 | description: Create a report to help us improve 3 | labels: ["bug"] 4 | body: 5 | - type: markdown 6 | attributes: 7 | value: | 8 | This issue form is for reporting bugs only! Please run this command first to see if your problem has been solved, otherwise open the issue: `~/klipper-backup/script.sh --fix` 9 | If you have a feature request, please use [feature_request](/Staubgeborener/klipper-backup/issues/new?assignees=&labels=feature+request&projects=&template=feature_request.yml&title=%5BFeature+request%5D%3A+). Please use [markdown syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code). 10 | - type: checkboxes 11 | attributes: 12 | label: Code of Conduct 13 | options: 14 | - label: I promise that i have used markdown syntax to make the code more readable which helps to fix the problem and that I have tested the --fix command mentioned above without success. 15 | required: true 16 | - type: textarea 17 | id: what-happened 18 | attributes: 19 | label: What happened 20 | description: >- 21 | A clear and concise description of what the bug is. 22 | validations: 23 | required: true 24 | - type: textarea 25 | id: expected-behavior 26 | attributes: 27 | label: What did you expect to happen 28 | description: >- 29 | A clear and concise description of what you expected to happen. 30 | validations: 31 | required: true 32 | - type: textarea 33 | id: repro-steps 34 | attributes: 35 | label: How to reproduce 36 | description: >- 37 | Minimal and precise steps to reproduce this bug. 38 | validations: 39 | required: true 40 | - type: textarea 41 | id: debug-output 42 | attributes: 43 | label: Debug 44 | description: >- 45 | Insert here the output of `~/klipper-backup/script.sh --debug` (DO NOT USE MARKDOWN HERE) 46 | render: shell 47 | validations: 48 | required: true 49 | - type: textarea 50 | id: additional-info 51 | attributes: 52 | label: Additional information 53 | description: | 54 | If you have any additional information for us, use the field below. 55 | 56 | Please note, you can attach screenshots or screen recordings here, by 57 | dragging and dropping files in the field below. 58 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: 💡 Feature request 2 | description: Suggest an idea for this project 3 | labels: ["feature request"] 4 | body: 5 | - type: markdown 6 | attributes: 7 | value: | 8 | This issue form is for feature requests only! 9 | If you have a bug report, please use [bug_report](/Staubgeborener/klipper-backup/issues/new?assignees=&labels=bug&projects=&template=bug_report.yml&title=%5BBug%5D%3A+). Please use [markdown syntax](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#quoting-code). 10 | - type: textarea 11 | id: related-to-problem 12 | attributes: 13 | label: Is your feature request related to a problem? Please describe. 14 | description: >- 15 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 16 | validations: 17 | required: true 18 | - type: textarea 19 | id: describe-solution 20 | attributes: 21 | label: Describe the solution you'd like 22 | description: >- 23 | A clear and concise description of what you want to happen. 24 | validations: 25 | required: true 26 | - type: textarea 27 | id: alternatives 28 | attributes: 29 | label: Describe alternatives you've considered 30 | description: >- 31 | A clear and concise description of any alternative solutions or features you've considered. 32 | validations: 33 | required: true 34 | - type: textarea 35 | id: additional-info 36 | attributes: 37 | label: Additional information 38 | description: | 39 | If you have any additional information for us, use the field below. 40 | 41 | Please note, you can attach screenshots or screen recordings here, by 42 | dragging and dropping files in the field below. -------------------------------------------------------------------------------- /.github/workflows/close_bot.yml: -------------------------------------------------------------------------------- 1 | name: Close inactive issues 2 | on: 3 | schedule: 4 | - cron: "30 1 * * *" 5 | 6 | jobs: 7 | close-issues: 8 | runs-on: ubuntu-latest 9 | permissions: 10 | issues: write 11 | pull-requests: write 12 | steps: 13 | - uses: actions/stale@v5 14 | with: 15 | days-before-issue-stale: 14 16 | days-before-issue-close: 14 17 | stale-issue-label: "stale" 18 | stale-issue-message: "This issue is stale because it has been open for 14 days with no activity." 19 | exempt-issue-labels: "ignore stale" 20 | close-issue-message: "This issue was closed because it has been inactive for 14 days since being marked as stale." 21 | days-before-pr-stale: -1 22 | days-before-pr-close: -1 23 | repo-token: ${{ secrets.GITHUB_TOKEN }} -------------------------------------------------------------------------------- /.github/workflows/markdown_issue_check.yml: -------------------------------------------------------------------------------- 1 | name: Check for Markdown code blocks in Issues 2 | 3 | on: 4 | issues: 5 | types: [opened] 6 | 7 | permissions: 8 | issues: write 9 | 10 | jobs: 11 | check_markdown: 12 | runs-on: ubuntu-latest 13 | name: Markdown issue 14 | 15 | steps: 16 | - name: Check if markdown code is used 17 | id: check_markdown 18 | run: | 19 | ISSUE_BODY="${{ github.event.issue.body }}" 20 | 21 | # Check if the issue body contains Markdown inline code or code block (`` ` ``) 22 | if echo "$ISSUE_BODY" | grep -q "\`"; then 23 | echo "Markdown code detected." 24 | echo "markdown_used=true" >> $GITHUB_ENV 25 | else 26 | echo "No Markdown code detected." 27 | echo "markdown_used=false" >> $GITHUB_ENV 28 | fi 29 | 30 | - name: Comment on the issue if no Markdown code is detected 31 | if: env.markdown_used == 'false' 32 | run: | 33 | ISSUE_NUMBER="${{ github.event.issue.number }}" 34 | REPO="${{ github.repository }}" 35 | 36 | # Define COMMENT_BODY with backticks directly 37 | COMMENT_BODY="Please use markdown syntax (``) for code snippets in your issue. You have confirmed the checkbox that you are using markdown, but none was recognized here. The markdown syntax makes your issue more readable and makes it easier to find a solution to your problem more quickly.\\n\\nExamples:\nThe symbol ` turns `code` into \`code\`.\\n\\nFor more code use ` three times at the beginning and at the end like this:\\n```\\nsome\\ncode\\n```\\nturns into:\\n\`\`\`\\nsome\\ncode\\n\`\`\`\\nPlease edit your outgoing post immediately. If you think that this hint is not necessary and you have correctly used markdown, then you can simply ignore this message." 38 | 39 | # Escape special characters in COMMENT_BODY 40 | ESCAPED_COMMENT_BODY=$(echo "$COMMENT_BODY" | sed 's/[&"]/\\&/g') 41 | 42 | # Post a comment on the issue 43 | curl -s -X POST \ 44 | -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ 45 | -H "Content-Type: application/json" \ 46 | -d "{\"body\":\"${ESCAPED_COMMENT_BODY}\"}" \ 47 | "https://api.github.com/repos/${REPO}/issues/${ISSUE_NUMBER}/comments" 48 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | .env 2 | secrets.conf -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ANNOUNCEMENT 2 | The beta test for the restore function is now open, more information can be found [here](https://github.com/Staubgeborener/Klipper-Backup/discussions/143). 3 | 4 | # Klipper-Backup 💾 5 | Klipper-Backup is a script for manual or automated GitHub backups. It's Lightweight, pragmatic and comfortable. 6 | 7 | ## Installation 8 | 9 | ### Download: 10 | ```shell 11 | curl -fsSL get.klipperbackup.xyz | bash 12 | ``` 13 | 14 | ### Installation/Configuration: 15 | ```shell 16 | ~/klipper-backup/install.sh 17 | ``` 18 | 19 | ## RTFM 20 | I would suggest reading the [docs](https://klipperbackup.xyz), as this provides detailed step-by-step instructions and further tips. 21 | 22 | ## YouTube 23 | There are several YouTube videos about Klipper-Backup - thanks to everyone! 24 | 25 | * [Chris Riley: Klipper Backup - Save Your Klipper Config - Before You Lose It! - Chris's Basement](https://www.youtube.com/watch?v=RCWWtzrI-e8) 26 | 27 | * [ModBot: This Klipper Add-on Could Save You! (Klipper-Backup)](https://www.youtube.com/watch?v=47qV9BE2n_Y) 28 | 29 | * [Minimal 3DP: The Ultimate Guide to Using Klipper Macros to Backup Your Configuration Files](https://www.youtube.com/watch?v=J4_dlCtZY48) -------------------------------------------------------------------------------- /install-files/klipper-backup-filewatch.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Klipper Backup Filewatch Service 3 | After= 4 | Wants= 5 | 6 | [Service] 7 | User= 8 | Type=simple 9 | ExecStart=/usr/bin/env bash -c '"$HOME/klipper-backup/utils/filewatch.sh"' 10 | 11 | [Install] 12 | WantedBy=default.target -------------------------------------------------------------------------------- /install-files/klipper-backup-on-boot.service: -------------------------------------------------------------------------------- 1 | [Unit] 2 | Description=Klipper Backup On-boot Service 3 | After= 4 | Wants= 5 | 6 | [Service] 7 | User= 8 | Type=oneshot 9 | ExecStart=/usr/bin/env bash -c "/usr/bin/env bash $HOME/klipper-backup/script.sh -c \"New Backup on boot - $(date +\"%%x - %%X\")\"" 10 | 11 | [Install] 12 | WantedBy=default.target 13 | -------------------------------------------------------------------------------- /install-files/moonraker.conf: -------------------------------------------------------------------------------- 1 | [update_manager klipper-backup] 2 | type: git_repo 3 | path: ~/klipper-backup 4 | origin: https://github.com/Staubgeborener/klipper-backup.git 5 | managed_services: moonraker 6 | primary_branch: main -------------------------------------------------------------------------------- /install.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | trap 'stty echo; exit' SIGINT 4 | 5 | parent_path=$( 6 | cd "$(dirname "${BASH_SOURCE[0]}")" 7 | pwd -P 8 | ) 9 | 10 | if [[ ! -f .env ]]; then 11 | cp $parent_path/.env.example $parent_path/.env 12 | fi 13 | 14 | source $parent_path/utils/utils.func 15 | 16 | unique_id=$(getUniqueid) 17 | 18 | set -e 19 | 20 | main() { 21 | clear 22 | sudo -v 23 | dependencies 24 | logo 25 | install_repo 26 | configure 27 | patch_klipper-backup_update_manager 28 | install_filewatch_service 29 | install_backup_service 30 | install_cron 31 | echo -e "${G}●${NC} Installation Complete!\n For help or further information, read the docs: https://klipperbackup.xyz" 32 | } 33 | 34 | dependencies() { 35 | loading_wheel "${Y}●${NC} Checking for installed dependencies" & 36 | loading_pid=$! 37 | check_dependencies "jq" "curl" "rsync" 38 | kill $loading_pid 39 | echo -e "\r\033[K${G}●${NC} Checking for installed dependencies ${G}Done!${NC}\n" 40 | sleep 1 41 | } 42 | 43 | install_repo() { 44 | questionline=$(getcursor) 45 | if ask_yn "Do you want to proceed with installation/(re)configuration?"; then 46 | tput cup $(($questionline - 1)) 0 47 | clearUp 48 | cd "$HOME" 49 | if [ ! -d "klipper-backup" ]; then 50 | loading_wheel "${Y}●${NC} Installing Klipper-Backup" & 51 | loading_pid=$! 52 | git clone https://github.com/Staubgeborener/klipper-backup.git 2>/dev/null 53 | chmod +x ./klipper-backup/script.sh 54 | cp ./klipper-backup/.env.example ./klipper-backup/.env 55 | sleep .5 56 | kill $loading_pid 57 | echo -e "\r\033[K${G}●${NC} Installing Klipper-Backup ${G}Done!${NC}\n" 58 | else 59 | check_updates 60 | fi 61 | else 62 | tput cup $(($questionline - 1)) 0 63 | clearUp 64 | echo -e "${R}●${NC} Installation aborted.\n" 65 | exit 1 66 | fi 67 | } 68 | 69 | check_updates() { 70 | cd ~/klipper-backup 71 | if [ "$(git rev-parse HEAD)" = "$(git ls-remote $(git rev-parse --abbrev-ref @{u} | sed 's/\// /g') | cut -f1)" ]; then 72 | echo -e "${G}●${NC} Klipper-Backup ${G}is up to date.${NC}\n" 73 | else 74 | echo -e "${Y}●${NC} Update for Klipper-Backup ${Y}Available!${NC}\n" 75 | questionline=$(getcursor) 76 | if ask_yn "Proceed with update?"; then 77 | tput cup $(($questionline - 3)) 0 78 | tput ed 79 | loading_wheel "${Y}●${NC} Updating Klipper-Backup" & 80 | loading_pid=$! 81 | if git pull >/dev/null 2>&1; then 82 | kill $loading_pid 83 | echo -e "\r\033[K${G}●${NC} Updating Klipper-Backup ${G}Done!${NC}\n\n Restarting installation script" 84 | sleep 1 85 | exec $parent_path/install.sh 86 | else 87 | kill $loading_pid 88 | echo -e "\r\033[K${R}●${NC} Error Updating Klipper-Backup: Repository is dirty running git reset --hard then restarting script" 89 | sleep 1 90 | git reset --hard 2>/dev/null 91 | exec $parent_path/install.sh 92 | fi 93 | else 94 | tput cup $(($questionline - 3)) 0 95 | clearUp 96 | echo -e "${M}●${NC} Klipper-Backup update ${M}skipped!${NC}\n" 97 | fi 98 | fi 99 | } 100 | 101 | configure() { 102 | ghtoken_username="" 103 | questionline=$(getcursor) 104 | if grep -q "github_token=ghp_xxxxxxxxxxxxxxxx" "$parent_path"/.env; then # Check if the github token still matches the value when initially copied from .env.example 105 | message="Do you want to proceed with configuring the Klipper-Backup .env?" 106 | else 107 | message="Do you want to proceed with reconfiguring the Klipper-Backup .env?" 108 | fi 109 | if ask_yn "$message"; then 110 | tput cup $(($questionline - 1)) 0 111 | clearUp 112 | pos1=$(getcursor) 113 | pos2=$(getcursor) 114 | 115 | getToken() { 116 | echo -e "See the following for how to create your token: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens (Ensure you set access to the backup repository and have push/pull & commit permissions for the token) \n" 117 | ghtoken=$(ask_token "Enter your GitHub token") 118 | result=$(check_ghToken "$ghtoken") # Check Github Token using github API to ensure token is valid and connection can be estabilished to github 119 | if [ "$result" != "" ]; then 120 | sed -i "s/^github_token=.*/github_token=$ghtoken/" "$HOME/klipper-backup/.env" 121 | ghtoken_username=$result 122 | else 123 | tput cup $(($pos2 - 2)) 0 124 | tput ed 125 | pos2=$(getcursor) 126 | echo "Invalid Github token or Unable to contact github API, Please re-enter your token and check for valid connection to github.com then try again!" 127 | getToken 128 | fi 129 | } 130 | getUser() { 131 | pos2=$(getcursor) 132 | ghuser=$(ask_textinput "Enter your github username" "$ghtoken_username") 133 | 134 | menu 135 | exitstatus=$? 136 | if [ $exitstatus = 0 ]; then 137 | sed -i "s/^github_username=.*/github_username=$ghuser/" "$HOME/klipper-backup/.env" 138 | tput cup $pos2 0 139 | tput ed 140 | else 141 | tput cup $(($pos2 - 1)) 0 142 | tput ed 143 | getUser 144 | fi 145 | } 146 | getRepo() { 147 | pos2=$(getcursor) 148 | ghrepo=$(ask_textinput "Enter your repository name") 149 | 150 | menu 151 | exitstatus=$? 152 | if [ $exitstatus = 0 ]; then 153 | sed -i "s/^github_repository=.*/github_repository=$ghrepo/" "$HOME/klipper-backup/.env" 154 | tput cup $pos2 0 155 | tput ed 156 | else 157 | tput cup $(($pos2 - 1)) 0 158 | tput ed 159 | getRepo 160 | fi 161 | } 162 | getBranch() { 163 | pos2=$(getcursor) 164 | repobranch=$(ask_textinput "Enter your desired branch name" "main") 165 | 166 | menu 167 | exitstatus=$? 168 | if [ $exitstatus = 0 ]; then 169 | sed -i "s/^branch_name=.*/branch_name=\"$repobranch\"/" "$HOME/klipper-backup/.env" 170 | tput cup $pos2 0 171 | tput ed 172 | else 173 | tput cup $(($pos2 - 1)) 0 174 | tput ed 175 | getBranch 176 | fi 177 | } 178 | getCommitName() { 179 | pos2=$(getcursor) 180 | commitname=$(ask_textinput "Enter desired commit username" "$(whoami)") 181 | 182 | menu 183 | exitstatus=$? 184 | if [ $exitstatus = 0 ]; then 185 | sed -i "s/^commit_username=.*/commit_username=\"$commitname\"/" "$HOME/klipper-backup/.env" 186 | tput cup $pos2 0 187 | tput ed 188 | else 189 | tput cup $(($pos2 - 1)) 0 190 | tput ed 191 | getCommitName 192 | fi 193 | } 194 | getCommitEmail() { 195 | pos2=$(getcursor) 196 | commitemail=$(ask_textinput "Enter desired commit email" "$(whoami)@$(hostname --short)-$unique_id") 197 | 198 | menu 199 | exitstatus=$? 200 | if [ $exitstatus = 0 ]; then 201 | sed -i "s/^commit_email=.*/commit_email=\"$commitemail\"/" "$HOME/klipper-backup/.env" 202 | tput cup $pos2 0 203 | tput ed 204 | else 205 | tput cup $(($pos2 - 1)) 0 206 | tput ed 207 | getCommitEmail 208 | fi 209 | } 210 | 211 | while true; do 212 | set +e 213 | getToken 214 | getUser 215 | getRepo 216 | getBranch 217 | getCommitName 218 | getCommitEmail 219 | set -e 220 | break 221 | done 222 | 223 | tput cup $(($questionline - 1)) 0 224 | tput ed 225 | echo -e "\r\033[K${G}●${NC} Configuration ${G}Done!${NC}\n" 226 | pos1=$(getcursor) 227 | else 228 | tput cup $(($questionline - 1)) 0 229 | clearUp 230 | echo -e "\r\033[K${M}●${NC} Configuration ${M}skipped!${NC}\n" 231 | pos1=$(getcursor) 232 | fi 233 | } 234 | 235 | patch_klipper-backup_update_manager() { 236 | questionline=$(getcursor) 237 | if [[ -d $HOME/moonraker ]] && systemctl is-active moonraker >/dev/null 2>&1; then 238 | if ! grep -Eq "^\[update_manager klipper-backup\]\s*$" "$HOME/printer_data/config/moonraker.conf"; then 239 | if ask_yn "Would you like to add Klipper-Backup to moonraker update manager?"; then 240 | tput cup $(($questionline - 2)) 0 241 | tput ed 242 | pos1=$(getcursor) 243 | loading_wheel "${Y}●${NC} Adding Klipper-Backup to update manager" & 244 | loading_pid=$! 245 | ### add new line to conf if it doesn't end with one 246 | if [[ $(tail -c1 "$HOME/printer_data/config/moonraker.conf" | wc -l) -eq 0 ]]; then 247 | echo "" >>"$HOME/printer_data/config/moonraker.conf" 248 | fi 249 | 250 | if /usr/bin/env bash -c "cat $parent_path/install-files/moonraker.conf >> $HOME/printer_data/config/moonraker.conf"; then 251 | sudo systemctl restart moonraker.service 252 | fi 253 | 254 | kill $loading_pid 255 | echo -e "\r\033[K${G}●${NC} Adding Klipper-Backup to update manager ${G}Done!${NC}\n" 256 | else 257 | tput cup $(($questionline - 2)) 0 258 | tput ed 259 | echo -e "\r\033[K${M}●${NC} Adding Klipper-Backup to update manager ${M}skipped!${NC}\n" 260 | fi 261 | else 262 | tput cup $(($questionline - 2)) 0 263 | tput ed 264 | echo -e "\r\033[K${M}●${NC} Adding Klipper-Backup to update manager ${M}skipped! (already added)${NC}\n" 265 | fi 266 | else 267 | tput cup $(($questionline - 2)) 0 268 | tput ed 269 | echo -e "${R}●${NC} Moonraker is not installed update manager configuration ${R}skipped!${NC}\n${Y}● Please install moonraker then run the script again to update the moonraker configuration${NC}\n" 270 | fi 271 | } 272 | 273 | install_filewatch_service() { 274 | questionline=$(getcursor) 275 | tput cup $(($questionline - 2)) 0 276 | tput ed 277 | pos1=$(getcursor) 278 | loading_wheel "${Y}●${NC} Checking for filewatch service" & 279 | loading_pid=$! 280 | if service_exists klipper-backup-filewatch; then 281 | echo -e "\r\033[K" 282 | kill $loading_pid 283 | message="Would you like to reinstall the filewatch backup service? (this will trigger a backup after changes are detected)" 284 | else 285 | echo -e "\r\033[K" 286 | kill $loading_pid 287 | message="Would you like to install the filewatch backup service? (this will trigger a backup after changes are detected)" 288 | fi 289 | if ask_yn "$message"; then 290 | tput cup $(($questionline - 2)) 0 291 | tput ed 292 | pos1=$(getcursor) 293 | set +e 294 | if ! checkinotify >/dev/null 2>&1; then # Checks if the version of inotify installed matches the latest release 295 | removeOldInotify 296 | echo -e "${Y}●${NC} Installing latest version of inotify-tools (This may take a few minutes)" 297 | sudo rm -rf inotify-tools/ # remove folder incase it for some reason still exists 298 | sudo rm -f /usr/bin/fsnotifywait /usr/bin/fsnotifywatch # remove symbolic links to keep error about file exists from occurring 299 | loading_wheel " ${Y}●${NC} Clone inotify-tools repo" & 300 | loading_pid=$! 301 | git clone https://github.com/inotify-tools/inotify-tools.git 2>/dev/null 302 | kill $loading_pid 303 | echo -e "\r\033[K ${G}●${NC} Clone inotify-tools repo ${G}Done!${NC}" 304 | sudo apt-get install autoconf autotools-dev automake libtool -y >/dev/null 2>&1 305 | 306 | cd inotify-tools/ 307 | 308 | buildCommands=("./autogen.sh" "./configure --prefix=/usr" "make" "make install") 309 | for ((i = 0; i < ${#buildCommands[@]}; i++)); do 310 | run_command "${buildCommands[i]}" 311 | done 312 | 313 | cd .. 314 | sudo rm -rf inotify-tools 315 | pos2=$(getcursor) 316 | tput cup $(($pos1 - 1)) 0 317 | tput ed 318 | echo -e "\r\033[K${G}●${NC} Installing latest version of inotify-tools ${G}Done!${NC}" 319 | set -e 320 | fi 321 | loading_wheel "${Y}●${NC} Installing filewatch service" & 322 | loading_pid=$! 323 | if ( 324 | !( 325 | sudo systemctl stop klipper-backup-filewatch.service 2>/dev/null 326 | sudo cp $parent_path/install-files/klipper-backup-filewatch.service /etc/systemd/system/klipper-backup-filewatch.service 327 | sudo sed -i "s/^After=.*/After=$(wantsafter)/" "/etc/systemd/system/klipper-backup-filewatch.service" 328 | sudo sed -i "s/^Wants=.*/Wants=$(wantsafter)/" "/etc/systemd/system/klipper-backup-filewatch.service" 329 | sudo sed -i "s/^User=.*/User=${SUDO_USER:-$USER}/" "/etc/systemd/system/klipper-backup-filewatch.service" 330 | sudo systemctl daemon-reload 2>/dev/null 331 | sudo systemctl enable klipper-backup-filewatch.service 2>/dev/null 332 | sudo systemctl start klipper-backup-filewatch.service 2>/dev/null 333 | sleep .5 334 | kill $loading_pid 335 | ) & 336 | 337 | start_time=$(date +%s) 338 | timeout_duration=20 339 | 340 | while [ "$(ps -p $! -o comm=)" ]; do 341 | # Calculate elapsed time 342 | end_time=$(date +%s) 343 | elapsed_time=$((end_time - start_time)) 344 | 345 | # Check if the timeout has been reached 346 | if [ $elapsed_time -gt $timeout_duration ]; then 347 | echo -e "\r\033[K${R}●${NC} Installing filewatch service took to long to complete!\n" 348 | kill $! 349 | kill $loading_pid 350 | exit 1 351 | fi 352 | 353 | sleep 1 354 | done 355 | ); then 356 | echo -e "\r\033[K${G}●${NC} Installing filewatch service ${G}Done!${NC}\n" 357 | fi 358 | else 359 | tput cup $(($questionline - 2)) 0 360 | tput ed 361 | echo -e "\r\033[K${M}●${NC} Installing filewatch service ${M}skipped!${NC}\n" 362 | 363 | fi 364 | } 365 | 366 | install_backup_service() { 367 | questionline=$(getcursor) 368 | tput cup $(($questionline - 2)) 0 369 | tput ed 370 | pos1=$(getcursor) 371 | loading_wheel "${Y}●${NC} Checking for on-boot service" & 372 | loading_pid=$! 373 | if service_exists klipper-backup-on-boot; then 374 | echo -e "\r\033[K" 375 | kill $loading_pid 376 | message="Would you like to reinstall the on-boot backup service?" 377 | else 378 | echo -e "\r\033[K" 379 | kill $loading_pid 380 | message="Would you like to install the on-boot backup service?" 381 | fi 382 | if ask_yn "$message"; then 383 | tput cup $(($questionline - 2)) 0 384 | tput ed 385 | pos1=$(getcursor) 386 | loading_wheel "${Y}●${NC} Installing on-boot service" & 387 | loading_pid=$! 388 | if ( 389 | !( 390 | sudo systemctl stop klipper-backup-on-boot.service 2>/dev/null 391 | sudo cp $parent_path/install-files/klipper-backup-on-boot.service /etc/systemd/system/klipper-backup-on-boot.service 392 | sudo sed -i "s/^After=.*/After=$(wantsafter)/" "/etc/systemd/system/klipper-backup-on-boot.service" 393 | sudo sed -i "s/^Wants=.*/Wants=$(wantsafter)/" "/etc/systemd/system/klipper-backup-on-boot.service" 394 | sudo sed -i "s/^User=.*/User=${SUDO_USER:-$USER}/" "/etc/systemd/system/klipper-backup-on-boot.service" 395 | sudo systemctl daemon-reload 2>/dev/null 396 | sudo systemctl enable klipper-backup-on-boot.service 2>/dev/null 397 | sudo systemctl start klipper-backup-on-boot.service 2>/dev/null 398 | kill $loading_pid 399 | ) & 400 | 401 | start_time=$(date +%s) 402 | timeout_duration=20 403 | 404 | while [ "$(ps -p $! -o comm=)" ]; do 405 | # Calculate elapsed time 406 | end_time=$(date +%s) 407 | elapsed_time=$((end_time - start_time)) 408 | 409 | # Check if the timeout has been reached 410 | if [ $elapsed_time -gt $timeout_duration ]; then 411 | echo -e "\r\033[K${R}●${NC} Installing on-boot service took to long to complete!\n" 412 | kill $! 413 | kill $loading_pid 414 | exit 1 415 | fi 416 | 417 | sleep 1 418 | done 419 | ); then 420 | echo -e "\r\033[K${G}●${NC} Installing on-boot service ${G}Done!${NC}\n" 421 | fi 422 | else 423 | tput cup $(($questionline - 2)) 0 424 | tput ed 425 | echo -e "\r\033[K${M}●${NC} Installing on-boot service ${M}skipped!${NC}\n" 426 | fi 427 | } 428 | 429 | install_cron() { 430 | questionline=$(getcursor) 431 | if [ -x "$(command -v cron)" ]; then 432 | if ! (crontab -l 2>/dev/null | grep -q "$HOME/klipper-backup/script.sh"); then 433 | if ask_yn "Would you like to install the cron task? (automatic backup every 4 hours)"; then 434 | tput cup $(($questionline - 2)) 0 435 | tput ed 436 | pos1=$(getcursor) 437 | loading_wheel "${Y}●${NC} Installing cron task" & 438 | loading_pid=$! 439 | ( 440 | crontab -l 2>/dev/null 441 | echo "0 */4 * * * $HOME/klipper-backup/script.sh -c \"Cron backup - \$(date +'\\%x - \\%X')\"" 442 | ) | crontab - 443 | sleep .5 444 | kill $loading_pid 445 | echo -e "\r\033[K${G}●${NC} Installing cron task ${G}Done!${NC}\n" 446 | else 447 | tput cup $(($questionline - 2)) 0 448 | tput ed 449 | echo -e "\r\033[K${M}●${NC} Installing cron task ${M}skipped!${NC}\n" 450 | fi 451 | else 452 | tput cup $(($questionline - 2)) 0 453 | tput ed 454 | echo -e "\r\033[K${M}●${NC} Installing cron task ${M}skipped! (already Installed)${NC}\n" 455 | fi 456 | else 457 | tput cup $(($questionline - 2)) 0 458 | tput ed 459 | echo -e "\r\033[K${M}●${NC} Installing cron task ${M}skipped! (cron is not installed on system)${NC}\n" 460 | fi 461 | } 462 | 463 | if [ "$1" == "check_updates" ]; then 464 | check_updates 465 | else 466 | main 467 | fi 468 | -------------------------------------------------------------------------------- /script.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | # set dotglob so that bash treats hidden files/folders starting with . correctly when copying them (ex. .themes from mainsail) 4 | shopt -s dotglob 5 | 6 | # Set parent directory path 7 | parent_path=$( 8 | cd "$(dirname "${BASH_SOURCE[0]}")" 9 | pwd -P 10 | ) 11 | 12 | # Initialize variables from .env file 13 | source "$parent_path"/.env 14 | source "$parent_path"/utils/utils.func 15 | 16 | loading_wheel "${Y}●${NC} Checking for installed dependencies" & 17 | loading_pid=$! 18 | check_dependencies "jq" "curl" "rsync" 19 | kill $loading_pid 20 | echo -e "\r\033[K${G}●${NC} Checking for installed dependencies ${G}Done!${NC}\n" 21 | 22 | # Do not touch these variables, the .env file and the documentation exist for this purpose 23 | backup_folder="config_backup" 24 | backup_path="$HOME/$backup_folder" 25 | allow_empty_commits=${allow_empty_commits:-true} 26 | use_filenames_as_commit_msg=${use_filenames_as_commit_msg:-false} 27 | git_protocol=${git_protocol:-"https"} 28 | git_host=${git_host:-"github.com"} 29 | ssh_user=${ssh_user:-"git"} 30 | 31 | if [[ $git_protocol == "ssh" ]]; then 32 | full_git_url=$git_protocol"://"$ssh_user"@"$git_host"/"$github_username"/"$github_repository".git" 33 | else 34 | full_git_url=$git_protocol"://"$github_token"@"$git_host"/"$github_username"/"$github_repository".git" 35 | fi 36 | exclude=${exclude:-"*.swp" "*.tmp" "printer-[0-9]*_[0-9]*.cfg" "*.bak" "*.bkp" "*.csv" "*.zip"} 37 | 38 | # Required for checking the use of the commit_message and debug parameter 39 | commit_message_used=false 40 | debug_output=false 41 | # Collect args before they are consumed by getopts 42 | args="$@" 43 | 44 | # Check parameters 45 | while [[ $# -gt 0 ]]; do 46 | case "$1" in 47 | -h|--help) 48 | show_help 49 | exit 0 50 | ;; 51 | -f|--fix) 52 | fix 53 | shift 54 | ;; 55 | -c|--commit_message) 56 | if [[ -z "$2" || "$2" =~ ^- ]]; then 57 | echo -e "\r\033[K${R}Error: commit message expected after $1${NC}" >&2 58 | exit 1 59 | else 60 | commit_message="$2" 61 | commit_message_used=true 62 | shift 2 63 | fi 64 | ;; 65 | -d|--debug) 66 | debug_output=true 67 | shift 68 | ;; 69 | *) 70 | echo -e "\r\033[K${R}Unknown option: $1${NC}" 71 | show_help 72 | exit 1 73 | ;; 74 | esac 75 | done 76 | 77 | # Check for updates 78 | [ $(git -C "$parent_path" rev-parse HEAD) = $(git -C "$parent_path" ls-remote $(git -C "$parent_path" rev-parse --abbrev-ref @{u} | sed 's/\// /g') | cut -f1) ] && echo -e "Klipper-Backup is up to date\n" || echo -e "${Y}●${NC} Update for Klipper-Backup ${Y}Available!${NC}\n" 79 | 80 | # Check if .env is v1 version 81 | if [[ ! -v backupPaths ]]; then 82 | echo ".env file is not using version 2 config, upgrading to V2" 83 | if bash $parent_path/utils/v1convert.sh; then 84 | echo "Upgrade complete restarting script.sh" 85 | sleep 2.5 86 | exec "$parent_path/script.sh" "$args" 87 | fi 88 | fi 89 | 90 | if [ "$debug_output" = true ]; then 91 | # Debug output: Show last command 92 | begin_debug_line 93 | if [[ "$SHELL" == */bash* ]]; then 94 | echo -e "Command: $0 $args" 95 | fi 96 | end_debug_line 97 | 98 | # Debug output: .env file with hidden token 99 | begin_debug_line 100 | while IFS= read -r line; do 101 | if [[ $line == github_token=* ]]; then 102 | echo "github_token=****************" 103 | else 104 | echo "$line" 105 | fi 106 | done < $HOME/klipper-backup/.env 107 | end_debug_line 108 | 109 | # Debug output: Check git repo 110 | if [[ $git_host == "github.com" ]]; then 111 | begin_debug_line 112 | if curl -fsS "https://api.github.com/repos/${github_username}/${github_repository}" >/dev/null; then 113 | echo "The GitHub repo ${github_username}/${github_repository} exists (public)" 114 | else 115 | echo "Error: no GitHub repo ${github_username}/${github_repository} found (maybe private)" 116 | fi 117 | end_debug_line 118 | fi 119 | fi 120 | 121 | # Check if backup folder exists, create one if it does not 122 | if [ ! -d "$backup_path" ]; then 123 | mkdir -p "$backup_path" 124 | fi 125 | 126 | cd "$backup_path" 127 | 128 | # Debug output: $HOME 129 | [ "$debug_output" = true ] && begin_debug_line && echo -e "\$HOME: $HOME" && end_debug_line 130 | 131 | # Debug output: $backup_path - (current) path and content 132 | [ "$debug_output" = true ] && begin_debug_line && echo -e "\$backup_path: $PWD" && echo -e "\nContent of \$backup_path:" && echo -ne "$(ls -la $backup_path)\n" && end_debug_line 133 | 134 | # Debug output: $backup_path/.git/config content 135 | if [ "$debug_output" = true ]; then 136 | begin_debug_line 137 | echo -e "\$backup_path/.git/config:\n" 138 | while IFS= read -r line; do 139 | if [[ $line == *"url ="*@* ]]; then 140 | masked_line=$(echo "$line" | sed -E 's/(url = https:\/\/)[^@]*(@.*)/\1********\2/') 141 | echo "$masked_line" 142 | else 143 | echo "$line" 144 | fi 145 | done < "$backup_path/.git/config" 146 | end_debug_line 147 | fi 148 | 149 | # Check if .git exists else init git repo 150 | if [ ! -d ".git" ]; then 151 | mkdir .git 152 | echo "[init] 153 | defaultBranch = "$branch_name"" >>.git/config #Add desired branch name to config before init 154 | git init 155 | # Check if the current checked out branch matches the branch name given in .env if not branch listed in .env 156 | elif [[ $(git symbolic-ref --short -q HEAD) != "$branch_name" ]]; then 157 | echo -e "Branch: $branch_name in .env does not match the currently checked out branch of: $(git symbolic-ref --short -q HEAD)." 158 | # Create branch if it does not exist 159 | if git show-ref --quiet --verify "refs/heads/$branch_name"; then 160 | git checkout "$branch_name" >/dev/null 161 | else 162 | git checkout -b "$branch_name" >/dev/null 163 | fi 164 | fi 165 | 166 | # Check if username is defined in .env 167 | if [[ "$commit_username" != "" ]]; then 168 | git config user.name "$commit_username" 169 | else 170 | git config user.name "$(whoami)" 171 | sed -i "s/^commit_username=.*/commit_username=\"$(whoami)\"/" "$parent_path"/.env 172 | fi 173 | 174 | # Check if email is defined in .env 175 | if [[ "$commit_email" != "" ]]; then 176 | git config user.email "$commit_email" 177 | else 178 | unique_id=$(date +%s%N | md5sum | head -c 7) 179 | user_email=$(whoami)@$(hostname --short)-$unique_id 180 | git config user.email "$user_email" 181 | sed -i "s/^commit_email=.*/commit_email=\"$user_email\"/" "$parent_path"/.env 182 | fi 183 | 184 | # Check if remote origin already exists and create if one does not 185 | if [ -z "$(git remote get-url origin 2>/dev/null)" ]; then 186 | git remote add origin "$full_git_url" 187 | fi 188 | 189 | # Check if remote origin changed and update when it is 190 | if [[ "$full_git_url" != $(git remote get-url origin) ]]; then 191 | git remote set-url origin "$full_git_url" 192 | fi 193 | 194 | # Check if branch exists on remote (newly created repos will not yet have a remote) and pull any new changes 195 | if git ls-remote --exit-code --heads origin $branch_name >/dev/null 2>&1; then 196 | git pull origin "$branch_name" 197 | # Delete the pulled files so that the directory is empty again before copying the new backup 198 | # The pull is only needed so that the repository nows its on latest and does not require rebases or merges 199 | find "$backup_path" -maxdepth 1 -mindepth 1 ! -name '.git' ! -name 'README.md' -exec rm -rf {} \; 200 | fi 201 | 202 | cd "$HOME" 203 | # Iterate through backupPaths array and copy files to the backup folder while ignoring symbolic links 204 | for path in "${backupPaths[@]}"; do 205 | fullPath="$HOME/$path" 206 | if [[ -d "$fullPath" && ! -f "$fullPath" ]]; then 207 | # Check if the directory path ends with only a '/' 208 | if [[ "$path" =~ /$ ]]; then 209 | # If it ends with '/', replace it with '/*' 210 | backupPaths[$i]="$path*" 211 | elif [[ -d "$path" ]]; then 212 | # If it's a directory without '/', add '/*' at the end 213 | backupPaths[$i]="$path/*" 214 | fi 215 | fi 216 | 217 | if compgen -G "$fullPath" >/dev/null; then 218 | # Iterate over every file in the path 219 | for file in $path; do 220 | # Skip if file is symbolic link 221 | if [ -h "$file" ]; then 222 | echo "Skipping symbolic link: $file" 223 | else 224 | file=$(readlink -e "$file") # Get absolute path before copy (Allows usage of .. in filepath eg. ../../etc/fstab resovles to /etc/fstab ) 225 | rsync -Rr "${file##"$HOME"/}" "$backup_path" 226 | fi 227 | done 228 | fi 229 | done 230 | 231 | # Debug output: $backup_path content after running rsync 232 | [ "$debug_output" = true ] && begin_debug_line && echo -e "Content of \$backup_path after rsync:" && echo -ne "$(ls -la $backup_path)\n" && end_debug_line 233 | 234 | cp "$parent_path"/.gitignore "$backup_path/.gitignore" 235 | 236 | # utilize gits native exclusion file .gitignore to add files that should not be uploaded to remote. 237 | # Loop through exclude array and add each element to the end of .gitignore 238 | for i in ${exclude[@]}; do 239 | # add new line to end of .gitignore if there is not one 240 | [[ $(tail -c1 "$backup_path/.gitignore" | wc -l) -eq 0 ]] && echo "" >>"$backup_path/.gitignore" 241 | echo $i >>"$backup_path/.gitignore" 242 | done 243 | 244 | # Individual commit message, if no parameter is set, use the current timestamp as commit message 245 | if ! $commit_message_used; then 246 | commit_message="New backup from $(date +"%x - %X")" 247 | fi 248 | 249 | cd "$backup_path" 250 | # Create and add Readme to backup folder if it doesn't already exist 251 | if ! [ -f "README.md" ]; then 252 | echo -e "# Klipper-Backup 💾 \nKlipper backup script for manual or automated GitHub backups \n\nThis backup is provided by [Klipper-Backup](https://github.com/Staubgeborener/klipper-backup)." >"$backup_path/README.md" 253 | fi 254 | 255 | # Show in commit message which files have been changed 256 | if $use_filenames_as_commit_msg; then 257 | commit_message=$(git diff --name-only "$branch_name" | xargs -n 1 basename | tr '\n' ' ') 258 | fi 259 | 260 | # Untrack all files so that any new excluded files are correctly ignored and deleted from remote 261 | git rm -r --cached . >/dev/null 2>&1 262 | git add . 263 | git commit -m "$commit_message" 264 | # Check if HEAD still matches remote (Means there are no updates to push) and create a empty commit just informing that there are no new updates to push 265 | if $allow_empty_commits && [[ $(git rev-parse HEAD) == $(git ls-remote $(git rev-parse --abbrev-ref @{u} 2>/dev/null | sed 's/\// /g') | cut -f1) ]]; then 266 | git commit --allow-empty -m "$commit_message - No new changes pushed" 267 | fi 268 | git push -u origin "$branch_name" 269 | 270 | # Remove files except .git folder after backup so that any file deletions can be logged on next backup 271 | find "$backup_path" -maxdepth 1 -mindepth 1 ! -name '.git' ! -name 'README.md' -exec rm -rf {} \; 272 | -------------------------------------------------------------------------------- /utils/filewatch.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | source "$HOME/klipper-backup/.env" 4 | watchlist="" 5 | for path in "${backupPaths[@]}"; do 6 | for file in $path; do 7 | if [ ! -h "$file" ]; then 8 | file_dir=$(dirname "$file") 9 | if [ "$file_dir" = "." ]; then 10 | watchlist+=" $HOME/$file" 11 | else 12 | watchlist+=" $HOME/$file_dir" 13 | fi 14 | fi 15 | done 16 | done 17 | 18 | watchlist=$(echo "$watchlist" | tr ' ' '\n' | sort -u | tr '\n' ' ') 19 | 20 | exclude_pattern=".swp|.tmp|printer-[0-9]*_[0-9]*.cfg|.bak|.bkp" 21 | 22 | inotifywait -mrP -e close_write -e move -e delete --exclude "$exclude_pattern" $watchlist | 23 | while read -r path event file; do 24 | if [ -z "$file" ]; then 25 | file=$(basename "$path") 26 | fi 27 | echo "Event Type: $event, Watched Path: $path, File Name: $file" 28 | file="$file" /usr/bin/env bash -c "/usr/bin/env bash $HOME/klipper-backup/script.sh -c \"\$file modified - \$(date +'%x - %X')\"" > /dev/null 2>&1 29 | done 30 | -------------------------------------------------------------------------------- /utils/utils.func: -------------------------------------------------------------------------------- 1 | R=$'\e[1;91m' # Red ${R} 2 | G=$'\e[1;92m' # Green ${G} 3 | Y=$'\e[1;93m' # Yellow ${Y} 4 | M=$'\e[1;95m' # Magenta ${M} 5 | C=$'\e[96m' # Cyan ${C} 6 | NC=$'\e[0m' # No Color ${NC} 7 | 8 | # Create unique id for git email 9 | getUniqueid() { 10 | echo $(date +%s%N | md5sum | head -c 7) 11 | } 12 | 13 | wantsafter() { 14 | if dpkg -l | grep -q '^ii.*network-manager' && systemctl is-active --quiet "NetworkManager"; then 15 | echo "NetworkManager-wait-online.service" 16 | else 17 | echo "network-online.target" 18 | fi 19 | } 20 | 21 | loading_wheel() { 22 | local frames="/ - \\ |" 23 | local delay=0.1 24 | 25 | while :; do 26 | for frame in $frames; do 27 | echo -n -e "\r$1 $frame" 28 | sleep $delay 29 | done 30 | done 31 | } 32 | 33 | getcursor() { 34 | local pos 35 | IFS='[;' read -p $'\e[6n' -d R -a pos -rs || echo "failed with error: $? ; ${pos[*]}" 36 | echo "${pos[1]}" 37 | } 38 | 39 | run_command() { 40 | command=$1 41 | loading_wheel " ${Y}●${NC} Running $command" & 42 | loading_pid=$! 43 | sudo $command >/dev/null 2>&1 44 | kill $loading_pid 45 | echo -e "\r\033[K ${G}●${NC} Running $command ${G}Done!${NC}" 46 | } 47 | 48 | # Move cursor up one line and clear the line 49 | clearUp() { 50 | echo -e "\r\033[K\033[1A" 51 | } 52 | 53 | logo() { 54 | clear 55 | echo -e "${C}$( 56 | cat <<"EOF" 57 | __ __ ___ ____ __ ____ __ ____ 58 | / //_// (_)___ ____ ___ _____ / __ )____ ______/ /____ ______ / _/___ _____/ /_____ _/ / / 59 | / ,< / / / __ \/ __ \/ _ \/ ___/_____/ __ / __ `/ ___/ //_/ / / / __ \______ / // __ \/ ___/ __/ __ `/ / / 60 | / /| |/ / / /_/ / /_/ / __/ / /_____/ /_/ / /_/ / /__/ ,< / /_/ / /_/ /_____// // / / (__ ) /_/ /_/ / / / 61 | /_/ |_/_/_/ .___/ .___/\___/_/ /_____/\__,_/\___/_/|_|\__,_/ .___/ /___/_/ /_/____/\__/\__,_/_/_/ 62 | /_/ /_/ /_/ 63 | EOF 64 | )${NC}" 65 | echo "" 66 | echo "===============================================================================================================" 67 | echo "" 68 | } 69 | 70 | ask_yn() { 71 | while true; do 72 | read -rp "$1 (yes/no, default is yes): " answer 73 | case $answer in 74 | [Yy]* | "") return 0 ;; 75 | [Nn]*) return 1 ;; 76 | *) ;; 77 | esac 78 | done 79 | } 80 | 81 | ask_token() { 82 | local prompt="$1: " 83 | local input="" 84 | echo -n "$prompt" >&2 85 | stty -echo # Disable echoing of characters 86 | while IFS= read -rs -n 1 char; do 87 | if [[ $char == $'\0' || $char == $'\n' ]]; then 88 | break 89 | elif [[ $char == $'\177' ]]; then # Check for backspace character 90 | if [ -n "$input" ]; then # Check if input is not empty 91 | input=${input%?} # Remove last character from input 92 | echo -en "\b \b" >&2 # Move cursor back, overwrite with space, move cursor back again 93 | fi 94 | else 95 | input+=$char 96 | echo -n "*" >&2 # Explicitly echo asterisks to stderr 97 | fi 98 | done 99 | stty echo # Re-enable echoing 100 | echo >&2 # Move to a new line after user input 101 | echo "$input" 102 | } 103 | 104 | ask_textinput() { 105 | if [ -n "$2" ]; then 106 | read -rp "$1 (default is $2): " input 107 | echo "${input:-$2}" 108 | else 109 | read -rp "$1: " input 110 | echo "$input" 111 | fi 112 | } 113 | 114 | # Function to move the cursor to a specific position 115 | function move_cursor() { 116 | echo -e "\033[${1};${2}H" 117 | } 118 | 119 | # Function to display the menu and return status codes 120 | function menu() { 121 | choice=1 122 | while true; do 123 | # Highlight the current choice 124 | if [ $choice -eq 1 ]; then 125 | echo -e "\e[7m1. Confirm\e[0m" 126 | echo "2. Re-enter" 127 | else 128 | echo "1. Confirm" 129 | echo -e "\e[7m2. Re-enter\e[0m" 130 | fi 131 | 132 | read -sn 1 key 133 | 134 | case $key in 135 | [1-2]) # Number keys 1 and 2 136 | choice=$key 137 | ;; 138 | A) # Up arrow 139 | if [ $choice -eq 2 ]; then 140 | ((choice--)) 141 | fi 142 | ;; 143 | B) # Down arrow 144 | if [ $choice -eq 1 ]; then 145 | ((choice++)) 146 | fi 147 | ;; 148 | "") # Enter key 149 | case $choice in 150 | 1) 151 | return 0 152 | ;; 153 | 2) 154 | return 1 155 | ;; 156 | esac 157 | ;; 158 | esac 159 | 160 | move_cursor $pos2 0 161 | 162 | done 163 | } 164 | 165 | check_ghToken() { 166 | GITHUB_TOKEN="$1" 167 | API_URL="https://api.github.com/user" 168 | 169 | response=$(curl -s -H "Authorization: token $GITHUB_TOKEN" $API_URL) 170 | 171 | if [[ $response =~ "message" ]]; then 172 | ghtoken_username="" 173 | echo $ghtoken_username 174 | else 175 | ghtoken_username=$(echo $response | jq -r '.login') 176 | echo $ghtoken_username 177 | fi 178 | } 179 | 180 | service_exists() { 181 | if systemctl list-unit-files | grep -q "$1.service"; then 182 | return 0 # Service exists 183 | else 184 | return 1 # Service does not exist 185 | fi 186 | } 187 | 188 | checkinotify() { 189 | local_version=$(inotifywait -h | grep -oP '\d+\.\d+\.\d+\.\d+') 190 | # Get the latest release information from the GitHub repository 191 | latest_release=$(curl -s "https://api.github.com/repos/inotify-tools/inotify-tools/releases/latest") 192 | # Extract the latest release version number 193 | latest_version=$(echo "$latest_release" | jq -r '.tag_name') 194 | 195 | # Compare the installed version with the latest version 196 | if [[ $local_version == $latest_version ]]; then 197 | return 0 #Local matches latest 198 | else 199 | return 1 #Local does not match latest 200 | fi 201 | } 202 | 203 | check_dependencies() { 204 | for pkg in "$@"; do 205 | if ! command -v "$pkg" &>/dev/null; then 206 | # Check the package manager and attempt a silent install 207 | if command -v apt-get &>/dev/null; then 208 | sudo apt-get update >/dev/null 209 | sudo apt-get install -y "$pkg" >/dev/null 2>&1 210 | elif command -v dnf &>/dev/null; then 211 | sudo dnf install -y "$pkg" >/dev/null 2>&1 212 | elif command -v pacman &>/dev/null; then 213 | sudo pacman -S --noconfirm "$pkg" >/dev/null 2>&1 214 | elif command -v apk &>/dev/null; then 215 | sudo apk add "$pkg" >/dev/null 2>&1 216 | else 217 | echo "Unsupported package manager. Please install '$pkg' manually." 218 | return 1 219 | fi 220 | 221 | # Check if the installation was successful 222 | if ! dpkg -s "$pkg" >/dev/null 2>&1; then 223 | echo "Installation failed. Please install '$pkg' manually." 224 | return 1 225 | fi 226 | fi 227 | done 228 | } 229 | 230 | removeOldInotify() { 231 | oldInotify=("inotifywait" "libinotifytools0" "libinotifytools0-dev") 232 | for pkg in "${oldInotify[@]}"; do 233 | # Check the package manager and attempt a silent install 234 | if command -v apt-get &>/dev/null; then 235 | sudo apt remove -y $pkg >/dev/null 2>&1 236 | elif command -v dnf &>/dev/null; then 237 | sudo dnf remove -y $pkg >/dev/null 2>&1 238 | elif command -v pacman &>/dev/null; then 239 | sudo pacman -Rs --noconfirm $pkg >/dev/null 2>&1 240 | elif command -v apk &>/dev/null; then 241 | sudo apk remove $pkg >/dev/null 2>&1 242 | else 243 | echo "Unsupported package manager. Please remove inotify-tools manually." 244 | return 1 245 | fi 246 | done 247 | } 248 | 249 | show_help(){ 250 | echo "Usage: $(basename $0) [OPTION]..." 251 | echo "Klipper-Backup is a script for manual or automated Klipper GitHub backups. It's Lightweight, pragmatic and comfortable." 252 | echo "https://github.com/Staubgeborener/klipper-backup" 253 | echo "https://klipperbackup.xyz" 254 | echo 255 | echo "Options:" 256 | echo " -h, --help display this help and exit" 257 | echo " -c, --commit_message [TEXT] use your own commit message for the git push" 258 | echo " -f, --fix delete the config_backup folder. This can help to solve the vast majority of error messages" 259 | echo " -d, --debug debugging output" 260 | echo 261 | echo "Examples:" 262 | echo " $(basename $0) --help" 263 | echo " $(basename $0) --commit_message \"My own commit message\"" 264 | echo " $(basename $0) --fix" 265 | echo " $(basename $0) --debug" 266 | } 267 | 268 | fix(){ 269 | loading_wheel "${Y}●{NC} Delete config_backup folder" & 270 | loading_pid=$! 271 | if [ ! -d "$HOME/$backup_folder" ]; then 272 | echo -e "\r\033[K${R}config_backup folder does exist${NC}\n" 273 | else 274 | rm -rf $HOME/$backup_folder 275 | echo -e "\r\033[K${G}●${NC} Delete config_backup folder ${G}Done!${NC}\n" 276 | fi 277 | kill $loading_pid 278 | exit 279 | 280 | } 281 | 282 | begin_debug_line(){ 283 | echo -e "\n------------DEBUG:------------" 284 | } 285 | 286 | end_debug_line(){ 287 | echo -e "------------------------------\n" 288 | } 289 | -------------------------------------------------------------------------------- /utils/v1convert.sh: -------------------------------------------------------------------------------- 1 | backupPaths=() 2 | configOptions=() 3 | 4 | scriptsh_parent_path=$( 5 | cd "$(dirname "${BASH_SOURCE[0]}")" 6 | cd .. 7 | pwd -P 8 | ) 9 | 10 | envpath="$scriptsh_parent_path/.env" 11 | 12 | source "$envpath" 13 | cp "$envpath" "$envpath.bkp" 14 | 15 | while IFS= read -r line; do 16 | if [[ $line == *"empty_commit"* ]]; then 17 | if [[ $line == "#"* ]]; then 18 | if [[ $line == *"yes"* ]]; then 19 | line="#allow_empty_commits=true" 20 | else 21 | line="#allow_empty_commits=false" 22 | fi 23 | else 24 | if [[ $line == *"yes"* ]]; then 25 | line="allow_empty_commits=true" 26 | else 27 | line="allow_empty_commits=false" 28 | fi 29 | fi 30 | fi 31 | configOptions+="$line \n" 32 | done < <(grep -m 1 -n "# Indivdual file syntax:" $envpath | cut -d ":" -f 1 | xargs -I {} expr {} - 1 | xargs -I {} head -n {} $envpath) 33 | 34 | 35 | while IFS= read -r path; do 36 | # Check if path is a directory or not a file (needed for /* checking as /* treats the path as not a directory) 37 | if [[ -d "$HOME/$path" && ! -f "$HOME/$path" ]]; then 38 | # Check if path does not end in /* or / 39 | if [[ ! "$path" =~ /\*$ && ! "$path" =~ /$ ]]; then 40 | path="$path/*" 41 | elif [[ ! "$path" =~ \$ && ! "$path" =~ /\*$ ]]; then 42 | path="$path*" 43 | fi 44 | fi 45 | backupPaths+=("$path") 46 | done < <(grep -v '^#' "$envpath" | grep 'path_' | sed 's/^.*=//') 47 | 48 | newbackupPaths="backupPaths=( \\ \n" 49 | for path in "${backupPaths[@]}"; do 50 | newbackupPaths+=" \"$path\" \\ \n" 51 | done 52 | newbackupPaths+=")" 53 | 54 | newexclude="exclude=( \\ \n" 55 | for extension in "${exclude[@]}"; do 56 | newexclude+=" \"$extension\" \\ \n" 57 | done 58 | newexclude+=")" 59 | 60 | rm "$envpath" 61 | cat >>"$envpath" <