Ansible role to install and maintain Nextcloud setups

This role is meant to deploy and upgrade Nextcloud instances to Debian systems.

Using the Ansible module nextcloud_app

This role uses my new Ansible module nextcloud_app for managing Nextcloud apps.

I opened a pull request[1] to include the moule into Ansible.

In the meantime, you can find the module shipped with this role at library/nextcloud_app.py. Ansible should find the module automatically.

[1] ansible/ansible#36744

How it works

• The requested Nextcloud version is installed into {{ nextcloud_work_dir }}/nextcloud-{{ nextcloud_version }}.
• The symlink {{ nextcloud_work_dir }}/nextcloud-current points to the active Nextcloud installation (or maintenance page uring upgrades).
• A simple maintenance page (to be displayed during upgrades) is installed to {{ nextcloud_work_dir }}/nextcloud-maintenance.

Preliminaries

The role takes care of installing and upgrading Nextcloud and its apps. It doesn't install or configure MariaDB/MySQL, mail or web service. The latter has to be done seperately.

PHP dependencies required for Nextcloud are installed by that role.

Some modules used in this role are new to Ansible 2.2 and it's tested with Ansible 2.2, 2.3 and 2.4.

The following preliminaries need to be met:

• Ansible 2.2 or newer
• Debian target system with the following requirements:
  • MariaDB/MySQL server with admin permissions (may be remote)
  • Webserver (e.g. Apache2/Nginx) with basic PHP support
  • Mail server if Nextcloud instance shall send out mails (may be remote)
• The Nextcloud data directory needs to be located outside nextcloud_work_dir

Usage example

• Integrate the role in your playbook:

• hosts: cloud.example.org roles:
  • nextcloud tags:
  • nextcloud

* Configure role variables in `host_vars` for the target system (see
  `defaults/main.yml` for a list of supported config variables):  
    

Nextcloud settings

nextcloud_version: 12.0.3 nextcloud_workdir: "/var/www/cloud.example.org/nextcloud" nextcloud_data_dir: "/srv/nextcloud/data" nextcloud_trusted_domains:

• cloud.example.org nextcloud_mysql_password: "" nextcloud_admin_password: ""

nextcloud_apps:

• admin_audit
• calendar
• contacts

* Deploy Nextcloud to the target system:  
    
  `ansible-playbook site.yml -t nextcloud -l cloud.example.org --diff`

* Configure the VirtualHost in your webserver. The following is an example
  snippet for a jinja2 Apache2 vhost template:  
    

{% set nextcloud_webroot = nextcloud_workdir|d() + '/nextcloud-current' %} DocumentRoot {{ nextcloud_webroot }} <Directory {{ nextcloud_webroot }}> Options FollowSymlinks AllowOverride All

	<IfModule mod_dav.c>
		Dav off
	</IfModule>

	SetEnv HOME {{ nextcloud_webroot }}
	SetEnv HTTP_HOME {{ nextcloud_webroot }}
</Directory>

# Upgrading Nextcloud

To upgrade a Nextcloud instance, it's sufficient to bump the version
in Role variable `nextcloud_version` and run the role again.

# License

This Ansible role is licensed under the GNU GPLv3 or later.

# Author

Copyright 2017-2018 Jonas Meurer <[email protected]>