From 11d0cad9fbf0edb1fa219c28af688f778e6c6523 Mon Sep 17 00:00:00 2001 From: Salt Date: Sun, 1 Nov 2020 04:55:05 -0600 Subject: [PATCH] Add Nextcloud AND BOY DOES IT SMELL --- inventory/group_vars/all.yml | 13 +- roles/common/tasks/packages.yml | 1 + roles/nextcloud/.gitignore | 2 + roles/nextcloud/.travis.yml | 35 + roles/nextcloud/.yamllint | 56 ++ roles/nextcloud/LICENSE | 674 ++++++++++++++++++ roles/nextcloud/README.md | 96 +++ roles/nextcloud/defaults/main.yml | 174 +++++ roles/nextcloud/filter_plugins/opml.py | 46 ++ roles/nextcloud/handlers/main.yml | 47 ++ roles/nextcloud/meta/.galaxy_install_info | 2 + roles/nextcloud/meta/main.yml | 25 + .../nextcloud/molecule/default/Dockerfile.j2 | 14 + roles/nextcloud/molecule/default/INSTALL.rst | 16 + roles/nextcloud/molecule/default/molecule.yml | 20 + roles/nextcloud/molecule/default/playbook.yml | 73 ++ roles/nextcloud/molecule/default/prepare.yml | 69 ++ .../molecule/default/requirements.yml | 8 + .../molecule/default/tests/test_default.py | 14 + roles/nextcloud/tasks/apps/news.yml | 252 +++++++ roles/nextcloud/tasks/core/apps.yml | 149 ++++ roles/nextcloud/tasks/core/config.yml | 55 ++ roles/nextcloud/tasks/core/install.yml | 80 +++ roles/nextcloud/tasks/core/integrity.yml | 97 +++ roles/nextcloud/tasks/core/occ.yml | 43 ++ roles/nextcloud/tasks/core/upgrade.yml | 54 ++ roles/nextcloud/tasks/main.yml | 4 + roles/nextcloud/tasks/nextcloud.yml | 26 + roles/nextcloud/tasks/users/group.yml | 47 ++ roles/nextcloud/tasks/users/user.yml | 51 ++ roles/nextcloud/tasks/users/user_config.yml | 76 ++ roles/nextcloud/tasks/variables.yml | 27 + roles/nextcloud/vars/main.yml | 30 + roles/requirements.yml | 4 + site.yml | 32 + 35 files changed, 2410 insertions(+), 2 deletions(-) create mode 100644 roles/nextcloud/.gitignore create mode 100644 roles/nextcloud/.travis.yml create mode 100644 roles/nextcloud/.yamllint create mode 100644 roles/nextcloud/LICENSE create mode 100644 roles/nextcloud/README.md create mode 100644 roles/nextcloud/defaults/main.yml create mode 100644 roles/nextcloud/filter_plugins/opml.py create mode 100644 roles/nextcloud/handlers/main.yml create mode 100644 roles/nextcloud/meta/.galaxy_install_info create mode 100644 roles/nextcloud/meta/main.yml create mode 100644 roles/nextcloud/molecule/default/Dockerfile.j2 create mode 100644 roles/nextcloud/molecule/default/INSTALL.rst create mode 100644 roles/nextcloud/molecule/default/molecule.yml create mode 100644 roles/nextcloud/molecule/default/playbook.yml create mode 100644 roles/nextcloud/molecule/default/prepare.yml create mode 100644 roles/nextcloud/molecule/default/requirements.yml create mode 100644 roles/nextcloud/molecule/default/tests/test_default.py create mode 100644 roles/nextcloud/tasks/apps/news.yml create mode 100644 roles/nextcloud/tasks/core/apps.yml create mode 100644 roles/nextcloud/tasks/core/config.yml create mode 100644 roles/nextcloud/tasks/core/install.yml create mode 100644 roles/nextcloud/tasks/core/integrity.yml create mode 100644 roles/nextcloud/tasks/core/occ.yml create mode 100644 roles/nextcloud/tasks/core/upgrade.yml create mode 100644 roles/nextcloud/tasks/main.yml create mode 100644 roles/nextcloud/tasks/nextcloud.yml create mode 100644 roles/nextcloud/tasks/users/group.yml create mode 100644 roles/nextcloud/tasks/users/user.yml create mode 100644 roles/nextcloud/tasks/users/user_config.yml create mode 100644 roles/nextcloud/tasks/variables.yml create mode 100644 roles/nextcloud/vars/main.yml diff --git a/inventory/group_vars/all.yml b/inventory/group_vars/all.yml index d7d17a4..35b59e3 100644 --- a/inventory/group_vars/all.yml +++ b/inventory/group_vars/all.yml @@ -11,8 +11,7 @@ apache_ssl_cipher_suite: AES256+EECDH:AES256+EDH apache_ssl_protocol: all -SSLv2 -SSLv3 -TLSv1 -TLSv1.1 # For geerlingguy.php -## There is no circumstance in which I need PHP but DON'T need mod_php -php_packages_extra: [ libapache2-mod-php ] +##RESERVED # For gitea secret_gitea_db_pass: !vault | @@ -44,3 +43,13 @@ gitea_internal_token: !vault | 61626133316161616335323630333461663163613430353438633235336331343934386464373866 62633234313261363537663061373931303832653531356566633739636264666635653936313965 623964653936646334313864643030653763 + +# For Nextcloud +secret_nextcloud_db_pass: !vault | + $ANSIBLE_VAULT;1.1;AES256 + 31626162623164373133356634323436373634616363663966313039313431643837326630346632 + 3066303432303064663838643533373933343166356437610a613134383566653035663462393538 + 37616538366337313265333333373432363031323336306436643839333337313735633463326133 + 6538383936643664370a663737333861303132313031373234396562653464653838343836663530 + 38396663633237383764613139346333636432613464356465663661653265323135363032633963 + 3335626335353431616365313232346431313439653132303833 diff --git a/roles/common/tasks/packages.yml b/roles/common/tasks/packages.yml index 5da20c6..c63e952 100644 --- a/roles/common/tasks/packages.yml +++ b/roles/common/tasks/packages.yml @@ -16,6 +16,7 @@ - net-tools - openssh-server - pwgen + - python-is-python3 # God damn you Nextcloud role - python3-apt - python3-boto - python3-boto3 diff --git a/roles/nextcloud/.gitignore b/roles/nextcloud/.gitignore new file mode 100644 index 0000000..58af8a2 --- /dev/null +++ b/roles/nextcloud/.gitignore @@ -0,0 +1,2 @@ +__pycache__ +*.py[cod] diff --git a/roles/nextcloud/.travis.yml b/roles/nextcloud/.travis.yml new file mode 100644 index 0000000..8fd1b4b --- /dev/null +++ b/roles/nextcloud/.travis.yml @@ -0,0 +1,35 @@ +--- +language: python +python: "2.7" + +sudo: false + +addons: + apt: + packages: + - python-pip + +env: + global: + ROLE_NAME: nextcloud + +install: + - pip install molecule docker + + - ansible --version + + - pwd + + # Create ansible.cfg with correct roles_path + - printf '[defaults]\nroles_path=../' > ansible.cfg + +before_script: + - cd ../ + - mv ansible-role-$ROLE_NAME nkakouros-original.$ROLE_NAME + - cd nkakouros-original.$ROLE_NAME + +script: + - molecule test + +notifications: + webhooks: https://galaxy.ansible.com/api/v1/notifications/ diff --git a/roles/nextcloud/.yamllint b/roles/nextcloud/.yamllint new file mode 100644 index 0000000..34d1b66 --- /dev/null +++ b/roles/nextcloud/.yamllint @@ -0,0 +1,56 @@ +--- + +rules: + braces: + min-spaces-inside: 1 + max-spaces-inside: 1 + min-spaces-inside-empty: 0 + max-spaces-inside-empty: 0 + brackets: + min-spaces-inside: 0 + max-spaces-inside: 0 + min-spaces-inside-empty: -1 + max-spaces-inside-empty: -1 + colons: + max-spaces-before: 0 + max-spaces-after: 1 + commas: + max-spaces-before: 0 + min-spaces-after: 1 + max-spaces-after: 1 + comments: + require-starting-space: true + min-spaces-from-content: 2 + comments-indentation: enable + document-end: disable + document-start: + present: true + empty-lines: + max: 2 + max-start: 0 + max-end: 0 + empty-values: + forbid-in-block-mappings: true + forbid-in-flow-mappings: true + hyphens: + max-spaces-after: 1 + indentation: + spaces: 2 + indent-sequences: true + check-multi-line-strings: false + key-duplicates: enable + key-ordering: disable + line-length: + max: 80 + allow-non-breakable-words: true + allow-non-breakable-inline-mappings: false + new-line-at-end-of-file: enable + new-lines: + type: unix + octal-values: + forbid-implicit-octal: true + forbid-explicit-octal: false + trailing-spaces: enable + truthy: + level: warning + diff --git a/roles/nextcloud/LICENSE b/roles/nextcloud/LICENSE new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/roles/nextcloud/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/roles/nextcloud/README.md b/roles/nextcloud/README.md new file mode 100644 index 0000000..da15288 --- /dev/null +++ b/roles/nextcloud/README.md @@ -0,0 +1,96 @@ +[![Build Status](https://travis-ci.com/nkakouros-original/ansible-role-nextcloud.svg?branch=master)](https://travis-ci.com/nkakouros-original/ansible-role-nextcloud) +[![Galaxy](https://img.shields.io/badge/galaxy-nkakouros.nextcloud-blue.svg)](https://galaxy.ansible.com/nkakouros/nextcloud/) + +# Ansible Role: Nextcloud + +Installs and upgrades Nextcloud and apps. **It only does that**, it does not +install a web server, a db server, etc. + +## Features + +This role allows you to: +- install, update and configure Nextcloud core +- install, update and configure Nextcloud apps available on the app store +- create and update users and groups + +## Requirements + +Ansible >= 2.7 + +While there are a bunch of other roles around to install Nextcloud, I did not +found them useful as they try to do everything in one role, ie setup Apache, +then MySQL, then install Nextcloud, etc. This might be useful for users who want +to have a Nextcloud instance running as fast as possible. However, I find the +approach too limiting as there are too many assumptions taking place. + +This role does not care where you install Nextcloud. It only downloads, installs +and configures Nextcloud itself. Its aim is to be used in a modular way +alongside other roles. (Or at least it tries to make no assumptions. If you find +any or cannot install nextcloud due to missing functionality, please open an +issue or a PR. Currently it has been tested only on Ubuntu 16.04). + +See the [Example playbook](#example-playbook) on how a complete playbook that +uses 3rd-party roles might look like. + +The python `listparser` module should be installed if you want to import feeds +into the `News` app from an opml file. E.g.: + +``` +pip install listaprser +``` + + +## Versions + +- _Supported Nextcloud versions_: Each release of the role will support all + officially supported Nextcloud versions, starting from version 14. That is, + versions older than Nextcloud 14 will not be supported ever by this role (for + instance Nextcloud 13, although it is supported officially as of this + writing). Also, with each new major version of Nextcloud, the version that + this role installs by default will be updated to match that latest major + release. + +- _Supported Ansible versions_: I am using an installation of Ansible that is + daily checked out from their [development + branch](https://github.com/ansible/ansible/tree/devel/). With each new Ansible + stable version (currently 2.7), a new release of this role will be created + that will be compatible with that new Ansible version. Work following such + a release will take place with the in-development next version of Ansible and + might use new Ansible features. + +For this above reasons, role releases will have names such as `v14-2.7-1.0`, +where: + +- `14` is the version of Nextcloud that this role will install by default +- `2.7` is the Ansible version that the release will be compatible with +- `1.0` is semantic versioning of the role itself (reset when either of the two + components above gets updated) + +The above release will of course also be compatible with later Ansible versions +that are compatible with Ansible 2.7. + +Role Variables +-------------- + +See +[defaults/main.yml](https://github.com/nkakouros-original/ansible-role-nextcloud/blob/master/defaults/main.yml) +for a full list of variables together with documentation on how to use them to +configure this role. + +Example Playbook +---------------- + +See [molecule/default/prepare.yml](molecule/default/prepare.yml) and +[molecule/default/playbook.yml](molecule/default/playbook.yml) for a working +example of how to use this role in conjuction with other roles to get a complete +server environment that runs Nextcloud. + +License +------- + +GPLv3 + +Author Information +------------------ + +Nikolaos Kakouros diff --git a/roles/nextcloud/defaults/main.yml b/roles/nextcloud/defaults/main.yml new file mode 100644 index 0000000..dfd04e3 --- /dev/null +++ b/roles/nextcloud/defaults/main.yml @@ -0,0 +1,174 @@ +--- + +nextcloud_enable: true +# Set this to 'no' to completely disable the role + +# Installation {{{ +nextcloud_version: 17 +# The major nextcloud version to install. You can use this to upgrade to a new +# major version as well. Even if you set 'nextcloud_download_url' manually (see +# next option), 'nextcloud_version' should be set as it is also used to +# correctly install the apps. + +nextcloud_download_url: >- + {%- if nextcloud_version > 0 -%} + https://download.nextcloud.com/server/releases/latest-{{ + nextcloud_version }}.zip + {%- else -%} + https://download.nextcloud.com/server/releases/latest.zip + {%- endif -%} +# The url to download nextcloud from. Currently only the latest stable version +# is supported by the role. + +nextcloud_installation_dir: '/var/www/html/nextcloud/' +# Where to extract nextcloud files. This is the directory where the web server +# will load nextcloud from. + +nextcloud_data_dir: "{{ nextcloud_installation_dir }}/data" +# Path to nextcloud user data directory. + +nextcloud_file_owner: 'www-data' +# The user that will own nextcloud files. + +nextcloud_database: + backend: mysql + # The database server that will be used. It should be already installed and + # the database should already exist. For 'mariadb', set this to 'mysql'. + + name: nextcloud + # The name of the database nextcloud will use. It should already exist on the + # system. + + user: nextcloud + # The database user that nextcloud will use to access the database. The user + # should already exist in the database backend (together with their password). + + pass: '' + # The database user's password. This variable should not be empty. + + host: localhost + # The database host + + port: 3306 + # The port the db server listens on + + prefix: oc_ + # Prefix for the nextcloud tables in the database. +# }}} +# Core configuration {{{ +# TODO make this part of nextcloud_config_system +nextcloud_enable_pretty_urls: true +# Set to yes to enable urls of the form https://example.org/calendar replacing +# https://example.org/nextcloud/index.php/s/Sv1b7krAUqmF8QQ. + +# TODO make this part of nextcloud_config_system +nextcloud_urls: + - https://localhost:80/folder +# This is a list of urls where your nextcloud installation should be accessible. +# You would normally need only one. If you specify more than one, the first one +# will be as the "main" one, for pretty urls, etc. +# }}} +# occ {{{ +nextcloud_occ_make_executable: true +# Whether to make the occ tool executable (to avoid using `php occ ...` and use +# `occ ...` directly). + +nextcloud_occ_system_command: true +# Whether to create a /usr/bin/occ executable script that will allow all users +# of the system to run `occ` (with completion if `nextcloud_occ_completions` is +# enabled). The script calls sudo to run `occ` as the nextcloud user. + +nextcloud_occ_completions: true +# Whether to enable bash completion for the occ tool +# }}} +# Users {{{ +nextcloud_admin_user: admin +# The name of the admin user + +nextcloud_admin_pass: '' +# The password of the admin user. This variable should not be empty. + +nextcloud_users: [] +# The ansible users to create, other than the admin. +# It is a list of hashes. Eg +# +# nextcloud_users: +# - name: alice +# pass: superstrongnot +# resetpassword: yes # reset the passsword every time the playbook is run +# display_name: Alice B. Charlie +# settings: +# - firstrunwizard: +# show: 0 +# - calendar: +# showWeekNr: 'yes' +# app_config: +# ... +# +# App and core configuration happens per user. To find out what config options +# are available, either make the changes manually and then the oc_preferences +# table in your nextcloud database or use the `occ config:list` command on your +# server to get a listing of the current configuration options. +# }}} +# Apps {{{ +nextcloud_remove_unknown_apps: false +# Setting to choose whether to remove or keep external apps which have not been +# installed through this role, but manually or via the Nextcloud admin interface + +nextcloud_apps: [] +# Nextcloud apps to be installed, removed, enabled or disabled +# It is a list of hashes. Eg +# +# nextcloud_apps: +# - name: calendar +# state: enabled +# +# The action can be defined using the app's state, the following states are +# supported: +# - present: The app will be installed, the enabled status will not be changed +# - absent: The app will be removed. Only available for external apps. +# - enabled: The app will be installed if not available yet, and will be +# enabled +# - disabled: The app will be installed if not available yet, and will be +# disabled +# +# Installation and removal is only supported for external apps, apps shipped +# with Nextcloud can only be enabled or disabled. By default, only apps with +# the explicit state `absent` are removed, to remove all apps missing from the +# list, set `nextcloud_remove_unknown_apps: true`. +# Currently, always the latest version available from the App Store is +# installed. + +nextcloud_config: {} +# A yaml array with settings of nextcloud apps. +# +# Nextcloud organizes its configuration in two categories: +# - system: this category contains all basic configuration parameters for the +# framework to operate. Its keys are stored in the `config.php` file +# of the instance installation's `config` directory. +# - apps: this category contains settings for the individual apps as well as +# for some core components of the framework (in `core`). These settings +# are stored in the database directly and require a correctly +# configured system to be accessed. +# +# For instance: +# ``` +# nextcloud_config: +# apps: +# core: +# backgroundjobs_mode: cron +# system: +# overwrite: +# cli: +# url: "{{ nextcloud_urls[0] | regex_replace(':[0-9]{2,5}', '') }}" +# trusted_domains: +# "{{ nextcloud_urls | map('urlsplit', 'hostname') | list }}" +# htaccess: +# RewriteBase: >- +# /{{ nextcloud_urls[0] +# | regex_replace('/$', '') +# | urlsplit('path') +# | regex_replace('^/') +# }} +# ``` +# }}} diff --git a/roles/nextcloud/filter_plugins/opml.py b/roles/nextcloud/filter_plugins/opml.py new file mode 100644 index 0000000..07360a8 --- /dev/null +++ b/roles/nextcloud/filter_plugins/opml.py @@ -0,0 +1,46 @@ +#!/usr/bin/env python + +import collections + +from ansible import errors + + +def read_opml(path): + try: + import listparser + except Exception: + raise errors.AnsibleFilterError( + 'the "opml" filter requires the "listparser" python module,' + + "install with `pip install listparser`" + ) + + try: + result = listparser.parse(path) + except Exception as e: + raise errors.AnsibleFilterError( + 'error while parsing opml file: "%s"' % str(e) + ) + + feeds = result["feeds"] + for index, feed in enumerate(feeds): + feeds[index]["folder"] = [ + item for sublist in feed.pop("categories") for item in sublist + ] + return feeds + + +# Taken from https://stackoverflow.com/questions/6027558/ +def dict_flatten(d, parent_key="", sep="_"): + items = [] + for k, v in d.items(): + new_key = parent_key + sep + k if parent_key else k + if isinstance(v, collections.MutableMapping): + items.extend(dict_flatten(v, new_key, sep=sep).items()) + else: + items.append((new_key, v)) + return dict(items) + + +class FilterModule(object): + def filters(self): + return {"opml": read_opml, "dict_flatten": dict_flatten} diff --git a/roles/nextcloud/handlers/main.yml b/roles/nextcloud/handlers/main.yml new file mode 100644 index 0000000..4fdb045 --- /dev/null +++ b/roles/nextcloud/handlers/main.yml @@ -0,0 +1,47 @@ +--- + +- name: Update .htaccess + block: + - name: Make .htaccess writable + file: + path: "{{ nextcloud_installation_dir }}/.htaccess" + mode: g+w + listen: nextcloud update htaccess + - name: Update .htaccess file + command: php occ maintenance:update:htaccess --no-interaction + args: + chdir: "{{ nextcloud_installation_dir }}" + listen: nextcloud update htaccess + become: true + become_user: "{{ nextcloud_file_owner }}" + - name: Make .htaccess unwritable again + file: + path: "{{ nextcloud_installation_dir }}/.htaccess" + mode: g-w + listen: nextcloud update htaccess + +- name: Set file permissions on Nextcloud files + block: + - name: Set Nextcloud file permissions + file: + path: "{{ nextcloud_installation_dir }}" + mode: u=rwX,g=rX,o-rwx + owner: "{{ nextcloud_file_owner }}" + group: "{{ nextcloud_file_owner }}" + recurse: true + listen: nextcloud set file permissions + - name: Set permissions on installation directory + file: + path: "{{ nextcloud_installation_dir }}" + owner: root + group: "{{ nextcloud_file_owner }}" + mode: 0o750 + state: directory + listen: nextcloud set file permissions + - name: Set permissions on htaccess file + file: + path: "{{ nextcloud_installation_dir }}/.htaccess" + owner: root + group: "{{ nextcloud_file_owner }}" + mode: 0o644 + listen: nextcloud set file permissions diff --git a/roles/nextcloud/meta/.galaxy_install_info b/roles/nextcloud/meta/.galaxy_install_info new file mode 100644 index 0000000..35f337e --- /dev/null +++ b/roles/nextcloud/meta/.galaxy_install_info @@ -0,0 +1,2 @@ +install_date: Sun Nov 1 09:50:37 2020 +version: master diff --git a/roles/nextcloud/meta/main.yml b/roles/nextcloud/meta/main.yml new file mode 100644 index 0000000..842f666 --- /dev/null +++ b/roles/nextcloud/meta/main.yml @@ -0,0 +1,25 @@ +--- + +galaxy_info: + role_name: nextcloud + author: Nikolaos Kakouros + description: + Featureful, unbloated Nextcloud Server role without php/DB/webserver/etc + provisions + # company: your company (optional) + license: GPLv3 + min_ansible_version: 2.7 + github_branch: master + platforms: + - name: Ubuntu + versions: + - xenial + galaxy_tags: + - nextcloud + - web + - cloud + - rss + - calendar + - tasks + +dependencies: [] diff --git a/roles/nextcloud/molecule/default/Dockerfile.j2 b/roles/nextcloud/molecule/default/Dockerfile.j2 new file mode 100644 index 0000000..0a60553 --- /dev/null +++ b/roles/nextcloud/molecule/default/Dockerfile.j2 @@ -0,0 +1,14 @@ +# Molecule managed + +{% if item.registry is defined %} +FROM {{ item.registry.url }}/{{ item.image }} +{% else %} +FROM {{ item.image }} +{% endif %} + +RUN if [ $(command -v apt-get) ]; then apt-get update && apt-get install -y python sudo bash ca-certificates && apt-get clean; \ + elif [ $(command -v dnf) ]; then dnf makecache && dnf --assumeyes install python sudo python-devel python2-dnf bash && dnf clean all; \ + elif [ $(command -v yum) ]; then yum makecache fast && yum install -y python sudo yum-plugin-ovl bash && sed -i 's/plugins=0/plugins=1/g' /etc/yum.conf && yum clean all; \ + elif [ $(command -v zypper) ]; then zypper refresh && zypper install -y python sudo bash python-xml && zypper clean -a; \ + elif [ $(command -v apk) ]; then apk update && apk add --no-cache python sudo bash ca-certificates; \ + elif [ $(command -v xbps-install) ]; then xbps-install -Syu && xbps-install -y python sudo bash ca-certificates && xbps-remove -O; fi diff --git a/roles/nextcloud/molecule/default/INSTALL.rst b/roles/nextcloud/molecule/default/INSTALL.rst new file mode 100644 index 0000000..b42edf5 --- /dev/null +++ b/roles/nextcloud/molecule/default/INSTALL.rst @@ -0,0 +1,16 @@ +******* +Docker driver installation guide +******* + +Requirements +============ + +* General molecule dependencies (see https://molecule.readthedocs.io/en/latest/installation.html) +* Docker Engine +* docker-py +* docker + +Install +======= + + $ sudo pip install docker-py diff --git a/roles/nextcloud/molecule/default/molecule.yml b/roles/nextcloud/molecule/default/molecule.yml new file mode 100644 index 0000000..4a998a8 --- /dev/null +++ b/roles/nextcloud/molecule/default/molecule.yml @@ -0,0 +1,20 @@ +--- +dependency: + name: galaxy +driver: + name: docker +lint: + name: yamllint +platforms: + - name: ubuntu-1604 + image: ubuntu:16.04 +provisioner: + name: ansible + lint: + name: ansible-lint +scenario: + name: default +verifier: + name: testinfra + lint: + name: flake8 diff --git a/roles/nextcloud/molecule/default/playbook.yml b/roles/nextcloud/molecule/default/playbook.yml new file mode 100644 index 0000000..9c380a0 --- /dev/null +++ b/roles/nextcloud/molecule/default/playbook.yml @@ -0,0 +1,73 @@ +--- + +- name: Converge + hosts: all + become: true + vars: + mysql_databases: + - name: nextcloud + mysql_users: + - name: nextcloud + password: password + priv: "nextcloud.*:ALL" + apache_vhosts: + - servername: localhost + documentroot: /var/www/html/nextcloud + extra_parameters: | + SetEnv HOME /var/www/html/nextcloud + SetEnv HTTP_HOME /var/www/html/nextcloud + nextcloud_database: + name: "{{ mysql_databases[0].name }}" + user: "{{ mysql_users[0].name }}" + pass: "{{ mysql_users[0].password }}" + nextcloud_admin_user: admin + nextcloud_admin_pass: password + nextcloud_urls_tmp: >- + {{ apache_vhosts + | map(attribute='servername') + | list + | zip_longest([], fillvalue=':80') + | map('join') + | list }} + nextcloud_urls: >- + {{ [] + | zip_longest(nextcloud_urls_tmp, fillvalue='http://') + | map('join') + | list }} + nextcloud_apps: + - name: calendar + - name: tasks + - name: news + nextcloud_config: + apps: + core: + backgroundjobs_mode: cron + nextcloud_users: + - name: demo + pass: 'tE(DVOsdo24)$@#f9S' + groups: + - admin + resetpassword: false + display_name: Nikolaos Kakouros + settings: + - firstrunwizard: + show: 0 + - calendar: + showWeekNr: true + pre_tasks: + - name: Gather facts + setup: ~ + become: false + tasks: + - include_role: + name: nkakouros-original.nextcloud + post_tasks: + - name: Check Nextcloud responds ok + uri: + url: http://localhost + return_content: true + register: _result + - name: Check Nextcloud return login form + assert: + that: + - _result.content is search('a safe home for all your data') diff --git a/roles/nextcloud/molecule/default/prepare.yml b/roles/nextcloud/molecule/default/prepare.yml new file mode 100644 index 0000000..b4780b4 --- /dev/null +++ b/roles/nextcloud/molecule/default/prepare.yml @@ -0,0 +1,69 @@ +--- + +- name: Prepare + hosts: all + become: true + vars: + mysql_root_password_update: false + mysql_databases: + - name: nextcloud + mysql_users: + - name: nextcloud + password: password + priv: "nextcloud.*:ALL" + mysql_packages: + - mariadb-client + - mariadb-server + - python-mysqldb + php_default_version_debian: '7.3' + php_packages_extra: + - "libapache2-mod-php{{ php_default_version_debian }}" + - "php{{ php_default_version_debian }}-zip" + - "php{{ php_default_version_debian }}-mysql" + - "php{{ php_default_version_debian }}-bz2" + - "php{{ php_default_version_debian }}-intl" + - "php{{ php_default_version_debian }}-gmp" + - "php{{ php_default_version_debian }}-apcu" + - "php{{ php_default_version_debian }}-imagick" + - "php{{ php_default_version_debian }}-dom" + - "php{{ php_default_version_debian }}-gd" + - "php{{ php_default_version_debian }}-curl" + - "php{{ php_default_version_debian }}-mbstring" + - php-mcrypt + apache_remove_default_vhost: true + apache_vhosts: + - servername: cloud.kakouros.net + documentroot: /var/www/html/nextcloud + extra_parameters: | + SetEnv HOME /var/www/html/nextcloud + SetEnv HTTP_HOME /var/www/html/nextcloud + apache_mods_enabled: + - rewrite.load + - "php{{ php_default_version_debian }}.load" + - headers.load + - env.load + - dir.load + - mime.load + apache_state: restarted + manala_cron_files: + - file: nextcloud + user: www-data + jobs: + - name: Run nextcloud cron + job: "php-cli -f {{ apache_vhosts.0.documentroot }}/cron.php" + minute: "*/1" + pre_tasks: + - name: Gather facts + setup: null + become: false + tasks: + - include_role: + name: iambryancs.ppa-ondrej + - include_role: + name: geerlingguy.php + - include_role: + name: geerlingguy.apache + - include_role: + name: geerlingguy.mysql + - include_role: + name: manala.cron diff --git a/roles/nextcloud/molecule/default/requirements.yml b/roles/nextcloud/molecule/default/requirements.yml new file mode 100644 index 0000000..6d66e64 --- /dev/null +++ b/roles/nextcloud/molecule/default/requirements.yml @@ -0,0 +1,8 @@ +--- + +- src: iambryancs.ppa-ondrej +- src: geerlingguy.php +- src: geerlingguy.mysql +- src: geerlingguy.apache +- src: geerlingguy.firewall +- src: manala.cron diff --git a/roles/nextcloud/molecule/default/tests/test_default.py b/roles/nextcloud/molecule/default/tests/test_default.py new file mode 100644 index 0000000..eedd64a --- /dev/null +++ b/roles/nextcloud/molecule/default/tests/test_default.py @@ -0,0 +1,14 @@ +import os + +import testinfra.utils.ansible_runner + +testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner( + os.environ['MOLECULE_INVENTORY_FILE']).get_hosts('all') + + +def test_hosts_file(host): + f = host.file('/etc/hosts') + + assert f.exists + assert f.user == 'root' + assert f.group == 'root' diff --git a/roles/nextcloud/tasks/apps/news.yml b/roles/nextcloud/tasks/apps/news.yml new file mode 100644 index 0000000..30d6e49 --- /dev/null +++ b/roles/nextcloud/tasks/apps/news.yml @@ -0,0 +1,252 @@ +--- + +- name: Create api url + set_fact: + _nextcloud_api_url_news: "{{ nextcloud_urls[0] }}/apps/news/api/v1-2" + when: nextcloud_enable_pretty_urls + +- name: Create api url + set_fact: + # TODO find the url without pretty urls + _nextcloud_api_url_news: "{{ _nextcloud_api_url_news }}" + when: not nextcloud_enable_pretty_urls + +- name: Find users that have News enabled + set_fact: + _nextcloud_news_users: >- + {{ + nextcloud_users + | selectattr('app_config.news', 'defined') + | list + }} + +- name: Merge feeds from opml files + set_fact: + _nextcloud_news_users: >- + [ + {%- for user in _nextcloud_news_users -%} + {%- if 'opml_file' in user.app_config.news -%} + {%- set ns = namespace(result=[]) -%} + {%- for opml_feed in + user['app_config']['news']['opml_file'] + | opml + -%} + {%- set feed = + user.app_config.news.feeds + | selectattr('url', 'equalto', opml_feed.url) + | list + -%} + {%- if feed | length == 0 -%} + {%- set ns.result = ns.result | union([opml_feed]) -%} + {%- endif -%} + {%- endfor -%} + {{ + user + | combine({ + "app_config": { + "news": { + "feeds": + ns.result + | union(user.app_config.news.feeds) + } + } + } + ) + }}, + {%- else -%} + {{ user }}, + {%- endif -%} + {%- endfor -%} + ] + + +- name: Read existing folders + uri: + method: GET + url: "{{ _nextcloud_api_url_news }}/folders" + headers: + Authorization: Basic {{ (item.name + ':' + item.pass) | b64encode }} + register: _nextcloud_existing_folders + loop: "{{ _nextcloud_news_users }}" + delegate_to: localhost + +- name: Read existing feeds + uri: + method: GET + url: "{{ _nextcloud_api_url_news }}/feeds" + headers: + Authorization: Basic {{ (item.name + ':' + item.pass) | b64encode }} + register: _nextcloud_existing_feeds + loop: "{{ _nextcloud_news_users }}" + delegate_to: localhost + +- name: Create feed folders + uri: + method: POST + url: "{{ _nextcloud_api_url_news }}/folders" + body_format: json + body: + name: "{{ item.1 }}" + headers: + Authorization: Basic {{ (item.0.name + ':' + item.0.pass) | b64encode }} + when: >- + _nextcloud_existing_folders.results[ + ( + _nextcloud_news_users + | map(attribute='name') + | flatten + ).index(item.0.name) + ]['json']['folders'] + | selectattr('name', 'equalto', item.1) + | list + | length == 0 + register: result + changed_when: result is success + loop: >- + {{ + _nextcloud_news_users + | zip( + _nextcloud_news_users + | subelements('app_config.news.feeds') + | map('last') + | flatten + | selectattr('folder', 'defined') + | selectattr('folder', 'ne', []) + | map(attribute='folder') + | flatten + | unique + ) + | list + }} + delegate_to: localhost + +- name: Read folders again + uri: + method: GET + url: "{{ _nextcloud_api_url_news }}/folders" + headers: + Authorization: Basic {{ (item.name + ':' + item.pass) | b64encode }} + when: result is changed + register: _nextcloud_existing_folders_again + changed_when: _nextcloud_existing_folders_again is success + loop: "{{ _nextcloud_news_users }}" + delegate_to: localhost + +- name: Update folders variable + set_fact: + _nextcloud_existing_folders: "{{ _nextcloud_existing_folders_again }}" + when: _nextcloud_existing_folders_again is changed + +- name: Create feeds + uri: + method: POST + url: "{{ _nextcloud_api_url_news }}/feeds" + body_format: json + body: + url: "{{ item.1.url }}" + folderId: >- + {{ + ( + _nextcloud_existing_folders.results[ + ( + _nextcloud_news_users + | map(attribute='name') + | flatten + ).index(item.0.name) + ]['json']['folders'] + | selectattr( + 'name', + 'equalto', + item.1.folder + | default([]) + | first + | default('') + ) + | list + | last + | default('__undefined__') + )['id'] + | default(omit) + }} + headers: + Authorization: Basic {{ (item.0.name + ':' + item.0.pass) | b64encode }} + when: >- + _nextcloud_existing_feeds.results[ + ( + _nextcloud_news_users + | map(attribute='name') + | flatten + ).index(item.0.name) + ]['json']['feeds'] + | selectattr('url', 'equalto', item.1.url) + | list + | length == 0 + register: result + changed_when: result is success + loop: "{{ _nextcloud_news_users | subelements('app_config.news.feeds') }}" + delegate_to: localhost + +# TODO this is a v2 api endpoint. I need to break it into `rename` and +# move-to-folder api calls for v1-2 +# - name: Update feeds +# uri: +# method: PATCH +# url: >- +# {{ _nextcloud_api_url_news }}/feeds/{{ +# ( +# _nextcloud_existing_feeds.results[ +# ( +# _nextcloud_news_users +# | map(attribute='name') +# | flatten +# ).index(item.0.name) +# ]['json']['feeds'] +# | selectattr('url', 'equalto', item.1.url) +# | list +# | last +# )['id'] +# }} +# body_format: json +# body: +# url: "{{ item.1.url }}" +# folderId: >- +# {{ +# ( +# _nextcloud_existing_folders.results[ +# ( +# _nextcloud_news_users +# | map(attribute='name') +# | flatten +# ).index(item.0.name) +# ]['json']['folders'] +# | selectattr( +# 'name', +# 'equalto', +# item.1.folder +# | default([]) +# | first +# | default('') +# ) +# | list +# | last +# | default('__undefined__') +# )['id'] +# | default(omit) +# }} +# headers: +# Authorization: Basic {{ (item.0.name + ':' + item.0.pass) | b64encode }} +# when: >- +# _nextcloud_existing_feeds.results[ +# ( +# _nextcloud_news_users +# | map(attribute='name') +# | flatten +# ).index(item.0.name) +# ]['json']['feeds'] +# | selectattr('url', 'equalto', item.1.url) +# | list +# | length > 0 +# register: result +# changed_when: result is success +# loop: "{{ _nextcloud_news_users | subelements('app_config.news.feeds') }}" +# delegate_to: localhost diff --git a/roles/nextcloud/tasks/core/apps.yml b/roles/nextcloud/tasks/core/apps.yml new file mode 100644 index 0000000..c8cfeb0 --- /dev/null +++ b/roles/nextcloud/tasks/core/apps.yml @@ -0,0 +1,149 @@ +--- + +- name: Read apps shipped with Nextcloud + command: php occ app:list --shipped=true --no-warnings --output=json + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + register: _result + changed_when: false + +- name: Parse occ command response as JSON + set_fact: + nextcloud_shipped_apps: "{{ _result.stdout | from_json }}" + +- name: Read external apps installed by the user + command: php occ app:list --shipped=false --no-warnings --output=json + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + register: _result + changed_when: false + +- name: Parse occ command response as JSON + set_fact: + nextcloud_installed_apps: "{{ _result.stdout | from_json }}" + +- name: Remove unknown external apps + command: php occ app:remove "{{ item.key }}" + loop: >- + {{ + nextcloud_installed_apps.enabled + | combine(nextcloud_installed_apps.disabled) + | dict2items + }} + become: true + become_user: "{{ nextcloud_file_owner }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + register: result + failed_when: result.stdout is not search('removed') or result is failed + changed_when: result is not failed + when: + - nextcloud_remove_unknown_apps | bool + - not (nextcloud_apps | selectattr('name', 'search', item.key) | list) + +- name: Remove unwanted external apps + command: php occ app:remove "{{ item.name }}" + loop: "{{ nextcloud_apps }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + register: result + failed_when: result.stdout is not search('removed') or result is failed + changed_when: result is not failed + when: + - item.name in (nextcloud_installed_apps.enabled + | combine(nextcloud_installed_apps.disabled)) + - item.state | default('enabled') == 'absent' + +# Install all apps from the configured list which +# - are external apps (not in the shipped apps list) and +# - are not yet installed (not in the installed apps list) and +# - have their state not set to "absent" +- name: Install external apps + command: php occ app:install "{{ item.name }}" + loop: "{{ nextcloud_apps }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + register: result + failed_when: result.stdout is not search('installed') or result is failed + changed_when: result is not failed + when: + - item.name not in (nextcloud_shipped_apps.enabled + | combine(nextcloud_shipped_apps.disabled)) + - item.name not in (nextcloud_installed_apps.enabled + | combine(nextcloud_installed_apps.disabled)) + - item.state | default('enabled') != 'absent' + notify: nextcloud set file permissions + +# Update list of available apps after installation and removal: +- name: Re-read installed external apps + command: php occ app:list --shipped=false --no-warnings --output=json + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + register: _result + changed_when: false + +- name: Parse occ command response as JSON + set_fact: + nextcloud_installed_apps: "{{ _result.stdout | from_json }}" + +# Check and update all external apps +- name: Update external apps + command: php occ app:update "{{ item.key }}" + loop: >- + {{ + nextcloud_installed_apps.enabled + | combine(nextcloud_installed_apps.disabled) + | dict2items + }} + become: true + become_user: "{{ nextcloud_file_owner }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + register: result + failed_when: result.stdout is search('not installed') or result is failed + changed_when: result.stdout is search('updated') and result is not failed + notify: nextcloud set file permissions + +# Enable all apps from the configured list which +# - are not yet enabled and +# - have their state set to "enabled" +- name: Enable apps + command: php occ app:enable "{{ item.name }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + loop: "{{ nextcloud_apps }}" + when: + - (item.state | default('enabled')) == 'enabled' + - item.name not in ( + nextcloud_installed_apps.enabled + | combine(nextcloud_shipped_apps.enabled) + ) + +# Disable all apps from the configured list which +# - are not yet disabled and +# - have their state set to "disabled" +- name: Disable apps + command: php occ app:disable "{{ item.name }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + loop: "{{ nextcloud_apps }}" + when: + - (item.state | default('enabled')) == 'disabled' + - item.name not in ( + nextcloud_installed_apps.disabled + | combine(nextcloud_shipped_apps.disabled) + ) diff --git a/roles/nextcloud/tasks/core/config.yml b/roles/nextcloud/tasks/core/config.yml new file mode 100644 index 0000000..da2d2b5 --- /dev/null +++ b/roles/nextcloud/tasks/core/config.yml @@ -0,0 +1,55 @@ +--- + +- name: Get global preferences + command: php occ config:list --private --output=json + args: + chdir: "{{ nextcloud_installation_dir }}" + register: _result + changed_when: false + no_log: true + become: true + become_user: "{{ nextcloud_file_owner }}" + +- name: Parse global preferences as json and merge configurations + set_fact: + _nextcloud_old_preferences: + "{{ _result.stdout | from_json }}" + _nextcloud_updated_preferences: >- + {{ + _result.stdout | from_json | combine(nextcloud_config, recursive=True) + }} + no_log: true + +- name: Configure nextcloud and apps + block: + - name: Create temporary config file + tempfile: + suffix: nextcloud + register: _result + + - name: Save config to file + copy: + content: "{{ nextcloud_config | to_json }}" + dest: "{{ _result.path }}" + owner: "{{ nextcloud_file_owner }}" + mode: 0o400 + + - name: Set up global preferences + command: php occ config:import "{{ _result.path }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + register: result + changed_when: result is success + notify: nextcloud update htaccess + failed_when: (result.stdout is not search('successfully imported') + or result is failed) + + - meta: flush_handlers + + - name: Delete temporary config file + file: + path: "{{ _result.path }}" + state: absent + when: _nextcloud_updated_preferences != _nextcloud_old_preferences diff --git a/roles/nextcloud/tasks/core/install.yml b/roles/nextcloud/tasks/core/install.yml new file mode 100644 index 0000000..9b2bbf7 --- /dev/null +++ b/roles/nextcloud/tasks/core/install.yml @@ -0,0 +1,80 @@ +--- + +# These tasks install Nextcloud if it is not installed on the system already. +# They should run only once. + +- name: Install unzip + package: + name: unzip + state: present + when: download_file_type == '.zip' + +- name: Install dependencies + package: + name: "{{ package }}" + loop: "{{ packages }}" + loop_control: + loop_var: package + vars: + packages: + - imagemagick + +- name: Check if nextcloud is already installed + stat: + path: "{{ nextcloud_installation_dir }}/updater/updater.phar" + register: _result + +- name: Download nextcloud + unarchive: + src: "{{ nextcloud_download_url }}" + dest: "{{ nextcloud_installation_parent_dir }}" + remote_src: true + owner: "{{ nextcloud_file_owner }}" + group: "{{ nextcloud_file_owner }}" + register: _result + when: not _result.stat.exists + +- name: Install nextcloud + block: + # When extracting the downloaded nextcloud archive, the files are placed + # under a nextcloud folder. Here, we rename this folder if the user has + # specified a different folder. + - name: Move nextcloud folder + command: >- + mv + "{{ nextcloud_installation_parent_dir }}/nextcloud" + "{{ nextcloud_installation_dir }}" + when: + - _result is not skipped + - nextcloud_installation_dir | basename != "nextcloud" + + - name: Create nextcloud data folder + file: + path: "{{ nextcloud_data_dir }}" + state: directory + owner: "{{ nextcloud_file_owner }}" + group: "{{ nextcloud_file_owner }}" + mode: 0o750 + + - name: Install nextcloud + command: >- + php occ maintenance:install + --no-interaction + --database "{{ nextcloud_database.backend }}" + --database-name "{{ nextcloud_database.name }}" + --database-user "{{ nextcloud_database.user }}" + --database-pass "{{ nextcloud_database.pass }}" + --database-host "{{ nextcloud_database.host }}" + --database-port "{{ nextcloud_database.port }}" + --database-table-prefix "{{ nextcloud_database.prefix }}" + --admin-user "{{ nextcloud_admin_user }}" + --admin-pass "{{ nextcloud_admin_pass }}" + --data-dir "{{ nextcloud_data_dir }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + creates: "{{ nextcloud_installation_dir }}/config/config.php" + become: true + become_user: "{{ nextcloud_file_owner }}" + notify: nextcloud set file permissions + + when: _result is not skipped diff --git a/roles/nextcloud/tasks/core/integrity.yml b/roles/nextcloud/tasks/core/integrity.yml new file mode 100644 index 0000000..6f889fd --- /dev/null +++ b/roles/nextcloud/tasks/core/integrity.yml @@ -0,0 +1,97 @@ +--- + +- name: Read extra files + block: + - name: Run integrity check for core + command: "php occ integrity:check-core --output=json" + args: + chdir: "{{ nextcloud_installation_dir }}" + register: nextcloud_integrity_core + become: true + become_user: "{{ nextcloud_file_owner }}" + failed_when: false + changed_when: false + + - name: Run integrity check for apps + command: "php occ integrity:check-app {{ item }} --output=json" + args: + chdir: "{{ nextcloud_installation_dir }}" + register: nextcloud_integrity_apps + loop: >- + {{ + ( + nextcloud_installed_apps.enabled + | combine(nextcloud_installed_apps.disabled) + ).keys() + | list + }} + changed_when: false + failed_when: false + become: true + become_user: "{{ nextcloud_file_owner }}" + + - name: Extract extra files that need deletion + set_fact: + nextcloud_extra_files: >- + [ + {%- for result in nextcloud_integrity_apps.results -%} + {%- set appname=result.item -%} + {%- set files=(result.stdout_lines[-1] | from_json) -%} + {%- if files is mapping and 'EXTRA_FILE' in files -%} + "{{ [] + | zip_longest( + files['EXTRA_FILE'].keys(), + fillvalue=("apps/" ~ appname) + ) + | map('join', '/') + | list + | join('","') }}" + , + {%- endif -%} + {%- endfor -%} + {%- set files=( + nextcloud_integrity_core.stdout_lines[-1] + | from_json + ) + -%} + {%- if files is mapping and 'EXTRA_FILE' in files -%} + '{{ files["EXTRA_FILE"].keys() | join("','") }}' + {%- endif -%} + ] + +- name: Delete extra files + block: + # Using `command` instead of `file` with a loop to make it (much) faster. + - name: Delete files found by integrity check + command: >- + rm -f '{{ nextcloud_extra_files | join("' '") }}' + args: + chdir: "{{ nextcloud_installation_dir }}" + warn: false + + - name: Re-run integrity check for core to update integrity results + command: "php occ integrity:check-core --output=json" + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + failed_when: false + changed_when: false + + - name: Re-run integrity check for apps to update integrity results + command: "php occ integrity:check-app {{ item }} --output=json" + args: + chdir: "{{ nextcloud_installation_dir }}" + loop: >- + {{ + ( + nextcloud_installed_apps.enabled + | combine(nextcloud_installed_apps.disabled) + ).keys() + | list + }} + changed_when: false + failed_when: false + become: true + become_user: "{{ nextcloud_file_owner }}" + when: nextcloud_extra_files | length > 0 diff --git a/roles/nextcloud/tasks/core/occ.yml b/roles/nextcloud/tasks/core/occ.yml new file mode 100644 index 0000000..50f93d5 --- /dev/null +++ b/roles/nextcloud/tasks/core/occ.yml @@ -0,0 +1,43 @@ +--- + +- name: Make occ executable + file: + path: "{{ nextcloud_installation_dir }}/occ" + mode: "u+x" + owner: "{{ nextcloud_file_owner }}" + group: "{{ nextcloud_file_owner }}" + when: nextcloud_occ_make_executable | bool + +- name: Make occ available as a system command + copy: + content: >- + sudo --preserve-env --user {{ nextcloud_file_owner }} \ + '{{ nextcloud_installation_dir }}/occ' "$@" + dest: /usr/bin/occ + owner: root + group: root + when: nextcloud_occ_system_command | bool + +- name: Setup completion for occ + block: + - name: Read occ completion functions + command: php occ _completion --generate-hook --shell-type bash + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + changed_when: false + register: _occ_completion + + - name: Install bash_completion + package: + name: bash-completion + + - name: Setup occ completion + copy: + content: "{{ _occ_completion.stdout }}" + dest: '/etc/bash_completion.d/nextcloud' + owner: root + group: root + mode: 0o644 + when: nextcloud_occ_completions | bool diff --git a/roles/nextcloud/tasks/core/upgrade.yml b/roles/nextcloud/tasks/core/upgrade.yml new file mode 100644 index 0000000..3bd0887 --- /dev/null +++ b/roles/nextcloud/tasks/core/upgrade.yml @@ -0,0 +1,54 @@ +--- + +- name: Check if update is available + command: php occ update:check --no-interaction + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + register: _result + changed_when: _result.stdout | regex_search('^Nextcloud .* is available') + failed_when: _result is failed + +- name: Make files writable by php user + file: + path: "{{ nextcloud_installation_dir }}" + mode: u=rwX,g=rX,o=rX + owner: "{{ nextcloud_file_owner }}" + group: "{{ nextcloud_file_owner }}" + recurse: true + when: _result.stdout | regex_search('^Nextcloud .* is available') + # Make sure to correctly set file permissions after the installation + notify: nextcloud set file permissions + +- name: Update Nextcloud installation + command: php updater/updater.phar --no-interaction + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + register: _result + failed_when: + - _result is failed + - _result.stdout is not search('Update successful') + # We only check for an upgrade of Nextcloud itself, not of the apps + when: _result.stdout | regex_search('^Nextcloud .* is available') + +- name: Check if upgrade is needed + command: php occ status + args: + chdir: "{{ nextcloud_installation_dir }}" + register: nextcloud_status + changed_when: false + become: true + become_user: "{{ nextcloud_file_owner }}" + +- name: Upgrade Nextcloud installation + command: php occ upgrade + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + when: >- + nextcloud_status.stdout + is search('Nextcloud or one of the apps require upgrade') diff --git a/roles/nextcloud/tasks/main.yml b/roles/nextcloud/tasks/main.yml new file mode 100644 index 0000000..ec0fa17 --- /dev/null +++ b/roles/nextcloud/tasks/main.yml @@ -0,0 +1,4 @@ +--- + +- include_tasks: nextcloud.yml + when: nextcloud_enable | bool diff --git a/roles/nextcloud/tasks/nextcloud.yml b/roles/nextcloud/tasks/nextcloud.yml new file mode 100644 index 0000000..f1f33b6 --- /dev/null +++ b/roles/nextcloud/tasks/nextcloud.yml @@ -0,0 +1,26 @@ +--- + +- include_tasks: variables.yml + +- include_tasks: core/install.yml + +- include_tasks: core/upgrade.yml + +- include_tasks: core/apps.yml + +- include_tasks: core/integrity.yml + +- include_tasks: core/config.yml + +- include_tasks: core/occ.yml + +- include_tasks: users/user.yml + +- include_tasks: users/group.yml + +- include_tasks: users/user_config.yml + +- include_tasks: + file: apps/news.yml + apply: + become: false diff --git a/roles/nextcloud/tasks/users/group.yml b/roles/nextcloud/tasks/users/group.yml new file mode 100644 index 0000000..a517580 --- /dev/null +++ b/roles/nextcloud/tasks/users/group.yml @@ -0,0 +1,47 @@ +--- + +- name: Create user groups + command: php occ group:add "{{ item }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + loop: >- + {{ + nextcloud_users + | map(attribute='groups') + | flatten + | list + | unique + }} + register: result + changed_when: result is success + failed_when: + result is failed and result.stdout is not search('already exists') + become: true + become_user: "{{ nextcloud_file_owner }}" + +- name: Get user info + command: php occ user:info "{{ item.name }}" --output=json + args: + chdir: "{{ nextcloud_installation_dir }}" + register: _nextcloud_user_info + loop: "{{ nextcloud_users }}" + changed_when: false + become: true + become_user: "{{ nextcloud_file_owner }}" + +- name: Add users to groups + command: php occ group:adduser "{{ item.1 }}" "{{ item.0.name }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + loop: "{{ nextcloud_users | subelements('groups') }}" + when: >- + item.1 not in + ( + _nextcloud_user_info.results + | map(attribute='stdout') + | map('from_json') + | selectattr('user_id', 'equalto', item.0.name) + | first + ).groups + become: true + become_user: "{{ nextcloud_file_owner }}" diff --git a/roles/nextcloud/tasks/users/user.yml b/roles/nextcloud/tasks/users/user.yml new file mode 100644 index 0000000..ad24b04 --- /dev/null +++ b/roles/nextcloud/tasks/users/user.yml @@ -0,0 +1,51 @@ +--- + +- name: Get user list + command: php occ user:list --output=json + args: + chdir: "{{ nextcloud_installation_dir }}" + register: nextcloud_online_users + changed_when: false + become: true + become_user: "{{ nextcloud_file_owner }}" + +# There might be non-json lines that break parsing. +- name: Remove non-json text from command output + set_fact: + nextcloud_online_users: >- + {{ + ( + nextcloud_online_users.stdout + | regex_replace('^[^{]*(.*)$', '\1') + | from_json + ).keys() + | list + }} + +- name: Create users + command: >- + php occ user:add + "{{ item.name }}" + --display-name "{{ item.display_name }}" + --password-from-env + args: + chdir: "{{ nextcloud_installation_dir }}" + when: item.name not in nextcloud_online_users + environment: + OC_PASS: "{{ item.pass }}" + loop: "{{ nextcloud_users }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + +- name: Update user password + command: php occ user:resetpassword "{{ item.name }}" --password-from-env + args: + chdir: "{{ nextcloud_installation_dir }}" + when: + - item.resetpassword | default(False) + - item.name in nextcloud_online_users + environment: + OC_PASS: "{{ item.pass }}" + loop: "{{ nextcloud_users }}" + become: true + become_user: "{{ nextcloud_file_owner }}" diff --git a/roles/nextcloud/tasks/users/user_config.yml b/roles/nextcloud/tasks/users/user_config.yml new file mode 100644 index 0000000..988c759 --- /dev/null +++ b/roles/nextcloud/tasks/users/user_config.yml @@ -0,0 +1,76 @@ +--- + +- name: Get local python version + become: false + command: python -V + delegate_to: localhost + register: localhost_python + changed_when: false + +- name: Register local python version + set_fact: + localhost_python: >- + {{ + localhost_python.stdout + | regex_replace('^Python ([0-9])\\..*$', '\\1') + }} + changed_when: false + +# TODO simplify this with filters +- name: Create user settings list + set_fact: + user_settings: >- + [ + {%- for user in nextcloud_users -%} + {%- for app_setting in user.settings -%} + {%- if localhost_python == '2' -%} + {%- for app, settings in app_setting.iteritems() -%} + {%- for key, value in settings.iteritems() -%} + { + 'user': "{{ user.name }}", + 'app': "{{ app }}", + 'key': "{{ key }}", + 'value': "{{ value }}" + }, + {%- endfor -%} + {%- endfor -%} + {%- elif localhost_python == '3' -%} + {%- for app, settings in app_setting.items() -%} + {%- for key, value in settings.items() -%} + { + 'user': "{{ user.name }}", + 'app': "{{ app }}", + 'key': "{{ key }}", + 'value': "{{ value }}" + }, + {%- endfor -%} + {%- endfor -%} + {%- endif -%} + {%- endfor -%} + {%- endfor -%} + ] + +- name: Read existing config values + command: "php occ user:setting {{ item.user }} {{ item.app }} {{ item.key }}" + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + failed_when: false + changed_when: false + register: user_config_values + loop: "{{ user_settings }}" + +- name: Enable user settings + command: >- + php occ user:setting + {{ item.0.user }} + {{ item.0.app }} + {{ item.0.key }} + {{ item.0.value }} + args: + chdir: "{{ nextcloud_installation_dir }}" + become: true + become_user: "{{ nextcloud_file_owner }}" + when: item.0.value != item.1.stdout + loop: "{{ user_settings | zip(user_config_values.results) | list }}" diff --git a/roles/nextcloud/tasks/variables.yml b/roles/nextcloud/tasks/variables.yml new file mode 100644 index 0000000..ff8477c --- /dev/null +++ b/roles/nextcloud/tasks/variables.yml @@ -0,0 +1,27 @@ +--- + +- name: Checking role configuration + assert: + that: + - nextcloud_database.pass + - ( nextcloud_admin_pass ) + msg: "DB user and admin user passwords cannot be empty" + +- name: Set missing defaults + set_fact: + nextcloud_database: + "{{ _nextcloud_database | combine(nextcloud_database) }}" + +- name: Extract download file type + set_fact: + download_file_type: "{{ nextcloud_download_url[-4:] }}" + +- name: Remove trailing slash from installation directory + set_fact: + nextcloud_installation_dir: >- + {{ nextcloud_installation_dir | regex_replace('/$', '') }} + +- name: Read installation parent dir + set_fact: + nextcloud_installation_parent_dir: + "{{ nextcloud_installation_dir | dirname }}" diff --git a/roles/nextcloud/vars/main.yml b/roles/nextcloud/vars/main.yml new file mode 100644 index 0000000..20eb7c1 --- /dev/null +++ b/roles/nextcloud/vars/main.yml @@ -0,0 +1,30 @@ +--- + +# This provides defaults for `nextcloud_database` keys that the user may have +# skipped. In `defaults/main.yml` all keys are set to defaults, but if the user +# specifies in their playbook the `nextcloud_database` variable, then those +# defaults are overwritten. +_nextcloud_database: + backend: mysql + # The database server that will be used. It should be already installed and + # the database should already exist. For 'mariadb', set this to 'mysql'. + + name: nextcloud + # The name of the database nextcloud will use. It should already exist on the + # system. + + user: nextcloud + # The database user that nextcloud will use to access the database. The user + # should already exist in the database backend (together with their password). + + pass: '' + # The database user's password. This variable should not be empty. + + host: localhost + # The database host + + port: 3306 + # The port the db server listens on + + prefix: oc_ + # Prefix for the nextcloud tables in the database. diff --git a/roles/requirements.yml b/roles/requirements.yml index f40c1b1..808c7fd 100644 --- a/roles/requirements.yml +++ b/roles/requirements.yml @@ -26,3 +26,7 @@ - src: thomas_maurice.ansible_role_gitea version: master name: gitea +# Docs: https://github.com/nkakouros-original/ansible-role-nextcloud +- src: nkakouros.nextcloud + version: master + name: nextcloud diff --git a/site.yml b/site.yml index 75f8d6e..c2f3b95 100755 --- a/site.yml +++ b/site.yml @@ -27,9 +27,13 @@ postgresql_users: - name: gitea password: "{{ secret_gitea_db_pass }}" + - name: nextcloud + password: "{{ secret_nextcloud_db_pass }}" postgresql_databases: - name: gitea owner: gitea + - name: nextcloud + owner: nextcloud become: yes tags: [ db, psql ] # Webservers @@ -46,11 +50,39 @@ ProxyPreserveHost On ProxyRequests Off ProxyPass / http://127.0.0.1:3000/ nocanon retry=1 + - servername: nc.test.desu.ltd + documentroot: /var/www/html/nextcloud become: yes tags: [ web, apache ] - role: php + vars: + php_memory_limit: 512M + php_packages_extra: + - libapache2-mod-php + - php-zip # For Nextcloud + - php-pgsql # For general DB stuff become: yes tags: [ web, php ] + - role: nextcloud + vars: + nextcloud_admin_user: admin + nextcloud_admin_pass: foobar + nextcloud_version: 19 + nextcloud_urls: + - http://nc.test.desu.ltd:80 + nextcloud_config: + system: + trusted_domains: + "{{ nextcloud_urls | map('urlsplit', 'hostname') | list }}" + nextcloud_database: + backend: pgsql + name: nextcloud + user: nextcloud + pass: "{{ secret_nextcloud_db_pass }}" + host: 192.168.122.169 + port: 5432 + become: yes + tags: [ web, nextcloud ] - role: gitea vars: # Look and feel