File Manager - BorneoXploit

Editing: occ_command.html

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
 <meta charset="utf-8" />
 <meta name="readthedocs-addons-api-version" content="1"><meta name="viewport" content="width=device-width, initial-scale=1" />

<a href="contents.html">
 
 <img src="_static/logo-white.png" class="logo" alt="Logo"/>
 </a>
 <div class="switch-menus">
 <div class="version-switch"></div>
 <div class="language-switch"></div>
 </div>
<div role="search">
 <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
 <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
 <input type="hidden" name="check_keywords" value="yes" />
 <input type="hidden" name="area" value="default" />
 </form>
</div>
 </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
 Getting Started
<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="release_schedule.html">Maintenance and release schedule</a></li>
<li class="toctree-l1"><a class="reference internal" href="gdpr/index.html">GDPR-compliance</a></li>
<li class="toctree-l1"><a class="reference internal" href="declarations/index.html">Declarations</a></li>
</ul>
Release notes
<ul>
<li class="toctree-l1"><a class="reference internal" href="release_notes/index.html">Critical changes</a></li>
</ul>
Installation
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Installation and server configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration_database/index.html">Database configuration</a></li>
</ul>
Configuration
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="configuration_server/index.html">Nextcloud configuration</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Using the occ command</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#occ-command-directory">occ command Directory</a></li>
<li class="toctree-l2"><a class="reference internal" href="#run-occ-as-your-http-user">Run occ as your HTTP user</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#environment-variables">Environment variables</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#enabling-autocompletion">Enabling autocompletion</a></li>
<li class="toctree-l2"><a class="reference internal" href="#run-commands-in-maintenance-mode">Run commands in maintenance mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="#apps-commands">Apps commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#background-jobs-selector">Background jobs selector</a></li>
<li class="toctree-l2"><a class="reference internal" href="#config-commands">Config commands</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#getting-a-single-configuration-value">Getting a single configuration value</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setting-a-single-configuration-value">Setting a single configuration value</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setting-an-array-configuration-value">Setting an array configuration value</a></li>
<li class="toctree-l3"><a class="reference internal" href="#setting-a-hierarchical-configuration-value">Setting a hierarchical configuration value</a></li>
<li class="toctree-l3"><a class="reference internal" href="#deleting-a-single-configuration-value">Deleting a single configuration value</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#dav-commands">Dav commands</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#manage-addressbooks">Manage addressbooks</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#list-all-addressbooks-of-a-user">List all addressbooks of a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#create-a-addressbook-for-a-user">Create a addressbook for a user</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#manage-calendars">Manage calendars</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#list-all-calendars-of-a-user">List all calendars of a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#create-a-calendar-for-a-user">Create a calendar for a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#delete-a-calendar-for-a-user">Delete a calendar for a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#move-a-calendar-of-a-user">Move a calendar of a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#export-a-calendar-of-a-user">Export a calendar of a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#import-a-calendar-to-a-user">Import a calendar to a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#misc">Misc</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#manage-calendar-subscriptions">Manage calendar subscriptions</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#list-all-calendar-subscriptions-of-a-user">List all calendar subscriptions of a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#create-a-calendar-subscription-for-a-user">Create a calendar subscription for a user</a></li>
<li class="toctree-l4"><a class="reference internal" href="#delete-a-calendar-subscription-for-a-user">Delete a calendar subscription for a user</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#sync-system-address-book">Sync system address book</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sync-birthday-calendar">Sync birthday calendar</a></li>
<li class="toctree-l3"><a class="reference internal" href="#disable-creation-of-example-events">Disable creation of example events</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#database-conversion">Database conversion</a></li>
<li class="toctree-l2"><a class="reference internal" href="#add-missing-indices">Add missing indices</a></li>
<li class="toctree-l2"><a class="reference internal" href="#encryption">Encryption</a></li>
<li class="toctree-l2"><a class="reference internal" href="#federation-sync">Federation sync</a></li>
<li class="toctree-l2"><a class="reference internal" href="#file-operations">File operations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#scan">Scan</a></li>
<li class="toctree-l3"><a class="reference internal" href="#scan-appdata">Scan appdata</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cleanup-previews">Cleanup previews</a></li>
<li class="toctree-l3"><a class="reference internal" href="#cleanup">Cleanup</a></li>
<li class="toctree-l3"><a class="reference internal" href="#repair-tree">Repair-Tree</a></li>
<li class="toctree-l3"><a class="reference internal" href="#sanitize-filenames">Sanitize filenames</a></li>
<li class="toctree-l3"><a class="reference internal" href="#transfer">Transfer</a></li>
<li class="toctree-l3"><a class="reference internal" href="#toggle-windows-compatibility">Toggle Windows compatibility</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#files-sharing">Files Sharing</a></li>
<li class="toctree-l2"><a class="reference internal" href="#files-external">Files external</a></li>
<li class="toctree-l2"><a class="reference internal" href="#integrity-check">Integrity check</a></li>
<li class="toctree-l2"><a class="reference internal" href="#l10n-create-javascript-translation-files-for-apps">l10n, create JavaScript translation files for apps</a></li>
<li class="toctree-l2"><a class="reference internal" href="#ldap-commands">LDAP commands</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#ldap-search">ldap:search</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-check-user">ldap:check-user</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-check-group">ldap:check-group</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-create-empty-config">ldap:create-empty-config</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-delete-config">ldap:delete-config</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-set-config">ldap:set-config</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-test-config">ldap:test-config</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-test-user-settings">ldap:test-user-settings</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-show-remnants">ldap:show-remnants</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#logging-commands">Logging commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#maintenance-commands">Maintenance commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#security">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="#status">Status</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#status-return-code">Status return code</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#trashbin">Trashbin</a></li>
<li class="toctree-l2"><a class="reference internal" href="#user-commands">User commands</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#user-add">user:add</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-resetpassword">user:resetpassword</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-delete">user:delete</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-lastseen">user:lastseen</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-profile">user:profile</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-setting">user:setting</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-report">user:report</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-list">user:list</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-info">user:info</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#group-commands">Group commands</a></li>
<li class="toctree-l2"><a class="reference internal" href="#versions">Versions</a></li>
<li class="toctree-l2"><a class="reference internal" href="#command-line-installation">Command line installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="#command-line-upgrade">Command line upgrade</a></li>
<li class="toctree-l2"><a class="reference internal" href="#two-factor-authentication">Two-factor authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="#disable-users">Disable users</a></li>
<li class="toctree-l2"><a class="reference internal" href="#system-tags">System Tags</a></li>
<li class="toctree-l2"><a class="reference internal" href="#antivirus">Antivirus</a></li>
<li class="toctree-l2"><a class="reference internal" href="#setupchecks">Setupchecks</a></li>
<li class="toctree-l2"><a class="reference internal" href="#snowflake-ids">Snowflake IDs</a></li>
<li class="toctree-l2"><a class="reference internal" href="#share-operations">Share operations</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#list">List</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#debugging">Debugging</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">Reference management</a></li>
<li class="toctree-l1"><a class="reference internal" href="webhook_listeners/index.html">Webhook Listeners</a></li>
<li class="toctree-l1"><a class="reference internal" href="windmill_workflows/index.html">Windmill Workflows</a></li>
</ul>
Files
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="file_workflows/index.html">Flow</a></li>
<li class="toctree-l1"><a class="reference internal" href="configuration_mimetypes/index.html">Mimetypes management</a></li>
</ul>
Apps
<ul>
<li class="toctree-l1"><a class="reference internal" href="apps_management.html">Apps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="exapps_management/index.html">ExApps management</a></li>
<li class="toctree-l1"><a class="reference internal" href="ai/index.html">Artificial Intelligence</a></li>
</ul>
Users
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration_user/index.html">User management</a></li>
<li class="toctree-l1"><a class="reference internal" href="desktop/index.html">Desktop Clients</a></li>
</ul>
Groupware
<ul>
<li class="toctree-l1"><a class="reference internal" href="groupware/index.html">Groupware</a></li>
</ul>
Office
<ul>
<li class="toctree-l1"><a class="reference internal" href="office/index.html">Office</a></li>
</ul>
Maintenance
<ul>
<li class="toctree-l1"><a class="reference internal" href="configuration_monitoring/index.html">Monitoring</a></li>
<li class="toctree-l1"><a class="reference internal" href="maintenance/index.html">Maintenance</a></li>
<li class="toctree-l1"><a class="reference internal" href="issues/index.html">Issues and troubleshooting</a></li>
</ul>
Links
<ul>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/">Community Help Forum</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">User Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://docs.nextcloud.com/">Developer Manuals</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/install/">Download</a></li>
<li class="toctree-l1"><a class="reference external" href="https://apps.nextcloud.com">App Store</a></li>
<li class="toctree-l1"><a class="reference external" href="https://help.nextcloud.com/t/translation-knowledge-valid-for-the-entire-nextcloud-project-wiki/51550">Translations</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/">GitHub</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/wiki/Maintenance-and-Release-Schedule">Supported versions</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/enterprise/">Nextcloud Enterprise</a></li>
<li class="toctree-l1"><a class="reference external" href="https://github.com/nextcloud/server/blob/master/COPYING-README">License</a></li>
<li class="toctree-l1"><a class="reference external" href="https://nextcloud.com/">Nextcloud GmbH</a></li>
</ul>

</div>
 </div>
 </nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
 
 <a href="contents.html">Nextcloud latest Administration Manual</a>
 </nav>

<div class="wy-nav-content">
 <div class="rst-content style-external-links">
 <div role="navigation" aria-label="Page navigation">
 <ul class="wy-breadcrumbs">
 <li><a href="contents.html" class="icon icon-home" aria-label="Home"></a></li>
 <li class="breadcrumb-item active">Using the occ command</li>
 <li class="wy-breadcrumbs-aside">
 <a href="https://github.com/nextcloud/documentation/edit/master/admin_manual/occ_command.rst" class="fa fa-github"> Edit on GitHub</a>
 </li>
 </ul>
 <hr/>
</div>
 <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
 <div itemprop="articleBody">
 
 <section id="using-the-occ-command">
<h1>Using the occ command<a class="headerlink" href="#using-the-occ-command" title="Link to this heading"></a></h1>
Nextcloud’s <code class="docutils literal notranslate">occ</code> command (origins from “ownCloud Console”) is Nextcloud’s command-line
interface. You can perform many common server operations with <code class="docutils literal notranslate">occ</code>, such as
installing and upgrading Nextcloud, manage users, encryption, passwords, LDAP
setting, and more.
<code class="docutils literal notranslate">occ</code> is in the <code class="file docutils literal notranslate">nextcloud/</code> directory; for example
<code class="file docutils literal notranslate">/var/www/nextcloud</code> on Ubuntu Linux. <code class="docutils literal notranslate">occ</code> is a PHP script. You must
run it as your HTTP user to ensure that the correct permissions are maintained
on your Nextcloud files and directories.
<section id="occ-command-directory">
<h2>occ command Directory<a class="headerlink" href="#occ-command-directory" title="Link to this heading"></a></h2>
<ul class="simple">
<li><a class="reference internal" href="#http-user-label">Run occ as your HTTP user</a></li>
<li><a class="reference internal" href="#run-commands-in-maintenance-mode">Run commands in maintenance mode</a></li>
<li><a class="reference internal" href="#apps-commands-label">Apps commands</a></li>
<li><a class="reference internal" href="#background-jobs-selector-label">Background jobs selector</a></li>
<li><a class="reference internal" href="#config-commands-label">Config commands</a></li>
<li><a class="reference internal" href="#dav-label">Dav commands</a></li>
<li><a class="reference internal" href="#database-conversion-label">Database conversion</a></li>
<li><a class="reference internal" href="#database-add-indices-label">Add missing indices</a></li>
<li><a class="reference internal" href="#encryption-label">Encryption</a></li>
<li><a class="reference internal" href="#federation-sync-label">Federation sync</a></li>
<li><a class="reference internal" href="#file-operations-label">File operations</a></li>
<li><a class="reference internal" href="#files-external-label">Files external</a></li>
<li><a class="reference internal" href="#integrity-check-label">Integrity check</a></li>
<li><a class="reference internal" href="#create-javascript-translation-files-label">l10n, create JavaScript translation files for apps</a></li>
<li><a class="reference internal" href="#ldap-commands-label">LDAP commands</a></li>
<li><a class="reference internal" href="#logging-commands-label">Logging commands</a></li>
<li><a class="reference internal" href="#maintenance-commands-label">Maintenance commands</a></li>
<li><a class="reference internal" href="#security-commands-label">Security</a></li>
<li><a class="reference internal" href="#trashbin-label">Trashbin</a></li>
<li><a class="reference internal" href="#user-commands-label">User commands</a></li>
<li><a class="reference internal" href="#group-commands-label">Group commands</a></li>
<li><a class="reference internal" href="#versions-label">Versions</a></li>
<li><a class="reference internal" href="#command-line-installation-label">Command line installation</a></li>
<li><a class="reference internal" href="#command-line-upgrade-label">Command line upgrade</a></li>
<li><a class="reference internal" href="#two-factor-auth-label">Two-factor authentication</a></li>
<li><a class="reference internal" href="#disable-user-label">Disable users</a></li>
<li><a class="reference internal" href="#system-tags-commands-label">System Tags</a></li>
<li><a class="reference internal" href="#antivirus-commands-label">Antivirus</a></li>
<li><a class="reference internal" href="#setupchecks-commands-label">Setupchecks</a></li>
<li><a class="reference internal" href="#snowflakes-commands-label">Snowflake IDs</a></li>
<li><a class="reference internal" href="#share-operations-label">Share operations</a></li>
<li><a class="reference internal" href="#debugging">Debugging</a></li>
</ul>
</section>
<section id="run-occ-as-your-http-user">
<h2>Run occ as your HTTP user<a class="headerlink" href="#run-occ-as-your-http-user" title="Link to this heading"></a></h2>
The HTTP user is different on the various Linux distributions:
<ul class="simple">
<li>The HTTP user and group in Debian/Ubuntu is www-data.</li>
<li>The HTTP user and group in Fedora/CentOS is apache.</li>
<li>The HTTP user and group in Arch Linux is http.</li>
<li>The HTTP user in openSUSE is wwwrun, and the HTTP group is www.</li>
</ul>
If your HTTP server is configured to use a different PHP version than the
default (/usr/bin/php), <code class="docutils literal notranslate">occ</code> should be run with the same version. For
example, in CentOS 6.5 with SCL-PHP70 installed, the command looks like this:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -u apache /opt/rh/php70/root/usr/bin/php /var/www/html/nextcloud/occ
</pre></div>
</div>
<div class="admonition note">
Note
Although the following examples make use of the <code class="docutils literal notranslate">sudo -u ... /path/to/php /path/to/occ</code> method, your environment may require use of a different wrapper utility than <code class="docutils literal notranslate">sudo</code> to execute the command as the appropriate user. Other common wrappers:
<ul class="simple">
<li><code class="docutils literal notranslate">su --command '/path/to/php ...' username</code> – Note here that the target user specification comes at the end, and the command to execute is specified first.</li>
<li><code class="docutils literal notranslate">runuser --user username -- /path/to/php ...</code> – This wrapper might be used in container contexts (ex: Docker / <code class="docutils literal notranslate">arm32v7/nextcloud</code>) where both <code class="docutils literal notranslate">sudo</code> and <code class="docutils literal notranslate">su</code> wrapper utilities cannot be used.</li>
</ul>
</div>
Running <code class="docutils literal notranslate">occ</code> with no options lists all commands and options, like this
example on Ubuntu:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ
Nextcloud version 19.0.0

Usage:
 command [options] [arguments]

Options:
 -h, --help Display this help message
 -q, --quiet Do not output any message
 -V, --version Display this application version
 --ansi Force ANSI output
 --no-ansi Disable ANSI output
 -n, --no-interaction Do not ask any interactive question
 --no-warnings Skip global warnings, show command output only
 -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output,
 2 for more verbose output and 3 for debug

Available commands:
 check check dependencies of the server
 environment
 help Displays help for a command
 list Lists commands
 status show some status information
 upgrade run upgrade routines after installation of
 a new release. The release has to be
 installed before.
</pre></div>
</div>
This is the same as <code class="docutils literal notranslate">sudo -E -u www-data php occ list</code>.
Run it with the <code class="docutils literal notranslate">-h</code> option for syntax help:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ -h
</pre></div>
</div>
Display your Nextcloud version:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ -V
 Nextcloud version 19.0.0
</pre></div>
</div>
Query your Nextcloud server status:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ status
 - installed: true
 - version: 19.0.0.12
 - versionstring: 19.0.0
 - edition:
</pre></div>
</div>
<code class="docutils literal notranslate">occ</code> has options, commands, and arguments. Options and arguments are
optional, while commands are required. The syntax is:
<div class="highlight-default notranslate"><div class="highlight"><pre>occ [options] command [arguments]
</pre></div>
</div>
Get detailed information on individual commands with the <code class="docutils literal notranslate">help</code> command, like
this example for the <code class="docutils literal notranslate">maintenance:mode</code> command:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ help maintenance:mode
Usage:
 maintenance:mode [options]

Options:
 --on enable maintenance mode
 --off disable maintenance mode
 -h, --help Display this help message
 -q, --quiet Do not output any message
 -V, --version Display this application version
 --ansi Force ANSI output
 --no-ansi Disable ANSI output
 -n, --no-interaction Do not ask any interactive question
 --no-warnings Skip global warnings, show command output only
 -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output,
 2 for more verbose output and 3 for debug
</pre></div>
</div>
The <code class="docutils literal notranslate">status</code> command from above has an option to define the output format.
The default is plain text, but it can also be <code class="docutils literal notranslate">json</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ status --output=json
{&quot;installed&quot;:true,&quot;version&quot;:&quot;19.0.0.9&quot;,&quot;versionstring&quot;:&quot;19.0.0&quot;,&quot;edition&quot;:&quot;&quot;}
</pre></div>
</div>
or <code class="docutils literal notranslate">json_pretty</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ status --output=json_pretty
{
 &quot;installed&quot;: true,
 &quot;version&quot;: &quot;19.0.0.12&quot;,
 &quot;versionstring&quot;: &quot;19.0.0&quot;,
 &quot;edition&quot;: &quot;&quot;
}
</pre></div>
</div>
This output option is available on all list and list-like commands:
<code class="docutils literal notranslate">status</code>, <code class="docutils literal notranslate">check</code>, <code class="docutils literal notranslate">app:list</code>, <code class="docutils literal notranslate">config:list</code>, <code class="docutils literal notranslate">encryption:status</code>
and <code class="docutils literal notranslate">encryption:list-modules</code>
<section id="environment-variables">
<h3>Environment variables<a class="headerlink" href="#environment-variables" title="Link to this heading"></a></h3>
<code class="docutils literal notranslate">sudo</code> does not forward environment variables by default. Put the variables before the <code class="docutils literal notranslate">php</code> command:
<div class="highlight-default notranslate"><div class="highlight"><pre>NC_debug=true sudo -E -u www-data php occ status
</pre></div>
</div>
Alternatively, you can <code class="docutils literal notranslate">export</code> the variable or use the <code class="docutils literal notranslate">-E</code> switch for <code class="docutils literal notranslate">sudo</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>NC_debug=true sudo -E -u www-data php occ status
</pre></div>
</div>
</section>
</section>
<section id="enabling-autocompletion">
<h2>Enabling autocompletion<a class="headerlink" href="#enabling-autocompletion" title="Link to this heading"></a></h2>
<div class="admonition note">
Note
Command autocompletion currently only works if the user you use to execute the occ commands has a profile.
<code class="docutils literal notranslate">www-data</code> in most cases is <code class="docutils literal notranslate">nologon</code> and therefore cannot use this feature.
</div>
Autocompletion is available for bash (and bash based consoles).
To enable it, you have to run one of the following commands:
<div class="highlight-default notranslate"><div class="highlight"><pre># BASH ~4.x, ZSH
source &lt;(/var/www/html/nextcloud/occ _completion --generate-hook)

# BASH ~3.x, ZSH
/var/www/html/nextcloud/occ _completion --generate-hook | source /dev/stdin

# BASH (any version)
eval $(/var/www/html/nextcloud/occ _completion --generate-hook)
</pre></div>
</div>
This will allow you to use autocompletion with the full path <code class="docutils literal notranslate">/var/www/html/nextcloud/occ &lt;tab&gt;</code>.
If you also want to use autocompletion on occ from within the directory without using the full path,
you need to specify <code class="docutils literal notranslate">--program occ</code> after the <code class="docutils literal notranslate">--generate-hook</code>.
If you want the completion to apply automatically for all new shell sessions, add the command to your
shell’s profile (eg. <code class="docutils literal notranslate">~/.bash_profile</code> or <code class="docutils literal notranslate">~/.zshrc</code>).
</section>
<section id="run-commands-in-maintenance-mode">
<h2>Run commands in maintenance mode<a class="headerlink" href="#run-commands-in-maintenance-mode" title="Link to this heading"></a></h2>
In maintenance mode, apps are not loaded <a class="footnote-reference brackets" href="#id4" id="id2" role="doc-noteref">[1]</a>, so commands from apps are unavailable. Commands integrated into Nextcloud server are available in maintenance mode.
We discourage the use of maintenance mode unless the command explicitly prompts you to do so or unless the commands’ documentation explicitly states that maintenance mode should be used.
A command may use events to communicate with other apps. An app can only react to an event when loaded. Example: The command user:delete deletes a user account. UserDeletedEvent is emitted. Calendar app implements an event listener to delete user data <a class="footnote-reference brackets" href="#id5" id="id3" role="doc-noteref">[2]</a>. In maintenance mode, the Calendar app is not loaded, and hence the user data not deleted.
<aside class="footnote-list brackets">
<aside class="footnote brackets" id="id4" role="doc-footnote">
[<a role="doc-backlink" href="#id2">1</a>]
Exception: <a class="reference external" href="https://github.com/nextcloud/server/blob/75f17b60945e15effc3eea41393eef2b13937226/lib/base.php#L780">The settings app is loaded</a>
</aside>
<aside class="footnote brackets" id="id5" role="doc-footnote">
[<a role="doc-backlink" href="#id3">2</a>]
<a class="reference external" href="https://github.com/nextcloud/calendar/blob/87e8586971a8676dc15a90f0cd969274678b7009/lib/Listener/UserDeletedListener.php">Calendar app event listener for UserDeletedEvent</a>
</aside>
</aside>
</section>
<section id="apps-commands">
<h2>Apps commands<a class="headerlink" href="#apps-commands" title="Link to this heading"></a></h2>
The <code class="docutils literal notranslate">app</code> commands list, enable, and disable apps:
<div class="highlight-default notranslate"><div class="highlight"><pre>app
 app:install install selected app
 app:disable disable an app
 app:enable enable an app
 app:getpath get an absolute path to the app directory
 app:list list all available apps
 app:update update an app or all apps
 app:remove disable and remove an app
</pre></div>
</div>
Download and install an app:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:install twofactor_totp
</pre></div>
</div>
Install but don’t enable:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:install --keep-disabled twofactor_totp
</pre></div>
</div>
Install regardless of the Nextcloud version requirement:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:install --force twofactor_totp
</pre></div>
</div>
List all of your installed apps, and show whether they are
enabled or disabled:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:list
</pre></div>
</div>
List all of your installed and enabled (flag <code class="docutils literal notranslate">--enabled</code>) or disabled (flag <code class="docutils literal notranslate">--disabled</code>) apps:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:list --enabled
</pre></div>
</div>
List non-shipped installed apps only:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:list --shipped false
</pre></div>
</div>
Enable an app, for example the External Storage Support app:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:enable files_external
files_external enabled
</pre></div>
</div>
Enable an app regardless of the Nextcloud version requirement:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:enable --force files_external
files_external enabled
</pre></div>
</div>
Enable an app for specific groups of users (i.e. restrict an app so only specific groups can see and use them):
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:enable --groups admin --groups sales files_external
files_external enabled for groups: admin, sales
</pre></div>
</div>
Enable multiple apps simultaneously:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:enable app1 app2 app3
app1 enabled
app2 enabled
app3 enabled
</pre></div>
</div>
Disable an app:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:disable files_external
files_external disabled
</pre></div>
</div>
Disable and remove an app:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:remove files_external
files_external disabled
files_external 1.21.0 removed
</pre></div>
</div>
Remove an app, but keep the app data:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:remove --keep-data files_external
files_external 1.21.0 removed
</pre></div>
</div>
You can get the full filepath to an app:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:getpath notifications
/var/www/nextcloud/apps/notifications
</pre></div>
</div>
To update an app, for instance Contacts:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:update contacts
</pre></div>
</div>
To update all apps:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:update --all
</pre></div>
</div>
To show available update(s) without updating:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:update --showonly
</pre></div>
</div>
To update an app to an unstable release, for instance News:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:update --allow-unstable news
</pre></div>
</div>
</section>
<section id="background-jobs-selector">
<h2>Background jobs selector<a class="headerlink" href="#background-jobs-selector" title="Link to this heading"></a></h2>
Use the <code class="docutils literal notranslate">background</code> command to select which scheduler you want to use for
controlling background jobs, Ajax, Webcron, or Cron. This is the same as using
the Cron section on your Nextcloud Admin page:
<div class="highlight-default notranslate"><div class="highlight"><pre>background
 background:ajax Use ajax to run background jobs
 background:cron Use cron to run background jobs
 background:webcron Use webcron to run background jobs
</pre></div>
</div>
This example selects Ajax:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ background:ajax
 Set mode for background jobs to &#39;ajax&#39;
</pre></div>
</div>
The other two commands are:
<ul class="simple">
<li><code class="docutils literal notranslate">background:cron</code></li>
<li><code class="docutils literal notranslate">background:webcron</code></li>
</ul>
See <a class="reference internal" href="configuration_server/background_jobs_configuration.html">Background jobs</a> to learn more.
</section>
<section id="config-commands">
<h2>Config commands<a class="headerlink" href="#config-commands" title="Link to this heading"></a></h2>
The <code class="docutils literal notranslate">config</code> commands are used to configure the Nextcloud server:
<div class="highlight-default notranslate"><div class="highlight"><pre>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
</pre></div>
</div>
While setting a configuration value, multiple options are available:
<blockquote>
<div><ul class="simple">
<li><code class="docutils literal notranslate">--value=VALUE</code> change the configuration value</li>
<li><code class="docutils literal notranslate">--type=TYPE</code> change the type of the value. Use carefully; can break your instance</li>
<li><code class="docutils literal notranslate">--lazy|--no-lazy</code> set value as <cite>lazy</cite></li>
<li><code class="docutils literal notranslate">--sensitive|--no-sensitive</code> set value as <cite>sensitive</cite></li>
<li><code class="docutils literal notranslate">--update-only</code> only updates if a value is already stored</li>
</ul>
</div></blockquote>
<div class="admonition note">
Note
See <a class="reference external" href="https://docs.nextcloud.com/server/33/developer_manual/digging_deeper/config/appconfig.html#concept-overview">Appconfig Concepts</a> to learn more about <cite>typed value</cite>, <cite>lazy</cite> and <cite>sensitive</cite> flag.
</div>
You can list all configuration values with one command:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ config:list
</pre></div>
</div>
By default, passwords and other sensitive data are omitted from the report, so
the output can be posted publicly (e.g. as part of a bug report). In order to
generate a full backport of all configuration values the <code class="docutils literal notranslate">--private</code> flag
needs to be set:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ config:list --private
</pre></div>
</div>
The exported content can also be imported again to allow the fast setup of
similar instances. The import command will only add or update values. Values
that exist in the current configuration, but not in the one that is being
imported are left untouched:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ config:import filename.json
</pre></div>
</div>
It is also possible to import remote files, by piping the input:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ config:import &lt; local-backup.json
</pre></div>
</div>
<div class="admonition note">
Note
While it is possible to update/set/delete the versions and installation
statuses of apps and Nextcloud itself, it is not recommended to do this
directly. Use the <code class="docutils literal notranslate">occ app:enable</code>, <code class="docutils literal notranslate">occ app:disable</code> and <code class="docutils literal notranslate">occ app:update</code>
commands instead.
</div>
<section id="getting-a-single-configuration-value">
<h3>Getting a single configuration value<a class="headerlink" href="#getting-a-single-configuration-value" title="Link to this heading"></a></h3>
These commands get the value of a single app or system configuration:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ config:system:get version
19.0.0.12

sudo -E -u www-data php occ config:app:delete appname provisioning_api
Config value provisioning_api of app appname deleted
</pre></div>
</div>
The delete command will by default not complain if the configuration was not set
before. If you want to be notified in that case, set the
<code class="docutils literal notranslate">--error-if-not-exists</code> flag:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ config:system:delete doesnotexist
--error-if-not-exists
Config provisioning_api of app appname could not be deleted because it did not
exist
</pre></div>
</div>
</section>
</section>
<section id="dav-commands">
<h2>Dav commands<a class="headerlink" href="#dav-commands" title="Link to this heading"></a></h2>
Manage addressbooks and calendars:
<div class="highlight-default notranslate"><div class="highlight"><pre>dav
 dav:create-addressbook Create a dav addressbook
 dav:create-calendar Create a dav calendar
 dav:create-subscription Create a dav subscription
 dav:delete-calendar Delete a dav calendar
 dav:delete-subscription Delete a calendar subscription for a user
 dav:fix-missing-caldav-changes Insert missing calendarchanges rows for existing events
 dav:list-addressbooks List all addressbooks of a user
 dav:list-calendars List all calendars of a user
 dav:list-subscriptions List all calendar subscriptions for a user
 dav:move-calendar Move a calendar from an user to another
 dav:remove-invalid-shares Remove invalid dav shares
 dav:retention:clean-up
 dav:send-event-reminders Sends event reminders
 dav:sync-birthday-calendar Synchronizes the birthday calendar
 dav:sync-system-addressbook Synchronizes users to the system addressbook
calendar
 calendar:export Export a calendar of a user
 calendar:import Import a calendar to a user
</pre></div>
</div>
<section id="manage-addressbooks">
<h3>Manage addressbooks<a class="headerlink" href="#manage-addressbooks" title="Link to this heading"></a></h3>
<section id="list-all-addressbooks-of-a-user">
<h4>List all addressbooks of a user<a class="headerlink" href="#list-all-addressbooks-of-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:list-addressbooks &lt;uid&gt;</code>
This example will list all addressbooks for user annie:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:list-addressbooks annie
</pre></div>
</div>
</section>
<section id="create-a-addressbook-for-a-user">
<h4>Create a addressbook for a user<a class="headerlink" href="#create-a-addressbook-for-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:create-addressbook &lt;user&gt; &lt;name&gt;</code>
This example creates the addressbook <code class="docutils literal notranslate">mollybook</code> for the user molly:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:create-addressbook molly mollybook
</pre></div>
</div>
</section>
</section>
<section id="manage-calendars">
<h3>Manage calendars<a class="headerlink" href="#manage-calendars" title="Link to this heading"></a></h3>
<section id="list-all-calendars-of-a-user">
<h4>List all calendars of a user<a class="headerlink" href="#list-all-calendars-of-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:list-calendars &lt;uid&gt;</code>
This example will list all calendars for user annie:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:list-calendars annie
</pre></div>
</div>
</section>
<section id="create-a-calendar-for-a-user">
<h4>Create a calendar for a user<a class="headerlink" href="#create-a-calendar-for-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:create-calendar &lt;user&gt; &lt;name&gt;</code>
This example creates the calendar <code class="docutils literal notranslate">mollycal</code> for the user molly:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:create-calendar molly mollycal
</pre></div>
</div>
</section>
<section id="delete-a-calendar-for-a-user">
<h4>Delete a calendar for a user<a class="headerlink" href="#delete-a-calendar-for-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:delete-calendar [--birthday] [-f|--force] [--] &lt;uid&gt; [&lt;name&gt;]</code> deletes the
calendar named <code class="docutils literal notranslate">name</code> (or the birthday calendar if <code class="docutils literal notranslate">--birthday</code> is
specified) of the user <code class="docutils literal notranslate">uid</code>. You can use the force option <code class="docutils literal notranslate">-f</code> or
<code class="docutils literal notranslate">--force</code> to delete the calendar instead of moving it to the trashbin.
This example will delete the calendar mollycal of user molly:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:delete-calendar molly mollycal
</pre></div>
</div>
This example will delete the birthday calendar of user molly:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:delete-calendar --birthday molly
</pre></div>
</div>
</section>
<section id="move-a-calendar-of-a-user">
<h4>Move a calendar of a user<a class="headerlink" href="#move-a-calendar-of-a-user" title="Link to this heading"></a></h4>
<div class="admonition note">
Note
Note that this will change existing share URLs.
</div>
<code class="docutils literal notranslate">dav:move-calendar [-f|--force] [--] &lt;name&gt; &lt;sourceuid&gt; &lt;destinationuid&gt;</code> allows the admin to move a calendar named <code class="docutils literal notranslate">name</code> from a user <code class="docutils literal notranslate">sourceuid</code> to the user <code class="docutils literal notranslate">destinationuid</code>. You can use the force option <cite>-f</cite> to enforce the move if there are conflicts with existing shares. The system will also generate a new unique calendar name in case there is a conflict over the destination user.
This example will move calendar named personal from user dennis to user sabine:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:move-calendar personal dennis sabine
</pre></div>
</div>
</section>
<section id="export-a-calendar-of-a-user">
<h4>Export a calendar of a user<a class="headerlink" href="#export-a-calendar-of-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">calendar:export [--format FORMAT] [--location LOCATION] [--] &lt;uid&gt; &lt;uri&gt;</code> exports the calendar entries from a calendar with the given <code class="docutils literal notranslate">uri</code> of user <code class="docutils literal notranslate">uid</code>.
Arguments:
<ul class="simple">
<li><code class="docutils literal notranslate">uid</code> (mandatory): User ID whose calendar will be exported.</li>
<li><code class="docutils literal notranslate">cid</code> (mandatory): Calendar URI to export.</li>
<li><code class="docutils literal notranslate">--format FORMAT</code> (optional, defaults to <code class="docutils literal notranslate">ical</code>): Output format. One of <code class="docutils literal notranslate">ical</code>, <code class="docutils literal notranslate">xcal</code>, or <code class="docutils literal notranslate">jcal</code>.</li>
<li><code class="docutils literal notranslate">--location &lt;file path&gt;</code> (optional, defaults to stdout): Path to the file to export to. If omitted, output is written to standard output.</li>
</ul>
The output format can be specified with the <code class="docutils literal notranslate">--format</code> option. Valid formats are <code class="docutils literal notranslate">ical</code> standard format (RFC 5545), <code class="docutils literal notranslate">xcal</code> XML iCalendar (RFC 6321), and <code class="docutils literal notranslate">jcal</code> JSON iCalendar (RFC 7265).
This example will export the calendar named personal of user dennis to a file named personal.ics in standard format:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ calendar:export dennis personal --location /tmp/personal.ics
</pre></div>
</div>
This example will export the calendar in XML iCalendar format:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ calendar:export dennis personal --format xcal --location /tmp/personal.xcal
</pre></div>
</div>
This example will export the calendar in JSON iCalendar format to standard output:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ calendar:export dennis personal --format jcal
</pre></div>
</div>
</section>
<section id="import-a-calendar-to-a-user">
<h4>Import a calendar to a user<a class="headerlink" href="#import-a-calendar-to-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">calendar:import [--format FORMAT] [--errors ERRORS] [--validation VALIDATION] [--supersede] [--show-created] [--show-updated] [--show-skipped] [--show-errors] [--] &lt;uid&gt; &lt;uri&gt; [&lt;location&gt;]</code> imports a calendar entries to the calendar with the given <code class="docutils literal notranslate">uri</code> of user <code class="docutils literal notranslate">uid</code>.
Arguments:
<ul class="simple">
<li><code class="docutils literal notranslate">uid</code> (mandatory): User ID to import the calendar for.</li>
<li><code class="docutils literal notranslate">uri</code> (mandatory): Calendar URI to import into.</li>
<li><code class="docutils literal notranslate">location</code> (optional, defaults to stdin): Path to the file to import. If omitted, reads from standard input.</li>
<li><code class="docutils literal notranslate">--format FORMAT</code> (optional, defaults to <code class="docutils literal notranslate">ical</code>): Input format. One of <code class="docutils literal notranslate">ical</code>, <code class="docutils literal notranslate">xcal</code>, or <code class="docutils literal notranslate">jcal</code>.</li>
<li><code class="docutils literal notranslate">--supersede</code> (optional): Force override of existing objects with the same UID.</li>
<li><code class="docutils literal notranslate">--show-created</code> (optional): Show UID of created objects after import.</li>
<li><code class="docutils literal notranslate">--show-updated</code> (optional): Show UID of updated objects after import.</li>
<li><code class="docutils literal notranslate">--show-skipped</code> (optional): Show UID of skipped objects (e.g., duplicates or invalid entries).</li>
<li><code class="docutils literal notranslate">--show-errors</code> (optional): Show UID of objects with errors during import.</li>
<li><code class="docutils literal notranslate">--errors ERRORS</code> (optional): How to handle errors. <code class="docutils literal notranslate">0</code> = continue on error, <code class="docutils literal notranslate">1</code> = fail on error.</li>
<li><code class="docutils literal notranslate">--validation VALIDATION</code> (optional): How to handle object validation. <code class="docutils literal notranslate">0</code> = no validation, <code class="docutils literal notranslate">1</code> = validate and skip on issue, <code class="docutils literal notranslate">2</code> = validate and fail on issue.</li>
</ul>
The input format can be specified with the <code class="docutils literal notranslate">--format</code> option, valid formats are <code class="docutils literal notranslate">ical</code> standard format (RFC 5545), <code class="docutils literal notranslate">xcal</code> XML iCalendar (RFC 6321) and <code class="docutils literal notranslate">jcal</code> JSON iCalendar (RFC 7265), the default is <code class="docutils literal notranslate">ical</code>.
This example will import from a file named personal.ics in standard format to the calendar named personal of user dennis:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ calendar:import dennis personal /tmp/personal.ics
</pre></div>
</div>
This example will import from a file named personal.xcal in XML iCalendar format to the calendar named personal of user dennis:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ calendar:import --format xcal dennis personal /tmp/personal.xcal
</pre></div>
</div>
This example will import from a file named personal.jcal in JSON iCalendar format to the calendar named personal of user dennis:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ calendar:import --format jcal dennis personal /tmp/personal.jcal
</pre></div>
</div>
This example will import from standard input to the calendar named personal of user dennis:
<div class="highlight-default notranslate"><div class="highlight"><pre>cat /tmp/personal.ics | sudo -E -u www-data php occ calendar:import dennis personal
</pre></div>
</div>
</section>
<section id="misc">
<h4>Misc<a class="headerlink" href="#misc" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:fix-missing-caldav-changes [&lt;user&gt;]</code> attempts to restore calendar sync changes when data in the calendarchanges table has been lost. If the user ID is omitted, the command runs for all users, which may take some time to complete.
<code class="docutils literal notranslate">dav:retention:clean-up</code> deletes elements from the CalDAV trash that are due for removal.
<code class="docutils literal notranslate">dav:remove-invalid-shares</code> removes invalid shares that were created due to a bug in the calendar app.
<code class="docutils literal notranslate">dav:send-event-reminders</code> is a command that should be called regularly through a dedicated
cron job to send event reminder notifications. See <a class="reference internal" href="groupware/calendar.html">Calendar / CalDAV</a> for more information on how to use this command.
</section>
</section>
<section id="manage-calendar-subscriptions">
<h3>Manage calendar subscriptions<a class="headerlink" href="#manage-calendar-subscriptions" title="Link to this heading"></a></h3>
<section id="list-all-calendar-subscriptions-of-a-user">
<h4>List all calendar subscriptions of a user<a class="headerlink" href="#list-all-calendar-subscriptions-of-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:list-subscriptions &lt;uid&gt;</code>
This example will list all calendar subscriptions for user annie:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:list-subscriptions annie
</pre></div>
</div>
</section>
<section id="create-a-calendar-subscription-for-a-user">
<h4>Create a calendar subscription for a user<a class="headerlink" href="#create-a-calendar-subscription-for-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:create-subscription &lt;user&gt; &lt;name&gt; &lt;url&gt; [&lt;color&gt;]</code>
This example creates the subscription for the lunar calendar <code class="docutils literal notranslate">Lunar Calendar</code> for the user molly:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:create-subscription molly &quot;Lunar Calendar&quot; webcal://cantonbecker.com/astronomy-calendar/astrocal.ics
</pre></div>
</div>
Optionally, a color for the new subscription calendar can be passed as a HEX color code:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:create-subscription molly &quot;Lunar Calendar&quot; calendar webcal://cantonbecker.com/astronomy-calendar/astrocal.ics &quot;#ff5733&quot;
</pre></div>
</div>
If not set, the theming default color will be used.
</section>
<section id="delete-a-calendar-subscription-for-a-user">
<h4>Delete a calendar subscription for a user<a class="headerlink" href="#delete-a-calendar-subscription-for-a-user" title="Link to this heading"></a></h4>
<code class="docutils literal notranslate">dav:delete-subscription &lt;uid&gt; &lt;uri&gt;</code>
This example deletes the subscription for the lunar calendar <code class="docutils literal notranslate">Lunar Calendar</code> for the user molly:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:delete-subscription molly &quot;Lunar Calendar&quot;
</pre></div>
</div>
</section>
</section>
<section id="sync-system-address-book">
<h3>Sync system address book<a class="headerlink" href="#sync-system-address-book" title="Link to this heading"></a></h3>
<code class="docutils literal notranslate">dav:sync-system-addressbook</code> synchronizes all users to the <a class="reference internal" href="groupware/contacts.html#system-address-book">system
address book</a>:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:sync-system-addressbook
</pre></div>
</div>
</section>
<section id="sync-birthday-calendar">
<h3>Sync birthday calendar<a class="headerlink" href="#sync-birthday-calendar" title="Link to this heading"></a></h3>
<code class="docutils literal notranslate">dav:sync-birthday-calendar [&lt;user&gt;]</code> adds all birthdays to your calendar from
addressbooks shared with you. This example syncs to your calendar from user bernie:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ dav:sync-birthday-calendar bernie
</pre></div>
</div>
</section>
<section id="disable-creation-of-example-events">
<h3>Disable creation of example events<a class="headerlink" href="#disable-creation-of-example-events" title="Link to this heading"></a></h3>
This will disable the automatic creation of example events in calendar:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ config:app:set dav create_example_event --value=false --type=boolean
</pre></div>
</div>
</section>
</section>
<section id="database-conversion">
<h2>Database conversion<a class="headerlink" href="#database-conversion" title="Link to this heading"></a></h2>
The SQLite database is good for testing, and for Nextcloud servers with small
single-user workloads that do not use sync clients, but production servers with
multiple users should use MariaDB, MySQL, or PostgreSQL. You can use <code class="docutils literal notranslate">occ</code> to
convert from SQLite to one of these other databases.
<div class="highlight-default notranslate"><div class="highlight"><pre>db
 db:convert-type Convert the Nextcloud database to the newly
 configured one
 db:generate-change-script generates the change script from the current
 connected db to db_structure.xml
</pre></div>
</div>
You need:
<ul class="simple">
<li>Your desired database and its PHP connector installed.</li>
<li>The login and password of a database admin user.</li>
<li>The database port number, if it is a non-standard port.</li>
</ul>
This is example converts SQLite to MySQL/MariaDB:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ db:convert-type mysql oc_dbuser 127.0.0.1
oc_database
</pre></div>
</div>
For a more detailed explanation see
<a class="reference internal" href="configuration_database/db_conversion.html">Converting database type</a>
</section>
<section id="add-missing-indices">
<h2>Add missing indices<a class="headerlink" href="#add-missing-indices" title="Link to this heading"></a></h2>
It might happen that we add from time to time new indices to already existing database tables,
for example to improve performance. In order to check your database for missing indices run
following command:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ db:add-missing-indices
</pre></div>
</div>
Use option <code class="docutils literal notranslate">--dry-run</code> to output the SQL queries without running them.
</section>
<section id="encryption">
<h2>Encryption<a class="headerlink" href="#encryption" title="Link to this heading"></a></h2>
<code class="docutils literal notranslate">occ</code> includes a complete set of commands for managing encryption:
<div class="highlight-default notranslate"><div class="highlight"><pre>encryption
 encryption:change-key-storage-root Change key storage root
 encryption:decrypt-all Disable server-side encryption and
 decrypt all files
 encryption:disable Disable encryption
 encryption:drop-legacy-filekey Drop legacy filekey for files still using it
 encryption:enable Enable encryption
 encryption:enable-master-key Enable the master key. Only available
 for fresh installations with no existing
 encrypted data! There is also no way to
 disable it again.
 encryption:encrypt-all Encrypt all files for all users
 encryption:list-modules List all available encryption modules
 encryption:set-default-module Set the encryption default module
 encryption:show-key-storage-root Show current key storage root
 encryption:status Lists the current status of encryption
</pre></div>
</div>
<code class="docutils literal notranslate">encryption:status</code> shows whether you have active encryption, and your default
encryption module. To enable encryption you must first enable the Encryption
app, and then run <code class="docutils literal notranslate">encryption:enable</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ app:enable encryption
sudo -E -u www-data php occ encryption:enable
sudo -E -u www-data php occ encryption:status
 - enabled: true
 - defaultModule: OC_DEFAULT_MODULE
</pre></div>
</div>
<code class="docutils literal notranslate">encryption:change-key-storage-root</code> is for moving your encryption keys to a
different folder. It takes one argument, <code class="docutils literal notranslate">newRoot</code>, which defines your new
root folder:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ encryption:change-key-storage-root /etc/oc-keys
</pre></div>
</div>
You can see the current location of your keys folder:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ encryption:show-key-storage-root
Current key storage root: default storage location (data/)
</pre></div>
</div>
<code class="docutils literal notranslate">encryption:list-modules</code> displays your available encryption modules. You will
see a list of modules only if you have enabled the Encryption app. Use
<code class="docutils literal notranslate">encryption:set-default-module [module name]</code> to set your desired module.
<code class="docutils literal notranslate">encryption:encrypt-all</code> encrypts all data files for all users. You must first
put your Nextcloud server into <a class="reference internal" href="#maintenance-commands-label">maintenance
mode</a> to prevent any user activity until encryption
is completed.
<code class="docutils literal notranslate">encryption:decrypt-all</code> decrypts all user data files, or optionally a single
user:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ encryption:decrypt freda
</pre></div>
</div>
Users must have enabled recovery keys on their Personal pages.
Note that if you do not have master key/recovery key enabled, you can ONLY
decrypt files per user, one user at a time and NOT when in maintenance mode.
You will need the users’ password to decrypt the files.
Use <code class="docutils literal notranslate">encryption:disable</code> to disable your encryption module. You must first put
your Nextcloud server into <a class="reference internal" href="#maintenance-commands-label">maintenance mode</a>
to prevent any user activity.
<code class="docutils literal notranslate">encryption:enable-master-key</code> creates a new master key, which is used for all
user data instead of individual user keys. This is especially useful to enable
single-sign on. Use this only on fresh installations with no existing data, or
on systems where encryption has not already been enabled. It is not possible to
disable it.
<code class="docutils literal notranslate">encryption:drop-legacy-filekey</code> scans the files for the legacy filekey
format using RC4 and get rid of it (if master key is enabled). The operation can
be quite slow as it needs to rewrite each encrypted file. If you do not do it files
will be migrated to drop their legacy filekey on the first modification. If you have
old files from Nextcloud&lt;25 still using base64 encoding this will migrate them to the
binary format and save about 33% disk space.
See <a class="reference internal" href="configuration_files/encryption_configuration.html">Server-side encryption configuration</a> to learn more.
</section>
<section id="federation-sync">
<h2>Federation sync<a class="headerlink" href="#federation-sync" title="Link to this heading"></a></h2>
<div class="admonition note">
Note
This command is only available when the “Federation” app (<code class="docutils literal notranslate">federation</code>) is
enabled.
</div>
Synchronize the addressbooks of all federated Nextcloud servers:
<div class="highlight-default notranslate"><div class="highlight"><pre>federation:sync-addressbooks Synchronizes addressbooks of all
 federated clouds
</pre></div>
</div>
In Nextcloud, servers connected with federation shares can share user
address books, and auto-complete usernames in share dialogs. Use this command
to synchronize federated servers:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ federation:sync-addressbooks
</pre></div>
</div>
</section>
<section id="file-operations">
<h2>File operations<a class="headerlink" href="#file-operations" title="Link to this heading"></a></h2>
Available <code class="docutils literal notranslate">occ</code> commands for the <code class="docutils literal notranslate">files</code> namespace:
<div class="highlight-default notranslate"><div class="highlight"><pre>files:cleanup cleanup filecache
files:copy Copy a file or folder
files:delete Delete a file or folder
files:get Get the contents of a file
files:move Move a file or folder
files:object:delete Delete an object from the object store
files:object:get Get the contents of an object
files:object:put Write a file to the object store
files:put Write contents of a file
files:recommendations:recommend
files:reminders List file reminders
files:repair-tree Try and repair malformed filesystem tree structures
files:scan rescan filesystem
files:scan-app-data rescan the AppData folder
files:transfer-ownership All files and folders are moved to another user - outgoing shares and incoming user file shares (optionally) are moved as well.
</pre></div>
</div>
<section id="scan">
<h3>Scan<a class="headerlink" href="#scan" title="Link to this heading"></a></h3>
The <code class="docutils literal notranslate">files:scan</code> command scans for new files and updates the file cache. You
may rescan all files, per-user, a space-delimited list of users, and limit the
search path. If not using <code class="docutils literal notranslate">--quiet</code>, statistics will be shown at the end of
the scan:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files:scan --help
Description:
 rescan filesystem

Usage:
 files:scan [options] [--] [&lt;user_id&gt;...]

Arguments:
 user_id will rescan all files of the given user(s)

Options:
 --output[=OUTPUT] Output format (plain, json or json_pretty, default is plain) [default: &quot;plain&quot;]
 -p, --path=PATH limit rescan to this path, eg. --path=&quot;/alice/files/Music&quot;, the user_id is determined by the path and the user_id parameter and --all are ignored
 --generate-metadata Generate metadata for all scanned files
 --all will rescan all files of all known users
 --unscanned only scan files which are marked as not fully scanned
 --shallow do not scan folders recursively
 --home-only only scan the home storage, ignoring any mounted external storage or share
 -h, --help Display help for the given command. When no command is given display help for the list command
 -q, --quiet Do not output any message
 -V, --version Display this application version
 --ansi|--no-ansi Force (or disable --no-ansi) ANSI output
 -n, --no-interaction Do not ask any interactive question
 --no-warnings Skip global warnings, show command output only
 -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
</pre></div>
</div>
Verbosity levels of <code class="docutils literal notranslate">-vv</code> or <code class="docutils literal notranslate">-vvv</code> are automatically reset to <code class="docutils literal notranslate">-v</code>
Note for option <code class="docutils literal notranslate">--unscanned</code>:
In general there is a background job (through cron) that will do that scan periodically.
The <code class="docutils literal notranslate">--unscanned</code> option makes it possible to trigger this from the CLI.
When using the <code class="docutils literal notranslate">--path</code> option, the path must consist of following
components:
<div class="highlight-default notranslate"><div class="highlight"><pre>&quot;user_id/files/path&quot;
 or
&quot;user_id/files/mount_name&quot;
 or
&quot;user_id/files/mount_name/path&quot;
</pre></div>
</div>
where the term <code class="docutils literal notranslate">files</code> is mandatory.
Example:
<div class="highlight-default notranslate"><div class="highlight"><pre>--path=&quot;/alice/files/Music&quot;
</pre></div>
</div>
In the example above, the user_id <code class="docutils literal notranslate">alice</code> is determined implicitly from the
path component given.
The <code class="docutils literal notranslate">--path</code>, <code class="docutils literal notranslate">--all</code> and <code class="docutils literal notranslate">[user_id]</code> parameters are exclusive - only
one must be specified.
</section>
<section id="scan-appdata">
<h3>Scan appdata<a class="headerlink" href="#scan-appdata" title="Link to this heading"></a></h3>
Appdata is a folder inside of the data directory which contains files that
are shared between users and can be put there by the server or apps like
avatar images, file previews and cached CSS files for example.
Since the regular files scan only operates on user files the <code class="docutils literal notranslate">occ files:scan-app-data</code>
command will check the appdata directory and make sure that the filecache is consistent
with the files on the actual storage.:
<div class="highlight-default notranslate"><div class="highlight"><pre>Usage:
 files:scan-app-data [options] [--] [&lt;folder&gt;]

Arguments:
 folder The appdata subfolder to scan [default: &quot;&quot;]
</pre></div>
</div>
</section>
<section id="cleanup-previews">
<h3>Cleanup previews<a class="headerlink" href="#cleanup-previews" title="Link to this heading"></a></h3>
<code class="docutils literal notranslate">preview:cleanup</code> removes all of the server’s preview files. This is useful
when changing the previews configuration (sizes, quality or file), and especially
on systems using Object Storage as Primary Storage where the <code class="docutils literal notranslate">appdata_xxx/preview</code>
folder can’t simply be deleted.
See <a class="reference internal" href="configuration_files/previews_configuration.html">Previews configuration</a>.
</section>
<section id="cleanup">
<h3>Cleanup<a class="headerlink" href="#cleanup" title="Link to this heading"></a></h3>
<code class="docutils literal notranslate">files:cleanup</code> tidies up the server’s file cache by deleting all file
entries that have no matching entries in the storage table.
</section>
<section id="repair-tree">
<h3>Repair-Tree<a class="headerlink" href="#repair-tree" title="Link to this heading"></a></h3>
<code class="docutils literal notranslate">files:repair-tree</code> try and repair malformed filesystem tree structures.
If for any reason the path of an entry in the filecache doesn’t match with
it’s expected path, based on the path of it’s parent node, you end up with an
entry in the filecache that exists in different places based on how the entry
is generated. For example, if while listing folder <code class="docutils literal notranslate">/foo</code> it contains a file
<code class="docutils literal notranslate">bar.txt</code>, but when trying to do anything with <code class="docutils literal notranslate">/foo/bar.txt</code> the file
doesn’t exists.
This command attempts to repair such entries by querying for entries where the path
doesn’t match the expected path based on it’s parent path and filename and resets it’s
path to the expected one.
</section>
<section id="sanitize-filenames">
<h3>Sanitize filenames<a class="headerlink" href="#sanitize-filenames" title="Link to this heading"></a></h3>
This command allows to automatically rename files not matching the current file naming constraints,
for example after enabling the <a class="reference internal" href="configuration_files/windows_compatible_filenames.html#windows-compatible-filenames">Windows compatible filenames</a>:
<div class="highlight-default notranslate"><div class="highlight"><pre>Usage:
 files:sanitize-filenames [options] [--] [&lt;user_id&gt;...]

Arguments:
 user_id Limit filename sanitizing to files given user(s) have access to

Options:
 --dry-run Do not actually rename any files but just check filenames.
 -c, --char-replacement=CHAR-REPLACEMENT Replacement for invalid character (by default space, underscore or dash is used)
</pre></div>
</div>
When running this command without parameters it will scan all files of all users
for filenames not comply with the current filename constraints and try to automatically
rename those files.
Invalid characters will be replaced by default with either a space, underscore, or dash
depending on which characters are allowed.
If your constraints forbid all of them, then you have to provide an character replacement
yourself by specifying the <code class="docutils literal notranslate">--char-replacement</code> option.
The <code class="docutils literal notranslate">--dry-run</code> option allows to perform the sanitizing without the actual renaming,
this is useful for estimating the execution time and to get an overview on what renaming
actions will be performed.
</section>
<section id="transfer">
<h3>Transfer<a class="headerlink" href="#transfer" title="Link to this heading"></a></h3>
The command <code class="docutils literal notranslate">occ files:transfer-ownership</code> can be used to transfer files from one user to another:
<div class="highlight-default notranslate"><div class="highlight"><pre>Usage:
 files:transfer-ownership [options] [--] &lt;source-user&gt; &lt;destination-user&gt;

Arguments:
 source-user owner of files which shall be moved
 destination-user user who will be the new owner of the files

Options:
 --path=PATH selectively provide the path to transfer. For example --path=&quot;folder_name&quot; [default: &quot;&quot;]
 --move move data from source user to root directory of destination user, which must be empty
 --transfer-incoming-shares[=TRANSFER-INCOMING-SHARES] transfer incoming user file shares to destination user. Usage: --transfer-incoming-shares=1 (value required) [default: &quot;2&quot;]
</pre></div>
</div>
You may transfer all files and shares from one user to another. This is useful
before removing a user:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files:transfer-ownership &lt;source-user&gt; &lt;destination-user&gt;
</pre></div>
</div>
The transferred files will appear inside a new sub-directory in the destination user’s home.
<div class="admonition note">
Note
Unless server side encryption is enabled, the command will init the &lt;destination-user&gt; file system in Nextcloud versions 22.2.6, 23.0.3 and since 24. When it is unable to create the user’s folder in the data directory it will show the following error: <code class="docutils literal notranslate">unable to rename, destination directory is not writable</code>. Before 22.2.6 the command <code class="docutils literal notranslate">occ files:transfer-ownership</code> would only work after the user has logged in for the first time.
</div>
If the destination user has no files at all (empty home), it is possible to also transfer all the source user’s files by passing <code class="docutils literal notranslate">--move</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files:transfer-ownership --move &lt;source-user&gt; &lt;destination-user&gt;
</pre></div>
</div>
In this case no sub-directory is created and all files will appear directly in the root of the user’s home.
It is also possible to transfer only one directory along with its contents. This can be useful to restructure your organization or quotas. The <code class="docutils literal notranslate">--path</code> argument is given as the path to the directory as seen from the source user:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files:transfer-ownership --path=&quot;path_to_dir&quot; &lt;source-user&gt; &lt;destination-user&gt;
</pre></div>
</div>
Incoming shares are not moved by default because the sharing user holds the ownership of the respective files. There is however an option to enable moving incoming shares.
In case the incoming shares must be transferred as well, use the argument <code class="docutils literal notranslate">--transfer-incoming-shares</code> with <code class="docutils literal notranslate">0</code> or <code class="docutils literal notranslate">1</code> as parameters
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files:transfer-ownership --transfer-incoming-shares=1 --path=&quot;path_to_dir&quot; &lt;source-user&gt; &lt;destination-user&gt;
</pre></div>
</div>
As an alternative, the system configuration option <code class="docutils literal notranslate">transferIncomingShares</code> in config.php can be set to <code class="docutils literal notranslate">true</code> to always transfer incoming shares.
The command line option <code class="docutils literal notranslate">--transfer-incoming-shares</code> overwrites the config.php option <code class="docutils literal notranslate">transferIncomingShares</code>. For example, <code class="docutils literal notranslate">'transferIncomingShares =&gt; true</code> can be overwritten by:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files:transfer-ownership --transfer-incoming-shares=0 &lt;source-user&gt; &lt;destination-user&gt;
</pre></div>
</div>
Users may also transfer files or folders selectively by themselves.
See <a class="reference external" href="https://docs.nextcloud.com/server/33/user_manual/en/files/transfer_ownership.html">user documentation</a> for details.
</section>
<section id="toggle-windows-compatibility">
<h3>Toggle Windows compatibility<a class="headerlink" href="#toggle-windows-compatibility" title="Link to this heading"></a></h3>
The command <code class="docutils literal notranslate">occ files:windows-compatible-filenames</code> can be used to toggle
enforcing <a class="reference internal" href="configuration_files/windows_compatible_filenames.html#windows-compatible-filenames">Windows compatible filenames</a>:
<div class="highlight-default notranslate"><div class="highlight"><pre>Usage:
 files:windows-compatible-filenames [options]

Options:
 --enable enable enforcing windows compatible filenames
 --disable disable enforcing windows compatible filenames
</pre></div>
</div>
</section>
</section>
<section id="files-sharing">
<h2>Files Sharing<a class="headerlink" href="#files-sharing" title="Link to this heading"></a></h2>
Commands for handling shares:
<div class="highlight-default notranslate"><div class="highlight"><pre>sharing
 sharing:cleanup-remote-storages Cleanup shared storage entries that have no matching entry in the shares_external table
 sharing:expiration-notification Notify share initiators when a share will expire the next day
 sharing:delete-orphan-shares Delete shares where the owner no longer has access to the file or the file is not available anymore
</pre></div>
</div>
</section>
<section id="files-external">
<h2>Files external<a class="headerlink" href="#files-external" title="Link to this heading"></a></h2>
These commands are used for managing Nextcloud’s External Storage feature. In
addition to replicating the configuration capabilities in the Web UI, additional
capabilities include exporting / importing configurations, scanning External
Storage mounts that require login credentials, and configuring update notifications
(if supported by the storage type).
<div class="admonition note">
Note
These commands are only available when the “External storage support” app
(<code class="docutils literal notranslate">files_external</code>) is enabled.
</div>
Available commands for the “files_external” namespace:
<div class="highlight-default notranslate"><div class="highlight"><pre>files_external:applicable Manage applicable users and groups for a mount
files_external:backends Show available authentication and storage backends
files_external:config Manage backend configuration for a mount
files_external:create Create a new mount configuration
files_external:delete Delete an external mount
files_external:export Export mount configurations
files_external:import Import mount configurations
files_external:list List configured admin or personal mounts
files_external:notify Listen for active update notifications for a configured external mount
files_external:option Manage mount options for a mount
files_external:scan Scan an external storage for changed files
files_external:verify Verify mount configuration
files_external:dependencies Check for any missing dependencies needed for mounting external storages
</pre></div>
</div>
<code class="docutils literal notranslate">files_external:scan</code> provides the ability to provide a username and/or password for cases where login credentials are used.
Use <code class="docutils literal notranslate">files_external:export</code> to export all admin mounts to stdout, and
<code class="docutils literal notranslate">files_external:export [user_id]</code> to export the mounts of the specified
Nextcloud user.
Use <code class="docutils literal notranslate">files_external:import [filename]</code> to import legacy JSON configurations,
and to copy external mount configurations to another Nextcloud server.
</section>
<section id="integrity-check">
<h2>Integrity check<a class="headerlink" href="#integrity-check" title="Link to this heading"></a></h2>
Apps which have a <code class="docutils literal notranslate">Featured</code> tag MUST be code signed with Nextcloud. Unsigned featured apps won’t be installable anymore. Code signing is optional for all third-party applications:
<div class="highlight-default notranslate"><div class="highlight"><pre>integrity
 integrity:check-app Check app integrity using a signature.
 integrity:check-core Check core integrity using a signature.
 integrity:sign-app Signs an app using a private key.
 integrity:sign-core Sign core using a private key
</pre></div>
</div>
After creating your signing key, sign your app like this example:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ integrity:sign-app --privateKey=/Users/lukasreschke/contacts.key --certificate=/Users/lukasreschke/CA/contacts.crt --path=/Users/lukasreschke/Programming/contacts
</pre></div>
</div>
Verify your app:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ integrity:check-app --path=/pathto/app appname
</pre></div>
</div>
When it returns nothing, your app is signed correctly. When it returns a message then there is an error. See <a class="reference external" href="https://docs.nextcloud.com/server/33/developer_manual/app_publishing_maintenance/code_signing.html#how-to-get-your-app-signed">Code Signing</a> in the Developer manual for more detailed information.
<code class="docutils literal notranslate">integrity:sign-core</code> is for Nextcloud core developers only.
See <a class="reference internal" href="issues/code_signing.html">Code signing</a> to learn more.
</section>
<section id="l10n-create-javascript-translation-files-for-apps">
<h2>l10n, create JavaScript translation files for apps<a class="headerlink" href="#l10n-create-javascript-translation-files-for-apps" title="Link to this heading"></a></h2>
This command is for app developers to update their translation mechanism from
ownCloud 7 to Nextcloud.
</section>
<section id="ldap-commands">
<h2>LDAP commands<a class="headerlink" href="#ldap-commands" title="Link to this heading"></a></h2>
<div class="admonition note">
Note
These commands are only available when the “LDAP user and group backend” app
(<code class="docutils literal notranslate">user_ldap</code>) is enabled.
</div>
These LDAP commands appear only when you have enabled the LDAP app. Then
you can run the following LDAP commands with <code class="docutils literal notranslate">occ</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>ldap
 ldap:check-user checks whether a user exists on LDAP.
 ldap:check-group checks whether a group exists on LDAP.
 ldap:create-empty-config creates an empty LDAP configuration
 ldap:delete-config deletes an existing LDAP configuration
 ldap:search executes a user or group search
 ldap:set-config modifies an LDAP configuration
 ldap:show-config shows the LDAP configuration
 ldap:show-remnants shows which users are not available on
 LDAP anymore, but have remnants in
 Nextcloud.
 ldap:test-config tests an LDAP configuration
 ldap:test-user-settings runs tests and show information about user
 related LDAP settings
</pre></div>
</div>
<section id="ldap-search">
<h3>ldap:search<a class="headerlink" href="#ldap-search" title="Link to this heading"></a></h3>
Search for an LDAP user, using this syntax
<blockquote>
<div>sudo -E -u www-data php occ <a class="reference external" href="ldap:search">ldap:search</a> [–group] [–offset=”…”]
[–limit=”…”] search
</div></blockquote>
Searches will match at the beginning of the attribute value only. This example
searches for givenNames that start with “rob”:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:search &quot;rob&quot;
</pre></div>
</div>
This will find robbie, roberta, and robin. Broaden the search to find, for
example, <code class="docutils literal notranslate">jeroboam</code> with the asterisk wildcard:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:search &quot;*rob&quot;
</pre></div>
</div>
User search attributes are set with <code class="docutils literal notranslate">ldap:set-config</code>
(below). For example, if your search attributes are
<code class="docutils literal notranslate">givenName</code> and <code class="docutils literal notranslate">sn</code> you can find users by first name + last name very
quickly. For example, you’ll find Terri Hanson by searching for <code class="docutils literal notranslate">te ha</code>.
Trailing whitespaces are ignored.
Check if an LDAP user exists. This works only if the Nextcloud server is
connected to an LDAP server:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:check-user robert
</pre></div>
</div>
</section>
<section id="ldap-check-user">
<h3>ldap:check-user<a class="headerlink" href="#ldap-check-user" title="Link to this heading"></a></h3>
Will not run a check when it finds a disabled LDAP
connection. This prevents users that exist on disabled LDAP connections from
being marked as deleted. If you know for certain that the user you are searching for
is not in one of the disabled connections, and exists on an active connection,
use the <code class="docutils literal notranslate">--force</code> option to force it to check all active LDAP connections:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:check-user --force robert
</pre></div>
</div>
</section>
<section id="ldap-check-group">
<h3>ldap:check-group<a class="headerlink" href="#ldap-check-group" title="Link to this heading"></a></h3>
Checks whether a group still exists in the LDAP directory.
Use with <code class="docutils literal notranslate">--update</code> to update the group membership cache on the Nextcloud side:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:check-group --update mygroup
</pre></div>
</div>
</section>
<section id="ldap-create-empty-config">
<h3>ldap:create-empty-config<a class="headerlink" href="#ldap-create-empty-config" title="Link to this heading"></a></h3>
Creates an empty LDAP configuration. The first one you create
has <code class="docutils literal notranslate">configID</code> <code class="docutils literal notranslate">s01</code>, and all subsequent configurations
that you create are automatically assigned IDs:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:create-empty-config
 Created new configuration with configID &#39;s01&#39;
</pre></div>
</div>
Then you can list and view your configurations:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:show-config
</pre></div>
</div>
And view the configuration for a single configID:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:show-config s01
</pre></div>
</div>
</section>
<section id="ldap-delete-config">
<h3>ldap:delete-config<a class="headerlink" href="#ldap-delete-config" title="Link to this heading"></a></h3>
Deletes an existing LDAP configuration:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:delete s01
Deleted configuration with configID &#39;s01&#39;
</pre></div>
</div>
</section>
<section id="ldap-set-config">
<h3>ldap:set-config<a class="headerlink" href="#ldap-set-config" title="Link to this heading"></a></h3>
This command is for manipulating configurations, like this
example that sets search attributes:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:set-config s01 ldapAttributesForUserSearch
&quot;cn;givenname;sn;displayname;mail&quot;
</pre></div>
</div>
</section>
<section id="ldap-test-config">
<h3>ldap:test-config<a class="headerlink" href="#ldap-test-config" title="Link to this heading"></a></h3>
Tests whether your configuration is correct and can bind to
the server:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:test-config s01
The configuration is valid and the connection could be established!
</pre></div>
</div>
</section>
<section id="ldap-test-user-settings">
<h3>ldap:test-user-settings<a class="headerlink" href="#ldap-test-user-settings" title="Link to this heading"></a></h3>
Tests user-related LDAP settings:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ ldap:test-user-settings &quot;cn=philip j. fry,ou=people,dc=planetexpress,dc=com&quot; --group &quot;Everyone&quot;

User cn=philip j. fry,ou=people,dc=planetexpress,dc=com is mapped with account name fry.
Known UUID is ce6cd914-71d5-103f-95a8-ad2dab17b2f9.
Configuration prefix is s01

Attributes set in configuration:
- ldapExpertUsernameAttr: uid
- ldapUuidUserAttribute: auto
- ldapEmailAttribute: mail
- ldapUserDisplayName: cn

Attributes fetched from LDAP using filter (|(objectclass=inetOrgPerson)):
- entryuuid: [&quot;ce6cd914-71d5-103f-95a8-ad2dab17b2f9&quot;]
- uid: [&quot;fry&quot;]
- mail: [&quot;fry@planetexpress.com&quot;]
- cn: [&quot;Philip J. Fry&quot;]

Detected UUID attribute: entryuuid

UUID for cn=philip j. fry,ou=people,dc=planetexpress,dc=com: ce6cd914-71d5-103f-95a8-ad2dab17b2f9

Group information:
Configuration:
- ldapGroupFilter: (|(objectclass=groupOfNames))
- ldapGroupMemberAssocAttr: member

Primary group:
Group from gidNumber:
All known groups: [&quot;Ship crew&quot;, &quot;Everyone&quot;]
MemberOf usage: off (0,1)

Group Everyone:
Group cn=everyone,ou=groups,dc=planetexpress,dc=com is mapped with name Everyone.
Known UUID is ce8b61c2-71d5-103f-95af-ad2dab17b2f9.
Members: [&quot;bender&quot;, &quot;fry&quot;, &quot;leela&quot;]
</pre></div>
</div>
</section>
<section id="ldap-show-remnants">
<h3>ldap:show-remnants<a class="headerlink" href="#ldap-show-remnants" title="Link to this heading"></a></h3>
Used to cleaning up the LDAP mappings table, and is
documented in <a class="reference internal" href="configuration_user/user_auth_ldap_cleanup.html">LDAP user cleanup</a>.
</section>
</section>
<section id="logging-commands">
<h2>Logging commands<a class="headerlink" href="#logging-commands" title="Link to this heading"></a></h2>
These commands view and configure your Nextcloud logging preferences:
<div class="highlight-default notranslate"><div class="highlight"><pre>log
 log:file manipulate Nextcloud logging backend
 log:manage manage logging configuration
 log:tail tail the nextcloud logfile [requires app &quot;Log Reader&quot; to be enabled]
 log:watch watch the nextcloud logfile live [requires app &quot;Log Reader&quot; to be enabled]
</pre></div>
</div>
Run <code class="docutils literal notranslate">log:file [--] [--enable] [--file] [--rotate-size]</code> to see your current logging status:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ log:file
Log backend Nextcloud: enabled
Log file: /opt/nextcloud/data/nextcloud.log
Rotate at: disabled
</pre></div>
</div>
<ul class="simple">
<li><code class="docutils literal notranslate">--enable</code> turns on logging.</li>
<li><code class="docutils literal notranslate">--file</code> sets a different log file path.</li>
<li><code class="docutils literal notranslate">--rotate-size</code> sets your rotation by log file size in bytes with; 0 disables rotation.</li>
</ul>
<code class="docutils literal notranslate">log:manage [--backend] [--level] [--timezone]</code> sets your logging backend, log level, and timezone. The defaults
are <code class="docutils literal notranslate">file</code>, <code class="docutils literal notranslate">warning</code>, and <code class="docutils literal notranslate">UTC</code>. Available options are:
<ul class="simple">
<li><code class="docutils literal notranslate">--backend [file, syslog, errorlog, systemd]</code></li>
<li><code class="docutils literal notranslate">--level [debug|info|warning|error|fatal]</code></li>
<li><code class="docutils literal notranslate">--timezone</code> according to <a class="reference external" href="https://www.php.net/manual/en/timezones.php">https://www.php.net/manual/en/timezones.php</a></li>
</ul>
</section>
<section id="maintenance-commands">
<h2>Maintenance commands<a class="headerlink" href="#maintenance-commands" title="Link to this heading"></a></h2>
Use these commands when you upgrade Nextcloud, manage encryption, perform
backups and other tasks that require locking users out until you are finished:
<div class="highlight-default notranslate"><div class="highlight"><pre>maintenance
 maintenance:data-fingerprint update the systems data-fingerprint after a backup is restored
 maintenance:mimetype:update-db Update database mimetypes and update filecache
 maintenance:mimetype:update-js Update mimetypelist.js
 maintenance:mode set maintenance mode
 maintenance:repair repair this installation
 maintenance:theme:update Apply custom theme changes
 maintenance:update:htaccess Updates the .htaccess file
 maintenance:repair-share-owner Fix some shares owner if it felt out of sync
</pre></div>
</div>
<code class="docutils literal notranslate">maintenance:mode</code> locks the sessions of all logged-in users, including
administrators, and displays a status screen warning that the server is in
maintenance mode. Users who are not already logged in cannot log in until
maintenance mode is turned off. When you take the server out of maintenance mode
logged-in users must refresh their Web browsers to continue working:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ maintenance:mode --on
sudo -E -u www-data php occ maintenance:mode --off
</pre></div>
</div>
After restoring a backup of your data directory or the database, you should always
call <code class="docutils literal notranslate">maintenance:data-fingerprint</code> once. This changes the ETag for all files
in the communication with sync clients, allowing them to realize a file was modified.
The <code class="docutils literal notranslate">maintenance:repair</code> command runs automatically during upgrades to clean
up the database, so while you can run it manually there usually isn’t a need
to:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ maintenance:repair
</pre></div>
</div>
<code class="docutils literal notranslate">maintenance:mimetype:update-db</code> updates the Nextcloud database and file cache
with changed mimetypes found in <code class="docutils literal notranslate">config/mimetypemapping.json</code>. Run this
command after modifying <code class="docutils literal notranslate">config/mimetypemapping.json</code>. If you change a
mimetype, run <code class="docutils literal notranslate">maintenance:mimetype:update-db --repair-filecache</code> to apply the
change to existing files.
Run the <code class="docutils literal notranslate">maintenance:theme:update</code> command if the icons of your custom theme are not
updated correctly. This updates the mimetypelist.js and clears the image cache.
</section>
<section id="security">
<h2>Security<a class="headerlink" href="#security" title="Link to this heading"></a></h2>
Use these commands to manage server-wide security related parameters. Currently this
includes <a class="reference internal" href="configuration_server/bruteforce_configuration.html">Brute force protection</a> and SSL certificates (the latter are useful when
creating federation connections with other Nextcloud servers that use self-signed certificates:
<div class="highlight-default notranslate"><div class="highlight"><pre>security
 security:bruteforce:attempts show bruteforce attempts status for a given IP address
 security:bruteforce:reset resets bruteforce attempts for a given IP address
 security:certificates list trusted certificates
 security:certificates:import import trusted certificate
 security:certificates:remove remove trusted certificate
</pre></div>
</div>
Reset an IP:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ security:bruteforce:reset [IP address]
</pre></div>
</div>
This example lists your installed certificates:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ security:certificates
</pre></div>
</div>
Import a new certificate:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ security:certificates:import /path/to/certificate
</pre></div>
</div>
Remove a certificate:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ security:certificates:remove [certificate name]
</pre></div>
</div>
</section>
<section id="status">
<h2>Status<a class="headerlink" href="#status" title="Link to this heading"></a></h2>
Use the status command to retrieve information about the current installation:
<div class="highlight-default notranslate"><div class="highlight"><pre>$ sudo -E -u www-data php occ status
 - installed: true
 - version: 25.0.2.3
 - versionstring: 25.0.2
 - edition:
 - maintenance: false
 - needsDbUpgrade: false
 - productname: Nextcloud
 - extendedSupport: false
</pre></div>
</div>
This information can also be formatted via JSON instead of plain text:
<div class="highlight-default notranslate"><div class="highlight"><pre>$ sudo -E -u www-data php occ status --output=json_pretty
{
 &quot;installed&quot;: true,
 &quot;version&quot;: &quot;25.0.2.3&quot;,
 &quot;versionstring&quot;: &quot;25.0.2&quot;,
 &quot;edition&quot;: &quot;&quot;,
 &quot;maintenance&quot;: false,
 &quot;needsDbUpgrade&quot;: false,
 &quot;productname&quot;: &quot;Nextcloud&quot;,
 &quot;extendedSupport&quot;: false
}
</pre></div>
</div>
<section id="status-return-code">
<h3>Status return code<a class="headerlink" href="#status-return-code" title="Link to this heading"></a></h3>
And finally, the <code class="docutils literal notranslate">-e</code> (for exit code) parameter can be used to check
the state of the nextcloud installation via return code:
<div class="highlight-default notranslate"><div class="highlight"><pre>$ sudo -E -u www-data php occ status -e
$ echo $?
0
$ sudo -E -u www-data php occ maintenance:mode --on
Maintenance mode enabled
$ sudo -E -u www-data php occ status -e
$ echo $?
1
$ sudo -E -u www-data php occ maintenance:mode --off
Maintenance mode disabled
$ sudo -E -u www-data php occ status -e
$ echo $?
0
</pre></div>
</div>
Note that by default there is no output when run with <code class="docutils literal notranslate">-e</code>. This is
intentional, so it can be used in scripts, monitoring checks, and systemd
units.
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head">Return code</th>
<th class="head">Description</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td>0</td>
<td>normal operation</td>
</tr>
<tr class="row-odd"><td>1</td>
<td>maintenance mode is enabled; the instance is currently
unavailable to users.</td>
</tr>
<tr class="row-even"><td>2</td>
<td><code class="docutils literal notranslate">sudo -E -u www-data php occ upgrade</code> is required</td>
</tr>
</tbody>
</table>
</section>
</section>
<section id="trashbin">
<h2>Trashbin<a class="headerlink" href="#trashbin" title="Link to this heading"></a></h2>
These commands allow for manually managing various aspects of the trash bin (deleted files):
<div class="highlight-default notranslate"><div class="highlight"><pre>trashbin
 trashbin:cleanup Permanently remove deleted files
 trashbin:expire Expires the users trashbin
 trashbin:size Configure the target trashbin size
 trashbin:restore Restore all deleted files according to the given filters
</pre></div>
</div>
<div class="admonition note">
Note
These commands are only available when the “Deleted files” app
(<code class="docutils literal notranslate">files_trashbin</code>) is enabled.
</div>
The <code class="docutils literal notranslate">trashbin:cleanup&#160; [--all-users] [--] [&lt;user_id&gt;...]</code> command removes the deleted files of the specified
users in a space-delimited list, or all users if –all-users is specified.
This example permanently removes the deleted files of all users:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ trashbin:cleanup --all-users
Remove all deleted files for all users
Remove deleted files for users on backend Database
 freda
 molly
 stash
 rosa
 edward
</pre></div>
</div>
This example permanently removes the deleted files of users molly and freda:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ trashbin:cleanup molly freda
Remove deleted files of molly
Remove deleted files of freda
</pre></div>
</div>
The <code class="docutils literal notranslate">trashbin:restore&#160; [--all-users] [--scope[=SCOPE]] [--since[=SINCE]] [--until[=UNTIL]] [--dry-run] [--] [&lt;user_id&gt;...]</code> command restores the deleted files of the specified
users in a space-delimited list, or all users if –all-users is specified.
This example restores the deleted user-files of all users:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ trashbin:restore --all-users
</pre></div>
</div>
This example restores the deleted user-files of users molly and freda:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ trashbin:restore molly freda
</pre></div>
</div>
The <code class="docutils literal notranslate">--scope</code> option can be used to limit the restore to a specific scope.
Possible values are “user”, “groupfolders” or “all” [default: “user”].
This example restores the deleted files of all groupfolders which are visible to the user freda:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ trashbin:restore --scope groupfolders freda
</pre></div>
</div>
The <code class="docutils literal notranslate">--since</code> and <code class="docutils literal notranslate">--until</code> options can be used to limit the restore to files deleted inside of the given time period.
This example restores the locally deleted files and files of any groupfolders which are visible to the user
freda. Additionally the files have to be deleted between <code class="docutils literal notranslate">01.08.2023 11:55:22</code> and <code class="docutils literal notranslate">02.08.2023 01:33</code>:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ trashbin:restore --scope all --since &quot;01.08.2023 11:55:22&quot; --until &quot;02.08.2023 01:33&quot; freda
</pre></div>
</div>
The <code class="docutils literal notranslate">--dry-run</code> option can be used to simulate the restore without actually restoring the files.
<div class="admonition note">
Note
You can use the verbose options (<code class="docutils literal notranslate">-v</code> or <code class="docutils literal notranslate">-vv</code>) to get more information about
the restore process and why some files might be skipped.
</div>
</section>
<section id="user-commands">
<h2>User commands<a class="headerlink" href="#user-commands" title="Link to this heading"></a></h2>
The <code class="docutils literal notranslate">user</code> commands create and remove users, reset passwords, manage authentication tokens / sessions, display a simple
report showing how many users you have, and when a user was last logged in:
<div class="highlight-default notranslate"><div class="highlight"><pre>user
 user:add adds a user
 user:add-app-password adds a app password named &quot;cli&quot; (deprecated: alias for user:auth-tokens:add)
 user:auth-tokens:add Add app password for the named account
 user:auth-tokens:delete Deletes an authentication token
 user:auth-tokens:list List authentication tokens of an user
 user:clear-avatar-cache clear avatar cache
 user:delete deletes the specified user
 user:disable disables the specified user
 user:enable enables the specified user
 user:info shows information about the specific user
 user:keys:verify Verify if the stored public key matches the stored private key
 user:lastseen shows when the user was logged in last time
 user:list shows list of all registered users
 user:report shows how many users have access
 user:resetpassword Resets the password of the named user
 user:setting Read and modify user settings
 user:keys:verify Verify that the stored public key matches
 the stored private key
</pre></div>
</div>
<section id="user-add">
<h3>user:add<a class="headerlink" href="#user-add" title="Link to this heading"></a></h3>
You can create a new user with their display name, login name, and any group
memberships with the <code class="docutils literal notranslate">user:add</code> command. The syntax is:
<div class="highlight-default notranslate"><div class="highlight"><pre>user:add [--password-from-env] [--generate-password] [--display-name[=&quot;...&quot;]] [-g|--group[=&quot;...&quot;]] [--email EMAIL]
uid
</pre></div>
</div>
The <code class="docutils literal notranslate">display-name</code> corresponds to the Full Name on the Users page in your
Nextcloud Web UI, and the <code class="docutils literal notranslate">uid</code> is their Username, which is their
login name. This example adds new user Layla Smith, and adds them to the
users and db-admins groups. Any groups that do not exist are created:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:add --display-name=&quot;Layla Smith&quot;
 --group=&quot;users&quot; --group=&quot;db-admins&quot; layla
 Enter password:
 Confirm password:
 The user &quot;layla&quot; was created successfully
 Display name set to &quot;Layla Smith&quot;
 User &quot;layla&quot; added to group &quot;users&quot;
 User &quot;layla&quot; added to group &quot;db-admins&quot;
</pre></div>
</div>
Go to your Users page, and you will see your new user.
<code class="docutils literal notranslate">password-from-env</code> allows you to set the user’s password from an environment
variable. This prevents the password from being exposed to all users via the
process list, and will only be visible in the history of the user (root)
running the command. This also permits creating scripts for adding multiple new
users.
To use <code class="docutils literal notranslate">password-from-env</code> you must run as “real” root, rather than <code class="docutils literal notranslate">sudo</code>,
because <code class="docutils literal notranslate">sudo</code> strips environment variables. This example adds new user Fred
Jones:
<div class="highlight-default notranslate"><div class="highlight"><pre>export OC_PASS=newpassword
sudo -E -u www-data php occ user:add --password-from-env --display-name=&quot;Fred Jones&quot; --group=&quot;users&quot; fred
The user &quot;fred&quot; was created successfully
Display name set to &quot;Fred Jones&quot;
User &quot;fred&quot; added to group &quot;users&quot;
</pre></div>
</div>
<code class="docutils literal notranslate">generate-password</code> allows you to set a securely generated password for the user.
This is never shown in the output and can be used to create users with temporary
passwords. This can be used in conjunction with the <code class="docutils literal notranslate">email</code> option to create
users with a temporary password and send a welcome email to the user’s email
address without user interaction:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:add layla --generate-password --email layla@example.tld
 The account &quot;layla&quot; was created successfully
 Welcome email sent to layla@example.tld
</pre></div>
</div>
The <code class="docutils literal notranslate">email</code> option allows you to set the user’s email address when creating
the user. A welcome email will be sent to the user’s email address if
<code class="docutils literal notranslate">newUser.sendEmail</code> is set to <code class="docutils literal notranslate">yes</code> in <code class="docutils literal notranslate">core</code>’s app config or not set at all:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:add layla --email layla@example.tld
 Enter password:
 Confirm password:
 The account &quot;layla&quot; was created successfully
 Welcome email sent to layla@example.tld
</pre></div>
</div>
</section>
<section id="user-resetpassword">
<h3>user:resetpassword<a class="headerlink" href="#user-resetpassword" title="Link to this heading"></a></h3>
You can reset any user’s password, including administrators (see
<a class="reference internal" href="configuration_user/reset_admin_password.html">Resetting a lost admin password</a>):
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:resetpassword layla
 Enter a new password:
 Confirm the new password:
 Successfully reset password for layla
</pre></div>
</div>
You may also use <code class="docutils literal notranslate">password-from-env</code> to reset passwords:
<div class="highlight-default notranslate"><div class="highlight"><pre>export OC_PASS=newpassword
sudo -E -u www-data php occ user:resetpassword --password-from-env layla
 Successfully reset password for layla
</pre></div>
</div>
</section>
<section id="user-delete">
<h3>user:delete<a class="headerlink" href="#user-delete" title="Link to this heading"></a></h3>
You can delete users:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:delete fred
</pre></div>
</div>
</section>
<section id="user-lastseen">
<h3>user:lastseen<a class="headerlink" href="#user-lastseen" title="Link to this heading"></a></h3>
View a specific user’s most recent login:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:lastseen layla
 layla&#39;s last login: 2024-03-20 17:18
</pre></div>
</div>
View a list of all users’ most recent login:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:lastseen --all
 albert&#39;s last login: 2024-03-18 10:30
 bob has never logged in.
 layla&#39;s last login: 2024-03-20 17:18
 stephanie&#39;s last login: 2024-01-11 13:26
</pre></div>
</div>
</section>
<section id="user-profile">
<h3>user:profile<a class="headerlink" href="#user-profile" title="Link to this heading"></a></h3>
Read user profile properties:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:profile admin
 - displayname: admin
 - address: Berlin
 - email: admin@example.net
 - profile_enabled: 1
 - pronouns: they/them
</pre></div>
</div>
Get a single profile property for a user:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:profile address
 Berlin
</pre></div>
</div>
Set a profile property:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:profile address Stuttgart
</pre></div>
</div>
Delete a profile property:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:profile address --delete
</pre></div>
</div>
</section>
<section id="user-setting">
<h3>user:setting<a class="headerlink" href="#user-setting" title="Link to this heading"></a></h3>
Read user settings:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:setting layla
 - core:
 - lang: en
 - login:
 - lastLogin: 1465910968
 - settings:
 - email: layla@example.tld
</pre></div>
</div>
Filter by app:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:setting layla core
 - core:
 - lang: en
</pre></div>
</div>
Get a single setting:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:setting layla core lang
en
</pre></div>
</div>
Set a setting:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:setting layla settings email &quot;new-layla@example.tld&quot;
</pre></div>
</div>
Delete a setting:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:setting layla settings email --delete
</pre></div>
</div>
</section>
<section id="user-report">
<h3>user:report<a class="headerlink" href="#user-report" title="Link to this heading"></a></h3>
Generate a simple report that counts all users, including users on external user
authentication servers such as LDAP:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:report
+------------------+----+
| User Report | |
+------------------+----+
| Database | 12 |
| LDAP | 86 |
| | |
| total users | 98 |
| | |
| user directories | 2 |
| active users | 15 |
| disabled users | 0 |
+------------------+----+
</pre></div>
</div>
<cite>active users</cite> shows the number of users which logged in at least once.
<cite>disabled users</cite> shows the number of users which are disabled.
There might be a discrepancy between the total number of users compared to the number of active users and the number of disabled users.
Users that have never logged in before are not counted as active or disabled users.
Some user backends also do not allow a count for the number of users.
</section>
<section id="user-list">
<h3>user:list<a class="headerlink" href="#user-list" title="Link to this heading"></a></h3>
You can use the command <code class="docutils literal notranslate">user:list</code> to list users. By default it will limit the output to 500 users but you can override that with options <code class="docutils literal notranslate">--limit</code> and <code class="docutils literal notranslate">--offset</code>. Use <code class="docutils literal notranslate">--disabled</code> to only list disabled users.
</section>
<section id="user-info">
<h3>user:info<a class="headerlink" href="#user-info" title="Link to this heading"></a></h3>
With the <code class="docutils literal notranslate">user:info</code> command, you can access an account information such as: user id, display name, quota, groups, storage usage… and many more
<div class="highlight-default notranslate"><div class="highlight"><pre>user:info admin
 - user_id: admin
 - display_name: admin
 - email: admin@domain.com
 - cloud_id: admin@cloud.domain.com
 - enabled: true
 - groups:
 - admin
 - users
 - quota: none
 - storage:
 - free: 162409623552
 - used: 1110
 - total: 162409624662
 - relative: 0
 - quota: -3
 - first_seen: 2025-03-14T08:44:46+00:00
 - last_seen: 2025-03-25T20:21:13+00:00
 - user_directory: /var/www/nextcloud/data/admin
 - backend: Database
</pre></div>
</div>
</section>
</section>
<section id="group-commands">
<h2>Group commands<a class="headerlink" href="#group-commands" title="Link to this heading"></a></h2>
The <code class="docutils literal notranslate">group</code> commands create and remove groups, add and remove users in
groups, display a list of all users in a group:
<div class="highlight-default notranslate"><div class="highlight"><pre>group
 group:add add a group
 group:delete remove a group
 group:adduser add a user to a group
 group:removeuser remove a user from a group
 group:list list configured groups
</pre></div>
</div>
You can create a new group with the <code class="docutils literal notranslate">group:add</code> command. The syntax is:
<div class="highlight-default notranslate"><div class="highlight"><pre>group:add [gid]
</pre></div>
</div>
The <code class="docutils literal notranslate">gid</code> corresponds to the group name you entering after clicking
“Add group” on the Users page in your Nextcloud Web UI. This example adds new
group “beer”:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ group:add beer
</pre></div>
</div>
Add an existing user to the specified group with the <code class="docutils literal notranslate">group:adduser</code>
command. The syntax is:
<div class="highlight-default notranslate"><div class="highlight"><pre>group:adduser [gid] [uid]
</pre></div>
</div>
This example adds the user “denis” to the existing group “beer”:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ group:adduser beer denis
</pre></div>
</div>
You can remove user from the group with the <code class="docutils literal notranslate">group:removeuser</code> command.
This example removes the existing user “denis” from the existing
group “beer”:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ group:removeuser beer denis
</pre></div>
</div>
Remove a group with the <code class="docutils literal notranslate">group:delete</code> command. Removing a group doesn’t
remove users in a group. You cannot remove the “admin” group. This example
removes the existing group “beer”:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ group:delete beer
</pre></div>
</div>
List configured groups via the <code class="docutils literal notranslate">group:list</code> command. The syntax is:
<div class="highlight-default notranslate"><div class="highlight"><pre>group:list [-l|--limit [LIMIT]] [-o|--offset [OFFSET]] [-i|--info] [--output [OUTPUT]]
</pre></div>
</div>
<code class="docutils literal notranslate">limit</code> allows you to specify the number of groups to retrieve (default: <code class="docutils literal notranslate">500</code>).
<code class="docutils literal notranslate">offset</code> is an offset for retrieving groups.
<code class="docutils literal notranslate">info</code> Show additional info (backend).
<code class="docutils literal notranslate">output</code> Output format: <code class="docutils literal notranslate">plain</code>, <code class="docutils literal notranslate">json</code> or <code class="docutils literal notranslate">json_pretty</code> (default: <code class="docutils literal notranslate">plain</code>).
</section>
<section id="versions">
<h2>Versions<a class="headerlink" href="#versions" title="Link to this heading"></a></h2>
<div class="admonition note">
Note
This command is only available when the “Versions” app (<code class="docutils literal notranslate">files_versions</code>) is
enabled.
</div>
Use this command to delete file versions for specific users, or for all users
when none are specified:
<div class="highlight-default notranslate"><div class="highlight"><pre>versions
 versions:cleanup Delete versions
 versions:expire Expires the users file versions
</pre></div>
</div>
This example deletes all versions for all users:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ versions:cleanup
Delete all versions
Delete versions for users on backend Database
 freda
 molly
 stash
 rosa
 edward
</pre></div>
</div>
You can delete versions for specific users in a space-delimited list:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ versions:cleanup freda molly
Delete versions of freda
Delete versions of molly
</pre></div>
</div>
</section>
<section id="command-line-installation">
<h2>Command line installation<a class="headerlink" href="#command-line-installation" title="Link to this heading"></a></h2>
These commands are available only after you have downloaded and unpacked the
Nextcloud archive, and taken no further installation steps.
You can install Nextcloud entirely from the command line. After downloading the
tarball and copying Nextcloud into the appropriate directories you can use <code class="docutils literal notranslate">occ</code>
commands in place of running the graphical Installation Wizard.
Then choose your <code class="docutils literal notranslate">occ</code> options. This lists your available options:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php /var/www/nextcloud/occ
Nextcloud is not installed - only a limited number of commands are available
Nextcloud version 19.0.0

Usage:
 [options] command [arguments]

Available commands:
 check check dependencies of the server environment
 help Displays help for a command
 list Lists commands
 status show some status information
 app
 l10n
 l10n:createjs Create javascript translation files for a given app
 maintenance
 maintenance:install install Nextcloud
</pre></div>
</div>
Display your <code class="docutils literal notranslate">maintenance:install</code> options:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ help maintenance:install
Nextcloud is not installed - only a limited number of commands are available
Usage:
 maintenance:install [--database=&quot;...&quot;] [--database-name=&quot;...&quot;]
[--database-host=&quot;...&quot;] [--database-user=&quot;...&quot;] [--database-pass[=&quot;...&quot;]]
[--database-table-prefix[=&quot;...&quot;]] [--admin-user=&quot;...&quot;] [--admin-pass=&quot;...&quot;]
[--data-dir=&quot;...&quot;]

Options:
 --database Supported database type (default: &quot;sqlite&quot;)
 --database-name Name of the database
 --database-host Hostname of the database (default: &quot;localhost&quot;)
 --database-user User name to connect to the database
 --database-pass Password of the database user
 --admin-user User name of the admin account (default: &quot;admin&quot;)
 --admin-pass Password of the admin account
 --data-dir Path to data directory (default:
 &quot;/var/www/nextcloud/data&quot;)
 --help (-h) Display this help message
 --quiet (-q) Do not output any message
 --verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal
 output, 2 for more verbose output and 3 for debug
 --version (-V) Display this application version
 --ansi Force ANSI output
 --no-ansi Disable ANSI output
 --no-interaction (-n) Do not ask any interactive question
</pre></div>
</div>
This example completes the installation:
<div class="highlight-default notranslate"><div class="highlight"><pre>cd /var/www/nextcloud/
sudo -E -u www-data php occ maintenance:install --database
&quot;mysql&quot; --database-name &quot;nextcloud&quot; --database-user &quot;root&quot; --database-pass
&quot;password&quot; --admin-user &quot;admin&quot; --admin-pass &quot;password&quot;
Nextcloud is not installed - only a limited number of commands are available
Nextcloud was successfully installed
</pre></div>
</div>
Supported databases are:
<div class="highlight-default notranslate"><div class="highlight"><pre>- sqlite (SQLite3 - Nextcloud Community edition only)
- mysql (MySQL/MariaDB)
- pgsql (PostgreSQL)
- oci (Oracle - Nextcloud Enterprise edition only)
</pre></div>
</div>
</section>
<section id="command-line-upgrade">
<h2>Command line upgrade<a class="headerlink" href="#command-line-upgrade" title="Link to this heading"></a></h2>
These commands are available only after you have downloaded upgraded packages or
tar archives, and before you complete the upgrade.
List all options:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ upgrade -h
Usage:
upgrade [--quiet]

Options:
--help (-h) Display this help message.
--quiet (-q) Do not output any message.
--verbose (-v|vv|vvv) Increase the verbosity of messages: 1 for normal output,
 2 for more verbose output and 3 for debug.
--version (-V) Display this application version.
--ansi Force ANSI output.
--no-ansi Disable ANSI output.
--no-interaction (-n) Do not ask any interactive question
</pre></div>
</div>
When you are performing an update or upgrade on your Nextcloud server (see the
Maintenance section of this manual), it is better to use <code class="docutils literal notranslate">occ</code> to perform the
database upgrade step, rather than the Web GUI, in order to avoid timeouts. PHP
scripts invoked from the Web interface are limited to 3600 seconds. In larger
environments this may not be enough, leaving the system in an inconsistent
state. After performing all the preliminary steps (see
<a class="reference internal" href="maintenance/upgrade.html">How to upgrade</a>) use this command to upgrade your databases,
like this example on CentOS Linux. Note how it details the steps:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ upgrade
Nextcloud or one of the apps require upgrade - only a limited number of
commands are available
Turned on maintenance mode
Checked database schema update
Checked database schema update for apps
Updated database
Updating &lt;gallery&gt; ...
Updated &lt;gallery&gt; to 0.6.1
Updating &lt;activity&gt; ...
Updated &lt;activity&gt; to 2.1.0
Update successful
Turned off maintenance mode
</pre></div>
</div>
Enabling verbosity displays timestamps:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ upgrade -v
Nextcloud or one of the apps require upgrade - only a limited number of commands are available
2015-06-23T09:06:15+0000 Turned on maintenance mode
2015-06-23T09:06:15+0000 Checked database schema update
2015-06-23T09:06:15+0000 Checked database schema update for apps
2015-06-23T09:06:15+0000 Updated database
2015-06-23T09:06:15+0000 Updated &lt;files_sharing&gt; to 0.6.6
2015-06-23T09:06:15+0000 Update successful
2015-06-23T09:06:15+0000 Turned off maintenance mode
</pre></div>
</div>
If there is an error it throws an exception, and the error is detailed in your
Nextcloud logfile, so you can use the log output to figure out what went wrong,
or to use in a bug report:
<div class="highlight-default notranslate"><div class="highlight"><pre>Turned on maintenance mode
Checked database schema update
Checked database schema update for apps
Updated database
Updating &lt;files_sharing&gt; ...
Exception
ServerNotAvailableException: LDAP server is not available
Update failed
Turned off maintenance mode
</pre></div>
</div>
</section>
<section id="two-factor-authentication">
<h2>Two-factor authentication<a class="headerlink" href="#two-factor-authentication" title="Link to this heading"></a></h2>
If a two-factor provider app is enabled, it is enabled for all users by default
(though the provider can decide whether or not the user has to pass the challenge).
In the case of a user losing access to the second factor (e.g. lost phone with
two-factor SMS verification), the admin can try to disable the two-factor
check for that user via the occ command:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ twofactorauth:disable &lt;uid&gt; &lt;provider_id&gt;
</pre></div>
</div>
<div class="admonition note">
Note
This is not supported by all providers.
</div>
To re-enable two-factor auth again use the following command:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ twofactorauth:enable &lt;uid&gt; &lt;provider_id&gt;
</pre></div>
</div>
<div class="admonition note">
Note
This is not supported by all providers.
</div>
</section>
<section id="disable-users">
<h2>Disable users<a class="headerlink" href="#disable-users" title="Link to this heading"></a></h2>
Admins can disable users via the occ command too:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:disable &lt;username&gt;
</pre></div>
</div>
Use the following command to enable the user again:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ user:enable &lt;username&gt;
</pre></div>
</div>
Note that once users are disabled, their connected browsers will be disconnected.
</section>
<section id="system-tags">
<h2>System Tags<a class="headerlink" href="#system-tags" title="Link to this heading"></a></h2>
List tags:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ tag:list
</pre></div>
</div>
Add a tag:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ tag:add &lt;name&gt; &lt;access&gt;
</pre></div>
</div>
Edit a tag:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ tag:edit --name &lt;name&gt; --access &lt;access&gt; &lt;id&gt;
</pre></div>
</div>
<cite>–name</cite> and <cite>–access</cite> are optional.
Delete a tag:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ tag:delete &lt;id&gt;
</pre></div>
</div>
Access level
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head">Level</th>
<th class="head">Visible¹</th>
<th class="head">Assignable²</th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td>public</td>
<td>Yes</td>
<td>Yes</td>
</tr>
<tr class="row-odd"><td>restricted</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr class="row-even"><td>invisible</td>
<td>No</td>
<td>No</td>
</tr>
</tbody>
</table>
<div class="line-block">
<div class="line">¹ User can see the tag</div>
<div class="line">² User can assign the tag to a file</div>
</div>
</section>
<section id="antivirus">
<h2>Antivirus<a class="headerlink" href="#antivirus" title="Link to this heading"></a></h2>
Get info about files in the scan queue:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files_antivirus:status [-v]
</pre></div>
</div>
Manually trigger the background scan:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files_antivirus:background-scan [-v] [-m MAX]
</pre></div>
</div>
Manually scan a single file:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files_antivirus:scan &lt;path&gt;
</pre></div>
</div>
Mark a file as scanned or unscanned:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ files_antivirus:mark &lt;path&gt; &lt;scanned|unscanned&gt;
</pre></div>
</div>
</section>
<section id="setupchecks">
<h2>Setupchecks<a class="headerlink" href="#setupchecks" title="Link to this heading"></a></h2>
Run the setupchecks via occ:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ setupchecks
</pre></div>
</div>
Example output:
<div class="highlight-default notranslate"><div class="highlight"><pre>dav:
 ✓ DAV system address book: No outstanding DAV system address book sync.
network:
 ✓ WebDAV endpoint: Your web server is properly set up to allow file synchronization over WebDAV.
 ✓ Data directory protected
 ✓ Internet connectivity
 ...
</pre></div>
</div>
</section>
<section id="snowflake-ids">
<h2>Snowflake IDs<a class="headerlink" href="#snowflake-ids" title="Link to this heading"></a></h2>
You can decode Snowflake IDs with occ:
<div class="highlight-default notranslate"><div class="highlight"><pre>sudo -E -u www-data php occ decode-snowflake &lt;snowflake_id&gt;
</pre></div>
</div>
Example output:
<div class="highlight-default notranslate"><div class="highlight"><pre>+--------------------+-------------------------+
| Snowflake ID | 6768789079123765868 |
| Seconds | 1575981518 |
| Milliseconds | 50 |
| Created from CLI | no |
| Server ID | 441 |
| Sequence ID | 2668 |
| Creation timestamp | 3335258318.050 |
| Creation date | 2075-09-09 12:38:38.050 |
+--------------------+-------------------------+
</pre></div>
</div>
</section>
<section id="share-operations">
<h2>Share operations<a class="headerlink" href="#share-operations" title="Link to this heading"></a></h2>
Available <code class="docutils literal notranslate">occ</code> commands for the <code class="docutils literal notranslate">share</code> namespace:
<div class="highlight-default notranslate"><div class="highlight"><pre>share:list list shares on the system
</pre></div>
</div>
<section id="list">
<h3>List<a class="headerlink" href="#list" title="Link to this heading"></a></h3>
The <code class="docutils literal notranslate">share:list</code> command lists all shares created on the system, with optional filters for recipient,
sharee, shared file and more.
</section>
</section>
<section id="debugging">
<h2>Debugging<a class="headerlink" href="#debugging" title="Link to this heading"></a></h2>
In certain situations it’s necessary to generate debugging information, e.g. before submitting a bug report. You can run <code class="docutils literal notranslate">occ</code> with debug logging:
<div class="highlight-default notranslate"><div class="highlight"><pre>NC_loglevel=0 sudo -E -u www-data php occ -h
</pre></div>
</div>
</section>
</section>

</div>
 </div>
 <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
 <a href="configuration_server/theming.html" class="btn btn-neutral float-left" title="Theming" accesskey="p" rel="prev"> Previous</a>
 <a href="reference/index.html" class="btn btn-neutral float-right" title="Reference management" accesskey="n" rel="next">Next </a>
 </div>

<hr/>

<div role="contentinfo">
 &#169; Copyright 2016-2026 Nextcloud GmbH and Nextcloud contributors.
 </div>

</footer>
 </div>
 </div>
 </section>
 </div>

<div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
 
 ☁️ latest
 
 
 <div class="rst-other-versions">
 <dl>
 <dt>☁️ Versions</dt>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/latest/admin_manual"
 
 style="color: var(--dark-link-color);"
 
 >
 latest
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/stable/admin_manual"
 
 >
 stable
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/32/admin_manual"
 
 >
 32
 </a>
 </dd>
 
 <dd style="width: 32%">
 <a href="https://docs.nextcloud.com/server/31/admin_manual"
 
 >
 31
 </a>
 </dd>
 
 </dl>
 </div>
 </div>
<script>
 jQuery(function () {
 SphinxRtdTheme.Navigation.enable(true);
 });
 </script>

</body>
</html>

Cancel