├── .config
    └── ansible-lint.yml
├── .gitignore
├── .woodpecker.yml
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
├── ansible.cfg
├── docs
    ├── README.md
    ├── alternative-architectures.md
    ├── assets
    │   └── garage-logo.svg
    ├── configuring-dns.md
    ├── configuring-playbook-interoperability.md
    ├── configuring-playbook.md
    ├── getting-the-playbook.md
    ├── installing.md
    ├── prerequisites.md
    └── uninstalling.md
├── examples
    ├── host-vars.yml
    └── hosts
├── group_vars
    └── garage_servers
├── inventory
    └── .gitkeep
├── justfile
├── requirements.yml
├── roles
    └── custom
    │   └── base
    │       ├── defaults
    │           └── main.yml
    │       └── tasks
    │           ├── main.yml
    │           └── setup.yml
└── setup.yml


/.config/ansible-lint.yml:
--------------------------------------------------------------------------------
 1 | ---
 2 | 
 3 | use_default_rules: true
 4 | 
 5 | skip_list:
 6 |   - unnamed-task
 7 |   - no-handler
 8 |   - command-instead-of-shell
 9 |   - yaml[line-length]
10 |   - no-changed-when
11 | 
12 | offline: true
13 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /inventory/*
2 | !/inventory/.gitkeep
3 | !/inventory/host_vars/.gitkeep
4 | 
5 | # ignore roles pulled by ansible-galaxy
6 | /roles/galaxy/*
7 | !/roles/galaxy/.gitkeep
8 | 


--------------------------------------------------------------------------------
/.woodpecker.yml:
--------------------------------------------------------------------------------
1 | ---
2 | pipeline:
3 |   build:
4 |     image: cytopia/ansible-lint
5 |     commands:
6 |       - "ansible-lint"
7 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
 1 | # 2023-03-15
 2 | 
 3 | * BREAKING CHANGE: Most variables have changed their name. Check `examples/host-vars.yml` to find the new names (usually `garage_garage_<var>` -> `garage_<var>`)
 4 | * Moved the main role to https://github.com/moan0s/role-garage to make it usable in [Mother-of-All-Self-Hosting Ansible playbook](https://github.com/mother-of-all-self-hosting/mash-playbook)
 5 | 
 6 | # 2023-03-10
 7 | 
 8 | The systemd services are renamed to use a `-` instead of `_`. If you already use this playbook that means:
 9 | 
10 | * Stop all garage nodes (`ansible-playbook -i inventory/hosts setup.yml --tags=stop`)
11 | * Delete the old service files (e.g `/etc/systemd/systemd/garage_node1.service`)
12 | * Pull the new playbook
13 | * Rerun the playbook & start the services ``
14 | * Check if everything works again.
15 | 
16 | # 2023-02-27
17 | 
18 | First version of this playbook is announced publicly


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                     GNU AFFERO GENERAL PUBLIC LICENSE
  2 |                        Version 3, 19 November 2007
  3 | 
  4 |  Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  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 Affero General Public License is a free, copyleft license for
 11 | software and other kinds of works, specifically designed to ensure
 12 | cooperation with the community in the case of network server software.
 13 | 
 14 |   The licenses for most software and other practical works are designed
 15 | to take away your freedom to share and change the works.  By contrast,
 16 | our General Public Licenses are intended to guarantee your freedom to
 17 | share and change all versions of a program--to make sure it remains free
 18 | software for all its users.
 19 | 
 20 |   When we speak of free software, we are referring to freedom, not
 21 | price.  Our General Public Licenses are designed to make sure that you
 22 | have the freedom to distribute copies of free software (and charge for
 23 | them if you wish), that you receive source code or can get it if you
 24 | want it, that you can change the software or use pieces of it in new
 25 | free programs, and that you know you can do these things.
 26 | 
 27 |   Developers that use our General Public Licenses protect your rights
 28 | with two steps: (1) assert copyright on the software, and (2) offer
 29 | you this License which gives you legal permission to copy, distribute
 30 | and/or modify the software.
 31 | 
 32 |   A secondary benefit of defending all users' freedom is that
 33 | improvements made in alternate versions of the program, if they
 34 | receive widespread use, become available for other developers to
 35 | incorporate.  Many developers of free software are heartened and
 36 | encouraged by the resulting cooperation.  However, in the case of
 37 | software used on network servers, this result may fail to come about.
 38 | The GNU General Public License permits making a modified version and
 39 | letting the public access it on a server without ever releasing its
 40 | source code to the public.
 41 | 
 42 |   The GNU Affero General Public License is designed specifically to
 43 | ensure that, in such cases, the modified source code becomes available
 44 | to the community.  It requires the operator of a network server to
 45 | provide the source code of the modified version running there to the
 46 | users of that server.  Therefore, public use of a modified version, on
 47 | a publicly accessible server, gives the public access to the source
 48 | code of the modified version.
 49 | 
 50 |   An older license, called the Affero General Public License and
 51 | published by Affero, was designed to accomplish similar goals.  This is
 52 | a different license, not a version of the Affero GPL, but Affero has
 53 | released a new version of the Affero GPL which permits relicensing under
 54 | this license.
 55 | 
 56 |   The precise terms and conditions for copying, distribution and
 57 | modification follow.
 58 | 
 59 |                        TERMS AND CONDITIONS
 60 | 
 61 |   0. Definitions.
 62 | 
 63 |   "This License" refers to version 3 of the GNU Affero General Public License.
 64 | 
 65 |   "Copyright" also means copyright-like laws that apply to other kinds of
 66 | works, such as semiconductor masks.
 67 | 
 68 |   "The Program" refers to any copyrightable work licensed under this
 69 | License.  Each licensee is addressed as "you".  "Licensees" and
 70 | "recipients" may be individuals or organizations.
 71 | 
 72 |   To "modify" a work means to copy from or adapt all or part of the work
 73 | in a fashion requiring copyright permission, other than the making of an
 74 | exact copy.  The resulting work is called a "modified version" of the
 75 | earlier work or a work "based on" the earlier work.
 76 | 
 77 |   A "covered work" means either the unmodified Program or a work based
 78 | on the Program.
 79 | 
 80 |   To "propagate" a work means to do anything with it that, without
 81 | permission, would make you directly or secondarily liable for
 82 | infringement under applicable copyright law, except executing it on a
 83 | computer or modifying a private copy.  Propagation includes copying,
 84 | distribution (with or without modification), making available to the
 85 | public, and in some countries other activities as well.
 86 | 
 87 |   To "convey" a work means any kind of propagation that enables other
 88 | parties to make or receive copies.  Mere interaction with a user through
 89 | a computer network, with no transfer of a copy, is not conveying.
 90 | 
 91 |   An interactive user interface displays "Appropriate Legal Notices"
 92 | to the extent that it includes a convenient and prominently visible
 93 | feature that (1) displays an appropriate copyright notice, and (2)
 94 | tells the user that there is no warranty for the work (except to the
 95 | extent that warranties are provided), that licensees may convey the
 96 | work under this License, and how to view a copy of this License.  If
 97 | the interface presents a list of user commands or options, such as a
 98 | menu, a prominent item in the list meets this criterion.
 99 | 
100 |   1. Source Code.
101 | 
102 |   The "source code" for a work means the preferred form of the work
103 | for making modifications to it.  "Object code" means any non-source
104 | form of a work.
105 | 
106 |   A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 | 
111 |   The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form.  A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 | 
122 |   The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities.  However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work.  For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 | 
135 |   The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 | 
139 |   The Corresponding Source for a work in source code form is that
140 | same work.
141 | 
142 |   2. Basic Permissions.
143 | 
144 |   All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met.  This License explicitly affirms your unlimited
147 | permission to run the unmodified Program.  The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work.  This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 | 
152 |   You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force.  You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright.  Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 | 
163 |   Conveying under any other circumstances is permitted solely under
164 | the conditions stated below.  Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 | 
167 |   3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 | 
169 |   No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 | 
175 |   When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 | 
183 |   4. Conveying Verbatim Copies.
184 | 
185 |   You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 | 
193 |   You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 | 
196 |   5. Conveying Modified Source Versions.
197 | 
198 |   You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 | 
202 |     a) The work must carry prominent notices stating that you modified
203 |     it, and giving a relevant date.
204 | 
205 |     b) The work must carry prominent notices stating that it is
206 |     released under this License and any conditions added under section
207 |     7.  This requirement modifies the requirement in section 4 to
208 |     "keep intact all notices".
209 | 
210 |     c) You must license the entire work, as a whole, under this
211 |     License to anyone who comes into possession of a copy.  This
212 |     License will therefore apply, along with any applicable section 7
213 |     additional terms, to the whole of the work, and all its parts,
214 |     regardless of how they are packaged.  This License gives no
215 |     permission to license the work in any other way, but it does not
216 |     invalidate such permission if you have separately received it.
217 | 
218 |     d) If the work has interactive user interfaces, each must display
219 |     Appropriate Legal Notices; however, if the Program has interactive
220 |     interfaces that do not display Appropriate Legal Notices, your
221 |     work need not make them do so.
222 | 
223 |   A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit.  Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 | 
233 |   6. Conveying Non-Source Forms.
234 | 
235 |   You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 | 
240 |     a) Convey the object code in, or embodied in, a physical product
241 |     (including a physical distribution medium), accompanied by the
242 |     Corresponding Source fixed on a durable physical medium
243 |     customarily used for software interchange.
244 | 
245 |     b) Convey the object code in, or embodied in, a physical product
246 |     (including a physical distribution medium), accompanied by a
247 |     written offer, valid for at least three years and valid for as
248 |     long as you offer spare parts or customer support for that product
249 |     model, to give anyone who possesses the object code either (1) a
250 |     copy of the Corresponding Source for all the software in the
251 |     product that is covered by this License, on a durable physical
252 |     medium customarily used for software interchange, for a price no
253 |     more than your reasonable cost of physically performing this
254 |     conveying of source, or (2) access to copy the
255 |     Corresponding Source from a network server at no charge.
256 | 
257 |     c) Convey individual copies of the object code with a copy of the
258 |     written offer to provide the Corresponding Source.  This
259 |     alternative is allowed only occasionally and noncommercially, and
260 |     only if you received the object code with such an offer, in accord
261 |     with subsection 6b.
262 | 
263 |     d) Convey the object code by offering access from a designated
264 |     place (gratis or for a charge), and offer equivalent access to the
265 |     Corresponding Source in the same way through the same place at no
266 |     further charge.  You need not require recipients to copy the
267 |     Corresponding Source along with the object code.  If the place to
268 |     copy the object code is a network server, the Corresponding Source
269 |     may be on a different server (operated by you or a third party)
270 |     that supports equivalent copying facilities, provided you maintain
271 |     clear directions next to the object code saying where to find the
272 |     Corresponding Source.  Regardless of what server hosts the
273 |     Corresponding Source, you remain obligated to ensure that it is
274 |     available for as long as needed to satisfy these requirements.
275 | 
276 |     e) Convey the object code using peer-to-peer transmission, provided
277 |     you inform other peers where the object code and Corresponding
278 |     Source of the work are being offered to the general public at no
279 |     charge under subsection 6d.
280 | 
281 |   A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 | 
285 |   A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling.  In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage.  For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product.  A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 | 
298 |   "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source.  The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 | 
306 |   If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information.  But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 | 
317 |   The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed.  Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 | 
325 |   Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 | 
331 |   7. Additional Terms.
332 | 
333 |   "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law.  If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 | 
342 |   When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it.  (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.)  You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 | 
349 |   Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 | 
353 |     a) Disclaiming warranty or limiting liability differently from the
354 |     terms of sections 15 and 16 of this License; or
355 | 
356 |     b) Requiring preservation of specified reasonable legal notices or
357 |     author attributions in that material or in the Appropriate Legal
358 |     Notices displayed by works containing it; or
359 | 
360 |     c) Prohibiting misrepresentation of the origin of that material, or
361 |     requiring that modified versions of such material be marked in
362 |     reasonable ways as different from the original version; or
363 | 
364 |     d) Limiting the use for publicity purposes of names of licensors or
365 |     authors of the material; or
366 | 
367 |     e) Declining to grant rights under trademark law for use of some
368 |     trade names, trademarks, or service marks; or
369 | 
370 |     f) Requiring indemnification of licensors and authors of that
371 |     material by anyone who conveys the material (or modified versions of
372 |     it) with contractual assumptions of liability to the recipient, for
373 |     any liability that these contractual assumptions directly impose on
374 |     those licensors and authors.
375 | 
376 |   All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10.  If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term.  If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 | 
386 |   If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 | 
391 |   Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 | 
395 |   8. Termination.
396 | 
397 |   You may not propagate or modify a covered work except as expressly
398 | provided under this License.  Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 | 
403 |   However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 | 
410 |   Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 | 
417 |   Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License.  If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 | 
423 |   9. Acceptance Not Required for Having Copies.
424 | 
425 |   You are not required to accept this License in order to receive or
426 | run a copy of the Program.  Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance.  However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work.  These actions infringe copyright if you do
431 | not accept this License.  Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 | 
434 |   10. Automatic Licensing of Downstream Recipients.
435 | 
436 |   Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License.  You are not responsible
439 | for enforcing compliance by third parties with this License.
440 | 
441 |   An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations.  If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 | 
451 |   You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License.  For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 | 
459 |   11. Patents.
460 | 
461 |   A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based.  The
463 | work thus licensed is called the contributor's "contributor version".
464 | 
465 |   A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version.  For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 | 
475 |   Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 | 
480 |   In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement).  To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 | 
487 |   If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients.  "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 | 
501 |   If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 | 
509 |   A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License.  You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 | 
524 |   Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 | 
528 |   12. No Surrender of Others' Freedom.
529 | 
530 |   If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License.  If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all.  For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 | 
540 |   13. Remote Network Interaction; Use with the GNU General Public License.
541 | 
542 |   Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software.  This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 | 
553 |   Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work.  The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 | 
561 |   14. Revised Versions of this License.
562 | 
563 |   The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time.  Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 | 
568 |   Each version is given a distinguishing version number.  If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation.  If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 | 
577 |   If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 | 
582 |   Later license versions may give you additional or different
583 | permissions.  However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 | 
587 |   15. Disclaimer of Warranty.
588 | 
589 |   THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 | 
598 |   16. Limitation of Liability.
599 | 
600 |   IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 | 
610 |   17. Interpretation of Sections 15 and 16.
611 | 
612 |   If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 | 
619 |                      END OF TERMS AND CONDITIONS
620 | 
621 |             How to Apply These Terms to Your New Programs
622 | 
623 |   If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 | 
627 |   To do so, attach the following notices to the program.  It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 | 
632 |     <one line to give the program's name and a brief idea of what it does.>
633 |     Copyright (C) <year>  <name of author>
634 | 
635 |     This program is free software: you can redistribute it and/or modify
636 |     it under the terms of the GNU Affero General Public License as published
637 |     by the Free Software Foundation, either version 3 of the License, or
638 |     (at your option) any later version.
639 | 
640 |     This program is distributed in the hope that it will be useful,
641 |     but WITHOUT ANY WARRANTY; without even the implied warranty of
642 |     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
643 |     GNU Affero General Public License for more details.
644 | 
645 |     You should have received a copy of the GNU Affero General Public License
646 |     along with this program.  If not, see <https://www.gnu.org/licenses/>.
647 | 
648 | Also add information on how to contact you by electronic and paper mail.
649 | 
650 |   If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source.  For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code.  There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 | 
658 |   You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | <https://www.gnu.org/licenses/>.
662 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | .PHONY: roles lint
 2 | 
 3 | help: ## Show this help.
 4 | 	@grep -F -h "##" $(MAKEFILE_LIST) | grep -v grep | sed -e 's/\\$$//' | sed -e 's/##//'
 5 | 
 6 | roles: ## Pull roles
 7 | 	rm -rf roles/galaxy
 8 | 	ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force
 9 | 
10 | lint: ## Runs ansible-lint against all roles in the playbook
11 | 	ansible-lint roles/custom
12 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Garage Docker Ansible Deploy
 2 | 
 3 | ![Garage Logo](docs/assets/garage-logo.svg)
 4 | 
 5 | ![Lint badge](https://woodpecker.hyteck.de/api/badges/moan0s/garage-docker-ansible-deploy/status.svg)
 6 | 
 7 | Garage is an open-source distributed object storage service tailored for self-hosting. This playbook helps you to set up
 8 | such a cluster:
 9 | 
10 | - on your own Debian/CentOS/RedHat server(s). Raspberry Pi is also supported
11 | - with everything run in [Docker](https://www.docker.com/) containers
12 | - powered by [the official Garage container image](https://hub.docker.com/r/dxflrs/garage)
13 | - [interoperates nicely](docs/configuring-playbook-interoperability.md) with [related](#related) Ansible playbooks or other services using Traefik for reverse-proxying
14 | * Reverse Proxy automatically managed by [Traefik](https://traefik.io).
15 | 
16 | ## Planned Features
17 | 
18 | * Multiple host support
19 |   * Testing
20 |   * Documentation explaining on how to run this playbook on multiple hosts
21 | 
22 | ## Installing
23 | 
24 | To configure and install Garage on your own server(s), follow the [README in the docs/ directory](docs/README.md).
25 | 
26 | ## Design
27 | 
28 | Garage is a very flexible software that can server a lot of use-cases. This playbook is opinionated in the sense that it
29 | reduces the flexibility of garage in favor of an easy deployment that should serve common use cases. While the playbook
30 | should of course be reusable and fairly modular it will never be a solution to all use cases. Assumptions that are made
31 | currently:
32 | 
33 | - Nodes have a public IPv4/IPv6 address
34 | - one subdomain per node, 1 additional subdomain per gateway node
35 | 
36 | The playbook will by default 
37 | 
38 | * Enable the admin API for each node, reachable via the assigned subdomain
39 | * Expose a user-defined port per node for replication
40 | * Use a gateway to expose the s3 API on a new subdomain
41 | 
42 | ## Support
43 | 
44 | - Matrix room: [#garage-docker-ansible-deploy:hyteck.de](https://matrix.to/#/#garage-docker-ansible-deploy:hyteck.de)
45 | 
46 | - Github issues: [moan0s/garage-docker-ansible-deploy/issues](https://github.com/moan0s/garage-docker-ansible-deploy/issues)
47 | 
48 | ## Related
49 | 
50 | This playbook started as a copy of these projects and aims to have a similar layout and reuse some roles. Check them out!
51 | 
52 | - [matrix-docker-ansible-deploy](https://github.com/spantaleev/matrix-docker-ansible-deploy) - for deploying a fully-featured [Matrix](https://matrix.org) homeserver
53 | 
54 | - [gitea-docker-ansible-deploy](https://github.com/spantaleev/gitea-docker-ansible-deploy) - for deploying a [Gitea](https://gitea.io) (self-hosted [Git](https://git-scm.com/) service) server
55 | 
56 | - [vaultwarden-docker-ansible-deploy](https://github.com/spantaleev/vaultwarden-docker-ansible-deploy) - for deploying a [Vaultwarden](https://github.com/dani-garcia/vaultwarden) password manager server (unofficial [Bitwarden](https://bitwarden.com/) compatible server)
57 | 
58 | # Miscellaneous
59 | 
60 | * Set `garage_debian_buster: true` to avoid a bug with debian buster (tested on a raspi 3A) ([more information](https://github.com/dani-garcia/vaultwarden/issues/2497))
61 | * Installing docker on Raspberry PI needs you to set `docker_apt_arch: arm64` in your `vars.yml`. Refer to [this issue](https://github.com/geerlingguy/ansible-role-docker/issues/402) for more information.
62 | 
63 | # Developer Notes
64 | 
65 | `Use ansible_facts[‘distribution_major_version’]` instead of `garage_debian_buster`
66 | 


--------------------------------------------------------------------------------
/ansible.cfg:
--------------------------------------------------------------------------------
1 | [defaults]
2 | retry_files_enabled = False
3 | 


--------------------------------------------------------------------------------
/docs/README.md:
--------------------------------------------------------------------------------
 1 | # Table of Contents
 2 | 
 3 | - [Prerequisites](prerequisites.md)
 4 | 
 5 | - [Configuring DNS](configuring-dns.md)
 6 | 
 7 | - [Configuring the playbook](configuring-playbook.md)
 8 | 
 9 | - [Installing](installing.md)
10 | 
11 | - [Uninstalling](uninstalling.md)
12 | 


--------------------------------------------------------------------------------
/docs/alternative-architectures.md:
--------------------------------------------------------------------------------
 1 | # Alternative architectures
 2 | 
 3 | As stated in the [Prerequisites](prerequisites.md), currently only `amd64` (`x86_64`) is fully supported.
 4 | 
 5 | The playbook automatically determines the target server's architecture (the `garage_architecture` variable) to be one of the following:
 6 | 
 7 | - `amd64` (`x86_64`)
 8 | - `arm32`
 9 | - `arm64`
10 | 
11 | Some tools and container images can be built on the host or other measures can be used to install on that architecture.
12 | 
13 | 
14 | ## Implementation details
15 | 
16 | For `amd64`, prebuilt container images are used for all components.
17 | 
18 | For other architecture (`arm64`, `arm32`), components which have a prebuilt image make use of it. If the component is not available for the specific architecture, self-building will be used - the container image for a specific component will be built from scratch on the server. Not all components support self-building though, so your mileage may vary.
19 | 


--------------------------------------------------------------------------------
/docs/assets/garage-logo.svg:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8" standalone="no"?>
  2 | <!-- Created with Inkscape (http://www.inkscape.org/) -->
  3 | 
  4 | <svg
  5 |    width="30mm"
  6 |    height="30mm"
  7 |    viewBox="0 0 30 30"
  8 |    version="1.1"
  9 |    id="svg5"
 10 |    xmlns="http://www.w3.org/2000/svg"
 11 |    xmlns:svg="http://www.w3.org/2000/svg">
 12 |   <defs
 13 |      id="defs2" />
 14 |   <g
 15 |      id="layer1"
 16 |      transform="translate(-47.531142,-150.58196)">
 17 |     <g
 18 |        id="g2446"
 19 |        transform="matrix(0.26458333,0,0,0.26458333,27.649536,132.01223)">
 20 |       <g
 21 |          id="g6567"
 22 |          transform="matrix(0.92473907,0,0,0.92473907,11.032718,11.165159)">
 23 |         <g
 24 |            id="g7383"
 25 |            transform="matrix(1.0300991,0,0,1.0300991,3.770254,-1.2763086)">
 26 |           <path
 27 |              id="path6"
 28 |              d="m 136.06214,99.13643 c -0.8681,0.09646 -1.83266,0 -2.70078,-0.289369 L 99.794436,89.780144 c -0.868109,-0.28937 -1.736218,-0.675196 -2.507872,-1.157479 z"
 29 |              style="stroke-width:0.964566" />
 30 |           <path
 31 |              id="path8"
 32 |              class="st0"
 33 |              d="m 85.036565,156.14226 c 1.919127,0.0226 3.842264,-0.048 5.758577,0.0407 1.109916,0.0647 2.081695,0.96893 2.125517,2.09821 0.05763,2.83895 0.0096,5.68171 0.02535,8.52216 0.0387,0.72125 -1.165534,0.55433 -1.656924,0.86227 -2.84639,0.78316 -5.867198,1.08468 -8.793555,0.62567 -2.484003,-0.4206 -4.607002,-2.18507 -5.651194,-4.45399 -1.332604,-2.83308 -1.546544,-6.07759 -1.21852,-9.15366 0.293175,-2.57048 1.448442,-5.0874 3.473195,-6.74732 2.184175,-1.91934 5.23662,-2.62252 8.078891,-2.19703 2.061965,0.25939 4.063024,1.01333 5.768107,2.20419 -0.194486,1.20116 -0.887464,2.34273 -1.929135,2.99015 -1.865545,-1.36891 -4.253598,-2.12198 -6.568068,-1.87184 -2.02236,0.3166 -3.762605,1.87404 -4.283558,3.85841 -0.666251,2.35645 -0.668458,4.88015 -0.252316,7.28143 0.337055,1.92315 1.48217,3.89047 3.44592,4.49149 1.860151,0.60901 3.846702,0.22762 5.72889,-0.0627 0.02323,-1.64043 -0.05713,-3.28547 0.06461,-4.92211 0.04478,-0.38456 -0.694745,-0.10524 -1.004029,-0.19009 -1.009365,-0.0553 -2.115945,0.1939 -3.015314,-0.38583 -0.860219,-0.80391 -0.327291,-2.03804 -0.09646,-2.99015 z"
 34 |              style="stroke-width:0.964566" />
 35 |           <path
 36 |              id="path10"
 37 |              class="st0"
 38 |              d="m 109.82594,166.17374 c -0.0965,0.38583 -0.28937,0.77165 -0.57875,1.15748 -0.19291,0.38583 -0.48228,0.6752 -0.77164,0.86811 -1.25394,-0.0965 -2.31497,-0.77165 -2.99017,-1.92913 -1.15748,1.25393 -2.89369,2.02559 -4.62991,2.02559 -1.639774,0 -2.893709,-0.48229 -3.76182,-1.44685 -0.771653,-0.96457 -1.253937,-2.12205 -1.253937,-3.37598 0,-1.83268 0.57874,-3.18307 1.736221,-4.05118 1.350393,-0.96456 2.893706,-1.44685 4.533456,-1.35039 0.96458,0 1.92914,0 2.79726,0.0965 v -0.96457 c 0,-1.73622 -0.77166,-2.50787 -2.41143,-2.50787 -1.15747,0 -2.797241,0.38583 -4.919286,1.15748 -0.675197,-0.77165 -1.061024,-1.83268 -1.061024,-2.8937 2.218503,-0.96456 4.53347,-1.44685 6.94488,-1.44685 1.44686,-0.0965 2.79725,0.38583 3.95473,1.3504 0.96457,0.86811 1.5433,2.2185 1.5433,4.05117 v 6.55905 c -0.0965,1.44685 0.19291,2.2185 0.86812,2.70078 z m -8.10237,-0.77165 c 1.25394,-0.0965 2.41142,-0.57874 3.18308,-1.54331 v -2.79724 c -0.77166,-0.0965 -1.63977,-0.0965 -2.41143,-0.0965 -0.77165,-0.0965 -1.44684,0.19291 -2.02558,0.67519 -0.482291,0.48229 -0.675204,1.06103 -0.675204,1.73622 0,0.57874 0.192913,1.15748 0.578744,1.63976 0.38583,0.19292 0.86811,0.38583 1.35039,0.38583 z"
 39 |              style="stroke-width:0.964566" />
 40 |           <path
 41 |              id="path12"
 42 |              class="st0"
 43 |              d="m 112.43026,153.92376 c 0.0965,-0.38583 0.28937,-0.77165 0.57874,-1.15748 0.19292,-0.38583 0.48229,-0.6752 0.77165,-0.86811 1.63976,0.19291 2.8937,1.35039 3.37599,2.8937 0.86811,-1.92913 2.2185,-2.8937 4.14764,-2.8937 0.57874,0 1.25392,0.0965 1.83267,0.19291 0,1.3504 -0.28937,2.60433 -0.96456,3.76181 -0.48229,-0.0965 -0.96457,-0.19291 -1.44685,-0.19291 -1.3504,0 -2.31496,0.67519 -3.18308,2.12204 v 10.2244 c -0.67519,0.0965 -1.35039,0.19291 -1.92914,0.19291 -0.67518,0 -1.35038,-0.0965 -2.02558,-0.19291 v -10.80314 c 0,-1.5433 -0.38582,-2.60433 -1.15748,-3.27952 z"
 44 |              style="stroke-width:0.964566" />
 45 |           <path
 46 |              id="path14"
 47 |              class="st0"
 48 |              d="m 138.08774,166.17374 c -0.0965,0.38583 -0.28937,0.77165 -0.57874,1.15748 -0.19291,0.38583 -0.48228,0.6752 -0.77165,0.86811 -1.25394,-0.0965 -2.31496,-0.77165 -2.99017,-1.92913 -1.15747,1.25393 -2.89369,2.02559 -4.62992,2.02559 -1.63975,0 -2.8937,-0.48229 -3.7618,-1.44685 -0.77166,-0.96457 -1.25394,-2.12205 -1.25394,-3.37598 0,-1.83268 0.57874,-3.18307 1.73622,-4.05118 1.25393,-0.96456 2.8937,-1.44685 4.43701,-1.35039 0.96456,0 1.92914,0 2.79724,0.0965 v -0.96457 c 0,-1.73622 -0.77164,-2.50787 -2.41142,-2.50787 -1.15748,0 -2.79724,0.38583 -4.91929,1.15748 -0.6752,-0.77165 -1.06102,-1.83268 -1.06102,-2.8937 2.2185,-0.96456 4.53346,-1.44685 6.94488,-1.44685 1.44685,-0.0965 2.79725,0.38583 3.95473,1.3504 0.96456,0.86811 1.5433,2.2185 1.5433,4.05117 v 6.55905 c 0,1.44685 0.38583,2.2185 0.96457,2.70078 z m -8.10236,-0.77165 c 1.25393,-0.0965 2.41142,-0.57874 3.18307,-1.54331 v -2.79724 c -0.77165,-0.0965 -1.63977,-0.0965 -2.41142,-0.0965 -0.77165,-0.0965 -1.44686,0.19291 -2.02559,0.67519 -0.48228,0.48229 -0.67519,1.06103 -0.67519,1.73622 0,0.57874 0.19291,1.15748 0.57874,1.63976 0.38582,0.19292 0.8681,0.38583 1.35039,0.38583 z"
 49 |              style="stroke-width:0.964566" />
 50 |           <path
 51 |              id="path16"
 52 |              class="st0"
 53 |              d="m 142.04247,166.07729 c -0.96457,-1.44685 -1.44686,-3.47244 -1.44686,-6.07677 0,-2.60433 0.57875,-4.62991 1.83268,-6.07676 1.06103,-1.35039 2.70079,-2.2185 4.43701,-2.2185 1.63977,0 3.18307,0.57874 4.34055,1.63976 0.57874,-0.77165 1.54332,-1.25394 2.50787,-1.35039 0.38583,0.19291 0.6752,0.57874 0.86812,0.86811 0.19291,0.38582 0.38583,0.67519 0.57874,1.15747 -0.57874,0.48229 -0.86812,1.44685 -0.86812,2.79725 v 9.06691 c 0,3.37598 -0.57874,5.7874 -1.63975,7.23424 -1.06103,1.44685 -2.99017,2.12205 -5.49804,2.12205 -1.92914,0 -3.95472,-0.38583 -5.7874,-1.06102 0,-1.06103 0.28937,-2.12205 0.96457,-2.8937 1.35039,0.6752 2.79724,0.96457 4.34054,0.96457 1.44686,0 2.41143,-0.38583 2.89371,-1.06103 0.57874,-0.86811 0.86811,-1.92913 0.77165,-2.99015 v -1.25394 c -1.15748,0.96457 -2.50787,1.54331 -4.05118,1.54331 -1.73622,-0.0965 -3.37599,-0.96457 -4.24409,-2.41141 z m 8.19882,-2.60433 v -7.42716 c -0.6752,-0.77165 -1.73622,-1.25393 -2.79725,-1.35039 -0.86811,0 -1.73621,0.57874 -2.12205,1.35039 -0.57874,1.25394 -0.86811,2.60433 -0.77165,3.95472 0,1.73622 0.19291,2.99016 0.67519,3.76181 0.28938,0.67519 1.06103,1.15748 1.83268,1.25393 1.3504,0 2.50788,-0.57874 3.18308,-1.5433 z"
 54 |              style="stroke-width:0.964566" />
 55 |           <path
 56 |              id="path26"
 57 |              class="st3"
 58 |              d="m 136.73735,113.02618 18.42323,-7.42716 c 0.38583,-0.19291 0.57874,-0.57874 0.48228,-1.06102 -0.0965,-0.19292 -0.19291,-0.38583 -0.48228,-0.48229 -2.12204,-0.8681 -4.82284,-1.92913 -7.42716,-2.99015 -0.4823,-0.19291 -5.01576,3.08661 -5.40158,3.37598 l -7.90945,6.36613 c -1.83268,1.73622 -0.19291,3.27953 2.31496,2.21851 z"
 59 |              style="stroke-width:0.964566" />
 60 |           <ellipse
 61 |              id="circle28"
 62 |              class="st3"
 63 |              cx="123.42634"
 64 |              cy="120.26041"
 65 |              rx="9.645668"
 66 |              ry="9.6456566"
 67 |              style="stroke-width:0.964566" />
 68 |           <path
 69 |              id="path6-0"
 70 |              d="m 136.06214,99.13643 c -0.8681,0.09646 -1.83266,0 -2.70078,-0.289369 L 99.794436,89.780144 c -0.868109,-0.28937 -1.736218,-0.675196 -2.507872,-1.157479 z"
 71 |              style="stroke-width:0.964566" />
 72 |           <path
 73 |              id="path18-7"
 74 |              class="st0"
 75 |              d="m 170.6901,161.35091 h -8.97047 c 0,1.06103 0.28937,2.02559 0.86811,2.8937 0.48228,0.6752 1.35039,1.06102 2.60432,1.06102 1.44686,-0.0965 2.89371,-0.48228 4.2441,-1.15748 0.6752,0.6752 1.06102,1.54331 1.15748,2.41142 -1.83267,1.25393 -3.95472,1.92913 -6.17323,1.83267 -2.41141,0 -4.14764,-0.77165 -5.20865,-2.31495 -1.06104,-1.54331 -1.54331,-3.5689 -1.54331,-6.07677 0,-2.50787 0.57873,-4.53346 1.73622,-6.07676 1.15747,-1.54331 2.99015,-2.41142 4.91928,-2.31496 2.12206,0 3.76182,0.6752 4.9193,1.92913 1.15748,1.35039 1.83267,3.08661 1.73622,4.91929 0,0.96456 -0.0965,1.92913 -0.28937,2.89369 z m -6.17323,-6.84841 c -1.73622,0 -2.70079,1.35039 -2.79724,3.95472 h 5.59448 v -0.38583 c 0,-0.86811 -0.19292,-1.83267 -0.67519,-2.60433 -0.48228,-0.67519 -1.3504,-0.96456 -2.12205,-0.96456 z"
 76 |              style="stroke-width:0.964566" />
 77 |           <path
 78 |              id="path24-3-6-9"
 79 |              class="st4"
 80 |              d="m 123.0405,70.199461 c -1.44685,0 -2.89371,0.28937 -4.14765,0.868109 L 76.259006,89.973057 c -0.771652,0.289369 -1.157479,1.253935 -0.868109,2.025588 0,0 0,0 0,0 0,0.09646 0,0.09646 0.09646,0.192913 l 6.848424,13.503922 h 5.980314 l -0.86811,-4.72638 c -0.09646,-0.38582 -0.675197,-3.086605 -1.253937,-5.015736 l 19.966532,6.269676 c 0.28937,1.25394 0.57874,2.41141 1.06103,3.47244 h 32.31298 c 0.38582,-1.06103 0.67519,-2.2185 0.86811,-3.47244 l 19.87007,-6.17322 c -0.57873,1.929131 -1.15747,4.62992 -1.25393,5.01574 l -0.86812,4.72637 h 5.98032 l 6.75197,-13.407459 0.0965,-0.09646 0.0965,-0.192913 c 0,0 0,0 0,0 0.0965,-0.192913 0.0965,-0.28937 0.0965,-0.482283 0,-0.675196 -0.38583,-1.253935 -0.96457,-1.543305 l -42.6339,-18.905486 c -1.54332,-0.675196 -2.99017,-1.061022 -4.53347,-0.964566 z"
 81 |              style="stroke-width:0.964566" />
 82 |           <path
 83 |              id="path24-3-2"
 84 |              class="st0"
 85 |              d="m 123.0405,79.073465 c -1.44685,0 -2.89371,0.28937 -4.14765,0.868109 L 76.259006,98.847061 c -0.771652,0.289369 -1.157479,1.253939 -0.868109,2.025589 0,0 0,0 0,0 0,0.0965 0,0.0965 0.09646,0.19291 l 3.665353,7.3307 h 7.909449 c -0.289371,-1.06102 -0.578742,-2.31496 -0.964568,-3.56889 l 11.285433,3.56889 h 51.507866 l 11.28542,-3.56889 c -0.38581,1.15748 -0.67518,2.50787 -0.96455,3.56889 h 7.90943 l 3.66536,-7.23424 0.0965,-0.0965 0.0965,-0.19291 c 0,0 0,0 0,0 0.0965,-0.19291 0.0965,-0.28937 0.0965,-0.48228 0,-0.6752 -0.38582,-1.25394 -0.96457,-1.543309 L 127.47751,79.941574 c -1.44686,-0.578739 -2.89371,-0.868109 -4.43701,-0.868109 z"
 86 |              style="stroke-width:0.964566" />
 87 |           <path
 88 |              id="path24-0"
 89 |              class="st4"
 90 |              d="m 171.07592,109.45728 c 0,0.19292 0,0.28937 -0.0965,0.48229 0,0 0,0 0,0 l -0.0965,0.19291 v 0 l -0.0965,0.0965 -10.32087,20.44879 c -1.44684,2.79724 -4.05116,2.70078 -3.66533,-0.0965 l 2.12203,-11.57479 c 0.0965,-0.38582 0.6752,-3.08661 1.25394,-5.01574 l -19.87014,6.17322 c -3.08661,20.35234 -29.90156,20.64171 -34.24212,0 L 86.0974,113.89428 c 0.578741,1.92914 1.157481,4.62992 1.253938,5.01575 l 2.122046,11.57478 c 0.482284,2.8937 -2.218503,2.99016 -3.665353,0.0965 L 75.390897,110.03602 c 0,-0.0964 -0.09646,-0.0964 -0.09646,-0.19291 -0.385827,-0.77165 0,-1.73622 0.771653,-2.02559 0,0 0,0 0,0 l 42.63386,-18.905486 c 2.70078,-1.157478 5.88385,-1.157478 8.58464,0 l 42.63385,18.905486 c 0.77166,0.38583 1.15748,0.96457 1.15748,1.63976 z"
 91 |              style="stroke-width:0.964566" />
 92 |           <path
 93 |              id="path26-2"
 94 |              class="st0"
 95 |              d="m 136.73735,113.02618 18.42323,-7.42716 c 0.38583,-0.19291 0.57874,-0.57874 0.48228,-1.06102 -0.0965,-0.19292 -0.19291,-0.38583 -0.48228,-0.48229 -2.12204,-0.8681 -4.82284,-1.92913 -7.42716,-2.99015 -0.4823,-0.19291 -5.01576,3.08661 -5.40158,3.37598 l -7.90945,6.36613 c -1.83268,1.73622 -0.19291,3.27953 2.31496,2.21851 z"
 96 |              style="stroke-width:0.964566" />
 97 |           <ellipse
 98 |              id="circle28-3"
 99 |              class="st0"
100 |              cx="123.42634"
101 |              cy="120.26041"
102 |              rx="9.645668"
103 |              ry="9.6456566"
104 |              style="stroke-width:0.964566" />
105 |         </g>
106 |       </g>
107 |     </g>
108 |   </g>
109 |   <style
110 |      type="text/css"
111 |      id="style2346">
112 | 	.st0{fill:#4E4E4E;}
113 | 	.st1{fill:#FFD952;}
114 | 	.st2{fill:#49C8FA;}
115 | 	.st3{fill:#45C8FF;}
116 | 	.st4{fill:#FF9329;}
117 | 	.st5{fill:#3B2100;}
118 | 	.st6{fill:#C3C3C3;}
119 | </style>
120 | </svg>
121 | 


--------------------------------------------------------------------------------
/docs/configuring-dns.md:
--------------------------------------------------------------------------------
 1 | # Configuring your DNS server
 2 | 
 3 | To set up Garage on your domain, you'd need to do some DNS configuration.
 4 | 
 5 | ## DNS settings example
 6 | 
 7 | The DNS setup is dependent on your actual layout. The following example shows two servers.
 8 | On both servers runs a gateway (gw). Server1 has two nodes as e.g. it has two drives while server2 has one node
 9 | 
10 | | Type  | Host                       | Priority | Weight | Port | Target                   |
11 | |-------|----------------------------|----------|--------|------|--------------------------|
12 | | A     | `garage-gw1.example.com`   | -        | -      | -    | `IP server1`             |
13 | | CNAME | `garage-api.example.com`   | -        | -      | -    | `garage-gw1.example.com` |
14 | | CNAME | `garage-node1.example.com` | -        | -      | -    | `garage-gw1.example.com` |
15 | | CNAME | `garage-node2.example.com` | -        | -      | -    | `garage-gw1.example.com` |
16 | | A     | `garage-node3.example.com` | -        | -      | -    | `IP server2`             |
17 | 
18 | Be mindful as to how long it will take for the DNS records to propagate.
19 | 
20 | When you're done configuring DNS, proceed to [Configuring the playbook](configuring-playbook.md).
21 | 


--------------------------------------------------------------------------------
/docs/configuring-playbook-interoperability.md:
--------------------------------------------------------------------------------
 1 | # Configuring interoperability with other services
 2 | 
 3 | This playbook tries to get you up and running with minimal effort - installing all required services (e.g. Docker).
 4 | 
 5 | Sometimes, you're using a server to host multiple services. In such cases these are undesirable:
 6 | 
 7 | - multiple playbooks trying to install Docker, etc.
 8 | 
 9 | Below, we offer some suggestions for how to make this playbook more interoperable. Feel free to cherry-pick the parts that make sense for your set up.
10 | 
11 | 
12 | ## Disabling Docker installation
13 | 
14 | If you're installing [Docker](https://www.docker.com/) on your server in another way, disable this component from the playbook:
15 | 
16 | ```yaml
17 | nextcloud_playbook_docker_installation_enabled: false
18 | ```
19 | 
20 | ## Disabling timesyncing (systemd-timesyncd / ntp) installation
21 | 
22 | If you're installing `systemd-timesyncd` or `ntp` on your server in another way, disable this component from the playbook:
23 | 
24 | ```yaml
25 | devture_timesync_installation_enabled: false
26 | ```
27 | 


--------------------------------------------------------------------------------
/docs/configuring-playbook.md:
--------------------------------------------------------------------------------
 1 | # Configuring the playbook
 2 | 
 3 | ## Preparing the inventory and your variables file (`vars.yml`)
 4 | 
 5 | Follow these steps inside the playbook directory:
 6 | 
 7 | - create a directory to hold your configuration (`mkdir inventory/host_vars/<your-domain>`)
 8 | 
 9 | - copy the sample configuration file (`cp examples/host-vars.yml inventory/host_vars/<your-domain>/vars.yml`)
10 | 
11 | - edit the configuration file (`inventory/host_vars/<your-domain>/vars.yml`) to your liking. See more in [Configuring Services](#configuring-services).
12 | 
13 | - copy the sample inventory hosts file (`cp examples/hosts inventory/hosts`)
14 | 
15 | - edit the inventory hosts file (`inventory/hosts`) to your liking
16 | 
17 | 
18 | ## Configuring Services
19 | 
20 | Doing the above preparation step, you're all set to proceed to [Installing](installing.md) with our default recommended configuration.
21 | 
22 | However, you may wish to tweak a few other things before installing (or any time later) and take a look at the various `defaults/main.yml` files in `roles/` and see if there's anything you'd like to copy over and override in your `vars.yml` configuration file.
23 | 
24 | 
25 | ## Installing
26 | 
27 | Once you've configured everything, you can proceed to [Installing](installing.md).
28 | 
29 | After installation, you can continue changing settings in `vars.yml` and re-running the installation step to make your server consistent with the configuration.
30 | 


--------------------------------------------------------------------------------
/docs/getting-the-playbook.md:
--------------------------------------------------------------------------------
 1 | # Getting the playbook
 2 | 
 3 | This Ansible playbook is meant to be executed on your own computer (not the Nextcloud server).
 4 | 
 5 | In special cases (if your computer cannot run Ansible, etc.) you may put the playbook on the server as well.
 6 | 
 7 | You can retrieve the playbook's source code by:
 8 | 
 9 | - [Using git to get the playbook](#using-git-to-get-the-playbook) (recommended)
10 | 
11 | - [Downloading the playbook as a ZIP archive](#downloading-the-playbook-as-a-zip-archive) (not recommended)
12 | 
13 | 
14 | ## Using git to get the playbook
15 | 
16 | We recommend using the [git](https://git-scm.com/) tool to get the playbook's source code.
17 | 
18 | Once you've installed git on your computer, you can go to any directory of your choosing and run the following command to retrieve the playbook's source code:
19 | 
20 | ```bash
21 | git clone https://github.com/spantaleev/nextcloud-docker-ansible-deploy.git
22 | ```
23 | 
24 | This will create a new `nextcloud-docker-ansible-deploy` directory.
25 | You're supposed to execute all other installation commands inside that directory.
26 | 
27 | 
28 | ## Downloading the playbook as a ZIP archive
29 | 
30 | Alternatively, you can download the playbook as a ZIP archive.
31 | 
32 | The latest version is always at the following URL: https://github.com/spantaleev/nextcloud-docker-ansible-deploy/archive/master.zip
33 | 
34 | You can extract this archive anywhere. You'll get a directory called `nextcloud-docker-ansible-deploy`.
35 | You're supposed to execute all other installation commands inside that directory.
36 | 
37 | 
38 | ---------------------------------------------
39 | 
40 | No matter which method you've used to download the playbook, you can proceed to [Prerequisites](prerequisites.md).
41 | 


--------------------------------------------------------------------------------
/docs/installing.md:
--------------------------------------------------------------------------------
 1 | # Installing
 2 | 
 3 | After [configuring DNS](configuring-dns.md) and [configuring the playbook](configuring-playbook.md), you're ready to install.
 4 | 
 5 | **Before installing** and each time you update the playbook in the future, you will need to update the Ansible roles in this playbook by running `just roles`. `just roles` is a shortcut (a `roles` target defined in [`justfile`](../justfile) and executed by the [`just`](https://github.com/casey/just) utility) which ultimately runs [ansible-galaxy](https://docs.ansible.com/ansible/latest/cli/ansible-galaxy.html) to download Ansible roles. If you don't have `just`, you can also manually run the `roles` commands seen in the `justfile`.
 6 | 
 7 | 
 8 | ## Playbook tags introduction
 9 | 
10 | The Ansible playbook's tasks are tagged, so that certain parts of the Ansible playbook can be run without running all other tasks.
11 | 
12 | The general command syntax is: `ansible-playbook -i inventory/hosts setup.yml --tags=COMMA_SEPARATED_TAGS_GO_HERE`
13 | 
14 | Here are some playbook tags that you should be familiar with:
15 | 
16 | - `setup-all` - runs all setup tasks (installation and uninstallation) for all components, but does not start/restart services
17 | 
18 | - `install-all` - like `setup-all`, but skips uninstallation tasks. Useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove components, you'd need to run `setup-all` though, or these components will still remain installed
19 | 
20 | - `setup-postgres` (e.g. `setup-garage`) - runs the setup tasks only for a given role, but does not start/restart services. You can discover these additional tags in each role (`roles/*/main.yml`). Running per-component setup tasks is **not recommended**, as components sometimes depend on each other
21 | 
22 | - `install-SERVICE` (e.g. `install-garage`) - like `setup-SERVICE`, but skips uninstallation tasks. See `install-all` above for additional information.
23 | 
24 | - `start` - starts all systemd services and makes them start automatically in the future
25 | 
26 | - `stop` - stops all systemd services
27 | 
28 | - `configure-garage` - applies your configuration to the nodes
29 | 
30 | `setup-*` tags and `install-*` tags **do not start services** automatically, because you may wish to do things before starting services, such as importing a database dump, restoring data from another server, etc.
31 | 
32 | 
33 | ## Installation
34 | 
35 | Run the playbook: `ansible-playbook -i inventory/hosts setup.yml --tags=setup-all`.
36 | 
37 | If your inventory file (`vars.yml`) contains encrypted variables, you may need to pass `--ask-vault-pass` to the `ansible-playbook` command.
38 | 
39 | After installing, you can start services with `just start-all` (or `ansible-playbook -i inventory/hosts setup.yml --tags=start`).
40 | 
41 | **Important**
42 | 
43 | When all services are successfully started you need to configure the nodes (connect them and apply a layout).
44 | Use `ansible-playbook -i inventory/hosts setup.yml --tags=configure-garage`. Due to a bug this will currently fail the
45 | first time so just execute the command twice.
46 | 


--------------------------------------------------------------------------------
/docs/prerequisites.md:
--------------------------------------------------------------------------------
 1 | # Prerequisites
 2 | 
 3 | - **CentOS** (7.0+) or Rockylinux / AlmaLinux, **Debian** (9/Stretch+ -- untested) or **Ubuntu** (16.04+ -- untested) server. This playbook can take over your whole server or [co-exist with other services](configuring-playbook-interoperability.md) that you have there.
 4 | 
 5 | - `root` access to your server (or a user capable of elevating to `root` via `sudo`).
 6 | 
 7 | - [Python](https://www.python.org/) being installed on the server. Most distributions install Python by default, but some don't
 8 | 
 9 | - the [Ansible](http://ansible.com/) program being installed on your own computer. It's used to run this playbook and configures your server for you
10 | 
11 | - [`git`](https://git-scm.com/) is the recommended way to [download the playbook](getting-the-playbook.md) to your computer
12 | 
13 | - Properly configured DNS records for `<your-domain>` (details in [Configuring DNS](configuring-dns.md)).
14 | 
15 | - Some TCP ports open. This playbook (actually [Docker itself](https://docs.docker.com/network/iptables/)) configures the server's internal firewall for you. In most cases, you don't need to do anything special. But **if your server is running behind another firewall**, you'd need to open these ports:
16 | 
17 |   - `80/tcp`: HTTP webserver
18 |   - `443/tcp`: HTTPS webserver
19 | 
20 | This playbook somewhat supports running on non-`amd64` architectures like ARM. See [Alternative Architectures](alternative-architectures.md).
21 | 
22 | When ready to proceed, continue with [Configuring DNS](configuring-dns.md).
23 | 


--------------------------------------------------------------------------------
/docs/uninstalling.md:
--------------------------------------------------------------------------------
 1 | # Uninstalling
 2 | 
 3 | **Note**: If you have some trouble with your installation configuration, you can just re-run the playbook and it will try to set things up again. You don't need to uninstall and install fresh.
 4 | 
 5 | However, if you've installed this on some server where you have other stuff you wish to preserve, and now want get rid of Garage, it's enough to do these:
 6 | 
 7 | - ensure all garage services are stopped and disabled (`systemctl disable --now 'garage*'`)
 8 | 
 9 | - delete the Garage-related systemd .service files (`rm -f /etc/systemd/system/garage*`)
10 | 
11 | - stop and disable Traefik (`systemctl disable --now devture-traefik`)
12 | 
13 | - delete the `devture-traefik` systemd service (`rm -f /etc/systemd/system/devture-traefik.service`)
14 | 
15 | - reload systemd (`systemctl daemon-reload`)
16 | 
17 | - delete some cached container images (or just delete them all: `docker rmi $(docker images -aq)`
18 | 
19 | - uninstall Docker itself, if necessary
20 | 
21 | - delete the `/garage` directory (`rm -rf /garage`)
22 | 


--------------------------------------------------------------------------------
/examples/host-vars.yml:
--------------------------------------------------------------------------------
 1 | # Garage uses a secret key that is shared between all nodes of the cluster in order to identify these nodes and allow
 2 | # them to communicate together. This key should be specified here in the form of a 32-byte hex-encoded random string.
 3 | # Such a string can be generated with a command such as ´openssl rand -hex 32´.
 4 | garage_rpc_secret: 'verysecret'
 5 | 
 6 | # Token for accessing the admin API.
 7 | # Generating a strong secret is advised (e.g. `openssl rand -hex 32`).
 8 | garage_admin_token: 'verysecret'
 9 | 
10 | # Uncomment the following line if you run this on a Raspberry Pi 3
11 | # garage_debian_buster: true
12 | 
13 | # This is the zone that your host will be in. Refer to https://garagehq.deuxfleurs.fr/documentation/cookbook/real-world/#creating-a-cluster-layout
14 | # for more information
15 | garage_zone: "dc1"
16 | 
17 | # The replication mode defines how many copies of your data are stored per region
18 | # "2" means data stored on Garage will be stored on two different nodes, if possible in different zones. Adjust this
19 | # to your needs.
20 | # Full reference: https://garagehq.deuxfleurs.fr/documentation/reference-manual/configuration/#replication-mode
21 | garage_replication_mode: 2
22 | 
23 | 
24 | ########################
25 | ## NODE CONFIGURATION ##
26 | ########################
27 | 
28 | # This is an example configuration of nodes. On this host we run 2 data nodes that both manage 1 3TB drive.
29 | # We access the nodes via a gateway node.
30 | 
31 | garage_node1_base_path: "/media/drive1/garage/node1"
32 | garage_node2_base_path: "/media/drive2/garage/node2"
33 | garage_nodes:
34 |   - name: "gateway1"
35 |     metadata_path: "{{ garage_meta_path }}/gw1"
36 |     data_path: "{{ garage_data_path }}/gw1"
37 |     gateway: true
38 |     rpc_bind_port: 3901
39 |     node_addr: "garage-gw1.example.com"
40 |     s3_api_addr: "s3.example.com"
41 |   - name: "node1"
42 |     gateway: false
43 |     capacity: 3
44 |     metadata_path: "{{ garage_node1_base_path }}/metadata"
45 |     data_path: "{{ garage_node1_base_path }}/data"
46 |     rpc_bind_port: 3911
47 |     node_addr: "garage-node1.example.com"
48 |   - name: "node2"
49 |     gateway: false
50 |     capacity: 3
51 |     metadata_path: "{{ garage_node2_base_path }}/metadata"
52 |     data_path: "{{ garage_node2_base_path }}/data"
53 |     rpc_bind_port: 3921
54 |     node_addr: "garage-node2.example.com"
55 | 
56 | #############
57 | ### TRAFIK ##
58 | #############
59 | 
60 | devture_traefik_ssl_email_address: "certs@example.com"
61 | 
62 | # For debugging purposes it can be helpful to use the traefik dashboard
63 | # Set a DNS record for `devture_traefik_dashboard_hostname` and uncomment&adjust the following lines
64 | # devture_traefik_dashboard_enabled: true
65 | # devture_traefik_dashboard_basicauth_user: "admin"
66 | # devture_traefik_dashboard_basicauth_password: "supersecret"
67 | # devture_traefik_dashboard_hostname: "traefik-firefly.example.com"
68 | 


--------------------------------------------------------------------------------
/examples/hosts:
--------------------------------------------------------------------------------
1 | # To connect using a non-root user (and elevate to root with sudo later),
2 | # replace `ansible_ssh_user=root` with something like this: `ansible_ssh_user=username become=true become_user=root`
3 | #
4 | # For improved Ansible performance, SSH pipelining is enabled by default (`ansible_ssh_pipelining=yes`).
5 | # If this causes SSH connection troubles, feel free to disable it.
6 | 
7 | [garage_servers]
8 | <your-domain> ansible_host=<your-server's IP address> ansible_ssh_user=root
9 | 


--------------------------------------------------------------------------------
/group_vars/garage_servers:
--------------------------------------------------------------------------------
  1 | ---
  2 | 
  3 | garage_identifier: garage
  4 | # Base directory that contains everything
  5 | garage_base_path: "/{{ garage_identifier }}"
  6 | 
  7 | garage_user_username: "{{ garage_identifier }}"
  8 | garage_user_uid: 3993
  9 | garage_user_gid: 3993
 10 | 
 11 | garage_playbook_docker_installation_enabled: true
 12 | 
 13 | # The architecture that your server runs.
 14 | # Recognized values by us are 'amd64', 'arm32' and 'arm64'.
 15 | # Not all architectures support all services, so your experience (on non-amd64) may vary.
 16 | garage_architecture: "{{ 'amd64' if ansible_architecture == 'x86_64' else ('arm64' if ansible_architecture == 'aarch64' else ('arm32' if ansible_architecture.startswith('armv') else '')) }}"
 17 | 
 18 | garage_docker_network: '{{ garage_identifier }}'
 19 | 
 20 | garage_playbook_traefik_role_enabled: true
 21 | 
 22 | garage_debian_buster: false
 23 | 
 24 | 
 25 | ########################################################################
 26 | #                                                                      #
 27 | # Playbook                                                            #
 28 | #                                                                      #
 29 | ########################################################################
 30 | 
 31 | # Controls whether to install Docker or not
 32 | # Also see `devture_docker_sdk_for_python_installation_enabled`.
 33 | garage_playbook_docker_installation_enabled: true
 34 | 
 35 | devture_playbook_state_preserver_vars_preservation_dst: "{{ garage_base_path }}/vars.yml"
 36 | devture_playbook_state_preserver_commit_hash_preservation_dst: "{{ garage_base_path }}/git.hash"
 37 | 
 38 | # Controls the additional network that reverse-proxyable services will be connected to.
 39 | garage_playbook_reverse_proxyable_services_additional_network: "{{ devture_traefik_container_network if devture_traefik_enabled else '' }}"
 40 | ########################################################################
 41 | #                                                                      #
 42 | # /Playbook                                                            #
 43 | #                                                                      #
 44 | ########################################################################
 45 | 
 46 | 
 47 | 
 48 | ########################################################################
 49 | #                                                                      #
 50 | # com.devture.ansible.role.systemd_service_manager                     #
 51 | #                                                                      #
 52 | ########################################################################
 53 | devture_systemd_service_manager_services_list_auto: |
 54 |   {{
 55 |     ([{'name': ('devture-traefik.service'), 'priority': 5000, 'groups': ['garage', 'traefik', 'reverse-proxies']}] if devture_traefik_enabled else [])
 56 |   }}
 57 | ########################################################################
 58 | #                                                                      #
 59 | # /com.devture.ansible.role.systemd_service_manager                    #
 60 | #                                                                      #
 61 | ########################################################################
 62 | 
 63 | 
 64 | 
 65 | ########################################################################
 66 | #                                                                      #
 67 | # garage                                                     #
 68 | #                                                                      #
 69 | ########################################################################
 70 | 
 71 | garage_systemd_required_services_list: |
 72 |   {{
 73 |     (['docker.service'])
 74 |   }}
 75 | 
 76 | garage_container_labels_traefik_enabled: true
 77 | garage_container_labels_traefik_docker_network: "{{ garage_playbook_reverse_proxyable_services_additional_network }}"
 78 | garage_container_additional_networks: "{{ [garage_playbook_reverse_proxyable_services_additional_network] if garage_playbook_reverse_proxyable_services_additional_network else [] }}"
 79 | 
 80 | ########################################################################
 81 | #                                                                      #
 82 | # /garage                                                    #
 83 | #                                                                      #
 84 | ########################################################################
 85 | 
 86 | ########################################################################
 87 | #                                                                      #
 88 | # com.devture.ansible.role.traefik                                     #
 89 | #                                                                      #
 90 | ########################################################################
 91 | 
 92 | # To completely disable the Traefik role from running, use `garage_playbook_traefik_role_enabled: false`.
 93 | # See the comment there for more details about why we have both `devture_traefik_enabled` and `garage_playbook_traefik_role_enabled`.
 94 | 
 95 | devture_traefik_uid: "{{ garage_user_uid }}"
 96 | devture_traefik_gid: "{{ garage_user_gid }}"
 97 | 
 98 | ########################################################################
 99 | #                                                                      #
100 | # /com.devture.ansible.role.traefik                                    #
101 | #                                                                      #
102 | ########################################################################


--------------------------------------------------------------------------------
/inventory/.gitkeep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/moan0s/garage-docker-ansible-deploy/a93b8c0561f46a738a58048286919122ce439017/inventory/.gitkeep


--------------------------------------------------------------------------------
/justfile:
--------------------------------------------------------------------------------
 1 | # Shows help
 2 | default:
 3 | 	@just --list --justfile {{ justfile() }}
 4 | 
 5 | # Pulls external Ansible roles
 6 | roles:
 7 | 	rm -rf roles/galaxy
 8 | 	ansible-galaxy install -r requirements.yml -p roles/galaxy/ --force
 9 | 
10 | # Runs ansible-lint against all roles in the playbook
11 | lint:
12 | 	ansible-lint
13 | 
14 | # Runs the playbook with --tags=install-all,start and optional arguments
15 | install-all *extra_args: (run-tags "install-all,start" extra_args)
16 | 
17 | # Runs the playbook with --tags=setup-all,start and optional arguments
18 | setup-all *extra_args: (run-tags "setup-all,start" extra_args)
19 | 
20 | # Runs the playbook with the given list of arguments
21 | run +extra_args:
22 | 	time ansible-playbook -i inventory/hosts setup.yml {{ extra_args }}
23 | 
24 | # Runs the playbook with the given list of comma-separated tags and optional arguments
25 | run-tags tags *extra_args:
26 | 	just --justfile {{ justfile() }} run --tags={{ tags }} {{ extra_args }}
27 | 
28 | # Starts all services
29 | start-all *extra_args: (run-tags "start-all" extra_args)
30 | 
31 | # Starts a specific service group
32 | start-group group *extra_args:
33 | 	@just --justfile {{ justfile() }} run-tags start-group --extra-vars="group={{ group }}" {{ extra_args }}
34 | 
35 | # Stops all services
36 | stop-all *extra_args: (run-tags "stop-all" extra_args)
37 | 
38 | # Stops a specific service group
39 | stop-group group *extra_args:
40 | 	@just --justfile {{ justfile() }} run-tags stop-group --extra-vars="group={{ group }}" {{ extra_args }}
41 | 


--------------------------------------------------------------------------------
/requirements.yml:
--------------------------------------------------------------------------------
 1 | ---
 2 | 
 3 | - src: geerlingguy.docker
 4 |   version: 6.1.0
 5 | 
 6 | - src: git+https://github.com/devture/com.devture.ansible.role.docker_sdk_for_python.git
 7 |   version: 6ba3be490b6f4c6f35ea109aeb8e533fa231b3a5
 8 | 
 9 | - src: git+https://github.com/devture/com.devture.ansible.role.playbook_help.git
10 |   version: c1f40e82b4d6b072b6f0e885239322bdaaaf554f
11 | 
12 | - src: git+https://github.com/devture/com.devture.ansible.role.systemd_docker_base.git
13 |   version: 327d2e17f5189ac2480d6012f58cf64a2b46efba
14 | 
15 | - src: git+https://github.com/devture/com.devture.ansible.role.timesync.git
16 |   version: 3d5bb2976815958cdce3f368fa34fb51554f899b
17 | 
18 | - src: git+https://github.com/devture/com.devture.ansible.role.playbook_state_preserver.git
19 |   version: ff2fd42e1c1a9e28e3312bbd725395f9c2fc7f16
20 | 
21 | - src: git+https://github.com/devture/com.devture.ansible.role.traefik.git
22 |   version: 803559c98ebf218713cd2b50bdf7ec94737c086a
23 | 
24 | - src: git+https://github.com/devture/com.devture.ansible.role.systemd_service_manager.git
25 |   version: 6ccb88ac5fc27e1e70afcd48278ade4b564a9096
26 | 
27 | - src: git+https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages.git
28 |   version: 9b4b088c62b528b73a9a7c93d3109b091dd42ec6
29 | 
30 | - src: git+https://github.com/moan0s/role-garage.git
31 |   version: 78f0a926f5a486fe08a567b7d3fb2c082001d97a
32 | 


--------------------------------------------------------------------------------
/roles/custom/base/defaults/main.yml:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/moan0s/garage-docker-ansible-deploy/a93b8c0561f46a738a58048286919122ce439017/roles/custom/base/defaults/main.yml


--------------------------------------------------------------------------------
/roles/custom/base/tasks/main.yml:
--------------------------------------------------------------------------------
1 | ---
2 | 
3 | 
4 | - block:
5 |     - ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup.yml"
6 |   tags:
7 |     - setup-all
8 |     - install-all
9 | 


--------------------------------------------------------------------------------
/roles/custom/base/tasks/setup.yml:
--------------------------------------------------------------------------------
 1 | ---
 2 | 
 3 | - name: Ensure Garage group is created
 4 |   ansible.builtin.group:
 5 |     name: "{{ garage_user_username }}"
 6 |     gid: "{{ garage_user_gid }}"
 7 |     state: present
 8 | 
 9 | - name: Ensure Garage user is created
10 |   ansible.builtin.user:
11 |     name: "{{ garage_user_username }}"
12 |     uid: "{{ garage_user_uid }}"
13 |     group: "{{ garage_user_username }}"
14 |     state: present
15 | 
16 | - name: Ensure Garage base path exists
17 |   ansible.builtin.file:
18 |     path: "{{ item }}"
19 |     state: directory
20 |     mode: "0750"
21 |     owner: "{{ garage_user_uid }}"
22 |     group: "{{ garage_user_gid }}"
23 |   with_items:
24 |     - "{{ garage_base_path }}"
25 | 
26 | - name: Ensure Garage network is created in Docker
27 |   community.docker.docker_network:
28 |     name: "{{ garage_docker_network }}"
29 |     driver: bridge
30 | 


--------------------------------------------------------------------------------
/setup.yml:
--------------------------------------------------------------------------------
 1 | ---
 2 | - name: "Set up garage servers"
 3 |   hosts: "{{ target if target is defined else 'garage_servers' }}"
 4 |   become: true
 5 | 
 6 |   roles:
 7 |     # This role has no tasks at all
 8 |     - role: galaxy/com.devture.ansible.role.playbook_help
 9 | 
10 |     # This role has no tasks at all
11 |     - role: galaxy/com.devture.ansible.role.systemd_docker_base
12 | 
13 |     - when: garage_playbook_docker_installation_enabled | bool
14 |       role: galaxy/geerlingguy.docker
15 |       vars:
16 |         docker_install_compose: false
17 |       tags:
18 |         - setup-docker
19 |         - setup-all
20 |         - install-docker
21 |         - install-all
22 | 
23 |     - role: custom/base
24 |       tags:
25 |         - setup-all
26 |         - install-all
27 | 
28 |     # This role exposes various tags (setup-garage, setup-all) so we don't tag it here.
29 |     - role: galaxy/role-garage
30 | 
31 |     - when: garage_playbook_traefik_role_enabled | bool
32 |       role: galaxy/com.devture.ansible.role.traefik
33 | 
34 |     - when: devture_systemd_service_manager_enabled | bool
35 |       role: galaxy/com.devture.ansible.role.systemd_service_manager
36 | 
37 |     # This is pretty much last, because we want it to better serve as a "last known good configuration".
38 |     # See: https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2217#issuecomment-1301487601
39 |     - when: devture_playbook_state_preserver_enabled | bool
40 |       role: galaxy/com.devture.ansible.role.playbook_state_preserver
41 |       tags:
42 |         - setup-all
43 |         - install-all
44 | 
45 |     - role: galaxy/com.devture.ansible.role.playbook_runtime_messages
46 | 


--------------------------------------------------------------------------------