Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nextcloud/ansible-collection-nextcloud-admin
The ansible galaxy for your nextcloud administrative needs.
https://github.com/nextcloud/ansible-collection-nextcloud-admin
ansible ansible-collection ansible-modules ansible-role nextcloud
Last synced: 5 days ago
JSON representation
The ansible galaxy for your nextcloud administrative needs.
- Host: GitHub
- URL: https://github.com/nextcloud/ansible-collection-nextcloud-admin
- Owner: nextcloud
- License: bsd-2-clause
- Created: 2016-09-09T02:56:05.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2024-11-20T07:32:02.000Z (about 1 month ago)
- Last Synced: 2024-12-03T18:32:26.334Z (19 days ago)
- Topics: ansible, ansible-collection, ansible-modules, ansible-role, nextcloud
- Language: Jinja
- Homepage: https://galaxy.ansible.com/nextcloud/admin
- Size: 910 KB
- Stars: 140
- Watchers: 13
- Forks: 76
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/nextcloud/ansible-collection-nextcloud-admin/actions?workflow=Lint)
[](https://github.com/nextcloud/ansible-collection-nextcloud-admin/actions?workflow=Tests)
[](https://github.com/nextcloud/ansible-collection-nextcloud-admin/actions?workflow=Tests%20latest)
# Ansible collection for nextcloud administration
This repository hosts the `nextcloud.admin` Ansible Collection (formerly the role `aalaesar.install_nextcloud`).
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.
## Ansible version compatibility
This collection has been tested against following Ansible versions: **>=2.14.0**.
Plugins and modules within a collection may be tested with only specific Ansible versions.
## Python Support
* Collection tested on 3.11+
## Supported nextcloud version
This collection supports Nextcloud versions: `27`, `28`, `29(latest)`
## Included content
### Modules
Name | Description
--- | ---
nextcloud.admin.run_occ|Run the occ command line tool with given arguments.
nextcloud.admin.app_info| Return state, version, updates and path of one external application.
nextcloud.admin.app | Manage nextcloud external applications (install, remove, disable, etc)
### Roles
Name | Description
--- | ---
nextcloud.admin.backup (**beta**)|Create a backup of a Nextcloud server - formerly `aalaesar.backup_nextcloud`
nextcloud.admin.install_nextcloud | Install and configure an Nextcloud instance for a Debian/Ubuntu server - formerly `aalaesar.install_nextcloud`
## Installation and Usage
### Dependencies
#### netaddr Python Library
Content in this collection requires the [network address manipulation library](https://pypi.org/project/netaddr/) to manipulate network address. You can install it with:
```
pip3 install netaddr
```
#### required standalone roles
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 command `ansible-galaxy role install -r /requirements.yml`.
Alternatively, you can also add the content of [this file](requirements.yml) in your own `requirements.yml` file prior to installing the collection
### Installing the Collection from Ansible Galaxy
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 a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format:
```yaml
---
collections:
- name: nextcloud.admin
version: 2.0.0
```
### Using modules from the Nextcloud Collection in your playbooks
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `nextcloud.admin.run_occ`:
```yaml
---
- hosts: nextcloud_host
gather_facts: false
become: true
tasks:
- name: list installed apps
nextcloud.admin.run_occ:
nextcloud_path: /var/www/nextcloud
command: app:list
```
If upgrading older playbooks from <2.0.0, you can minimise your changes by defining `collections` in your play and refer to this collection's role as `install_nextcloud`, instead of `nextcloud.admin.install_nextcloud`, as in this example:
```yaml
---
- hosts: localhost
gather_facts: false
connection: local
collections:
- nextcloud.admin
tasks:
- name: deploy nextcloud and dependencies
include_role:
name: install_nextcloud
# previously:
# name: aalaesar.install_nextcloud
```
For documentation on how to use:
- __individual modules__: please use `ansible-doc` command after installing this collection.
- __included roles__: as per ansible standard, ansible role are documented in their own README file.
## Testing and Development
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 configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths), and work on it there.
### Testing with `molecule`
The `tests` directory contains playbooks for running integration tests on various scenarios.
There are also integration tests in the `molecule` directory
## Publishing New Versions
Releases are automatically built and pushed to Ansible Galaxy for any new tag.
## License
BSD
See LICENCE to see the full text.