Repository files navigation

This repository hosts thenextcloud.admin Ansible Collection.

The collection includes a variety of Ansible content to help automate the management of nextcloud, as well as provisioning and maintenance of instances of nextcloud.

This collection has been tested against following Ansible versions:>=2.15.0.

Plugins and modules within a collection may be tested with only specific Ansible versions.

• Collection tested on 3.12+

This collection supports Nextcloud versions:29,30,31(latest)The community makes it's best efforts to keep tested versions updated withNextcloud release schedule.

Content in this collection requires thenetwork address manipulation library to manipulate network address. You can install it with:

    pip3 install netaddr

By default, some roles in this collection are dependant of standalone roles from other namespaces. (this can be disabled).

Due to some limitations, ansible-galaxy does not install them automatically, them need to be installed afterward.

Once the collection is installed, run the commandansible-galaxy role install -r <this_collection_folder>/requirements.yml.

Alternatively, you can also add the content ofthis file in your ownrequirements.yml file prior to installing the collection

Before using the nextcloud collection, you need to install it with the Ansible Galaxy CLI:

ansible-galaxy collection install nextcloud.admin

You can also include it in arequirements.yml file and install it viaansible-galaxy collection install -r requirements.yml, using the format:

---collections:  -name:nextcloud.adminversion:2.2.3

It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for examplenextcloud.admin.run_occ:

----hosts:nextcloud_hostgather_facts:falsebecome:truetasks:    -name:list installed appsnextcloud.admin.run_occ:nextcloud_path:/var/www/nextcloudcommand:app:list

If upgrading older playbooks from <2.0.0, you can minimise your changes by definingcollections in your play and refer to this collection's role asinstall_nextcloud, instead ofnextcloud.admin.install_nextcloud, as in this example:

----hosts:localhostgather_facts:falseconnection:localcollections:    -nextcloud.admintasks:    -name:deploy nextcloud and dependenciesinclude_role:name:install_nextcloud

For documentation on how to use:

• individual modules: please useansible-doc command after installing this collection.
• included roles: as per ansible standard, ansible role are documented in their own README file.

If you want to develop new content for this collection or improve what's already here, the easiest way to work on the collection is to clone it into one of the configuredCOLLECTIONS_PATHS, and work on it there.

Thetests directory contains playbooks for running integration tests on various scenarios.There are also integration tests in themolecule directory

Releases are automatically built and pushed to Ansible Galaxy for any new tag.

BSD

See LICENCE to see the full text.