ns8-nextcloud

Start and configure a Nexctloud instance:

• with PHP FPM + nginx as a proxy
• redis caching
• MariaDB database The module uses Official Nextcloud image.

Install

Instantiate the module:

add-module nextcloud 1

The output of the command will return the instance name. Output example:

{'module_id': 'nextcloud8', 'image_name': 'nextcloud', 'image_url': 'ghcr.io/nethserver/nextcloud:latest'}

Configure

Let's assume that the nextcloud istance is named nextcloud1.

Then launch configure-module, by setting the following parameters:

• fully qualified domain name for Nextcloud
• let's encrypt option
• LDAP domain (optional)

Example:

api-cli run module/nextcloud1/configure-module --data - <<EOF
{
    "host": "nextcloud.nethserver.org",
    "lets_encrypt": true,
    "domain": "ad.nethserver.org",
    "password": "Nethesis,1234"
}
EOF

To execute occ command inside an instance:

runagent -m nextcloud1 occ <args>

You can customize FPM configuration by changing the file named zzz_nethserver.conf inside the state directory. Example:

runagent -m nextcloud1 vi zzz_nethserver.conf

Specific ldap mail field for Samba AD

You can change the mail field used by Nextcloud with an environment variable. The default LDAP mail field is userPrincipalName, which corresponds to the AD domain name and not the user's email address. By adding LDAP_MAIL_ATTRIBUTE your users wil be able to login with :

• sAMAccountName: eg john
• userPrincipalName: eg john@ad.domain.com
• mail: eg john@domain.com

runagent -m nextcloud1 vim environment add : LDAP_MAIL_ATTRIBUTE=mail systemctl --user restart nextcloud

DB-fix script

Nextcloud requires manual database fixes that cannot be automated during upgrade, as operations may take a long time with large amounts of data. In such cases, the nextcloud-db-optimize command can be run manually to optimize the Nextcloud database outside production hours.

runagent -m nextcloud1 nextcloud-db-optimize

Uninstall

To uninstall the instance:

remove-module --no-preserve nextcloud1

Testing

Test the module using the test-module.sh script:

./test-module.sh <NODE_ADDR> ghcr.io/nethserver/nextcloud:latest

The tests are made using Robot Framework

UI translation

Translated with Weblate.

To setup the translation process:

• add GitHub Weblate app to your repository
• add your repository to hosted.weblate.org or ask a NethServer developer to add it to ns8 Weblate project