├── .github └── workflows │ └── linter.yml ├── LICENSE ├── README.md └── install-docker.sh /.github/workflows/linter.yml: -------------------------------------------------------------------------------- 1 | --- 2 | ########################### 3 | ########################### 4 | ## Linter GitHub Actions ## 5 | ########################### 6 | ########################### 7 | name: Lint Code Base 8 | 9 | # 10 | # Documentation: 11 | # https://help.github.com/en/articles/workflow-syntax-for-github-actions 12 | # 13 | 14 | ############################# 15 | # Start the job on all push # 16 | ############################# 17 | on: 18 | push: 19 | pull_request: 20 | branches: [main] 21 | 22 | ############### 23 | # Set the Job # 24 | ############### 25 | jobs: 26 | build: 27 | # Name the Job 28 | name: Lint Code Base 29 | # Set the agent to run on 30 | runs-on: ubuntu-latest 31 | 32 | ################## 33 | # Load all steps # 34 | ################## 35 | steps: 36 | ########################## 37 | # Checkout the code base # 38 | ########################## 39 | - name: Checkout Code 40 | uses: actions/checkout@v2 41 | with: 42 | # Full git history is needed to get a proper list of changed files within `super-linter` 43 | fetch-depth: 0 44 | 45 | ################################ 46 | # Run Linter against code base # 47 | ################################ 48 | - name: Lint Code Base 49 | uses: github/super-linter@v4.10.1 50 | env: 51 | SHELLCHECK_OPTS: "-e SC1091 -e SC2295 -e SC2317" 52 | VALIDATE_ALL_CODEBASE: false 53 | VALIDATE_MARKDOWN: false 54 | ERROR_ON_MISSING_EXEC_BIT: true 55 | DEFAULT_BRANCH: main 56 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 57 | FILTER_REGEX_EXCLUDE: README.md -------------------------------------------------------------------------------- /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 | # install-docker.sh 2 | 3 | This is a script to install docker binaries. It can help you quickly extract the docker binaries from various mirrors without the steps of setting up the repository. 4 | 5 | Supports installation on more operating systems, centos, debian, ubuntu, openSUSE, Kali, archlinux, manjaro, gentoo, Alpine, voidlinux, artixlinux, antixlinux. 6 | 7 | Support docker-compose binary installation. 8 | 9 | Support systemd、openrc、runit. 10 | 11 | ## Quickstart 12 | 13 | ```bash 14 | curl -fsSL https://mirror.ghproxy.com/https://raw.githubusercontent.com/dyrnq/install-docker/main/install-docker.sh | bash -s docker \ 15 | --mirror Tuna \ 16 | --version 27.1.1 17 | ``` 18 | 19 | or with docker-compose 20 | 21 | ```bash 22 | curl -fsSL https://cdn.jsdelivr.net/gh/dyrnq/install-docker@main/install-docker.sh | bash -s docker \ 23 | --mirror Tuna \ 24 | --version 27.1.1 \ 25 | --with-compose \ 26 | --compose-version 2.29.1 \ 27 | --compose-mirror daocloud 28 | ``` 29 | 30 | or with docker-compose plugin 31 | 32 | ```bash 33 | mkdir -p /usr/local/lib/docker/cli-plugins 34 | curl -fsSL https://mirror.ghproxy.com/https://raw.githubusercontent.com/dyrnq/install-docker/main/install-docker.sh | bash -s docker \ 35 | --mirror tencent \ 36 | --version 27.1.1 \ 37 | --with-compose \ 38 | --compose-version 2.29.1 \ 39 | --compose-mirror daocloud \ 40 | --compose-prefix /usr/local/lib/docker/cli-plugins \ 41 | --systemd-mirror "ghproxy" 42 | ``` 43 | 44 | ## Get 45 | 46 | ```bash 47 | git clone --depth 1 https://github.com/dyrnq/install-docker.git 48 | ``` 49 | 50 | or 51 | 52 | ```bash 53 | curl -fsSL -O https://raw.githubusercontent.com/dyrnq/install-docker/main/install-docker.sh 54 | 55 | or 56 | 57 | curl -fsSL -O https://cdn.jsdelivr.net/gh/dyrnq/install-docker@main/install-docker.sh 58 | 59 | or 60 | 61 | curl -fsSL -O https://mirror.ghproxy.com/https://raw.githubusercontent.com/dyrnq/install-docker/main/install-docker.sh 62 | 63 | chmod +x ./install-docker.sh 64 | ``` 65 | 66 | ## Usage 67 | 68 | * --version 69 | 70 | ```bash 71 | ./install-docker.sh --mirror Tuna --version 27.1.1 --prefix /usr/local/bin 72 | ``` 73 | 74 | * --mirror 75 | 76 | | mirror | mirror web address | 77 | |-------------|---------------------------------------------------| 78 | | aliyun | | 79 | | 163 | | 80 | | tencent | | 81 | | huaweicloud | | 82 | | tuna | | 83 | | tsinghua | | 84 | | nyist | | 85 | | ustc | | 86 | | sjtu | | 87 | | zju | | 88 | | nju | | 89 | | njupt | | 90 | | bfsu | | 91 | | nwafu | | 92 | | sustech | | 93 | | hit | | 94 | | xtom | | 95 | | pku | | 96 | | ynu | | 97 | | bupt | | 98 | | njtech | | 99 | | qlu | | 100 | 101 | * --with-compose 102 | 103 | ```bash 104 | ./install-docker.sh --mirror Tuna --version 27.1.1 --prefix /usr/local/bin --with-compose --compose-version 2.29.1 --compose-mirror daocloud --compose-prefix /usr/local/bin 105 | ``` 106 | 107 | * --dry-run 108 | 109 | ```bash 110 | ./install-docker.sh --mirror Tuna --dry-run 111 | ``` 112 | 113 | ## Command-Line Options 114 | 115 | | Name | Description | Default | 116 | | ---------- | ---------------- | ---------------------- | 117 | | --mirror | mirror of docker binary download url | | 118 | | --prefix | docker binary installation directory | /usr/local/bin | 119 | | --version | docker binary version | 20.10.2 | 120 | | --with-compose | install docker-compose | | 121 | | --compose-prefix | docker-compose installation directory | /usr/local/bin | 122 | | --compose-version | docker-compose version | 1.28.2 | 123 | | --compose-mirror | mirror of docker-compose download url | | 124 | | --systemd-mirror | mirror of dockerd`s systemd unit files | jsdelivr | 125 | | --no-systemd | do not install dockerd`s systemd unit files | | 126 | | --daemon-json | daemon.json path or url | | 127 | | --daemon-json-prefix | daemon.json path | /etc/docker | 128 | | --no-daemon-json | do not install daemon.json | | 129 | | --with-openrc | will install dockerd`s init.d files | | 130 | | --openrc-mirror | mirror of dockerd`s init.d files | jsdelivr | 131 | | --with-runit | will install dockerd`s runit files | | 132 | | --runit-mirror | mirror of dockerd`s runit files | jsdelivr | 133 | | --dry-run | dry run | | 134 | | --override-existing | override existing | | 135 | 136 | ## Tks 137 | 138 | * [https://get.docker.com/](https://get.docker.com/) 139 | * [https://mirrorz.org/](https://mirrorz.org/) 140 | * 141 | * 142 | -------------------------------------------------------------------------------- /install-docker.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -Eeo pipefail 3 | 4 | 5 | DEFAULT_DOWNLOAD_URL="https://download.docker.com" 6 | DEFAULT_PREFIX=/usr/local/bin 7 | DEFAULT_VERSION="20.10.2" 8 | DEFAULT_COMPOSE_VERSION="1.28.2" 9 | DEFAULT_COMPOSE_DOWNLOAD_URL="https://github.com/docker/compose" 10 | DEFAULT_COMPOSE_PREFIX=${DEFAULT_PREFIX} 11 | # The channel to install from: 12 | # * nightly 13 | # * test 14 | # * stable 15 | # * edge (deprecated) 16 | DEFAULT_CHANNEL_VALUE="stable" 17 | DEFAULT_SYSTEMD_DOCKER_SERVICE="https://cdn.jsdelivr.net/gh/moby/moby@master/contrib/init/systemd/docker.service" 18 | DEFAULT_SYSTEMD_DOCKER_SOCKET="https://cdn.jsdelivr.net/gh/moby/moby@master/contrib/init/systemd/docker.socket" 19 | DEFAULT_SYSTEMD_CONTAINERD_SERVICE="https://cdn.jsdelivr.net/gh/containerd/containerd@main/containerd.service" 20 | DEFAULT_SYSTEMD_PREFIX=/usr/lib/systemd/system 21 | DEFAULT_SYSTEMD=1 22 | DEFAULT_WRITE_DAEMON_JSON_FILE=1 23 | DEFAULT_DAEMON_JSON_FILE_PREFIX="/etc/docker" 24 | DEFAULT_DAEMON_JSON_VAR="{\"live-restore\":true,\"registry-mirrors\":[\"https://docker.mirrors.ustc.edu.cn\"],\"storage-driver\":\"overlay2\",\"log-level\":\"info\",\"log-driver\":\"json-file\",\"log-opts\":{\"max-size\":\"100m\"}}" 25 | 26 | OPENRC_DOCKER_CONFD="https://cdn.jsdelivr.net/gh/alpinelinux/aports@master/community/docker/docker.confd" 27 | OPENRC_DOCKER_INITD="https://cdn.jsdelivr.net/gh/alpinelinux/aports@master/community/docker/docker.initd" 28 | 29 | RUNIT_DOCKER_RUN="https://cdn.jsdelivr.net/gh/void-linux/void-packages@master/srcpkgs/moby/files/docker/run" 30 | 31 | if [ -z "$CHANNEL" ]; then 32 | CHANNEL=$DEFAULT_CHANNEL_VALUE 33 | fi 34 | 35 | if [ -z "$DOWNLOAD_URL" ]; then 36 | DOWNLOAD_URL=$DEFAULT_DOWNLOAD_URL 37 | fi 38 | 39 | if [ -z "$PREFIX" ]; then 40 | PREFIX=$DEFAULT_PREFIX 41 | fi 42 | 43 | if [ -z "$VERSION" ]; then 44 | VERSION=$DEFAULT_VERSION 45 | fi 46 | 47 | if [ -z "$COMPOSE_VERSION" ]; then 48 | COMPOSE_VERSION=$DEFAULT_COMPOSE_VERSION 49 | fi 50 | 51 | if [ -z "$COMPOSE_PREFIX" ]; then 52 | COMPOSE_PREFIX=$DEFAULT_COMPOSE_PREFIX 53 | fi 54 | 55 | if [ -z "$COMPOSE_DOWNLOAD_URL" ]; then 56 | COMPOSE_DOWNLOAD_URL=$DEFAULT_COMPOSE_DOWNLOAD_URL 57 | fi 58 | 59 | if [ -z "$SYSTEMD_DOCKER_SERVICE" ]; then 60 | SYSTEMD_DOCKER_SERVICE=$DEFAULT_SYSTEMD_DOCKER_SERVICE 61 | fi 62 | 63 | if [ -z "$SYSTEMD_DOCKER_SOCKET" ]; then 64 | SYSTEMD_DOCKER_SOCKET=$DEFAULT_SYSTEMD_DOCKER_SOCKET 65 | fi 66 | 67 | if [ -z "$SYSTEMD_CONTAINERD_SERVICE" ]; then 68 | SYSTEMD_CONTAINERD_SERVICE=$DEFAULT_SYSTEMD_CONTAINERD_SERVICE 69 | fi 70 | 71 | if [ -z "$SYSTEMD_PREFIX" ]; then 72 | if [ -d "$DEFAULT_SYSTEMD_PREFIX" ]; then 73 | SYSTEMD_PREFIX=$DEFAULT_SYSTEMD_PREFIX 74 | elif [ -d "/etc/systemd/system" ]; then 75 | SYSTEMD_PREFIX="/etc/systemd/system" 76 | fi 77 | fi 78 | if [ -z "$DAEMON_JSON_FILE_PREFIX" ]; then 79 | DAEMON_JSON_FILE_PREFIX=$DEFAULT_DAEMON_JSON_FILE_PREFIX 80 | fi 81 | 82 | 83 | 84 | mirror='' 85 | compose_mirror='' 86 | systemd_mirror='' 87 | openrc_mirror='' 88 | runit_mirror='' 89 | SYSTEMD=${DEFAULT_SYSTEMD:-} 90 | DRY_RUN=${DRY_RUN:-} 91 | OVERRIDE_EXISTING=${OVERRIDE_EXISTING:-} 92 | WITH_COMPOSE=${WITH_COMPOSE:-} 93 | WITH_OPENRC=${WITH_OPENRC:-} 94 | WITH_RUNIT=${WITH_RUNIT:-} 95 | WRITE_DAEMON_JSON_FILE=${DEFAULT_WRITE_DAEMON_JSON_FILE:-} 96 | DAEMON_JSON_FILE=${DAEMON_JSON_FILE:-} 97 | FLAG_PREFIX=${FLAG_PREFIX:-} 98 | FLAG_COMPOSE_PREFIX=${FLAG_COMPOSE_PREFIX:-} 99 | NO_MKDIR=${NO_MKDIR:-} 100 | while [ $# -gt 0 ]; do 101 | case "$1" in 102 | --mirror) 103 | mirror_opt="$2" 104 | mirror="$(echo "$mirror_opt" | tr '[:upper:]' '[:lower:]')" 105 | shift 106 | ;; 107 | --prefix) 108 | PREFIX="$2" 109 | FLAG_PREFIX=1 110 | shift 111 | ;; 112 | --version) 113 | VERSION="$2" 114 | shift 115 | ;; 116 | --compose-prefix) 117 | COMPOSE_PREFIX="$2" 118 | FLAG_COMPOSE_PREFIX=1 119 | shift 120 | ;; 121 | --compose-version) 122 | COMPOSE_VERSION="$2" 123 | shift 124 | ;; 125 | --compose-mirror) 126 | compose_mirror_opt="$2" 127 | compose_mirror="$(echo "$compose_mirror_opt" | tr '[:upper:]' '[:lower:]')" 128 | shift 129 | ;; 130 | --dry-run) 131 | DRY_RUN=1 132 | ;; 133 | --override-existing) 134 | OVERRIDE_EXISTING=1 135 | ;; 136 | --no-systemd) 137 | SYSTEMD='' 138 | ;; 139 | --daemon-json) 140 | WRITE_DAEMON_JSON_FILE=1 141 | DAEMON_JSON_FILE="$2" 142 | ;; 143 | --daemon-json-prefix) 144 | DAEMON_JSON_FILE_PREFIX="$2" 145 | shift 146 | ;; 147 | --no-daemon-json) 148 | WRITE_DAEMON_JSON_FILE='' 149 | ;; 150 | --systemd-mirror) 151 | systemd_mirror_opt="$2" 152 | systemd_mirror="$(echo "$systemd_mirror_opt" | tr '[:upper:]' '[:lower:]')" 153 | shift 154 | ;; 155 | --openrc-mirror) 156 | openrc_mirror_opt="$2" 157 | openrc_mirror="$(echo "$openrc_mirror_opt" | tr '[:upper:]' '[:lower:]')" 158 | shift 159 | ;; 160 | --runit-mirror) 161 | runit_mirror_opt="$2" 162 | runit_mirror="$(echo "$runit_mirror_opt" | tr '[:upper:]' '[:lower:]')" 163 | shift 164 | ;; 165 | --systemd-prefix) 166 | SYSTEMD_PREFIX="$2" 167 | shift 168 | ;; 169 | --with-compose) 170 | WITH_COMPOSE=1 171 | ;; 172 | --with-openrc) 173 | WITH_OPENRC=1 174 | ;; 175 | --with-runit) 176 | WITH_RUNIT=1 177 | ;; 178 | --no-mkdir) 179 | NO_MKDIR=1 180 | ;; 181 | --*) 182 | echo "Illegal option $1" 183 | ;; 184 | esac 185 | shift $(( $# > 0 ? 1 : 0 )) 186 | done 187 | 188 | case "$mirror" in 189 | aliyun) 190 | DOWNLOAD_URL="https://mirrors.aliyun.com/docker-ce" 191 | ;; 192 | huaweicloud) 193 | DOWNLOAD_URL="https://repo.huaweicloud.com/docker-ce" 194 | ;; 195 | 163) 196 | DOWNLOAD_URL="https://mirrors.163.com/docker-ce" 197 | ;; 198 | tencent) 199 | DOWNLOAD_URL="https://mirrors.cloud.tencent.com/docker-ce" 200 | ;; 201 | tsinghua|tuna) 202 | DOWNLOAD_URL="https://mirrors.tuna.tsinghua.edu.cn/docker-ce" 203 | ;; 204 | nyist) 205 | DOWNLOAD_URL="https://mirror.nyist.edu.cn/docker-ce" 206 | ;; 207 | ustc) 208 | DOWNLOAD_URL="https://mirrors.ustc.edu.cn/docker-ce" 209 | ;; 210 | sjtu) 211 | DOWNLOAD_URL="https://mirror.sjtu.edu.cn/docker-ce" 212 | ;; 213 | zju) 214 | DOWNLOAD_URL="https://mirrors.zju.edu.cn/docker-ce" 215 | ;; 216 | nju) 217 | DOWNLOAD_URL="https://mirrors.nju.edu.cn/docker-ce" 218 | ;; 219 | njupt) 220 | DOWNLOAD_URL="https://mirrors.njupt.edu.cn/docker-ce" 221 | ;; 222 | bfsu) 223 | DOWNLOAD_URL="https://mirrors.bfsu.edu.cn/docker-ce" 224 | ;; 225 | nwafu) 226 | DOWNLOAD_URL="https://mirrors.nwafu.edu.cn/docker-ce" 227 | ;; 228 | sustech) 229 | DOWNLOAD_URL="https://mirrors.sustech.edu.cn/docker-ce" 230 | ;; 231 | hit) 232 | DOWNLOAD_URL="https://mirrors.hit.edu.cn/docker-ce" 233 | ;; 234 | xtom) 235 | DOWNLOAD_URL="https://mirrors.xtom.com.hk/docker-ce" 236 | ;; 237 | pku) 238 | DOWNLOAD_URL="https://mirrors.pku.edu.cn/docker-ce" 239 | ;; 240 | ynu) 241 | DOWNLOAD_URL="https://mirrors.ynu.edu.cn/docker-ce" 242 | ;; 243 | bupt) 244 | DOWNLOAD_URL="https://mirrors.bupt.edu.cn/docker-ce" 245 | ;; 246 | njtech) 247 | DOWNLOAD_URL="https://mirrors.njtech.edu.cn/docker-ce" 248 | ;; 249 | qlu) 250 | DOWNLOAD_URL="https://mirrors.qlu.edu.cn/docker-ce" 251 | ;; 252 | esac 253 | 254 | case "$compose_mirror" in 255 | daocloud) 256 | COMPOSE_DOWNLOAD_URL="https://files.m.daocloud.io/github.com/docker/compose" 257 | ;; 258 | *) 259 | COMPOSE_DOWNLOAD_URL="${compose_mirror}" 260 | ;; 261 | esac 262 | 263 | case "$systemd_mirror" in 264 | github) 265 | SYSTEMD_DOCKER_SERVICE="https://raw.githubusercontent.com/moby/moby/master/contrib/init/systemd/docker.service" 266 | SYSTEMD_DOCKER_SOCKET="https://raw.githubusercontent.com/moby/moby/master/contrib/init/systemd/docker.socket" 267 | SYSTEMD_CONTAINERD_SERVICE="https://raw.githubusercontent.com/containerd/containerd/main/containerd.service" 268 | ;; 269 | jsdelivr) 270 | SYSTEMD_DOCKER_SERVICE="https://cdn.jsdelivr.net/gh/moby/moby@master/contrib/init/systemd/docker.service" 271 | SYSTEMD_DOCKER_SOCKET="https://cdn.jsdelivr.net/gh/moby/moby@master/contrib/init/systemd/docker.socket" 272 | SYSTEMD_CONTAINERD_SERVICE="https://cdn.jsdelivr.net/gh/containerd/containerd@main/containerd.service" 273 | ;; 274 | ghproxy) 275 | SYSTEMD_DOCKER_SERVICE="https://mirror.ghproxy.com/https://raw.githubusercontent.com/moby/moby/master/contrib/init/systemd/docker.service" 276 | SYSTEMD_DOCKER_SOCKET="https://mirror.ghproxy.com/https://raw.githubusercontent.com/moby/moby/master/contrib/init/systemd/docker.socket" 277 | SYSTEMD_CONTAINERD_SERVICE="https://mirror.ghproxy.com/https://raw.githubusercontent.com/containerd/containerd/main/containerd.service" 278 | ;; 279 | daocloud) 280 | SYSTEMD_DOCKER_SERVICE="https://files.m.daocloud.io/github.com/moby/moby/raw/master/contrib/init/systemd/docker.service" 281 | SYSTEMD_DOCKER_SOCKET="https://files.m.daocloud.io/github.com/moby/moby/raw/master/contrib/init/systemd/docker.socket" 282 | SYSTEMD_CONTAINERD_SERVICE="https://files.m.daocloud.io/github.com/containerd/containerd/raw/main/containerd.service" 283 | ;; 284 | *) 285 | SYSTEMD_DOCKER_SERVICE="${systemd_mirror}/https://raw.githubusercontent.com/moby/moby/master/contrib/init/systemd/docker.service" 286 | SYSTEMD_DOCKER_SOCKET="${systemd_mirror}/https://raw.githubusercontent.com/moby/moby/master/contrib/init/systemd/docker.socket" 287 | SYSTEMD_CONTAINERD_SERVICE="${systemd_mirror}/https://raw.githubusercontent.com/containerd/containerd/main/containerd.service" 288 | ;; 289 | esac 290 | 291 | case "$openrc_mirror" in 292 | github) 293 | OPENRC_DOCKER_CONFD="https://raw.githubusercontent.com/alpinelinux/aports/master/community/docker/docker.confd" 294 | OPENRC_DOCKER_INITD="https://raw.githubusercontent.com/alpinelinux/aports/master/community/docker/docker.initd" 295 | ;; 296 | jsdelivr) 297 | OPENRC_DOCKER_CONFD="https://cdn.jsdelivr.net/gh/alpinelinux/aports@master/community/docker/docker.confd" 298 | OPENRC_DOCKER_INITD="https://cdn.jsdelivr.net/gh/alpinelinux/aports@master/community/docker/docker.initd" 299 | ;; 300 | ghproxy) 301 | OPENRC_DOCKER_CONFD="https://mirror.ghproxy.com/https://raw.githubusercontent.com/alpinelinux/aports/master/community/docker/docker.confd" 302 | OPENRC_DOCKER_INITD="https://mirror.ghproxy.com/https://raw.githubusercontent.com/alpinelinux/aports/master/community/docker/docker.initd" 303 | ;; 304 | daocloud) 305 | OPENRC_DOCKER_CONFD="https://files.m.daocloud.io/github.com/alpinelinux/aports/raw/master/community/docker/docker.confd" 306 | OPENRC_DOCKER_INITD="https://files.m.daocloud.io/github.com/alpinelinux/aports/raw/master/community/docker/docker.initd" 307 | ;; 308 | *) 309 | OPENRC_DOCKER_CONFD="${openrc_mirror}/https://raw.githubusercontent.com/alpinelinux/aports/master/community/docker/docker.confd" 310 | OPENRC_DOCKER_INITD="${openrc_mirror}/https://raw.githubusercontent.com/alpinelinux/aports/master/community/docker/docker.initd" 311 | ;; 312 | esac 313 | 314 | case "$runit_mirror" in 315 | github) 316 | RUNIT_DOCKER_RUN="https://raw.githubusercontent.com/void-linux/void-packages/master/srcpkgs/moby/files/docker/run" 317 | ;; 318 | jsdelivr) 319 | RUNIT_DOCKER_RUN="https://cdn.jsdelivr.net/gh/void-linux/void-packages@master/srcpkgs/moby/files/docker/run" 320 | ;; 321 | ghproxy) 322 | RUNIT_DOCKER_RUN="https://mirror.ghproxy.com/https://raw.githubusercontent.com/void-linux/void-packages/master/srcpkgs/moby/files/docker/run" 323 | ;; 324 | daocloud) 325 | RUNIT_DOCKER_RUN="https://files.m.daocloud.io/github.com/void-linux/void-packages/raw/master/srcpkgs/moby/files/docker/run" 326 | ;; 327 | *) 328 | RUNIT_DOCKER_RUN="${runit_mirror}/https://raw.githubusercontent.com/void-linux/void-packages/master/srcpkgs/moby/files/docker/run" 329 | ;; 330 | esac 331 | 332 | command_exists() { 333 | command -v "$@" > /dev/null 2>&1 334 | } 335 | 336 | is_flag_prefix() { 337 | if [ -z "$FLAG_PREFIX" ]; then 338 | return 1 339 | else 340 | return 0 341 | fi 342 | } 343 | 344 | is_flag_compose_prefix() { 345 | if [ -z "$FLAG_COMPOSE_PREFIX" ]; then 346 | return 1 347 | else 348 | return 0 349 | fi 350 | } 351 | if is_flag_prefix && ! is_flag_compose_prefix; then 352 | COMPOSE_PREFIX="$PREFIX" 353 | fi 354 | is_dry_run() { 355 | if [ -z "$DRY_RUN" ]; then 356 | return 1 357 | else 358 | return 0 359 | fi 360 | } 361 | is_override_existing() { 362 | if [ -z "$OVERRIDE_EXISTING" ]; then 363 | return 1 364 | else 365 | return 0 366 | fi 367 | } 368 | is_no_mkdir() { 369 | if [ -z "$NO_MKDIR" ]; then 370 | return 1 371 | else 372 | return 0 373 | fi 374 | } 375 | is_write_daemon_json() { 376 | if [ -z "$WRITE_DAEMON_JSON_FILE" ]; then 377 | return 1 378 | else 379 | return 0 380 | fi 381 | } 382 | 383 | is_systemd() { 384 | if [ -z "$SYSTEMD" ]; then 385 | return 1 386 | else 387 | return 0 388 | fi 389 | } 390 | 391 | is_with_openrc() { 392 | if [ -z "$WITH_OPENRC" ]; then 393 | return 1 394 | else 395 | return 0 396 | fi 397 | } 398 | 399 | is_with_runit() { 400 | if [ -z "$WITH_RUNIT" ]; then 401 | return 1 402 | else 403 | return 0 404 | fi 405 | } 406 | 407 | is_with_compose() { 408 | if [ -z "$WITH_COMPOSE" ]; then 409 | return 1 410 | else 411 | return 0 412 | fi 413 | } 414 | 415 | is_wsl() { 416 | case "$(uname -r)" in 417 | *microsoft* ) true ;; # WSL 2 418 | *Microsoft* ) true ;; # WSL 1 419 | * ) false;; 420 | esac 421 | } 422 | 423 | is_darwin() { 424 | case "$(uname -s)" in 425 | *darwin* ) true ;; 426 | *Darwin* ) true ;; 427 | * ) false;; 428 | esac 429 | } 430 | 431 | deprecation_notice() { 432 | distro=$1 433 | date=$2 434 | echo 435 | echo "DEPRECATION WARNING:" 436 | echo " The distribution, $distro, will no longer be supported in this script as of $date." 437 | echo " If you feel this is a mistake please submit an issue at https://github.com/docker/docker-install/issues/new" 438 | echo 439 | sleep 10 440 | } 441 | 442 | get_distribution() { 443 | lsb_dist="" 444 | # Every system that we officially support has /etc/os-release 445 | if [ -r /etc/os-release ]; then 446 | lsb_dist="$(. /etc/os-release && echo "$ID")" 447 | fi 448 | # Returning an empty string here should be alright since the 449 | # case statements don't act unless you provide an actual value 450 | echo "$lsb_dist" 451 | } 452 | 453 | semverParse() { 454 | major="${1%%.*}" 455 | minor="${1#$major.}" 456 | minor="${minor%%.*}" 457 | patch="${1#$major.$minor.}" 458 | patch="${patch%%[-.]*}" 459 | } 460 | 461 | echo_docker_as_nonroot() { 462 | if is_dry_run; then 463 | return 464 | fi 465 | if command_exists docker && [ -e /var/run/docker.sock ]; then 466 | ( 467 | set -x 468 | $sh_c 'docker version' 469 | ) || true 470 | fi 471 | your_user=your-user 472 | [ "$user" != 'root' ] && your_user="$user" 473 | # intentionally mixed spaces and tabs here -- tabs are stripped by "<<-EOF", spaces are kept in the output 474 | echo "If you would like to use Docker as a non-root user, you should now consider" 475 | echo "adding your user to the \"docker\" group with something like:" 476 | echo 477 | echo " sudo usermod -aG docker $your_user" 478 | echo 479 | echo "Remember that you will have to log out and back in for this to take effect!" 480 | echo 481 | echo "WARNING: Adding a user to the \"docker\" group will grant the ability to run" 482 | echo " containers which can be used to obtain root privileges on the" 483 | echo " docker host." 484 | echo " Refer to https://docs.docker.com/engine/security/security/#docker-daemon-attack-surface" 485 | echo " for more information." 486 | 487 | } 488 | 489 | 490 | 491 | do_install_static() { 492 | set +e 493 | if ! grep -e "^docker" /etc/group >& /dev/null; then 494 | $sh_c "groupadd docker 2>/dev/null || addgroup -S docker" 495 | fi 496 | set -e 497 | 498 | if ! is_no_mkdir; then 499 | $sh_c "mkdir -p /etc/docker/" 500 | $sh_c "mkdir -p /var/lib/docker/" 501 | $sh_c "mkdir -p /var/lib/containerd/" 502 | $sh_c "mkdir -p /etc/containerd/" 503 | fi 504 | 505 | platform=$(uname -s | awk '{print tolower($0)}') 506 | url=${DOWNLOAD_URL}/${platform}/static/${CHANNEL}/$(uname -m)/docker-${VERSION}.tgz 507 | 508 | $sh_c "curl -fsSL ${url} | tar -xvz --strip-components 1 --directory=${PREFIX}" 509 | if is_with_compose; then 510 | 511 | if [[ $COMPOSE_VERSION =~ ^v1.* ]]; then 512 | COMPOSE_VERSION="${COMPOSE_VERSION:1}" 513 | fi 514 | 515 | if [[ $COMPOSE_VERSION =~ ^2.* ]]; then 516 | COMPOSE_VERSION="v${COMPOSE_VERSION}" 517 | fi 518 | 519 | if [[ $COMPOSE_VERSION =~ ^v2.* || $COMPOSE_VERSION =~ ^2.* ]]; then 520 | uname_kernel=$(uname -s); 521 | compose_file="docker-compose-${uname_kernel,}-$(uname -m)"; 522 | else 523 | compose_file="docker-compose-$(uname -s)-$(uname -m)"; 524 | fi 525 | 526 | 527 | compose_url="${COMPOSE_DOWNLOAD_URL}/releases/download/${COMPOSE_VERSION}/${compose_file}" 528 | # https://github.com/docker/compose/releases/download/v2.24.7/docker-compose-linux-x86_64 529 | # https://github.com/docker/compose/releases/download/1.29.2/docker-compose-Linux-x86_64 530 | $sh_c "curl -fSL --progress-bar $compose_url -o $COMPOSE_PREFIX/docker-compose" 531 | $sh_c "chmod +x $COMPOSE_PREFIX/docker-compose" 532 | fi 533 | 534 | daemonJsonPath="${DAEMON_JSON_FILE_PREFIX}/daemon.json" 535 | 536 | if is_write_daemon_json; then 537 | 538 | if [ -n "$DAEMON_JSON_FILE" ]; then 539 | if [[ "$DAEMON_JSON_FILE" =~ ^http.* ]]; then 540 | $sh_c "curl --retry 3 -fsSL ${DAEMON_JSON_FILE} --output ${daemonJsonPath}"; 541 | else 542 | $sh_c "cat ${DAEMON_JSON_FILE} > ${daemonJsonPath}"; 543 | fi 544 | else 545 | 546 | if is_dry_run; then 547 | echo "cat > ${daemonJsonPath} << EOF" 548 | cat << EOF 549 | $DEFAULT_DAEMON_JSON_VAR 550 | EOF 551 | echo "EOF" 552 | else 553 | if command_exists python3; then 554 | $sh_c "echo '$DEFAULT_DAEMON_JSON_VAR' | python3 -m json.tool > ${daemonJsonPath}" 555 | else 556 | $sh_c "echo '$DEFAULT_DAEMON_JSON_VAR' > ${daemonJsonPath}" 557 | fi 558 | fi 559 | fi 560 | fi 561 | if [[ "$(cat /proc/1/comm)" =~ systemd ]] && is_systemd; then 562 | $sh_c "mkdir -p /etc/systemd/system/docker.service.d" 563 | $sh_c "curl --retry 3 -fsSL -o ${SYSTEMD_PREFIX}/docker.service ${SYSTEMD_DOCKER_SERVICE}" 564 | $sh_c "curl --retry 3 -fsSL -o ${SYSTEMD_PREFIX}/docker.socket ${SYSTEMD_DOCKER_SOCKET}" 565 | $sh_c "curl --retry 3 -fsSL -o ${SYSTEMD_PREFIX}/containerd.service ${SYSTEMD_CONTAINERD_SERVICE}" 566 | if [ "$PREFIX" != "/usr/bin" ]; then 567 | $sh_c "sed -i \"s@/usr/bin/dockerd@""$PREFIX""/dockerd@g\" ${SYSTEMD_PREFIX}/docker.service" 568 | fi 569 | if [ "$PREFIX" != "/usr/local/bin" ]; then 570 | $sh_c "sed -i \"s@/usr/local/bin/containerd@""$PREFIX""/containerd@g\" ${SYSTEMD_PREFIX}/containerd.service" 571 | fi 572 | $sh_c "systemctl daemon-reload && systemctl enable docker" 573 | docker_state=$(systemctl show --property SubState docker | cut -d '=' -f 2) 574 | if [ "$docker_state" = "running" ]; then 575 | echo "docker is running" 576 | else 577 | $sh_c "systemctl start docker || journalctl -xe --no-pager -u docker" 578 | fi 579 | fi 580 | 581 | # openrc compatible 582 | if openrc --version > /dev/null 2>&1 && is_with_openrc; then 583 | $sh_c "curl --retry 3 -fsSL -o /etc/conf.d/docker ${OPENRC_DOCKER_CONFD}" 584 | $sh_c "curl --retry 3 -fsSL -o /etc/init.d/docker ${OPENRC_DOCKER_INITD}" 585 | $sh_c "chmod +x /etc/init.d/docker" 586 | if [ "$PREFIX" != "/usr/bin" ]; then 587 | $sh_c "sed -i \"s@^#DOCKERD_BINARY.*@DOCKERD_BINARY=""$PREFIX""/dockerd@g\" /etc/conf.d/docker" 588 | fi 589 | $sh_c "rc-update add docker > /dev/null 2>&1" 590 | $sh_c "rc-service docker start > /dev/null 2>&1" 591 | fi 592 | 593 | # runit compatible 594 | if [ "$(cat /proc/1/comm 2> /dev/null)" = "runit" ] && is_with_runit; then 595 | sv="/etc/sv" 596 | for sv_path in "/etc/sv" "/etc/runit/sv"; do 597 | if test -d "${sv_path}"; then 598 | sv="${sv_path}"; 599 | break; 600 | fi 601 | done 602 | $sh_c "mkdir -p ${sv}/docker" 603 | $sh_c "curl --retry 3 -fsSL -o ${sv}/docker/run ${RUNIT_DOCKER_RUN}" 604 | $sh_c "chmod +x ${sv}/docker/run" 605 | $sh_c "ln -s -f ${sv}/docker /etc/runit/runsvdir/current/" 606 | fi 607 | } 608 | 609 | 610 | do_install() { 611 | if command_exists docker && ! is_dry_run && ! is_override_existing; then 612 | docker_version="$(docker -v | cut -d ' ' -f3 | cut -d ',' -f1)" 613 | MAJOR_W=1 614 | MINOR_W=10 615 | 616 | semverParse "$docker_version" 617 | 618 | shouldWarn=0 619 | if [ "$major" -lt "$MAJOR_W" ]; then 620 | shouldWarn=1 621 | fi 622 | 623 | if [ "$major" -le "$MAJOR_W" ] && [ "$minor" -lt "$MINOR_W" ]; then 624 | shouldWarn=1 625 | fi 626 | 627 | cat >&2 <<-'EOF' 628 | Warning: the "docker" command appears to already exist on this system. 629 | 630 | If you already have Docker installed, this script can cause trouble, which is 631 | why we're displaying this warning and provide the opportunity to cancel the 632 | installation. 633 | 634 | If you installed the current Docker package using this script and are using it 635 | EOF 636 | 637 | if [ $shouldWarn -eq 1 ]; then 638 | cat >&2 <<-'EOF' 639 | again to update Docker, we urge you to migrate your image store before upgrading 640 | to v1.10+. 641 | 642 | You can find instructions for this here: 643 | https://github.com/docker/docker/wiki/Engine-v1.10.0-content-addressability-migration 644 | EOF 645 | else 646 | cat >&2 <<-'EOF' 647 | again to update Docker, you can safely ignore this message. 648 | EOF 649 | fi 650 | 651 | cat >&2 <<-'EOF' 652 | 653 | You may press Ctrl+C now to abort this script. 654 | EOF 655 | ( set -x; sleep 20 ) 656 | fi 657 | 658 | user="$(id -un 2>/dev/null || true)" 659 | 660 | sh_c='sh -c' 661 | if [ "$user" != 'root' ]; then 662 | if command_exists sudo; then 663 | sh_c='sudo -E sh -c' 664 | elif command_exists su; then 665 | sh_c='su -c' 666 | else 667 | cat >&2 <<-'EOF' 668 | Error: this installer needs the ability to run commands as root. 669 | We are unable to find either "sudo" or "su" available to make this happen. 670 | EOF 671 | exit 1 672 | fi 673 | fi 674 | 675 | if is_dry_run; then 676 | sh_c="echo" 677 | fi 678 | 679 | # perform some very rudimentary platform detection 680 | lsb_dist=$( get_distribution ) 681 | lsb_dist="$(echo "$lsb_dist" | tr '[:upper:]' '[:lower:]')" 682 | 683 | if is_wsl; then 684 | echo 685 | echo "WSL DETECTED: We recommend using Docker Desktop for Windows." 686 | echo "Please get Docker Desktop from https://www.docker.com/products/docker-desktop" 687 | echo 688 | cat >&2 <<-'EOF' 689 | 690 | You may press Ctrl+C now to abort this script. 691 | EOF 692 | ( set -x; sleep 20 ) 693 | fi 694 | 695 | # Run setup for each distro accordingly 696 | case "$lsb_dist" in 697 | opensuse-tumbleweed|opensuse-leap) 698 | if ! command_exists iptables; then 699 | echo 700 | echo "ERROR: iptables not found" 701 | echo "Please install iptables from https://software.opensuse.org/download.html?project=security%3Anetfilter&package=iptables" 702 | echo 703 | exit 1 704 | fi 705 | ;; 706 | *) 707 | if [ -z "$lsb_dist" ]; then 708 | if is_darwin; then 709 | echo 710 | echo "ERROR: Unsupported operating system 'macOS'" 711 | echo "Please get Docker Desktop from https://www.docker.com/products/docker-desktop" 712 | echo 713 | exit 1 714 | fi 715 | fi 716 | ;; 717 | esac 718 | 719 | local prefix_check='' 720 | if [ ! -d "$PREFIX" ]; then 721 | echo "ERROR: ${PREFIX} directory does not exist" 722 | prefix_check=1 723 | fi 724 | if [ ! "$PREFIX" = "$COMPOSE_PREFIX" ] && [ ! -d "$COMPOSE_PREFIX" ]; then 725 | echo "ERROR: ${COMPOSE_PREFIX} directory does not exist" 726 | prefix_check=1 727 | fi 728 | if [ -n "$prefix_check" ]; then 729 | exit 1 730 | fi 731 | 732 | do_install_static 733 | echo_docker_as_nonroot 734 | exit 0 735 | } 736 | 737 | 738 | 739 | # if [ "$(id -u 2>/dev/null || true)" -ne 0 ] 740 | # then echo "Please run as root" 741 | # exit 1 742 | # fi 743 | 744 | 745 | 746 | do_install --------------------------------------------------------------------------------