REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• nextcloud: Manage NextCloud

Private Classes

• nextcloud::base: Manage Nextcloud base config
• nextcloud::config: Manage Nextcloud configuration
• nextcloud::database: Manage Nextcloud database
• nextcloud::dependencies: Manage Nextcloud dependencies
• nextcloud::wrapper: Manage Nextcloup wrapper

Defined types

• nextcloud::htaccess: A short summary of the purpose of this defined type.
• nextcloud::occ::exec: Run Nextcloud CLI tool

Data types

• Nextcloud::Iso3166_1_alpha_2: ISO 3166-1 alpha-2 codes https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
• Nextcloud::Iso639_1: ISO 639-1 codes https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Tasks

• app_install: Install an application
• app_list: List apps
• app_update: Update all apps without confirmation
• app_update_check: Show available updates for apps
• deploy: Deploy Nextcloud
• maintenance: Turn on/off maintenance mode
• occ: Execute custom occ command
• update_check: Check if an update is available using occ update:check
• user_invite: Invite a user

Classes

nextcloud

Manage NextCloud

Parameters

The following parameters are available in the nextcloud class:

• hostname
• database_password
• php_version
• database_username
• database_name
• user
• group
• log_level
• trashbin_retention
• services_to_restart_after_upgrade
• default_language
• default_phone_region

hostname

Data type: Stdlib::Fqdn

The hostname of the instance

database_password

Data type: String[20]

Password for the database

php_version

Data type: String[3,3]

Version of PHP to use

database_username

Data type: String[1]

Username for the database

Default value: 'nextcloud'

database_name

Data type: String[1]

Name of the database

Default value: 'nextcloud'

user

Data type: String[1]

Owner of the instance files

Default value: 'nextcloud'

group

Data type: String[1]

Group of the instance files

Default value: $user

log_level

Data type: Integer[0, 4]

Log level

Default value: 2

trashbin_retention

Data type: String[1]

Retention mode for the trash

Default value: 'auto'

services_to_restart_after_upgrade

Data type: Array[String[1]]

A list of services to notify on update

Default value: []

default_language

Data type: Optional[Nextcloud::Iso639_1]

Default language

Default value: undef

default_phone_region

Data type: Optional[Nextcloud::Iso3166_1_alpha_2]

Defaulte phone region

Default value: undef

Defined types

nextcloud::htaccess

A short summary of the purpose of this defined type.

Parameters

The following parameters are available in the nextcloud::htaccess defined type:

• user
• group
• path

user

Data type: String[1]

Owner of the .htacess file

group

Data type: String[1]

Group of the .htacess file

path

Data type: Stdlib::Absolutepath

Path to the .htaccess file

Default value: $name

nextcloud::occ::exec

Run Nextcloud CLI tool

Examples

nextcloud::occ::exec { 'enable maintenance mode':
  args  => 'maintenance:mode --on',
  path  => '/srv/www/nextcloud.example.com',
  user  => 'nextcloud',
  group => 'nextcloud',
}

Parameters

The following parameters are available in the nextcloud::occ::exec defined type:

• path
• user
• group
• args
• refreshonly
• unless

path

Data type: Stdlib::Absolutepath

user

Data type: String[1]

group

Data type: String[1]

Default value: $user

args

Data type: String[1]

Default value: $title

refreshonly

Data type: Boolean

Default value: false

unless

Data type: Optional[String[1]]

Default value: undef

Data types

Nextcloud::Iso3166_1_alpha_2

ISO 3166-1 alpha-2 codes https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

Alias of Pattern[/\A[A-Z][A-Z]\z/]

Nextcloud::Iso639_1

ISO 639-1 codes https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Alias of Pattern[/\A[a-z][a-z]\Z/]

Tasks

app_install

Install an application

Supports noop? false

Parameters

application

Data type: String

Application name to install

app_list

List apps

Supports noop? false

Parameters

shipped

Data type: Boolean

Show core Nextcloud apps too

app_update

Update all apps without confirmation

Supports noop? false

app_update_check

Show available updates for apps

Supports noop? false

deploy

Deploy Nextcloud

Supports noop? false

Parameters

version

Data type: String[1]

The version to deploy

maintenance

Turn on/off maintenance mode

Supports noop? false

Parameters

mode

Data type: Optional[Enum[on,off]]

Target maintenance mode

occ

Execute custom occ command

Supports noop? false

Parameters

command

Data type: String[1]

OCC command

update_check

Check if an update is available using occ update:check

Supports noop? false

user_invite

Invite a user

Supports noop? false

Parameters

username

Data type: String[1]

Username used to connect to Nextcloud

display_name

Data type: Optional[String[1]]

Display name

group

Data type: Optional[String[1]]

Group (e.g. 'admin')

email

Data type: String[1]

Email