├── .gitignore ├── LICENSE ├── ReadMe.md ├── dashboard ├── .env.example ├── ReadMe.md ├── configs │ ├── config.json │ ├── local-docker.json │ └── traefik.json └── docker-compose.yml ├── download ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── ghost ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── gitea ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── gotify ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── media ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── monitoring ├── ReadMe.md ├── frontend │ ├── .env.example │ ├── README.md │ └── docker-compose.yml └── per-host │ ├── .env.example │ ├── README.md │ ├── alert.rules.example │ ├── docker-compose.yml │ └── prometheus.yml.example ├── parrot ├── .env.example ├── README.md └── docker-compose.yml ├── plex ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── portainer ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── titra ├── .env.example ├── ReadMe.md └── docker-compose.yml ├── traefik ├── .env.example ├── ReadMe.md ├── docker-compose.yml └── service.yml └── watchtower ├── .env.example ├── ReadMe.md └── docker-compose.yml /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store 2 | .env -------------------------------------------------------------------------------- /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 | Composing 635 | Copyright (C) 2020 Will Fantom 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 | Composing Copyright (C) 2020 Will Fantom 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 | # Composing 2 | 3 | Here you will find a selection of docker compose files that, for those wanting to get into self-hosting, might find useful. 4 | 5 | This is a summary of docker-compose repos I have created in the past, along with a few new useful services and updates to existing services. 6 | 7 | To use, you simply need `Docker`, `Docker-Compose`. It works best if can forward ports `443` and `80` in you router to your server device and have a domain that uses CloudFlare DNS (other provides are normally still easy to change to with træfik). 8 | 9 | ## Services 10 | 11 | Each service has a short description in their directory. Below is a list of all services, existing here now, and to exist here in the near future. 12 | 13 | - [X] Ingress Service (træfik) - [here](traefik/) 14 | - [X] Container Manager (portainer) - [here](portainer/) 15 | - [X] Image Auto-Updater (watchtower) - [here](watchtower/) 16 | - [X] Blogging Platform (ghost - works well with Ulysses Note Editor) - [here](ghost/) 17 | - [X] Notification Platform (gotify) - [here](gotify/) 18 | - [X] Time/Wage Manager (titra) - [here](titra/) 19 | - [X] Torrent Downloader (transmission) -[here](download/) 20 | - [X] Usenet Downloader (sabnzbd) - [here](download/) 21 | - [X] TV Show Download Automator (sonarr) - [here](media/) 22 | - [X] Film Download Automator (radarr) - [here](media/) 23 | - [X] Music Download Automator (lidarr) - [here](media/) 24 | - [X] Transcoder (tdarr) - [here](media/) 25 | - [X] Media Server (plex... for now) - [here](plex/) 26 | - [X] Media Server Monitor (tautulli) - [here](plex/) 27 | - [ ] Media Server Manager (organizr v2) 28 | - [X] Media Request Manager (ombi) - [here](media/) 29 | - [X] Container Monitor (cadvisor) - [here](monitoring/) 30 | - [X] Node Monitor (prom node monitor) - [here](monitoring/) 31 | - [X] Time Series DB (prometheus) - [here](monitoring/) 32 | - [X] Stats Graph Tool (grafana) - [here](monitoring/) 33 | - [ ] Dashboard (coming soon....!) 34 | - [X] Self Hosted Git (gitea) - [here](gitea/) 35 | - [ ] Self Hosted Cloud (nextcloud) 36 | 37 | ## Usage 38 | 39 | To run any of these services, I suggest the use of Træfik! To set this up, navigate to the `traefik` directory and run: 40 | 41 | ```bash 42 | docker network create traefik-network 43 | docker-compose up -d 44 | ``` 45 | 46 | (Remember to create the `.env` file for the træfik system first!!) 47 | 48 | Beyond this, each directory contains a docker compose file and and an example `.env` file. Modify the env, using values appropriate to your setup, then simply run the following in the directory: 49 | 50 | ```bash 51 | docker-compose up -d 52 | ``` -------------------------------------------------------------------------------- /dashboard/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=example.tld -------------------------------------------------------------------------------- /dashboard/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Dashboard (SUI) 2 | 3 | This compose file brings up a dashbard for your hosted apps. 4 | 5 | SUI uses the docker socket and the traefik API to always populate your dashboard with the apps that you are running. 6 | 7 | ## ENV file 8 | 9 | To run this, you must create a `.env` file in this directory. Below are the required fields: 10 | 11 | - DOMAIN - Your FQDN 12 | 13 | ## Config 14 | 15 | You must also edit the config file at `./configs/traefik.json` and input your traefik URL (along with your traefik username and password if you have basic auth enabled on your traefik service) 16 | -------------------------------------------------------------------------------- /dashboard/configs/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "title": "App Dashboard", 3 | "debug": false, 4 | "appproviders": [ 5 | { 6 | "name": "traefik", 7 | "type": "traefik" 8 | } 9 | ], 10 | "engines": { 11 | "duckduckgo": { 12 | "url": "https://duckduckgo.com/?q=", 13 | "prefix": "d" 14 | } 15 | }, 16 | "bookmarks": { 17 | "social": [ 18 | { 19 | "name": "telegram-web", 20 | "url": "https://web.telegram.org" 21 | }, 22 | { 23 | "name": "facebook", 24 | "url": "https://messenger.com" 25 | } 26 | ], 27 | "music": [ 28 | { 29 | "name": "spotify", 30 | "url": "https://listen.spotify.com" 31 | } 32 | ] 33 | }, 34 | "app_refresh": 20 35 | } 36 | -------------------------------------------------------------------------------- /dashboard/configs/local-docker.json: -------------------------------------------------------------------------------- 1 | { 2 | "connection": "unix", 3 | "path": "/var/run/docker.sock" 4 | } 5 | -------------------------------------------------------------------------------- /dashboard/configs/traefik.json: -------------------------------------------------------------------------------- 1 | { 2 | "url": "https://traefik.example.tld", 3 | "user": "yourtraefikusername", 4 | "pass": "yourtraefikpassword", 5 | "ignored": ["PROMETHEUS@INTERNAL", "NOOP@INTERNAL", "API@INTERNAL"], 6 | "dockers": ["local-docker"] 7 | } 8 | -------------------------------------------------------------------------------- /dashboard/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | sui: 5 | container_name: sui 6 | image: willfantom/sui:latest 7 | restart: unless-stopped 8 | networks: 9 | - traefik-network 10 | dns: 11 | - 1.1.1.1 12 | - 1.0.0.1 13 | volumes: 14 | - ./configs:/sui 15 | - /var/run/docker.sock:/var/run/docker.sock:ro 16 | labels: 17 | - traefik.enable=true 18 | - traefik.http.routers.sui.rule=Host(`apps.${DOMAIN}`, `dash.${DOMAIN}`) 19 | - traefik.http.services.sui.loadbalancer.server.port=6999 20 | - traefik.http.routers.sui.middlewares=basic 21 | - traefik.http.routers.sui.tls=true 22 | - traefik.http.routers.sui.tls.certresolver=cfdns 23 | - sui.enabled=true 24 | - sui.name=dashboard 25 | - sui.icon=home 26 | 27 | networks: 28 | traefik-network: 29 | external: true 30 | default: 31 | driver: bridge 32 | -------------------------------------------------------------------------------- /download/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.tld 2 | 3 | PUID=1000 4 | PGID=999 5 | TZ=Europe/London 6 | 7 | COMPLETED_DOWNLOADS=/downloads/completed 8 | INCOMPLETE_DOWNLOADS=/downloads/incomplete 9 | 10 | NZBS=/services/hydra/nzbs 11 | TORRENTS=/services/jackett/torrents 12 | 13 | HYDRA_CNF=/services/hydra/config 14 | SAB_CNF=/services/sabnzbd 15 | TRANSMISSION_CNF=/services/transmission 16 | 17 | VPNPROVIDER= 18 | VPNEMAIL= 19 | VPNPASSWORD= 20 | LOCAL_SUBNET=192.168.1.0/24 21 | 22 | TRANSMISSIONUSERNAME=myusername 23 | TRANSMISSIONPASSWORD=mypassword -------------------------------------------------------------------------------- /download/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Download 2 | 3 | Downloader services that can be used with the automators in [media](/media) 4 | 5 | - Sabnzbd for usenet 6 | - Transmission for torrents 7 | 8 | - Hydra for collating usenet indexer searches 9 | 10 | **You should be using this with the Træfik service!** 11 | 12 | ## ENV file 13 | 14 | To run this, you must create a `.env` file in this directory. Below are the required fields: 15 | 16 | - DOMAIN - Your FQDN 17 | - COMPLETED_DOWNLOADS - Where completed downloads are store 18 | - INCOMPLETE_DOWNLOADS - Where incomplete downloads are stored 19 | - NZBS - The dir where nzb files to be use by sab are stored 20 | - TORRENTS - The dir where torrent files to be used by transmission are stored 21 | - HYDRA_CNF - The dir where hydra's config will be stored 22 | - SAB_CNF - The dir where sab's config will be stored 23 | - TRANSMISSION_CNF - The dir where transmission's config will be stored 24 | - VPNPROVIDER - Your VPN provider (e.g. mullvad) 25 | - VPNEMAIL - Your VPN username/email 26 | - VPNPASSWORD - Your VPN password 27 | - LOCAL_SUBNET - Your local address range (e.g. 10.0.30.0/24) 28 | - TRANSMISSIONUSERNAME - The username you wish to use to access transmission 29 | - TRANSMISSIONPASSWORD - The password you wish to use to access transmission -------------------------------------------------------------------------------- /download/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | transmission: 6 | container_name: transmission 7 | image: haugene/transmission-openvpn:latest 8 | restart: unless-stopped 9 | cap_add: 10 | - NET_ADMIN 11 | networks: 12 | - traefik-network 13 | dns: 14 | - 1.1.1.1 15 | - 1.0.0.1 16 | volumes: 17 | - /etc/localtime:/etc/localtime:ro 18 | - ${TRANSMISSION_CNF}/cnf:/data 19 | - ${COMPLETED_DOWNLOADS}:/downloads 20 | - ${INCOMPLETE_DOWNLOADS}:/incomplete 21 | - ${TORRENTS}:/watch 22 | environment: 23 | - OPENVPN_PROVIDER=${VPNPROVIDER} 24 | - OPENVPN_USERNAME=${VPNEMAIL} 25 | - OPENVPN_PASSWORD=${VPNPASSWORD} 26 | - CREATE_TUN_DEVICE=true 27 | - LOCAL_NETWORK=${LOCAL_SUBNET} 28 | - PUID=${PUID} 29 | - PGID=${PGID} 30 | - TRANSMISSION_WEB_UI=combustion 31 | - TRANSMISSION_DOWNLOAD_DIR=/downloads 32 | - TRANSMISSION_INCOMPLETE_DIR=/incomplete 33 | - TRANSMISSION_DOWNLOAD_QUEUE_ENABLED=true 34 | - TRANSMISSION_WATCH_DIR_ENABLED=true 35 | - TRANSMISSION_WATCH_DIR=/watch 36 | - TRANSMISSION_DOWNLOAD_QUEUE_SIZE=5 37 | - OPENVPN_OPTS=--inactive 3600 --ping 10 --ping-exit 60 38 | - TRANSMISSION_RPC_PORT=9091 39 | - TRANSMISSION_RPC_AUTHENTICATION_REQUIRED=true 40 | - TRANSMISSION_RPC_HOST_WHITELIST_ENABLED=false 41 | - TRANSMISSION_RPC_WHITELIST_ENABLED=false 42 | - TRANSMISSION_RPC_PASSWORD=${TRANSMISSIONPASSWORD} 43 | - TRANSMISSION_RPC_USERNAME=${TRANSMISSIONUSERNAME} 44 | - TRANSMISSION_UMASK=002 45 | - TRANSMISSION_RATIO_LIMIT=2 46 | - TRANSMISSION_RATIO_LIMIT_ENABLED=true 47 | - WEBPROXY_ENABLED=false 48 | labels: 49 | - traefik.enable=true 50 | - traefik.http.routers.transmission.rule=Host(`transmission.${DOMAIN}`,`torrent.${DOMAIN}`) 51 | - traefik.http.services.transmission.loadbalancer.server.port=9091 52 | - traefik.http.routers.transmission.middlewares=sso,basic 53 | - traefik.http.routers.transmission.tls=true 54 | - traefik.http.routers.transmission.tls.certresolver=cfdns 55 | 56 | sabnzbd: 57 | container_name: sabnzbd 58 | image: linuxserver/sabnzbd 59 | restart: unless-stopped 60 | networks: 61 | - traefik-network 62 | dns: 63 | - 1.1.1.1 64 | - 1.0.0.1 65 | volumes: 66 | - ${SAB_CNF}/cnf:/config 67 | - ${COMPLETED_DOWNLOADS}:/downloads 68 | - ${INCOMPLETE_DOWNLOADS}:/incomplete 69 | - ${NZBS}:/watched 70 | environment: 71 | - PUID=${PUID} 72 | - PGID=${PGID} 73 | - TZ=${TZ} 74 | labels: 75 | - traefik.enable=true 76 | - traefik.http.routers.sabnzbd.rule=Host(`sabnzbd.${DOMAIN}`,`usenet.${DOMAIN}`) 77 | - traefik.http.services.sabnzbd.loadbalancer.server.port=8080 78 | - traefik.http.routers.sabnzbd.middlewares=sso,basic 79 | - traefik.http.routers.sabnzbd.tls=true 80 | - traefik.http.routers.sabnzbd.tls.certresolver=cfdns 81 | 82 | hydra: 83 | container_name: hydra 84 | image: linuxserver/hydra2 85 | restart: unless-stopped 86 | networks: 87 | - traefik-network 88 | dns: 89 | - 1.1.1.1 90 | - 1.0.0.1 91 | volumes: 92 | - ${HYDRA_CNF}:/config 93 | - ${NZBS}:/downloads 94 | environment: 95 | - PUID=${PUID} 96 | - PGID=${PGID} 97 | - TZ=${TZ} 98 | labels: 99 | - traefik.enable=true 100 | - traefik.http.routers.hydra.rule=Host(`hydra.${DOMAIN}`) 101 | - traefik.http.services.hydra.loadbalancer.server.port=5076 102 | - traefik.http.routers.hydra.middlewares=sso,basic 103 | - traefik.http.routers.hydra.tls=true 104 | - traefik.http.routers.hydra.tls.certresolver=cfdns 105 | 106 | networks: 107 | traefik-network: 108 | external: true 109 | default: 110 | driver: bridge 111 | -------------------------------------------------------------------------------- /ghost/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.tld 2 | GHOST_DB_PASSWORD=mydbpassword! 3 | 4 | GHOST_APPS=/services/ghost/apps 5 | GHOST_DATA=/services/ghost/data 6 | GHOST_IMGS=/services/ghost/images 7 | GHOST_THEMES=/services/ghost/themes 8 | 9 | GHOST_DB_DATA=/services/ghost/db -------------------------------------------------------------------------------- /ghost/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Ghost CMS (blogging platform) 2 | 3 | Ghost CMS for a blog. 4 | 5 | To learn more about Ghost CMS, check out their [site](https://ghost.org). 6 | 7 | **You should be using this with the Træfik service!** 8 | 9 | ## ENV file 10 | 11 | To run this, you must create a `.env` file in this directory. Below are the required fields: 12 | 13 | - DOMAIN - Your FQDN 14 | - GHOST_DB_PASSWORD - The password for your database 15 | - This should be secure, but don't worry too much, as this db is not exposed fully to the web 16 | - GHOST_APPS - Directory for your ghost apps 17 | - GHOST_DATA - Directory for your ghost data 18 | - GHOST_IMGS - Directory for your ghost images 19 | - GHOST_THEMES - Directory for your ghost themes 20 | - GHOST_DB_DATA - Directory for your ghost database -------------------------------------------------------------------------------- /ghost/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.7' 2 | 3 | services: 4 | 5 | ghost: 6 | container_name: ghost 7 | image: ghost:alpine 8 | restart: unless-stopped 9 | networks: 10 | - default 11 | - traefik-network 12 | environment: 13 | - url=https://blog.${DOMAIN} 14 | - database__client=mysql 15 | - database__connection__host=ghost-db 16 | - database__connection__user=root 17 | - database__connection__password=${GHOST_DB_PASSWORD} 18 | - database__connection__database=ghost 19 | - mail__transport=SMTP 20 | - mail__options__host=ghost-mail 21 | - mail__options__port=25 22 | volumes: 23 | - ${GHOST_APPS}:/var/lib/ghost/content/apps 24 | - ${GHOST_DATA}:/var/lib/ghost/content/data 25 | - ${GHOST_IMGS}:/var/lib/ghost/content/images 26 | - ${GHOST_THEMES}:/var/lib/ghost/content/themes 27 | labels: 28 | - traefik.enable=true 29 | - traefik.http.routers.ghost.entrypoints=websecure 30 | - traefik.http.routers.ghost.rule=Host(`blog.${DOMAIN}`) 31 | - traefik.http.services.ghost.loadBalancer.server.port=2368 32 | - traefik.http.routers.ghost.middlewares=basic 33 | - traefik.http.routers.ghost.tls=true 34 | - traefik.http.routers.ghost.tls.certresolver=cfdns 35 | 36 | ghost-mail: 37 | container_name: ghost-mail 38 | image: bytemark/smtp 39 | restart: unless-stopped 40 | networks: 41 | - default 42 | 43 | ghost-db: 44 | container_name: ghost-db 45 | image: mysql:5.7 46 | restart: unless-stopped 47 | networks: 48 | - default 49 | volumes: 50 | - ${GHOST_DB_DATA}:/var/lib/mysql 51 | environment: 52 | - MYSQL_ROOT_PASSWORD=${GHOST_DB_PASSWORD} 53 | - MYSQL_DATABASE=ghost 54 | 55 | networks: 56 | traefik-network: 57 | external: true 58 | default: 59 | driver: bridge -------------------------------------------------------------------------------- /gitea/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.yld 2 | GITEA_DATA=/services/gitea 3 | SECRET=supergoodsecret -------------------------------------------------------------------------------- /gitea/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Gitea 2 | 3 | Self hosted Git server. 4 | 5 | **You should be using this with the Træfik service!** 6 | 7 | ## Warning 8 | 9 | You should uncomment the environmental vars in the compose file after you have completed the web based setup of this service! (You should also restart the service after un-commenting the lines in the file) 10 | 11 | Also, the env var for `DISABLE_REGISTRATION` does not seem to work, thus you must edit the generated config file in the container to set this option. 12 | 13 | ## ENV file 14 | 15 | To run this, you must create a `.env` file in this directory. Below are the required fields: 16 | 17 | - DOMAIN - Your FQDN 18 | - GITEA_DATA - The path where you want your gitea data to be stored 19 | - SECRET - Global secret key 20 | -------------------------------------------------------------------------------- /gitea/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | gitea: 6 | container_name: gitea 7 | image: gitea/gitea:latest 8 | restart: unless-stopped 9 | networks: 10 | - traefik-network 11 | volumes: 12 | - ${GITEA_DATA}:/data 13 | - /etc/timezone:/etc/timezone:ro 14 | - /etc/localtime:/etc/localtime:ro 15 | environment: 16 | - USER_UID=1000 17 | - USER_GID=1000 18 | - RUN_MODE=prod 19 | - DISABLE_SSH=true 20 | - HTTP_PORT=3000 21 | - ROOT_URL=https://git.${DOMAIN} 22 | ## Uncomment these after installation 23 | #- INSTALL_LOCK=true 24 | #- SECRET_KEY=${SECRET} 25 | #- DISABLE_REGISTRATION=true 26 | labels: 27 | - traefik.enable=true 28 | #- traefik.http.middlewares.giteaShowRepos.redirectregex.regex=^https?://git.${DOMAIN}/$$ 29 | #- traefik.http.middlewares.giteaShowRepos.redirectregex.replacement=https://git.${DOMAIN}/explore/repos 30 | - traefik.http.routers.gitea.entrypoints=websecure 31 | - traefik.http.routers.gitea.rule=Host(`git.${DOMAIN}`) 32 | - traefik.http.services.gitea.loadBalancer.server.port=3000 33 | - traefik.http.routers.gitea.middlewares=basic 34 | #- traefik.http.routers.gitea.middlewares=basic,giteaShowRepos 35 | - traefik.http.routers.gitea.tls=true 36 | - traefik.http.routers.gitea.tls.certresolver=cfdns 37 | 38 | networks: 39 | traefik-network: 40 | external: true 41 | default: 42 | driver: bridge -------------------------------------------------------------------------------- /gotify/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.tld 2 | 3 | GOTIFY_DATA=/services/gotify/data 4 | USERNAME=myusername 5 | PASSWORD="supersecirepassword!" -------------------------------------------------------------------------------- /gotify/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Gotify 2 | 3 | A notification service you can use a bit like PushBullet. 4 | 5 | **You should be using this with the Træfik service!** 6 | 7 | ## ENV file 8 | 9 | To run this, you must create a `.env` file in this directory. Below are the required fields: 10 | 11 | - DOMAIN - Your FQDN 12 | - GOTIFY_DATA - The path where you want your gotify data to be stored 13 | - USERNAME - The username for the admin account 14 | - PASSWORD - The quoted password for the admin account (quotes are needed in most cases) 15 | -------------------------------------------------------------------------------- /gotify/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | gotify: 6 | container_name: gotify 7 | image: gotify/server:latest 8 | restart: unless-stopped 9 | networks: 10 | - traefik-network 11 | volumes: 12 | - ${GOTIFY_DATA}/data:/app/data 13 | environment: 14 | - TZ=${TZ} 15 | - GOTIFY_DATABASE_DIALECT=sqlite3 16 | - GOTIFY_DATABASE_CONNECTION=data/gotify.db 17 | - GOTIFY_DEFAULTUSER_NAME=${USERNAME} 18 | - GOTIFY_DEFAULTUSER_PASS=${PASSWORD} 19 | labels: 20 | - traefik.enable=true 21 | - traefik.http.routers.gotify.entrypoints=websecure 22 | - traefik.http.routers.gotify.rule=Host(`gotify.${DOMAIN}`,`notify.${DOMAIN}`) 23 | - traefik.http.services.gotify.loadBalancer.server.port=80 24 | - traefik.http.routers.gotify.middlewares=basic 25 | - traefik.http.routers.gotify.tls=true 26 | - traefik.http.routers.gotify.tls.certresolver=cfdns 27 | 28 | networks: 29 | traefik-network: 30 | external: true 31 | default: 32 | driver: bridge -------------------------------------------------------------------------------- /media/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.tld 2 | 3 | PUID=0 4 | PGID=999 5 | TZ=Europe/London 6 | 7 | SONARR_CNF=/services/sonarr 8 | RADARR_CNF=/services/radarr 9 | LIDARR_CNF=/services/lidarr 10 | OVERSEERR_CNF=/services/overseerr 11 | REQUESTRR_CNF=/services/requestrr 12 | 13 | TDARR_DATA=/services/tdarr/data 14 | TDARR_DB=/services/tdarr/db 15 | TRANSCODE_CACHE=/services/tdarr/cache 16 | 17 | DOWNLOADS_DIR=/downloads/completed 18 | MEDIA_DIR=/media 19 | -------------------------------------------------------------------------------- /media/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Media Services 2 | 3 | This compose file provides several media download automators: 4 | 5 | - Sonarr: A service for automating TV downloads 6 | - Radarr: A service for automating Movie downloads 7 | - Lidarr: A service for automating Music downloads 8 | - Overeerr: A frontend to add content to the above services (can be used by N users) 9 | - Requestrr: A Discord bot for making media requests via Overseerr 10 | - Tdarr (Intel QSV variant): A services for automating the transcoding process 11 | 12 | For media request notifications (mobile), I suggest the app LunaSea. 13 | 14 | Tdarr is provided here in an example that uses Intel QuickSync Video. QSV is excellent if you wish to convert a large library from h264 to h265(hevc) to save some storage space. There are other variants that can just use software transcoding or use an NVidia GPU. 15 | 16 | ## ENV file 17 | 18 | To run this, you must create a `.env` file in this directory. Below are the required fields: 19 | 20 | - DOMAIN - Your FQDN 21 | - PUID - Your user ID (run the command `id`) 22 | - PGID - The ID of the docker group (can also be found via `id`) 23 | - TZ - Your timezone (e.g. `Europe/London`) 24 | - SONARR_CNF - The dir where you will store your sonarr config and db 25 | - RADARR_CNF - The dir where you will store your radarr config and db 26 | - LIDARR_CNF - The dir where you will store your lidarr config and db 27 | - OVERSEERR_CNF - The dir where you will store your overseerr config 28 | - REQUESTRR_CNF - The dir where you will store your requestrr config 29 | - TDARR_DATA - The directory where Tdarr will store any application data 30 | - TDARR_DB - The directory where Tdarr will store its database 31 | - TRANSCODE_CACHE - The directory where any temp files for transcoding will be stored. To increase the lifespan of your disks/ssds, I suggest this directory being on a RAM Disk 32 | 33 | - MEDIA_DATA - The dir where you media collection is 34 | - DOWNLOADS_DIR - The dir where your completed download will be stored 35 | -------------------------------------------------------------------------------- /media/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | sonarr: 5 | container_name: sonarr 6 | image: linuxserver/sonarr:preview 7 | restart: unless-stopped 8 | networks: 9 | - traefik-network 10 | environment: 11 | - TZ=${TZ} 12 | - PUID=${PUID} 13 | - PGID=${PGID} 14 | dns: 15 | - 1.1.1.1 16 | - 1.0.0.1 17 | volumes: 18 | - ${SONARR_CNF}:/config 19 | - ${DOWNLOADS_DIR}:/downloads 20 | - ${MEDIA_DIR}/tv:/tv 21 | labels: 22 | - traefik.enable=true 23 | - traefik.http.routers.sonarr.rule=Host(`sonarr.${DOMAIN}`) 24 | - traefik.http.services.sonarr.loadbalancer.server.port=8989 25 | - traefik.http.routers.sonarr.middlewares=sso,basic 26 | - traefik.http.routers.sonarr.tls=true 27 | - traefik.http.routers.sonarr.tls.certresolver=cfdns 28 | - sui.enbaled=true 29 | - sui.name=tv-sonarr 30 | - sui-icon=tv 31 | 32 | radarr: 33 | container_name: radarr 34 | image: linuxserver/radarr:preview 35 | restart: unless-stopped 36 | networks: 37 | - traefik-network 38 | dns: 39 | - 1.1.1.1 40 | - 1.0.0.1 41 | environment: 42 | - TZ=${TZ} 43 | - PUID=${PUID} 44 | - PGID=${PGID} 45 | volumes: 46 | - ${RADARR_CNF}:/config 47 | - ${DOWNLOADS_DIR}:/downloads 48 | - ${MEDIA_DIR}/movies:/movies 49 | labels: 50 | - traefik.enable=true 51 | - traefik.http.routers.radarr.rule=Host(`radarr.${DOMAIN}`) 52 | - traefik.http.services.radarr.loadbalancer.server.port=7878 53 | - traefik.http.routers.radarr.middlewares=sso,basic 54 | - traefik.http.routers.radarr.tls=true 55 | - traefik.http.routers.radarr.tls.certresolver=cfdns 56 | - sui.enbaled=true 57 | - sui.name=movies-radarr 58 | - sui-icon=film 59 | 60 | lidarr: 61 | container_name: lidarr 62 | image: linuxserver/lidarr:latest 63 | restart: unless-stopped 64 | networks: 65 | - traefik-network 66 | dns: 67 | - 1.1.1.1 68 | - 1.0.0.1 69 | environment: 70 | - TZ=${TZ} 71 | - PUID=${PUID} 72 | - PGID=${PGID} 73 | volumes: 74 | - ${LIDARR_CNF}:/config 75 | - ${DOWNLOADS_DIR}:/downloads 76 | - ${MEDIA_DIR}/music:/music 77 | labels: 78 | - traefik.enable=true 79 | - traefik.http.routers.lidarr.rule=Host(`lidarr.${DOMAIN}`) 80 | - traefik.http.services.lidarr.loadbalancer.server.port=8686 81 | - traefik.http.routers.lidarr.middlewares=sso,basic 82 | - traefik.http.routers.lidarr.tls=true 83 | - traefik.http.routers.lidarr.tls.certresolver=cfdns 84 | - sui.enbaled=true 85 | - sui.name=music-lidarr 86 | - sui-icon=music 87 | 88 | tdarr: 89 | container_name: tdarr 90 | image: haveagitgat/tdarr_aio:qsv 91 | restart: unless-stopped 92 | privileged: true 93 | devices: 94 | - /dev/dri:/dev/dri 95 | networks: 96 | - traefik-network 97 | volumes: 98 | - ${TDARR_DATA}:/home/Tdarr/Documents/Tdarr 99 | - ${TDARR_DB}:/var/lib/mongodb 100 | - ${MEDIA_DIR}:/home/Tdarr/media 101 | - ${TRANSCODE_CACHE}:/home/Tdarr/cache 102 | - /etc/localtime:/etc/localtime:ro 103 | environment: 104 | - TZ=${TZ} 105 | - PUID=${PUID} 106 | - PGID=${PGID} 107 | labels: 108 | - traefik.enable=true 109 | - traefik.http.routers.tdarr.entrypoints=websecure 110 | - traefik.http.routers.tdarr.rule=Host(`transcode.${DOMAIN}`) 111 | - traefik.http.services.tdarr.loadbalancer.server.port=8265 112 | - traefik.http.routers.tdarr.middlewares=sso,basic 113 | - traefik.http.routers.tdarr.tls=true 114 | - traefik.http.routers.tdarr.tls.certresolver=cfdns 115 | 116 | overseerr: 117 | container_name: overseerr 118 | image: sctx/overseerr 119 | restart: unless-stopped 120 | networks: 121 | - default 122 | - traefik-network 123 | environment: 124 | - TZ=${TZ} 125 | - PUID=${PUID} 126 | - PGID=${PGID} 127 | - LOG_LEVEL=info 128 | volumes: 129 | - ${OVERSEERR_CNF}:/app/config 130 | labels: 131 | - traefik.enable=true 132 | - traefik.http.routers.overseerr.rule=Host(`request.${DOMAIN}`,`requests.${DOMAIN}`) 133 | - traefik.http.services.overseerr.loadbalancer.server.port=5055 134 | - traefik.http.routers.overseerr.middlewares=basic 135 | - traefik.http.routers.overseerr.tls=true 136 | - traefik.http.routers.overseerr.tls.certresolver=cfdns 137 | - sui.enbaled=true 138 | - sui.name=media requests 139 | 140 | requestrr: 141 | container_name: requestrr 142 | image: darkalfx/requestrr:latest 143 | restart: unless-stopped 144 | networks: 145 | - default 146 | - traefik-network 147 | volumes: 148 | - ${REQUESTRR_CNF}:/root/config 149 | labels: 150 | - traefik.enable=true 151 | - traefik.http.routers.requestrr.rule=Host(`requestrr.${DOMAIN}`) 152 | - traefik.http.services.requestrr.loadbalancer.server.port=4545 153 | - traefik.http.routers.requestrr.middlewares=basic 154 | - traefik.http.routers.requestrr.tls=true 155 | - traefik.http.routers.requestrr.tls.certresolver=cfdns 156 | 157 | networks: 158 | traefik-network: 159 | external: true 160 | default: 161 | driver: bridge 162 | -------------------------------------------------------------------------------- /monitoring/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Monitoring 2 | 3 | This section is split into the folling stacks: 4 | 5 | - Per Host: This stack collects data from the host it is deployed on, and also store it in a time series database. This databased can then be accessed via an API, locally or remotely. 6 | - See [here](./per-host/README.md). 7 | 8 | - Frontend: This stack simply provides a friendly UI for the monitoring data. You can connect as many databases from the `per-host` stack to this so you can collate and show all the data in one place. 9 | - See [here](./frontend/README.md). 10 | -------------------------------------------------------------------------------- /monitoring/frontend/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.tld 2 | 3 | GRAFANA_DATA_DIR=/services/monitoring/grafana/data 4 | GRAFANA_PLUGINS=grafana-clock-panel,grafana-piechart-panel,grafana-simple-json-datasource 5 | -------------------------------------------------------------------------------- /monitoring/frontend/README.md: -------------------------------------------------------------------------------- 1 | # Monitoring [frontend] 2 | 3 | This is to act as a frontend to your monitoring. You can connect Grafana to N Prometheus instances, so I suggest only running this on a single host, and connecting your N Prometheus services to it. 4 | 5 | This monitoring stack uses the following service: 6 | - Grafana: Used for as a front-end for monitoring data. Basically, makes pretty graphs 7 | 8 | ## ENV file 9 | 10 | To run this, you must create a `.env` file in this directory. Below are the required fields: 11 | 12 | - DOMAIN - Your FQDN 13 | - GRAFANA_DATA_DIR - Path to where grafana data will be stored 14 | - GRAFANA_PLUGINS - Comma seperated list of grafana plugins to be installed 15 | -------------------------------------------------------------------------------- /monitoring/frontend/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.7' 2 | 3 | services: 4 | 5 | grafana: 6 | container_name: grafana 7 | image: grafana/grafana:latest 8 | restart: unless-stopped 9 | user: root 10 | networks: 11 | - traefik-network 12 | volumes: 13 | - ${GRAFANA_DATA_DIR}:/var/lib/grafana 14 | environment: 15 | - GF_INSTALL_PLUGINS=${GRAFANA_PLUGINS} 16 | labels: 17 | - traefik.enable=true 18 | - traefik.http.routers.grafana.entrypoints=websecure 19 | - traefik.http.routers.grafana.rule=Host(`monitor.${DOMAIN}`) 20 | - traefik.http.services.grafana.loadBalancer.server.port=3000 21 | - traefik.http.routers.grafana.middlewares=sso,basic 22 | - traefik.http.routers.grafana.tls=true 23 | - traefik.http.routers.grafana.tls.certresolver=cfdns 24 | 25 | networks: 26 | traefik-network: 27 | external: true 28 | default: 29 | driver: bridge 30 | -------------------------------------------------------------------------------- /monitoring/per-host/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.tld 2 | 3 | PROMETHEUS_CONFIG_DIR=/services/monitoring/prometheus/config 4 | PROMETHEUS_DATA_DIR=/services/monitoring/prometheus/data 5 | ALERT_MANAGER_CONFIG=/services/monitoring/alets/config 6 | -------------------------------------------------------------------------------- /monitoring/per-host/README.md: -------------------------------------------------------------------------------- 1 | # Monitoring [per-node] 2 | 3 | This stack of services is intended to be run on ever host that you have. E.g. if you have a home machine and a VPS, this should be run on both as it will monitor only the host it is deployed on. 4 | If you want a convenient way to see any collected data (graphs etc...), look at the other monitoring stack [here](../frontend/README.md). 5 | 6 | This monitoring stack uses the following services: 7 | - Prometheus: A Time Series DataBase (TSDB) that scrapes services (polling) for data amd store it. It also provides an API to collect the metrics (what grafana uses). 8 | - Alerts-Manager: Can send alerts based on rules setup in prometheus, allowing you to receive notifications when you need them. 9 | - Node Exporter: Collects metrics from the host system (such as storage, cpu and memory) and provides them in a way where prometheus can 'scrape' them. 10 | - CAdvisor: Collects metrics on containers (memory, cpu etc...) and provides them in a way where prometheus can 'scrape' them. 11 | 12 | Of these services, only Prometheus should be exposed to the network, and should also have http basic auth if over `https`. 13 | 14 | ## ENV file 15 | 16 | To run this, you must create a `.env` file in this directory. Below are the required fields: 17 | 18 | - DOMAIN - Your FQDN 19 | - PROMETHEUS_CONFIG_DIR - Path to where the prometheus config will be stored 20 | - Make sure to move your `prometheus.yml` and `alert.rules` to this directory 21 | - PROMETHEUS_DATA_DIR - Path to where the prometheus data will be stored 22 | - ALERT_MANAGER_CONFIG - Path to where the alert manager config will be stored 23 | - Make sure to move your alert manager config to here 24 | -------------------------------------------------------------------------------- /monitoring/per-host/alert.rules.example: -------------------------------------------------------------------------------- 1 | groups: 2 | - name: core 3 | rules: 4 | 5 | - alert: service_down 6 | expr: up == 0 7 | for: 2m 8 | labels: 9 | severity: page 10 | annotations: 11 | summary: "Instance {{ $labels.instance }} down" 12 | description: "{{ $labels.instance }} of job {{ $labels.job }} has been down for more than 2 minutes." 13 | -------------------------------------------------------------------------------- /monitoring/per-host/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '3.7' 2 | 3 | services: 4 | 5 | prometheus: 6 | container_name: prometheus 7 | image: prom/prometheus:latest 8 | restart: unless-stopped 9 | user: root 10 | networks: 11 | - default 12 | - traefik-network 13 | volumes: 14 | - ${PROMETHEUS_CONFIG_DIR}:/etc/prometheus/ 15 | - ${PROMETHEUS_DATA_DIR}:/prometheus 16 | command: 17 | - '--config.file=/etc/prometheus/prometheus.yml' 18 | - '--storage.tsdb.path=/prometheus' 19 | - '--web.console.libraries=/usr/share/prometheus/console_libraries' 20 | - '--web.console.templates=/usr/share/prometheus/consoles' 21 | labels: 22 | - traefik.enable=true 23 | - traefik.http.routers.prom.entrypoints=websecure 24 | - traefik.http.routers.prom.rule=Host(`prom.${DOMAIN}`) 25 | - traefik.http.services.prom.loadBalancer.server.port=9090 26 | - traefik.http.routers.prom.middlewares=bauth,basic 27 | - traefik.http.routers.prom.tls=true 28 | - traefik.http.routers.prom.tls.certresolver=cfdns 29 | 30 | node-exporter: 31 | container_name: node-exporter 32 | image: prom/node-exporter 33 | restart: unless-stopped 34 | networks: 35 | - default 36 | volumes: 37 | - /proc:/host/proc:ro 38 | - /sys:/host/sys:ro 39 | - /:/rootfs:ro 40 | command: 41 | - '--path.procfs=/host/proc' 42 | - '--path.sysfs=/host/sys' 43 | - --collector.filesystem.ignored-mount-points 44 | - "^/(sys|proc|dev|host|etc|rootfs/var/lib/docker/containers|rootfs/var/lib/docker/overlay2|rootfs/run/docker/netns|rootfs/var/lib/docker/aufs)($$|/)" 45 | 46 | alertmanager: 47 | container_name: prometheus-alert-manager 48 | image: prom/alertmanager 49 | restart: unless-stopped 50 | networks: 51 | - default 52 | volumes: 53 | - ${ALERT_MANAGER_CONFIG}:/etc/alertmanager/ 54 | command: 55 | - '--config.file=/etc/alertmanager/config.yml' 56 | - '--storage.path=/alertmanager' 57 | 58 | cadvisor: 59 | container_name: cadvisor 60 | image: google/cadvisor 61 | restart: unless-stopped 62 | networks: 63 | - default 64 | volumes: 65 | - /:/rootfs:ro 66 | - /var/run:/var/run:rw 67 | - /sys:/sys:ro 68 | - /var/lib/docker/:/var/lib/docker:ro 69 | 70 | networks: 71 | traefik-network: 72 | external: true 73 | default: 74 | driver: bridge 75 | -------------------------------------------------------------------------------- /monitoring/per-host/prometheus.yml.example: -------------------------------------------------------------------------------- 1 | global: 2 | scrape_interval: 15s 3 | evaluation_interval: 15s 4 | 5 | rule_files: 6 | - "alert.rules" 7 | 8 | scrape_configs: 9 | - job_name: 'traefik' 10 | scrape_interval: 5s 11 | static_configs: 12 | - targets: ['traefik:8080'] 13 | 14 | - job_name: 'nodeexporter' 15 | scrape_interval: 15s 16 | static_configs: 17 | - targets: ['node-exporter:9100'] 18 | 19 | - job_name: 'cadvisor' 20 | scrape_interval: 30s 21 | static_configs: 22 | - targets: ['cadvisor:8080'] 23 | 24 | - job_name: 'prometheus' 25 | scrape_interval: 15s 26 | static_configs: 27 | - targets: ['localhost:9090'] 28 | 29 | alerting: 30 | alertmanagers: 31 | - scheme: http 32 | static_configs: 33 | - targets: 34 | - 'alertmanager:9093' 35 | -------------------------------------------------------------------------------- /parrot/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=example.tld 2 | REDIRECT=https://www.youtube.com/watch?v=dQw4w9WgXcQ -------------------------------------------------------------------------------- /parrot/README.md: -------------------------------------------------------------------------------- 1 | # Party Parrot 2 | 3 | Displays an animated parrt when the URL is cURLd. 4 | 5 | `curl https://parrot.example.tld` 6 | 7 | This will do the same as `curl parrot.live`, but just self-hosted. Although a little bit pointless for many, it can act as quite a nice landing page, simply redirecting back to a site such as `duck duck go` when seen via a browser, yet showing the party parrot when curld. 8 | 9 | 10 | **You should be using this with the Træfik service!** 11 | 12 | ## ENV file 13 | 14 | To run this, you must create a `.env` file in this directory. Below are the required fields: 15 | 16 | - DOMAIN - Your FQDN 17 | - REDIRECT - The URL to direct a client to if they connect via a web browser (not cURL) 18 | -------------------------------------------------------------------------------- /parrot/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | parrot: 5 | container_name: parrot 6 | image: willfantom/parrot.live 7 | restart: unless-stopped 8 | networks: 9 | - traefik-network 10 | environment: 11 | - PARROT_REDIRECT=${REDIRECT} 12 | labels: 13 | - traefik.enable=true 14 | - traefik.http.routers.parrot.rule=Host(`parrot.${DOMAIN}`) 15 | - traefik.http.services.parrot.loadbalancer.server.port=3000 16 | - traefik.http.routers.parrot.middlewares=basic 17 | - traefik.http.routers.parrot.tls=true 18 | - traefik.http.routers.parrot.tls.certresolver=tlsc 19 | 20 | networks: 21 | traefik-network: 22 | external: true 23 | default: 24 | driver: bridge 25 | -------------------------------------------------------------------------------- /plex/.env.example: -------------------------------------------------------------------------------- 1 | # User ID 2 | PUID=0 3 | # Docker Group ID 4 | PGID=999 5 | 6 | # Your Timezone 7 | TZ=Europe/London 8 | 9 | # Your domain 10 | DOMAIN=mydomain.tld 11 | 12 | PLEX_DIR=/services/plex 13 | MEDIA_DATA=/media 14 | TRANSCODE_DIR=/tmp -------------------------------------------------------------------------------- /plex/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Plex Media Server 2 | 3 | A pretty decent media server with tonnes of features. However, due to a few reasons, such as the use of sqlite, this might change soon... 4 | 5 | Tautulli is also included for stats collection. 6 | 7 | ## ENV file 8 | 9 | To run this, you must create a `.env` file in this directory. Below are the required fields: 10 | 11 | - DOMAIN - Your FQDN 12 | - PUID - Your user ID (run the command `id`) 13 | - PGID - The ID of the docker group (can also be found via `id`) 14 | - TZ - Your timezone (e.g. `Europe/London`) 15 | - PLEX_DIR - The dir where you will store your plex data 16 | - MEDIA_DATA - The dir where you media collection is 17 | - TRANSCODE_DIR - The dir where to store tmp transcode files 18 | 19 | ## Claiming 20 | 21 | When running for the first time, get a plex claim token for your plex account from [here](https://www.plex.tv/claim/). 22 | 23 | Then run the following command: 24 | 25 | ```bash 26 | export PLEX_CLAIM= 27 | ``` 28 | 29 | ## Transcoding 30 | 31 | I suggest making `TRANSCODE_DIR` a directory on a RAM disk for better performance and less writes to an SSD! 32 | -------------------------------------------------------------------------------- /plex/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | plex: 6 | container_name: plex 7 | restart: unless-stopped 8 | image: plexinc/pms-docker 9 | devices: 10 | - /dev/dri:/dev/dri 11 | privileged: true 12 | network_mode: "host" 13 | volumes: 14 | - ${PLEX_DIR}/config:/config 15 | - ${TRANSCODE_DIR}/transcode:/transcode 16 | - ${MEDIA_DATA}:/media 17 | ports: 18 | - "32400:32400/tcp" 19 | - "3005:3005/tcp" 20 | - "8324:8324/tcp" 21 | - "32469:32469/tcp" 22 | - "1900:1900/udp" 23 | - "32410:32410/udp" 24 | - "32412:32412/udp" 25 | - "32413:32413/udp" 26 | - "32414:32414/udp" 27 | environment: 28 | - TZ=${TZ} 29 | - HOSTNAME="Docker-Plex" 30 | - PLEX_CLAIM=${PLEX_CLAIM} 31 | - PLEX_UID=${PUID} 32 | - PLEX_GID=${PGID} 33 | labels: 34 | # Don't auto update 35 | - com.centurylinklabs.watchtower.enable="false" 36 | 37 | tautulli: 38 | container_name: tautulli 39 | restart: unless-stopped 40 | image: linuxserver/tautulli 41 | depends_on: 42 | - plex 43 | environment: 44 | - PUID=${PUID} 45 | - PGID=${PGID} 46 | - TZ=${TZ} 47 | volumes: 48 | - ${PLEX_DIR}/tautulli:/config 49 | networks: 50 | - traefik-network 51 | labels: 52 | - traefik.enable=true 53 | - traefik.http.routers.tautulli.entrypoints=websecure 54 | - traefik.http.routers.tautulli.rule=Host(`stats.${DOMAIN}`) 55 | - traefik.http.services.tautulli.loadbalancer.server.port=8181 56 | - traefik.http.routers.tautulli.middlewares=basic 57 | - traefik.http.routers.tautulli.tls=true 58 | - traefik.http.routers.tautulli.tls.certresolver=cfdns 59 | 60 | 61 | networks: 62 | traefik-network: 63 | external: true 64 | default: 65 | driver: bridge 66 | 67 | -------------------------------------------------------------------------------- /portainer/.env.example: -------------------------------------------------------------------------------- 1 | PORTAINER_DATA=/services/portainer/data 2 | 3 | DOMAIN=mydomain.tld -------------------------------------------------------------------------------- /portainer/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Portainer 2 | 3 | A web service for managing containers. Useful for viewing container logs remotely. 4 | 5 | **You should be using this with the Træfik service!** 6 | 7 | ## ENV file 8 | 9 | To run this, you must create a `.env` file in this directory. Below are the required fields: 10 | 11 | - DOMAIN - Your FQDN 12 | - PORTAINER_DATA - The path where you want your portainer data to be stored 13 | -------------------------------------------------------------------------------- /portainer/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | portainer: 6 | container_name: portainer 7 | image: portainer/portainer 8 | restart: always 9 | networks: 10 | - traefik-network 11 | volumes: 12 | - /var/run/docker.sock:/var/run/docker.sock 13 | - ${PORTAINER_DATA}:/data 14 | labels: 15 | - traefik.enable=true 16 | - traefik.http.routers.portainer.entrypoints=websecure 17 | - traefik.http.routers.portainer.rule=Host(`containers.${DOMAIN}`) 18 | - traefik.http.services.portainer.loadBalancer.server.port=9000 19 | - traefik.http.routers.portainer.middlewares=sso,basic 20 | - traefik.http.routers.portainer.tls=true 21 | - traefik.http.routers.portainer.tls.certresolver=cfdns 22 | 23 | networks: 24 | traefik-network: 25 | external: true 26 | default: 27 | driver: bridge -------------------------------------------------------------------------------- /titra/.env.example: -------------------------------------------------------------------------------- 1 | DOMAIN=mydomain.tld 2 | 3 | TITRA_DB_DATA=/services/titra/data -------------------------------------------------------------------------------- /titra/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Titra 2 | 3 | Titra is a time logging tool. Great if you are doing freelance work and need to keep track of hours spent on a project. 4 | 5 | **You should be using this with the Træfik service!** 6 | 7 | ## ENV file 8 | 9 | To run this, you must create a `.env` file in this directory. Below are the required fields: 10 | 11 | - DOMAIN - Your FQDN 12 | - TITRA_DB_DATA - The path where you want your titra data to be stored 13 | -------------------------------------------------------------------------------- /titra/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | titra: 6 | container_name: titra 7 | image: kromit/titra 8 | restart: unless-stopped 9 | depends_on: 10 | - titra-db 11 | networks: 12 | - traefik-network 13 | - default 14 | environment: 15 | - ROOT_URL=https://timetrack.${DOMAIN} 16 | - MONGO_URL=mongodb://titra-db/titra 17 | - PORT=3000 18 | labels: 19 | - traefik.enable=true 20 | - traefik.http.routers.titra.entrypoints=websecure 21 | - traefik.http.routers.titra.rule=Host(`timetrack.${DOMAIN}`) 22 | - traefik.http.services.titra.loadBalancer.server.port=3000 23 | - traefik.http.routers.titra.middlewares=basic 24 | - traefik.http.routers.titra.tls=true 25 | - traefik.http.routers.titra.tls.certresolver=cfdns 26 | 27 | titra-db: 28 | container_name: titra-db 29 | image: mongo:4.0 30 | restart: unless-stopped 31 | networks: 32 | - default 33 | volumes: 34 | - ${TITRA_DB_DATA}:/data/db 35 | 36 | networks: 37 | traefik-network: 38 | external: true 39 | default: 40 | driver: bridge -------------------------------------------------------------------------------- /traefik/.env.example: -------------------------------------------------------------------------------- 1 | CERT_DIR=${HOME}/.traefik/certs 2 | RULES_DIR=${HOME}/.traefik/rules 3 | LOGS_DIR=${HOME}/.traefik/logs 4 | CF_API_EMAIL=mycloudflareemail@domain.tld 5 | CF_API_KEY=1234isthissecure 6 | 7 | # User/Pass For Basic Auth (use a .htpasswd generator) 8 | USERNAME=username 9 | HASHEDPASS=$superhasedpassword 10 | 11 | ALLOWED_SUBNETS=127.0.0.1/32 12 | WHITELISTED_EMAILS=myemail@domain.tld 13 | 14 | AUTH_ID=1234myauthid.apps.googleusercontent.com 15 | AUTH_SECRET=supersecretkey 16 | RANDOM_SECRET=isthisevenrandom 17 | 18 | # For 2FA bypass on automaton APIs 19 | RADARR_API_KEY=keyyyyyyyyyyyyy 20 | SONARR_API_KEY=keyyyyyyyyyyyyy 21 | LIDARR_API_KEY=keyyyyyyyyyyyyy 22 | SAB_API_KEY=keyyyyyyyyyyyyy 23 | 24 | DOMAIN=mydomain.tld -------------------------------------------------------------------------------- /traefik/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Træfik 2 | 3 | Secure reverse proxy / load-balancer. This is used as an ingress to access all services. 4 | 5 | To learn more about træfik, read the docs [here](https://docs.traefik.io). 6 | 7 | Some basic træfik middlewares are also included for: hsts, basic-auth, forward-auth (google oauth), rate limiting and ssl redirection. 8 | 9 | All the middlewares stated above will work with little to no configuration steps required. However, forward auth will require some steps to be taken. 10 | 11 | To use, ensure you have created the external `docker network create traefik-network`! 12 | 13 | ## TLS 14 | 15 | There are 2 options for TLS provided in this compose file: TLS Challenge and DNS Challenge. If you plan to use a mix of both for any reason, ensure that the email address that you use for both are the same. 16 | 17 | Use the certificate resolver `tlsc` to use the TLS Challenge. 18 | 19 | Use the certificate resolver `cfdns` to use the DNS Challenge. This uses Cloudflare as I find it good to use for hosting my services. If you prefer an alternative DNS provider, this compose file can be easily adapted to use others. See the træfik docs for a full list of supported DNS provides that work with the DNS Challenge. 20 | 21 | ## Træfik v2.2 Update 22 | 23 | This file uses the entrypoint redirection mechanism introduced in Træfik v2.2 to force all `http` requests to be redirected as `https` at port `443`. This means that each services no longer needs 2 routers (one at each entrypoint). 24 | 25 | ## File Provider 26 | 27 | The services on this repo uses Træfik's **docker provider**, however, the **file provider** is also enabled. In the `.env` file you make, you will specify a `RULES_DIR`. This is a folder where you can store `.yml` files that will be parsed as rules. An example yml file has been provided as `service.yml`. This service uses the **sso** middleware and the **basic** middleware chain, both of which are provided by the Træfik's docker mechanism. It also uses the `cfdns` certificate resolver. Specifically, the example services proxys to a service running at the IP *192.168.1.45* on port *8080*. 28 | 29 | ## ENV file 30 | 31 | To run this, you must create a `.env` file in this directory. Below are the required fields: 32 | 33 | - CERT_DIR - The path to store TLS certs for your domain and sub-domains 34 | - RULES_DIR - The path to the directory where file rules can be stored. This allows you to add non-docker services to your traefik reverse proxy 35 | - LOGS_DIR - The path to the directory where traefik will store its logs (can be in /tmp) 36 | - CF_API_EMAIL - The email address of your cloudflare account 37 | - CF_API_KEY - Your global cloudflare API key 38 | - USERNAME - A username for use with basic auth 39 | - HASHEDPASS - A hashed password for use with basic auth (can use a .htpasswd gen) 40 | - ALLOWED_SUBNETS - A list of subnets that your inner serves should be accessible from (not used by default) 41 | - WHITELISTED_EMAILS - Email address of google accounts that can access your server through sso (use with forward auth) 42 | - AUTH_ID - Your google oauth ID 43 | - AUTH_SECRET - Your google oauth secret 44 | - RANDOM_SECRET - A random string that you create 45 | 46 | DOMAIN - your FQDN -------------------------------------------------------------------------------- /traefik/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | traefik: 6 | container_name: traefik 7 | image: traefik:latest 8 | restart: always 9 | networks: 10 | - default 11 | - traefik-network 12 | ports: 13 | - 8080:8080 14 | - 443:443 15 | - 80:80 16 | volumes: 17 | - ${CERT_DIR}:/letsencrypt 18 | - ${RULES_DIR}:/rules 19 | - ${LOGS_DIR}:/logs 20 | - /var/run/docker.sock:/var/run/docker.sock:ro 21 | environment: 22 | - CF_API_EMAIL=${CF_API_EMAIL} 23 | - CF_API_KEY=${CF_API_KEY} 24 | command: 25 | - "--api=true" 26 | - "--api.dashboard=true" 27 | - "--accesslog=false" 28 | - "--accesslog.filepath=/logs/access.log" 29 | - "--accesslog.format=json" 30 | - "--accesslog.filters.statuscodes=300-599" 31 | - "--accesslog.filters.retryattempts" 32 | - "--accesslog.filters.minduration=100ms" 33 | - "--log.level=ERROR" 34 | - "--providers.docker=true" 35 | - "--providers.docker.watch=true" 36 | - "--providers.docker.exposedbydefault=false" 37 | - "--providers.docker.network=traefik-network" 38 | - "--providers.file.directory=/rules" 39 | - "--providers.file.watch=true" 40 | - "--entrypoints.web.address=:80" 41 | - "--entrypoints.websecure.address=:443" 42 | - "--entrypoints.web.http.redirections.entryPoint.to=websecure" 43 | - "--entrypoints.web.http.redirections.entryPoint.scheme=https" 44 | - "--entrypoints.web.http.redirections.entrypoint.permanent=true" 45 | - "--certificatesResolvers.tlsc.acme.tlschallenge=true" 46 | - "--certificatesresolvers.tlsc.acme.email=${CF_API_EMAIL}" 47 | - "--certificatesresolvers.tlsc.acme.storage=/letsencrypt/acme-tls.json" 48 | - "--certificatesresolvers.cfdns.acme.dnschallenge=true" 49 | - "--certificatesresolvers.cfdns.acme.dnschallenge.provider=cloudflare" 50 | - "--certificatesresolvers.cfdns.acme.email=${CF_API_EMAIL}" 51 | - "--certificatesresolvers.cfdns.acme.storage=/letsencrypt/acme.json" 52 | - "--metrics.prometheus.buckets=0.1,0.3,1.2,5.0" 53 | - "--metrics.prometheus.entrypoint=traefik" 54 | labels: 55 | - traefik.enable=true 56 | 57 | ## Middlewares 58 | 59 | # Basic Auth (with details from ingress/.env) 60 | - traefik.http.middlewares.bauth.basicauth.users=${USERNAME}:${HASHEDPASS} 61 | # Forward Auth 62 | - traefik.http.middlewares.sso.forwardAuth.address=http://traefik-sso-fw:4181 63 | - traefik.http.middlewares.sso.forwardauth.trustForwardHeader=true 64 | - traefik.http.middlewares.sso.forwardAuth.authResponseHeaders=X-Forwarded-User 65 | # Security Headers 66 | - traefik.http.middlewares.hsts.headers.sslForceHost=true 67 | - traefik.http.middlewares.hsts.headers.stsSeconds=315360000 68 | - traefik.http.middlewares.hsts.headers.stsIncludeSubdomains=true 69 | - traefik.http.middlewares.hsts.headers.stsPreload=true 70 | - traefik.http.middlewares.xss.headers.browserXssFilter=true 71 | - traefik.http.middlewares.frameDeny.headers.frameDeny=true 72 | - traefik.http.middlewares.nosniff.headers.contentTypeNosniff=true 73 | # Internal Only (Requires Træfik to be running with network mode host) 74 | # - traefik.http.middlewares.inner.ipwhitelist.sourcerange=${ALLOWED_SUBNETS} 75 | # Rate Limit 76 | - traefik.http.middlewares.ratelimit.ratelimit.average=1000 77 | - traefik.http.middlewares.ratelimit.ratelimit.burst=100 78 | 79 | # Middleware Chains 80 | - traefik.http.middlewares.basic.chain.middlewares=ratelimit,hsts,xss,nosniff,frameDeny 81 | - traefik.http.middlewares.full-auth.chain.middlewares=sso,bauth 82 | 83 | # Træfik Dashboard Labels 84 | - traefik.http.routers.traefik.entrypoints=websecure 85 | - traefik.http.routers.traefik.rule=Host(`traefik.${DOMAIN}`) 86 | - traefik.http.routers.traefik.service=api@internal 87 | - traefik.http.routers.traefik.middlewares=sso,basic 88 | - traefik.http.routers.traefik.tls=true 89 | - traefik.http.routers.traefik.tls.certresolver=cfdns 90 | 91 | # Don't auto update 92 | - com.centurylinklabs.watchtower.enable="false" 93 | 94 | traefik-sso-fw: 95 | image: thomseddon/traefik-forward-auth 96 | container_name: traefik-sso-fw 97 | restart: always 98 | environment: 99 | - PROVIDERS_GOOGLE_CLIENT_ID=${AUTH_ID} 100 | - PROVIDERS_GOOGLE_CLIENT_SECRET=${AUTH_SECRET} 101 | - SECRET=${RANDOM_SECRET} 102 | - AUTH_HOST=auth.${DOMAIN} 103 | - INSECURE_COOKIE=false 104 | - COOKIE_DOMAIN=${DOMAIN} 105 | - LOG_LEVEL=debug 106 | - WHITELIST=${WHITELISTED_EMAILS} 107 | networks: 108 | - traefik-network 109 | command: 110 | - --rule.trapi.rule="PathPrefix(`/api`) && Host(`traefik.${DOMAIN}`)" 111 | - --rule.trapi.action=allow 112 | - --rule.rdapi.rule="PathPrefix(`/api`) && Host(`radarr.${DOMAIN}`) && Headers(`X-Api-Key`, `${RADARR_API_KEY}`)" 113 | - --rule.rdapi.action=allow 114 | - --rule.snapi.rule="PathPrefix(`/api`) && Host(`sonarr.${DOMAIN}`) && Headers(`X-Api-Key`, `${SONARR_API_KEY}`)" 115 | - --rule.snapi.action=allow 116 | - --rule.ldapi.rule="PathPrefix(`/api`) && Host(`lidarr.${DOMAIN}`) && Headers(`X-Api-Key`, `${LIDARR_API_KEY}`)" 117 | - --rule.ldapi.action=allow 118 | - --rule.sbapi.rule="PathPrefix(`/api`) && Host(`sabnzbd.${DOMAIN}`) && Headers(`X-Api-Key`, `${SAB_API_KEY}`)" 119 | - --rule.sbapi.action=allow 120 | labels: 121 | - traefik.enable=true 122 | - traefik.http.services.traefik-sso-fw.loadBalancer.server.port=4181 123 | - traefik.http.routers.traefik-sso-fw.entryPoints=websecure 124 | - traefik.http.routers.traefik-sso-fw.rule=host(`auth.${DOMAIN}`) 125 | - traefik.http.routers.traefik-sso-fw.middlewares=basic,sso 126 | - traefik.http.routers.traefik-sso-fw.tls=true 127 | - traefik.http.routers.traefik-sso-fw.tls.certResolver=cfdns 128 | 129 | networks: 130 | traefik-network: 131 | external: true 132 | default: 133 | driver: bridge 134 | -------------------------------------------------------------------------------- /traefik/service.yml: -------------------------------------------------------------------------------- 1 | http: 2 | routers: 3 | 4 | service-rtr: 5 | rule: "Host(`service.mydomain.tld`)" 6 | service: my-service 7 | entryPoints: 8 | - websecure 9 | middlewares: 10 | - sso@docker 11 | - basic@docker 12 | tls: 13 | certResolver: cfdns 14 | 15 | services: 16 | my-service: 17 | loadBalancer: 18 | passHostHeader: true 19 | servers: 20 | - url: http://192.168.1.45:8080 21 | -------------------------------------------------------------------------------- /watchtower/.env.example: -------------------------------------------------------------------------------- 1 | TZ=Europe/London 2 | GOTIFY_DOMAIN=https://gotify.example.tld 3 | GOTIFY_TOKEN=sososososecret -------------------------------------------------------------------------------- /watchtower/ReadMe.md: -------------------------------------------------------------------------------- 1 | # Watchtower 2 | 3 | Watchtower will ensure all the containers running (and are visible over the local docker socket) are updated. 4 | 5 | This uses the default check interval of 5mins. 6 | 7 | **You should be using this with the [Gotify](/gotify/ReadMe.md) service!** 8 | 9 | ## ENV file 10 | 11 | To run this, you must create a `.env` file in this directory. Below are the required fields: 12 | 13 | - TZ - Your Timezone 14 | - GOTIFY_DOMAIN - The url (including schema (e.g. `https://`)) of your Gotify instance 15 | - GOTIFY_TOKEN - The application token of a created Gotify application 16 | -------------------------------------------------------------------------------- /watchtower/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.7" 2 | 3 | services: 4 | 5 | watchtower: 6 | container_name: watchtower 7 | image: containrrr/watchtower 8 | restart: unless-stopped 9 | environment: 10 | - TZ=${TZ} 11 | - WATCHTOWER_CLEANUP=true 12 | - WATCHTOWER_NOTIFICATIONS=gotify 13 | - WATCHTOWER_NOTIFICATION_GOTIFY_URL=${GOTIFY_DOMAIN} 14 | - WATCHTOWER_NOTIFICATION_GOTIFY_TOKEN=${GOTIFY_TOKEN} 15 | volumes: 16 | - /var/run/docker.sock:/var/run/docker.sock 17 | --------------------------------------------------------------------------------