Nextcloud

https://docs.nextcloud.com/server/latest/admin_manual/
Admin
Nextcloud is a self-hosted file hosting, synchronization, and collaboration platform that enables...
Tokens:186,216
Snippets:2,897
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install and Start Redis

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Install the Redis package and ensure the service is enabled and running.

```bash
dnf install -y redis
systemctl enable redis.service
systemctl start redis.service
```

--------------------------------

### Launch Client After Installation

Source: https://docs.nextcloud.com/server/latest/admin_manual/desktop/massdeployment.html

Automatically start the client upon completion of the installation process.

```bash
msiexec /i Nextcloud-x.y.z-x64.msi LAUNCH="1"
```

--------------------------------

### Enable Installation Wizard

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Create the CAN_INSTALL file to trigger the web-based setup wizard.

```bash
# touch /var/www/nextcloud/config/CAN_INSTALL
```

--------------------------------

### Start Client with Log Directory and Expiration

Source: https://docs.nextcloud.com/server/latest/admin_manual/desktop/troubleshooting.html

Example command to start the client while specifying a log directory and expiration time.

```bash
nextcloud --logdir /tmp/nextcloud_logs --logexpire 48
```

--------------------------------

### Full Automatic Configuration

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/automatic_configuration.html

Provides all necessary parameters to bypass the Finish setup screen entirely during installation.

```php
<?php
$AUTOCONFIG = array(
  "dbtype"        => "mysql",
  "dbname"        => "nextcloud",
  "dbuser"        => "username",
  "dbpass"        => "password",
  "dbhost"        => "localhost",
  "dbtableprefix" => "",
  "adminlogin"    => "root",
  "adminpass"     => "root-password",
  "directory"     => "/www/htdocs/nextcloud/data",
);
```

--------------------------------

### Install Apache and required modules

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/example-docker.html

Installs the Apache web server and enables the proxy modules required for the reverse proxy setup.

```bash
apt-get install apache2
a2enmod proxy proxy_wstunnel proxy_http ssl
```

--------------------------------

### Display Installation Help

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_system.html

Shows available options for the maintenance:install command before Nextcloud is installed.

```bash
sudo -E -u www-data php /var/www/nextcloud/occ maintenance:install --help
Nextcloud is not installed - only a limited number of commands are available

Usage:
  maintenance:install [options]

Options:
      --database[=DATABASE]                  Supported database type [default: "sqlite"]
      --database-name[=DATABASE-NAME]        Name of the database
      --database-host[=DATABASE-HOST]        Hostname of the database [default: "localhost"]
      --database-port[=DATABASE-PORT]        Port of the database
      --database-user[=DATABASE-USER]        User name to connect to the database
      --database-pass[=DATABASE-PASS]        Password of the database user
      --database-table-prefix[=...]          Table prefix for every table in the database
      --admin-user[=ADMIN-USER]              User name of the admin account [default: "admin"]
      --admin-pass[=ADMIN-PASS]              Password of the admin account
      --data-dir[=DATA-DIR]                  Path to data directory [default: "/var/www/nextcloud/data"]
```

--------------------------------

### Run system setup checks

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_system.html

Executes diagnostic checks to verify the server installation configuration.

```bash
sudo -E -u www-data php occ setupchecks
```

--------------------------------

### Install Document Server package

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/euro-office/installation_debian.html

Install the downloaded package using apt.

```bash
sudo apt-get install -y /tmp/euro-office-documentserver.deb
```

--------------------------------

### Install an app

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_apps.html

Commands for installing applications with various options.

```bash
sudo -E -u www-data php occ app:install twofactor_totp
```

```bash
sudo -E -u www-data php occ app:install --keep-disabled twofactor_totp
```

```bash
sudo -E -u www-data php occ app:install --force twofactor_totp
```

--------------------------------

### Configure cluster topology

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/caching_configuration.html

Example configuration for a cluster setup in config.php using seed nodes.

```php
'memcache.kvstore' => [
   'seeds' => [
      ['host' => 'cache-cluster.example.com', 'port' => 7000],
      ['host' => 'cache-cluster.example.com', 'port' => 7001],
   ],
],
```

--------------------------------

### Enable and Start MariaDB

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Configure the MariaDB service to start at boot and initiate the service.

```bash
systemctl enable mariadb.service
systemctl start mariadb.service
```

--------------------------------

### Install system prerequisites

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/euro-office/installation_debian.html

Install necessary services including PostgreSQL, Redis, RabbitMQ, Nginx, and Supervisor.

```bash
sudo apt-get install -y postgresql redis-server rabbitmq-server nginx supervisor
```

--------------------------------

### Configure single server KeyValueCache topology

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/caching_configuration.html

Example configuration for a single server KeyValueCache setup in config.php.

```php
'memcache.locking' => '\OC\Memcache\KeyValueCache',
'memcache.distributed' => '\OC\Memcache\KeyValueCache',
'memcache_customprefix' => 'mynextcloudprefix',
'memcache.kvstore' => [
   'server' => [
      'host' => 'cache-host.example.com',
      'port' => 6379,
      // Protocol used to connect. One of 'tcp', 'tls' or 'unix'.
      // When omitted it is derived from the host (a leading '/' means 'unix').
      'protocol' => 'tcp',
   ],
   'user'         => 'nextcloud', // only sent when the server uses ACLs
   'password'     => 'password',
   'dbindex'      => 0,
   'timeout'      => 1.5,
   'read_timeout' => 1.5,
   'persistent'   => false, // keep the connection open across requests
],
```

--------------------------------

### Enable and start Apache service

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Configures the Apache service to start on boot and initiates the service immediately.

```bash
systemctl enable httpd.service
systemctl start httpd.service
```

--------------------------------

### Install Nextcloud via CLI

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_system.html

Executes the installation process using a MySQL database configuration.

```bash
sudo -E -u www-data php occ maintenance:install \
  --database mysql \
  --database-name nextcloud \
  --database-host 127.0.0.1 \
  --database-user nextcloud \
  --database-pass secret \
  --admin-user admin \
  --admin-pass password
  Nextcloud was successfully installed
```

--------------------------------

### Configure Installation Directory

Source: https://docs.nextcloud.com/server/latest/admin_manual/desktop/massdeployment.html

Set a custom installation path using the INSTALLDIR property during the initial installation.

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi INSTALLDIR="C:\Program Files\Non Standard Nextcloud Client Folder"
```

--------------------------------

### Run NextcloudPI Installation Script

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html

Executes the installation script for NextcloudPI.

```bash
sudo bash install.sh
```

--------------------------------

### Install Apache web server

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Installs the Apache HTTP server package.

```bash
dnf install -y httpd
```

--------------------------------

### Installation success message

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/euro-office/installation_debian.html

The expected output upon successful completion of the installation script.

```text
Congratulations, the Euro-Office DocumentServer has been installed successfully!
```

--------------------------------

### Toggle Example Event Creation

Source: https://docs.nextcloud.com/server/latest/admin_manual/groupware/calendar.html

Enable or disable the automatic creation of an example event for new users via the command line.

```bash
sudo -E -u www-data php occ config:app:set dav create_example_event --value=no
```

--------------------------------

### Install system packages

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_ubuntu.html

Updates the package list and installs Apache, MariaDB, and necessary PHP modules.

```bash
sudo apt update && sudo apt upgrade
sudo apt install apache2 mariadb-server libapache2-mod-php php-gd php-mysql \
php-curl php-mbstring php-intl php-gmp php-xml php-imagick php-zip
```

--------------------------------

### Enable and start httpd

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Use rcctl to enable and start the httpd service.

```shell
# rcctl enable httpd
# rcctl start httpd
```

--------------------------------

### Install Nextcloud package

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Install the base Nextcloud package using pkg_add.

```shell
# pkg_add nextcloud
```

--------------------------------

### Install Nextcloud snap

Source: https://docs.nextcloud.com/server/latest/admin_manual/maintenance/package_upgrade.html

Command to install the Nextcloud snap package on Ubuntu systems.

```bash
sudo snap install nextcloud
```

--------------------------------

### Configure Sentinel managed replication topology

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/caching_configuration.html

Example configuration for a Sentinel managed replication setup in config.php.

```php
'memcache.kvstore' => [
   'sentinel' => [
      'service' => 'mymaster',
      'seeds' => [
         ['host' => 'sentinel1.example.com', 'port' => 26379],
         ['host' => 'sentinel2.example.com', 'port' => 26379],
         ['host' => 'sentinel3.example.com', 'port' => 26379],
      ],
   ],
],
```

--------------------------------

### Retrieve Installation Status

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_system.html

Retrieves current installation details. Use the json_pretty output format for machine-readable data.

```bash
sudo -E -u www-data php occ status
```

```bash
sudo -E -u www-data php occ status --output=json_pretty
```

--------------------------------

### Install additional dependencies

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Install required database and caching packages for the Nextcloud environment.

```shell
# pkg_add postgresql-server redis pecl82-redis php-pdo_pgsql
```

--------------------------------

### Install system dependencies

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Installs essential packages required for the Nextcloud installation and general system maintenance.

```bash
dnf install -y epel-release yum-utils unzip curl wget \
bash-completion policycoreutils-python-utils mlocate bzip2
```

--------------------------------

### Install MariaDB on CentOS

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Install the MariaDB server package using dnf.

```bash
dnf install -y mariadb mariadb-server
```

--------------------------------

### Install optional PHP modules

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Installs the optional redis and imagick PHP extensions.

```bash
dnf install -y php-redis php-imagick
```

--------------------------------

### Automate Nextcloud MSI Installation

Source: https://docs.nextcloud.com/server/latest/admin_manual/desktop/massdeployment.html

Run the installer in passive mode with default settings.

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi
```

--------------------------------

### Start PHP-FPM Service

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Enable and start the PHP-FPM service using rcctl.

```bash
# rcctl enable php82_fpm
# rcctl start php82_fpm
```

--------------------------------

### Run Nextcloud VM Installation Script

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html

Executes the production installation script for the Nextcloud VM.

```bash
sudo bash nextcloud_install_production.sh
```

--------------------------------

### Run Installation via occ

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/command_line_installation.html

Execute the maintenance:install command to configure the database and admin credentials. Ensure you are in the root Nextcloud directory before running this command.

```bash
$ cd /var/www/nextcloud/
$ sudo -E -u www-data php occ  maintenance:install \
--database 'mysql' --database-name 'nextcloud' \
--database-user 'nextcloud' --database-pass 'password' \
--admin-user 'admin' --admin-pass 'password'
```

--------------------------------

### Toggle Default Example Contact via CLI

Source: https://docs.nextcloud.com/server/latest/admin_manual/groupware/contacts.html

Enable or disable the automatic creation of an example contact for new users.

```bash
sudo -E -u www-data php occ config:app:set dav enableDefaultContact --value=no
```

--------------------------------

### Pre-seed installer configuration

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/euro-office/installation_debian.html

Set debconf selections to automate the database configuration during package installation.

```bash
echo "ds ds/db-type select postgres
ds ds/db-host string localhost
ds ds/db-port string 5432
ds ds/db-user string ds
ds ds/db-pwd password ds
ds ds/db-name string ds" | sudo debconf-set-selections
```

--------------------------------

### Supported Database Types

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/command_line_installation.html

List of database drivers supported for the installation process.

```text
- sqlite (SQLite3 - Nextcloud Community edition only)
- mysql (MySQL/MariaDB)
- pgsql (PostgreSQL)
- oci (Oracle currently only possible if you contact us at https://nextcloud.com/enterprise as part of a subscription)
```

--------------------------------

### GET ocs/v1.php/cloud/apps/

Source: https://docs.nextcloud.com/server/latest/admin_manual/apps_management_api.html

Returns a list of apps installed on the Nextcloud server.

```APIDOC
## GET ocs/v1.php/cloud/apps/

### Description
Returns a list of apps installed on the Nextcloud server. Authentication is done by sending a Basic HTTP Authorization header.

### Method
GET

### Endpoint
ocs/v1.php/cloud/apps/

### Parameters
#### Query Parameters
- **filter** (string) - Optional - Filter apps by 'enabled' or 'disabled'.

### Response
#### Success Response (100)
- **apps** (list) - List of installed app identifiers.
```

--------------------------------

### Define instanceid

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html

A unique identifier for the Nextcloud installation, automatically generated during setup.

```php
'instanceid' => '',
```

--------------------------------

### Secure MariaDB Installation

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Run the security script to improve MariaDB instance security.

```bash
mysql_secure_installation
```

--------------------------------

### Convert SQLite to MariaDB/MySQL

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/db_conversion.html

Example command to migrate an existing SQLite installation to a MariaDB or MySQL database.

```bash
sudo -E -u www-data php occ db:convert-type --password="<password>" --port="3306" --all-apps mysql <username> <hostname> nextcloud
```

--------------------------------

### Configure S3 Object Storage

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html

Example configuration for S3-compatible object storage.

```php
'objectstore' => [
        'class' => 'OC\\Files\\ObjectStore\\S3',
        'arguments' => [
            'bucket' => 'nextcloud',
            'key' => 'your-access-key',
            'secret' => 'your-secret-key',
            'hostname' => 's3.example.com',
            'port' => 443,
            'use_ssl' => true,
            'region' => 'us-east-1',
            // optional: Maximum number of retry attempts for failed S3 requests
            // Default: 5
            'retriesMaxAttempts' => 5,
            // Data Integrity Protections for Amazon S3 (https://docs.aws.amazon.com/sdkref/latest/guide/feature-dataintegrity.html)
            // Valid values are "when_required" (default) and "when_supported".
            // To ensure compatibility with 3rd party S3 implementations, Nextcloud disables it by default. However, if you are
            // using Amazon S3 (or any other implementation that supports it) we recommend enabling it by using "when_supported".
            'request_checksum_calculation' => 'when_required',
            'response_checksum_validation' => 'when_required',
        ],
    ],
```

--------------------------------

### Example MySQL/MariaDB configuration file

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/linux_database_configuration.html

A sample configuration for /etc/mysql/my.cnf including performance and character set settings.

```ini
[server]
skip_name_resolve = 1
innodb_buffer_pool_size = 128M
innodb_buffer_pool_instances = 1
innodb_flush_log_at_trx_commit = 2
innodb_log_buffer_size = 32M
innodb_max_dirty_pages_pct = 90
query_cache_type = 1
query_cache_limit = 2M
query_cache_min_res_unit = 2k
query_cache_size = 64M
tmp_table_size= 64M
max_heap_table_size= 64M
slow_query_log = 1
slow_query_log_file = /var/log/mysql/slow.log
long_query_time = 1

[client-server]
!includedir /etc/mysql/conf.d/
!includedir /etc/mysql/mariadb.conf.d/

[client]
default-character-set = utf8mb4

[mysqld]
character_set_server = utf8mb4
collation_server = utf8mb4_bin
transaction_isolation = READ-COMMITTED
binlog_format = ROW
innodb_large_prefix=on
innodb_file_format=barracuda
innodb_file_per_table=1
```

--------------------------------

### Initialize PostgreSQL database

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/euro-office/installation_debian.html

Create the dedicated database user and database instance for the Document Server.

```bash
sudo -u postgres psql -c "CREATE USER ds WITH PASSWORD 'ds';"
sudo -u postgres psql -c "CREATE DATABASE ds OWNER ds;"
```

--------------------------------

### Configure PHP PostgreSQL Extension

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/linux_database_configuration.html

Example configuration for the PHP PostgreSQL module in /etc/php7/conf.d/pgsql.ini.

```ini
# configuration for PHP PostgreSQL module
extension=pdo_pgsql.so
extension=pgsql.so

[PostgreSQL]
pgsql.allow_persistent = On
pgsql.auto_reset_persistent = Off
pgsql.max_persistent = -1
pgsql.max_links = -1
pgsql.ignore_notice = 0
pgsql.log_notice = 0
```

--------------------------------

### Locate Package READMEs

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Path to the directory containing documentation for installed OpenBSD packages.

```text
/usr/local/share/doc/pkg-readmes/
```

--------------------------------

### Deploy HaRP container on independent host

Source: https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/DeployConfigurations.html

Starts the HaRP container with specific trusted proxy settings for multi-host setups.

```bash
docker run \
  -e HP_SHARED_KEY="some_very_secure_password" \
  -e NC_INSTANCE_URL="https://cloud.acme.com" \
  -e HP_TRUSTED_PROXY_IPS="192.168.0.0/24" \	  # Replace with your actual trusted proxy subnet (Host3's IP or subnet)
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v /some/path/certs:/certs \
  -p 8780:8780 \
  -p 8782:8782 \
  --name appapi-harp -h appapi-harp \
  --restart unless-stopped \
  -d ghcr.io/nextcloud/nextcloud-appapi-harp:release
```

--------------------------------

### Prepare Chroot Environment

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Copy necessary SSL and DNS configuration files into the /var/www jail.

```bash
# mkdir -p /var/www/etc/ssl
# install -m 444 -o root -g bin /etc/ssl/cert.pem /etc/ssl/openssl.cnf \
        /var/www/etc/ssl/
# cp /etc/resolv.conf /var/www/etc
```

--------------------------------

### Generated Database Credentials

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/installation_wizard.html

Example of the database user and password entries automatically generated and written to config.php when the installer creates a dedicated user.

```php
'dbuser' => 'oc_admin',
'dbpassword' => 'pX65Ty5DrHQkYPE5HRsDvyFHlZZHcm',
```

--------------------------------

### Interactive wizard preconfiguration commands

Source: https://docs.nextcloud.com/server/latest/admin_manual/desktop/massdeployment.html

Use these parameters to prefill the Account Setup Wizard, allowing users to skip manual entry of the server URL and local sync path.

```windows
"C:\Program Files\Nextcloud\nextcloud.exe" --overridelocaldir "D:/work/nextcloud-sync-folder" --overrideserverurl https://cloud.example.com
```

```linux/macos
nextcloud --overridelocaldir "/home/<user>/nextcloud-sync-folder" --overrideserverurl https://cloud.example.com
```

--------------------------------

### Example of an upgrade error log

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_system.html

Shows the output when an exception occurs during the upgrade process.

```text
Turned on maintenance mode
Checked database schema update
Checked database schema update for apps
Updated database
Updating <files_sharing> ...
Exception
ServerNotAvailableException: LDAP server is not available
Update failed
Turned off maintenance mode
```

--------------------------------

### Install required PHP modules

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Installs the core PHP modules required for a basic Nextcloud installation.

```bash
dnf install -y php php-cli php-gd php-mbstring php-intl php-pecl-apcu\
     php-mysqlnd php-opcache php-json php-zip
```

--------------------------------

### Configure spare servers

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/server_tuning.html

Example settings for dynamic process management to handle sync-client bursts.

```ini
pm.min_spare_servers = 4    # adjust upward for many connected clients
pm.max_spare_servers = 16
```

--------------------------------

### Initialize PostgreSQL Database

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Initialize the PostgreSQL data directory and start the server as the _postgresql user.

```bash
$ su - _postgresql
$ mkdir /var/postgresql/data
$ initdb -D /var/postgresql/data -U postgres -A md5 -E UTF8 -W
...
Enter new superuser password: PASSWORD
Enter it again: PASSWORD
...
Success. You can now start the database server using:

pg_ctl -D /var/postgresql/data -l logfile start

$ pg_ctl -D /var/postgresql/data -l logfile start
server starting
$ exit
```

--------------------------------

### Install yum-utils

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Installs the yum-utils package to provide the yum-config-manager command.

```bash
dnf install yum-utils
```

--------------------------------

### Start MySQL or MariaDB command line interface

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/linux_database_configuration.html

Commands to access the database shell for user and database creation.

```bash
mysql -uroot -p
```

```bash
mariadb -uroot -p
```

--------------------------------

### List configuration commands

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_apps.html

Displays the available commands for managing server and app configurations.

```bash
config
 config:app:delete      Delete an app config value
 config:app:get         Get an app config value
 config:app:set         Set an app config value
 config:import          Import a list of configs
 config:list            List all configs
 config:system:delete   Delete a system config value
 config:system:get      Get a system config value
 config:system:set      Set a system config value
```

--------------------------------

### Enable an ExApp

Source: https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/ManagingExApps.html

Enables a registered ExApp.

```bash
app_api:app:enable <appid>
```

--------------------------------

### List installed apps

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_apps.html

Commands to list installed applications with filtering options.

```bash
sudo -E -u www-data php occ app:list
```

```bash
sudo -E -u www-data php occ app:list --enabled
```

```bash
sudo -E -u www-data php occ app:list --shipped false
```

--------------------------------

### Implement Manual-Install resolveExAppUrl

Source: https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/DeployConfigurations.html

A basic implementation of the resolveExAppUrl function for the Manual-Install deploy type.

```php
public function resolveExAppUrl(
    string $appId, string $protocol, string $host, array $deployConfig, int $port, array &$auth
): string {
    if (boolval($deployConfig['harp'] ?? false)) {
        $url = rtrim($deployConfig['nextcloud_url'], '/');
        if (str_ends_with($url, '/index.php')) {
            $url = substr($url, 0, -10);
        }
        return sprintf('%s/exapps/%s', $url, $appId);
    }
```

--------------------------------

### Initialize Key-Value Store Configuration

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html

Starts the configuration array for the Key-Value store used for in-memory caching.

```php
'memcache.kvstore' => [
```

--------------------------------

### Configure installed status

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html

Indicates the installation status of the Nextcloud instance, defaulting to false.

```php
'installed' => false,
```

--------------------------------

### Create database user and database

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/linux_database_configuration.html

SQL commands to set up the Nextcloud database and user privileges.

```sql
CREATE USER 'username'@'localhost' IDENTIFIED BY 'password';
CREATE DATABASE IF NOT EXISTS nextcloud CHARACTER SET utf8mb4 COLLATE utf8mb4_bin;
GRANT ALL PRIVILEGES on nextcloud.* to 'username'@'localhost';
```

--------------------------------

### Non-interactive account provisioning commands

Source: https://docs.nextcloud.com/server/latest/admin_manual/desktop/massdeployment.html

Use these commands to automate account setup without user interaction. Ensure the local directory is empty and the server URL is correct.

```windows
"C:\Program Files\Nextcloud\nextcloud.exe" ^
  --userid admin ^
  --apppassword Jliy12356785jxnHa2ZCiZ9MX48ncECwDso95Pq3a5HABjY34ZvhZiXrPfpKWUg7aOHAX5 ^
  --serverurl https://cloud.example.com ^
  --localdirpath "D:\Nextcloud-sync-folder" ^
  --remotedirpath /Music ^
  --isvfsenabled 1
```

```linux
nextcloud \
  --userid admin \
  --apppassword Jliy12356785jxnHa2ZCiZ9MX48ncECwDso95Pq3a5HABjY34ZvhZiXrPfpKWUg7aOHAX5 \
  --serverurl https://cloud.example.com \
  --localdirpath "/home/admin/Nextcloud-sync-folder" \
  --remotedirpath /Music \
  --isvfsenabled 0
```

```macos
nextcloud \
  --userid admin \
  --apppassword Jliy12356785jxnHa2ZCiZ9MX48ncECwDso95Pq3a5HABjY34ZvhZiXrPfpKWUg7aOHAX5 \
  --serverurl https://cloud.example.com \
  --localdirpath "/Users/admin/Nextcloud-sync-folder" \
  --remotedirpath /Music \
  --isvfsenabled 1
```

--------------------------------

### Add a new user

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_users.html

Syntax and examples for creating new users with various options like group assignment, environment-based passwords, and email notifications.

```bash
user:add [--password-from-env] [--generate-password] [--display-name[="..."]] [-g|--group[="..."]] [--email EMAIL] uid
```

```bash
sudo -E -u www-data php occ user:add --display-name="Layla Smith" \
  --group="users" --group="db-admins" layla
  Enter password:
  Confirm password:
  The user "layla" was created successfully
  Display name set to "Layla Smith"
  User "layla" added to group "users"
  User "layla" added to group "db-admins"
```

```bash
export OC_PASS=newpassword
sudo -E -u www-data php occ user:add --password-from-env \
  --display-name="Layla Smith" --group="users" layla
The user "layla" was created successfully
Display name set to "Layla Smith"
User "layla" added to group "users"
```

```bash
sudo -E -u www-data php occ user:add layla --generate-password --email layla@example.tld
  The account "layla" was created successfully
  Welcome email sent to layla@example.tld
```

```bash
sudo -E -u www-data php occ user:add layla --email layla@example.tld
  Enter password:
  Confirm password:
  The account "layla" was created successfully
  Welcome email sent to layla@example.tld
```

--------------------------------

### Enable Recommended Apache Modules

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/source_installation.html

Commands to enable recommended modules for improved performance and compatibility.

```bash
a2enmod headers
a2enmod env
a2enmod dir
a2enmod mime
```

```bash
a2enmod setenvif
```

--------------------------------

### View Theming Configuration

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_system.html

Display all current theming settings or the value of a specific key.

```bash
sudo -E -u www-data php occ theming:config
```

```bash
sudo -E -u www-data php occ theming:config name
```

--------------------------------

### Install Remi repository configuration

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_centos.html

Installs the configuration package for the Remi repository on CentOS 8.

```bash
dnf install https://rpms.remirepo.net/enterprise/remi-release-8.rpm
```

--------------------------------

### Install ClamAV on Debian/Ubuntu

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/antivirus_configuration.html

Use apt-get to install the ClamAV package and daemon on Debian-based systems.

```bash
apt-get install clamav clamav-daemon
```

--------------------------------

### Create PostgreSQL User and Database (Peer Authentication)

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/linux_database_configuration.html

SQL commands to set up the database and user for Nextcloud when using peer authentication.

```sql
CREATE USER username CREATEDB;
CREATE DATABASE nextcloud OWNER username TEMPLATE template0 ENCODING 'UTF8';
GRANT CREATE ON SCHEMA public TO username;
```

--------------------------------

### Install ClamAV on RHEL/CentOS 7

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/antivirus_configuration.html

Install the EPEL repository and required ClamAV packages on RedHat-based systems.

```bash
yum install epel-release
yum install clamav clamav-scanner clamav-scanner-systemd clamav-server
clamav-server-systemd clamav-update
```

--------------------------------

### Example dynamic PHP-FPM configuration

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/server_tuning.html

A baseline configuration for dynamic mode on a server with 2 GB of RAM dedicated to PHP.

```ini
pm = dynamic
pm.max_children = 30
pm.start_servers = 8
pm.min_spare_servers = 4
pm.max_spare_servers = 16
pm.max_requests = 500
```

--------------------------------

### Enable and Start ClamAV Service

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/antivirus_configuration.html

Use systemctl to enable and start the clamd service on RHEL/CentOS systems.

```bash
systemctl enable clamd@scan.service
systemctl start clamd@scan.service
```

--------------------------------

### Sample config.php for SQLite

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html

Typical configuration array for a fresh Nextcloud installation using the SQLite database driver.

```php
<?php
$CONFIG = array (
  'instanceid' => 'occ6f7365735',
  'passwordsalt' => '2c5778476346786306303',
  'trusted_domains' =>
  array (
    0 => 'localhost',
    1 => 'studio',
  ),
  'datadirectory' => '/var/www/nextcloud/data',
  'dbtype' => 'sqlite3',
  'version' => '7.0.2.1',
  'installed' => true,
);
```

--------------------------------

### Search or get groups via cURL

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/instruction_set_for_groups.html

Retrieves a list of groups from the server using a GET request.

```bash
$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/groups?search=adm -H "OCS-APIRequest: true"
```

```xml
<?xml version="1.0"?>
<ocs>
  <meta>
    <statuscode>100</statuscode>
    <status>ok</status>
  </meta>
  <data>
    <groups>
      <element>admin</element>
    </groups>
  </data>
</ocs>
```

--------------------------------

### Configure Euro Office in config.php

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/euro-office/configuration.html

Define settings directly in the config.php file. Note that verify_peer_off must be a string value.

```php
"eurooffice" => [
    "DocumentServerUrl" => "https://office.example.com/",
    "jwt_secret" => "your-secret",
    "verify_peer_off" => "true",
],
```

--------------------------------

### Get app information via cURL

Source: https://docs.nextcloud.com/server/latest/admin_manual/apps_management_api.html

Retrieves details for a specific application using a GET request.

```bash
$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/apps/files -H "OCS-APIRequest: true"
```

--------------------------------

### Start SMB update notifications

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/external_storage/smb.html

Use the occ command to begin listening for changes on a specific SMB mount.

```bash
occ files_external:notify <mount_id>
```

--------------------------------

### Install Euro-Office via OCC

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/euro-office/configuration.html

Command to install the Euro-Office application using the Nextcloud occ command-line tool.

```bash
sudo -E -u www-data php occ app:install eurooffice
```

--------------------------------

### Access MySQL command line

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_ubuntu.html

Opens the MySQL interface to perform database setup.

```bash
sudo mysql
```

--------------------------------

### Install Data Request App

Source: https://docs.nextcloud.com/server/latest/admin_manual/gdpr/helpful_apps.html

Command to install the Data Request app via the occ command-line interface.

```bash
sudo -E -u www-data php occ app:install data_request
```

--------------------------------

### List Versions Commands

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_files.html

Displays available commands for the Versions app.

```bash
versions
 versions:cleanup  delete file versions
 versions:expire   expire file versions according to the configured retention policy
```

--------------------------------

### Install Drop Account App

Source: https://docs.nextcloud.com/server/latest/admin_manual/gdpr/helpful_apps.html

Command to install the Drop Account app via the occ command-line interface.

```bash
sudo -E -u www-data php occ app:install drop_account
```

--------------------------------

### Create PostgreSQL User and Database (Password Authentication)

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_database/linux_database_configuration.html

SQL commands to set up the database and user for Nextcloud when using password authentication.

```sql
CREATE USER username WITH PASSWORD 'password' CREATEDB;
CREATE DATABASE nextcloud TEMPLATE template0 ENCODING 'UTF8';
ALTER DATABASE nextcloud OWNER TO username;
GRANT ALL PRIVILEGES ON DATABASE nextcloud TO username;
GRANT ALL PRIVILEGES ON SCHEMA public TO username;
```

--------------------------------

### Define app allowlist

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html

Filters which apps are installable from the app store. An empty array prevents all app store installations.

```php
'appsallowlist' => [],
```

--------------------------------

### Install Collabora Online Packages

Source: https://docs.nextcloud.com/server/latest/admin_manual/office/example-ubuntu.html

Updates the package list and installs the core Collabora Online server and branding packages.

```bash
sudo apt update && sudo apt install coolwsd code-brand
```

--------------------------------

### Customize Installed Features via MSI

Source: https://docs.nextcloud.com/server/latest/admin_manual/desktop/massdeployment.html

Control specific features like desktop shortcuts or shell extensions during or after installation.

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi REMOVE=DesktopShortcut
```

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi ADDDEFAULT=Client
```

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi ADDDEFAULT=StartMenuShortcuts
```

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi NO_DESKTOP_SHORTCUT="1" NO_SHELL_EXTENSIONS="1"
```

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi ADDDEFAULT="DesktopShortcut"
```

```bash
msiexec /passive /i Nextcloud-x.y.z-x64.msi REMOVE="DesktopShortcut"
```

--------------------------------

### Example account export output

Source: https://docs.nextcloud.com/server/latest/admin_manual/groupware/troubleshooting.html

Sample output showing account details including the account ID.

```text
Account 1393:
- E-Mail: christoph@domain.com
- Name: Christoph Wurst
- IMAP user: christoph
- IMAP host: mx.domain.com:993, security: ssl
- SMTP user: christoph
- SMTP host: mx.domain.com:587, security: tls
```

--------------------------------

### Get Single User Details via cURL

Source: https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/instruction_set_for_users.html

Retrieves information for a specific user by their ID using a GET request.

```bash
$ curl -X GET http://admin:secret@example.com/ocs/v1.php/cloud/users/Frank -H "OCS-APIRequest: true"
```

--------------------------------

### Disable example events configuration

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_database.html

Sets the dav application configuration to prevent the automatic creation of example events for new users.

```bash
sudo -E -u www-data php occ config:app:set dav create_example_event \
  --value=false --type=boolean
```

--------------------------------

### List Preview Commands

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_files.html

Displays available commands for managing preview files.

```bash
preview
 preview:cleanup                      remove all generated preview files
```

--------------------------------

### Enable PHP Modules

Source: https://docs.nextcloud.com/server/latest/admin_manual/installation/example_openbsd.html

Create symbolic links to enable the required PHP modules on OpenBSD.

```bash
# cd /etc/php-8.2.sample
# for i in *; do ln -sf ../php-8.2.sample/$i ../php-8.2/; done
```

--------------------------------

### Import configuration values

Source: https://docs.nextcloud.com/server/latest/admin_manual/occ_apps.html

Commands to import configuration settings from a file or via piped input.

```bash
sudo -E -u www-data php occ config:import filename.json
```

```bash
sudo -E -u www-data php occ config:import < local-backup.json
```

--------------------------------

### Register manual install deploy daemon with HaRP

Source: https://docs.nextcloud.com/server/latest/admin_manual/exapps_management/ManagingDeployDaemons.html

Registers a daemon for manual installations where ExApps are launched manually by the user rather than via Docker containers.

```bash
app_api:daemon:register manual_install_harp "Harp Manual Install" "manual-install" "http" "appapi-harp:8780" "http://nextcloud.local" --net nextcloud --harp --harp_frp_address "appapi-harp:8782" --harp_shared_key "some_very_secure_password"
```
Tokens:
Raw