?i»?
Your IP : 13.58.26.185
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Using the occ command — Nextcloud 13 Administration Manual 13 documentation</title>
<link rel="stylesheet" href="../_static/" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/main.min.css" type="text/css" />
<link rel="stylesheet" href="../_static/styles.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '13',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/js/jquery-1.11.0.min.js"></script>
<script type="text/javascript" src="../_static/js/jquery-fix.js"></script>
<script type="text/javascript" src="../_static/bootstrap-3.1.0/js/bootstrap.min.js"></script>
<script type="text/javascript" src="../_static/bootstrap-sphinx.js"></script>
<link rel="top" title="Nextcloud 13 Administration Manual 13 documentation" href="../contents.html" />
<link rel="up" title="Server configuration" href="index.html" />
<link rel="next" title="Configuring the activity app" href="activity_configuration.html" />
<link rel="prev" title="Warnings on admin page" href="security_setup_warnings.html" />
<meta charset='utf-8'>
<meta http-equiv='X-UA-Compatible' content='IE=edge,chrome=1'>
<meta name='viewport' content='width=device-width, initial-scale=1.0, maximum-scale=1'>
<meta name="apple-mobile-web-app-capable" content="yes">
<meta name="theme-color" content="#1d2d44">
</head>
<body role="document">
<div class="wrap container not-front">
<div class="content row">
<main class="main">
<div class="row">
<div class="col-md-3">
<div class="sidebar">
<h1>Nextcloud 13 Administration Manual</h1>
<div class="sidebar-search">
<form class="headersearch" action="../search.html" method="get">
<input type="text" value="" name="q" id="q" class="form-control" />
<button class="btn btn-default" type="submit" id="searchsubmit">Search</button>
</form>
</div>
<div class="menu-support-container">
<ul id="menu-support" class="menu">
<ul>
<li><a href="../contents.html">Table of Contents</a></li>
</ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../index.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../release_notes.html">Release notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation/index.html">Installation</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="index.html">Server configuration</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="security_setup_warnings.html">Warnings on admin page</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="">Using the occ command</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#occ-command-directory">occ command Directory</a></li>
<li class="toctree-l3"><a class="reference internal" href="#run-occ-as-your-http-user">Run occ as your HTTP user</a></li>
<li class="toctree-l3"><a class="reference internal" href="#enabling-autocompletion">Enabling autocompletion</a></li>
<li class="toctree-l3"><a class="reference internal" href="#apps-commands">Apps commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="#background-jobs-selector">Background jobs selector</a></li>
<li class="toctree-l3"><a class="reference internal" href="#config-commands">Config commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="#dav-commands">Dav commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="#database-conversion">Database conversion</a></li>
<li class="toctree-l3"><a class="reference internal" href="#add-missing-indices">Add missing indices</a></li>
<li class="toctree-l3"><a class="reference internal" href="#encryption">Encryption</a></li>
<li class="toctree-l3"><a class="reference internal" href="#federation-sync">Federation sync</a></li>
<li class="toctree-l3"><a class="reference internal" href="#file-operations">File operations</a></li>
<li class="toctree-l3"><a class="reference internal" href="#files-external">Files external</a></li>
<li class="toctree-l3"><a class="reference internal" href="#integrity-check">Integrity check</a></li>
<li class="toctree-l3"><a class="reference internal" href="#l10n-create-javascript-translation-files-for-apps">l10n, create JavaScript translation files for apps</a></li>
<li class="toctree-l3"><a class="reference internal" href="#ldap-commands">LDAP commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="#logging-commands">Logging commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="#maintenance-commands">Maintenance commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="#security">Security</a></li>
<li class="toctree-l3"><a class="reference internal" href="#trashbin">Trashbin</a></li>
<li class="toctree-l3"><a class="reference internal" href="#user-commands">User commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="#versions">Versions</a></li>
<li class="toctree-l3"><a class="reference internal" href="#command-line-installation">Command line installation</a></li>
<li class="toctree-l3"><a class="reference internal" href="#command-line-upgrade">Command line upgrade</a></li>
<li class="toctree-l3"><a class="reference internal" href="#two-factor-authentication">Two-factor authentication</a></li>
<li class="toctree-l3"><a class="reference internal" href="#disable-users">Disable users</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="activity_configuration.html">Configuring the activity app</a></li>
<li class="toctree-l2"><a class="reference internal" href="caching_configuration.html">Configuring memory caching</a></li>
<li class="toctree-l2"><a class="reference internal" href="background_jobs_configuration.html">Defining background jobs</a></li>
<li class="toctree-l2"><a class="reference internal" href="config_sample_php_parameters.html">Config.php Parameters</a></li>
<li class="toctree-l2"><a class="reference internal" href="email_configuration.html">Email configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="external_sites.html">Linking external sites</a></li>
<li class="toctree-l2"><a class="reference internal" href="language_configuration.html">Language configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="logging_configuration.html">Logging configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="harden_server.html">Hardening and security guidance</a></li>
<li class="toctree-l2"><a class="reference internal" href="reverse_proxy_configuration.html">Reverse proxy configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="thirdparty_php_configuration.html">Using third party PHP components</a></li>
<li class="toctree-l2"><a class="reference internal" href="automatic_configuration.html">Automatic configuration setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="server_tuning.html">Server tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="theming.html">Theming</a></li>
</ul>
</li>
<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="../configuration_files/index.html">File sharing and management</a></li>
<li class="toctree-l1"><a class="reference internal" href="../file_workflows/index.html">File workflows</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_database/index.html">Database configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../configuration_mimetypes/index.html">Mimetypes management</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>
</ul>
</div>
</div>
</div>
<div class="col-md-9">
<div class="page-content">
<ul class="prevnext-title list-unstyled list-inline">
<li class="prev">
<a href="security_setup_warnings.html" title="Previous Chapter: Warnings on admin page"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm">« Warnings on admin page</span>
</a>
</li>
<li class="next">
<a href="activity_configuration.html" title="Next Chapter: Configuring the activity app"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm">Configuring the activity app »</span>
</a>
</li>
</ul>
<div class="section" id="using-the-occ-command">
<h1>Using the occ command<a class="headerlink" href="#using-the-occ-command" title="Permalink to this headline">ΒΆ</a></h1>
<p>Nextcloud’s <code class="docutils literal"><span class="pre">occ</span></code> command (origins from “ownCloud Console”) is Nextcloud’s command-line
interface. You can perform many common server operations with <code class="docutils literal"><span class="pre">occ</span></code>, such as
installing and upgrading Nextcloud, manage users, encryption, passwords, LDAP
setting, and more.</p>
<p><code class="docutils literal"><span class="pre">occ</span></code> is in the <code class="file docutils literal"><span class="pre">nextcloud/</span></code> directory; for example
<code class="file docutils literal"><span class="pre">/var/www/nextcloud</span></code> on Ubuntu Linux. <code class="docutils literal"><span class="pre">occ</span></code> is a PHP script. <strong>You must
run it as your HTTP user</strong> to ensure that the correct permissions are maintained
on your Nextcloud files and directories.</p>
<div class="section" id="occ-command-directory">
<h2>occ command Directory<a class="headerlink" href="#occ-command-directory" title="Permalink to this headline">ΒΆ</a></h2>
<ul class="simple">
<li><a class="reference internal" href="#http-user-label"><span>Run occ as your HTTP user</span></a></li>
<li><a class="reference internal" href="#apps-commands-label"><span>Apps commands</span></a></li>
<li><a class="reference internal" href="#background-jobs-selector-label"><span>Background jobs selector</span></a></li>
<li><a class="reference internal" href="#config-commands-label"><span>Config commands</span></a></li>
<li><a class="reference internal" href="#dav-label"><span>Dav commands</span></a></li>
<li><a class="reference internal" href="#database-conversion-label"><span>Database conversion</span></a></li>
<li><a class="reference internal" href="#database-add-indices-label"><span>Add missing indices</span></a></li>
<li><a class="reference internal" href="#encryption-label"><span>Encryption</span></a></li>
<li><a class="reference internal" href="#federation-sync-label"><span>Federation sync</span></a></li>
<li><a class="reference internal" href="#file-operations-label"><span>File operations</span></a></li>
<li><a class="reference internal" href="#files-external-label"><span>Files external</span></a></li>
<li><a class="reference internal" href="#integrity-check-label"><span>Integrity check</span></a></li>
<li><a class="reference internal" href="#create-javascript-translation-files-label"><span>l10n, create JavaScript translation files for apps</span></a></li>
<li><a class="reference internal" href="#ldap-commands-label"><span>LDAP commands</span></a></li>
<li><a class="reference internal" href="#logging-commands-label"><span>Logging commands</span></a></li>
<li><a class="reference internal" href="#maintenance-commands-label"><span>Maintenance commands</span></a></li>
<li><a class="reference internal" href="#security-commands-label"><span>Security</span></a></li>
<li><a class="reference internal" href="#trashbin-label"><span>Trashbin</span></a></li>
<li><a class="reference internal" href="#user-commands-label"><span>User commands</span></a></li>
<li><a class="reference internal" href="#versions-label"><span>Versions</span></a></li>
<li><a class="reference internal" href="#command-line-installation-label"><span>Command line installation</span></a></li>
<li><a class="reference internal" href="#command-line-upgrade-label"><span>Command line upgrade</span></a></li>
<li><a class="reference internal" href="#two-factor-auth-label"><span>Two-factor authentication</span></a></li>
<li><a class="reference internal" href="#disable-user-label"><span>Disable users</span></a></li>
</ul>
</div>
<div class="section" id="run-occ-as-your-http-user">
<span id="http-user-label"></span><h2>Run occ as your HTTP user<a class="headerlink" href="#run-occ-as-your-http-user" title="Permalink to this headline">ΒΆ</a></h2>
<p>The HTTP user is different on the various Linux distributions:</p>
<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>
<p>If your HTTP server is configured to use a different PHP version than the
default (/usr/bin/php), <code class="docutils literal"><span class="pre">occ</span></code> should be run with the same version. For
example, in CentOS 6.5 with SCL-PHP56 installed, the command looks like this:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u apache /opt/rh/php56/root/usr/bin/php /var/www/html/nextcloud/occ
</pre></div>
</div>
<p>Running <code class="docutils literal"><span class="pre">occ</span></code> with no options lists all commands and options, like this
example on Ubuntu:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ
Nextcloud version 9.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>
<p>This is the same as <code class="docutils literal"><span class="pre">sudo</span> <span class="pre">-u</span> <span class="pre">www-data</span> <span class="pre">php</span> <span class="pre">occ</span> <span class="pre">list</span></code>.</p>
<p>Run it with the <code class="docutils literal"><span class="pre">-h</span></code> option for syntax help:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ -h
</pre></div>
</div>
<p>Display your Nextcloud version:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ -V
Nextcloud version 9.0.0
</pre></div>
</div>
<p>Query your Nextcloud server status:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ status
- installed: true
- version: 9.0.0.19
- versionstring: 9.0.0
- edition:
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">occ</span></code> has options, commands, and arguments. Options and arguments are
optional, while commands are required. The syntax is:</p>
<div class="highlight-python"><div class="highlight"><pre>occ [options] command [arguments]
</pre></div>
</div>
<p>Get detailed information on individual commands with the <code class="docutils literal"><span class="pre">help</span></code> command, like
this example for the <code class="docutils literal"><span class="pre">maintenance:mode</span></code> command:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -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>
<p>The <code class="docutils literal"><span class="pre">status</span></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"><span class="pre">json</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ status --output=json
{"installed":true,"version":"9.0.0.19","versionstring":"9.0.0","edition":""}
</pre></div>
</div>
<p>or <code class="docutils literal"><span class="pre">json_pretty</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ status --output=json_pretty
{
"installed": true,
"version": "9.0.0.19",
"versionstring": "9.0.0",
"edition": ""
}
</pre></div>
</div>
<p>This output option is available on all list and list-like commands:
<code class="docutils literal"><span class="pre">status</span></code>, <code class="docutils literal"><span class="pre">check</span></code>, <code class="docutils literal"><span class="pre">app:list</span></code>, <code class="docutils literal"><span class="pre">config:list</span></code>, <code class="docutils literal"><span class="pre">encryption:status</span></code>
and <code class="docutils literal"><span class="pre">encryption:list-modules</span></code></p>
</div>
<div class="section" id="enabling-autocompletion">
<h2>Enabling autocompletion<a class="headerlink" href="#enabling-autocompletion" title="Permalink to this headline">ΒΆ</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This currently only works, if the user you use to execute the occ commands has a profile.
<code class="docutils literal"><span class="pre">www-data</span></code> in most cases is <code class="docutils literal"><span class="pre">nologon</span></code> and therefor can <strong>not</strong> use this.</p>
</div>
<p>Since Nextcloud 11 autocompletion is available for bash (and bash based consoles).
To enable it, you have to run <strong>one</strong> of the following commands:</p>
<div class="highlight-python"><div class="highlight"><pre># BASH ~4.x, ZSH
source <(/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>
<p>This will allow you to use autocompletion with the full path <code class="docutils literal"><span class="pre">/var/www/html/nextcloud/occ</span> <span class="pre"><tab></span></code>.</p>
<p>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"><span class="pre">--program</span> <span class="pre">occ</span></code> after the <code class="docutils literal"><span class="pre">--generate-hook</span></code>.</p>
<p>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"><span class="pre">~/.bash_profile</span></code> or <code class="docutils literal"><span class="pre">~/.zshrc</span></code>).</p>
</div>
<div class="section" id="apps-commands">
<span id="apps-commands-label"></span><h2>Apps commands<a class="headerlink" href="#apps-commands" title="Permalink to this headline">ΒΆ</a></h2>
<p>The <code class="docutils literal"><span class="pre">app</span></code> commands list, enable, and disable apps:</p>
<div class="highlight-python"><div class="highlight"><pre>app
app:install install selected app
app:check-code check code to be compliant
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
</pre></div>
</div>
<p>List all of your installed apps, and show whether they are
enabled or disabled:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ app:list
</pre></div>
</div>
<p>Enable an app, for example the External Storage Support app:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ app:enable files_external
files_external enabled
</pre></div>
</div>
<p>Disable an app:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ app:disable files_external
files_external disabled
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">app:check-code</span></code> has multiple checks: it checks if an app uses Nextcloud’s
public API (<code class="docutils literal"><span class="pre">OCP</span></code>) or private API (<code class="docutils literal"><span class="pre">OC_</span></code>), and it also checks for deprecated
methods and the validity of the <code class="docutils literal"><span class="pre">info.xml</span></code> file. By default all checks are
enabled. The Activity app is an example of a correctly-formatted app:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ app:check-code notifications
App is compliant - awesome job!
</pre></div>
</div>
<p>If your app has issues, you’ll see output like this:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ app:check-code foo_app
Analysing /var/www/nextcloud/apps/files/foo_app.php
4 errors
line 45: OCP\Response - Static method of deprecated class must not be
called
line 46: OCP\Response - Static method of deprecated class must not be
called
line 47: OCP\Response - Static method of deprecated class must not be
called
line 49: OC_Util - Static method of private class must not be called
</pre></div>
</div>
<p>You can get the full filepath to an app:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ app:getpath notifications
/var/www/nextcloud/apps/notifications
</pre></div>
</div>
</div>
<div class="section" id="background-jobs-selector">
<span id="background-jobs-selector-label"></span><h2>Background jobs selector<a class="headerlink" href="#background-jobs-selector" title="Permalink to this headline">ΒΆ</a></h2>
<p>Use the <code class="docutils literal"><span class="pre">background</span></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 <strong>Cron</strong> section on your Nextcloud Admin page:</p>
<div class="highlight-python"><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>
<p>This example selects Ajax:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ background:ajax
Set mode for background jobs to 'ajax'
</pre></div>
</div>
<p>The other two commands are:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">background:cron</span></code></li>
<li><code class="docutils literal"><span class="pre">background:webcron</span></code></li>
</ul>
<p>See <a class="reference internal" href="background_jobs_configuration.html"><em>Defining background jobs</em></a> to learn more.</p>
</div>
<div class="section" id="config-commands">
<span id="config-commands-label"></span><h2>Config commands<a class="headerlink" href="#config-commands" title="Permalink to this headline">ΒΆ</a></h2>
<p>The <code class="docutils literal"><span class="pre">config</span></code> commands are used to configure the Nextcloud server:</p>
<div class="highlight-python"><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>
<p>You can list all configuration values with one command:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:list
</pre></div>
</div>
<p>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"><span class="pre">--private</span></code> flag
needs to be set:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:list --private
</pre></div>
</div>
<p>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:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:import filename.json
</pre></div>
</div>
<p>It is also possible to import remote files, by piping the input:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:import < local-backup.json
</pre></div>
</div>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">While it is possible to update/set/delete the versions and installation
statuses of apps and Nextcloud itself, it is <strong>not</strong> recommended to do this
directly. Use the <code class="docutils literal"><span class="pre">occ</span> <span class="pre">app:enable</span></code>, <code class="docutils literal"><span class="pre">occ</span> <span class="pre">app:disable</span></code> and <code class="docutils literal"><span class="pre">occ</span> <span class="pre">update</span></code>
commands instead.</p>
</div>
<div class="section" id="getting-a-single-configuration-value">
<h3>Getting a single configuration value<a class="headerlink" href="#getting-a-single-configuration-value" title="Permalink to this headline">ΒΆ</a></h3>
<p>These commands get the value of a single app or system configuration:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:system:get version
9.0.0.19
sudo -u www-data php occ config:app:get activity installed_version
2.2.1
</pre></div>
</div>
</div>
<div class="section" id="setting-a-single-configuration-value">
<h3>Setting a single configuration value<a class="headerlink" href="#setting-a-single-configuration-value" title="Permalink to this headline">ΒΆ</a></h3>
<p>These commands set the value of a single app or system configuration:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:system:set logtimezone
--value="Europe/Berlin"
System config value logtimezone set to Europe/Berlin
sudo -u www-data php occ config:app:set files_sharing
incoming_server2server_share_enabled --value="yes" --type=boolean
Config value incoming_server2server_share_enabled for app files_sharing set to yes
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">config:system:set</span></code> command creates the value, if it does not already
exist. To update an existing value, set <code class="docutils literal"><span class="pre">--update-only</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:system:set doesnotexist --value="true"
--type=boolean --update-only
Value not updated, as it has not been set before.
</pre></div>
</div>
<p>Note that in order to write a Boolean, float, or integer value to the
configuration file, you need to specify the type on your command. This
applies only to the <code class="docutils literal"><span class="pre">config:system:set</span></code> command. The following values are
known:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">boolean</span></code></li>
<li><code class="docutils literal"><span class="pre">integer</span></code></li>
<li><code class="docutils literal"><span class="pre">float</span></code></li>
<li><code class="docutils literal"><span class="pre">string</span></code> (default)</li>
</ul>
<p>When you want to e.g. disable the maintenance mode run the following command:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:system:set maintenance --value=false
--type=boolean
Nextcloud is in maintenance mode - no app have been loaded
System config value maintenance set to boolean false
</pre></div>
</div>
</div>
<div class="section" id="setting-an-array-configuration-value">
<h3>Setting an array configuration value<a class="headerlink" href="#setting-an-array-configuration-value" title="Permalink to this headline">ΒΆ</a></h3>
<p>Some configurations (e.g. the trusted domain setting) are an array of data.
In order to set (and also get) the value of one key, you can specify multiple
<code class="docutils literal"><span class="pre">config</span></code> names separated by spaces:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:system:get trusted_domains
localhost
nextcloud.local
sample.tld
</pre></div>
</div>
<p>To replace <code class="docutils literal"><span class="pre">sample.tld</span></code> with <code class="docutils literal"><span class="pre">example.com</span></code> trusted_domains => 2 needs to be
set:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:system:set trusted_domains 2
--value=example.com
System config value trusted_domains => 2 set to string example.com
sudo -u www-data php occ config:system:get trusted_domains
localhost
nextcloud.local
example.com
</pre></div>
</div>
</div>
<div class="section" id="deleting-a-single-configuration-value">
<h3>Deleting a single configuration value<a class="headerlink" href="#deleting-a-single-configuration-value" title="Permalink to this headline">ΒΆ</a></h3>
<p>These commands delete the configuration of an app or system configuration:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ config:system:delete maintenance:mode
System config value maintenance:mode deleted
sudo -u www-data php occ config:app:delete appname provisioning_api
Config value provisioning_api of app appname deleted
</pre></div>
</div>
<p>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"><span class="pre">--error-if-not-exists</span></code> flag:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -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>
</div>
</div>
<div class="section" id="dav-commands">
<span id="dav-label"></span><h2>Dav commands<a class="headerlink" href="#dav-commands" title="Permalink to this headline">ΒΆ</a></h2>
<p>A set of commands to create addressbooks, calendars, and to
migrate addressbooks from 8.2 when you upgrade to 9.0:</p>
<div class="highlight-python"><div class="highlight"><pre>dav
dav:create-addressbook Create a dav addressbook
dav:create-calendar Create a dav calendar
dav:migrate-addressbooks Migrate addressbooks from the contacts
app to core
dav:migrate-calendars Migrate calendars from the calendar app to
core
dav:sync-birthday-calendar Synchronizes the birthday calendar
dav:sync-system-addressbook Synchronizes users to the system
addressbook
</pre></div>
</div>
<p>The syntax for <code class="docutils literal"><span class="pre">dav:create-addressbook</span></code> and <code class="docutils literal"><span class="pre">dav:create-calendar</span></code> is
<code class="docutils literal"><span class="pre">dav:create-addressbook</span> <span class="pre">[user]</span> <span class="pre">[name]</span></code>. This example creates the addressbook
<code class="docutils literal"><span class="pre">mollybook</span></code> for the user molly:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ dav:create-addressbook molly mollybook
</pre></div>
</div>
<p>This example creates a new calendar for molly:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ dav:create-calendar molly mollycal
</pre></div>
</div>
<p>Molly will immediately see these on her Calendar and Contacts pages.</p>
<p>In 9.0, the CalDAV server has been integrated into core. Your existing
calendars and contacts should migrate automatically when you upgrade. If
something goes wrong you can try a manual migration. First delete any
partially-migrated calendars or addressbooks. Then run this
command to migrate user’s contacts:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ dav:migrate-addressbooks [user]
</pre></div>
</div>
<p>Run this command to migrate calendars:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ dav:migrate-calendars [user]
</pre></div>
</div>
<p>See <a class="reference external" href="http://morrisjobke.de/2016/03/07/ownCloud-9.0-calendar-migration-analysis/">ownCloud 9.0 - calendar migration analysis</a>
for help with troubleshooting and reporting problems.</p>
<p><code class="docutils literal"><span class="pre">dav:sync-birthday-calendar</span></code> adds all birthdays to your calendar from
addressbooks shared with you. This example syncs to your calendar from user
bernie:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ dav:sync-birthday-calendar bernie
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">dav:sync-system-addressbook</span></code> synchronizes all users to the system
addressbook:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ dav:sync-system-addressbook
</pre></div>
</div>
</div>
<div class="section" id="database-conversion">
<span id="database-conversion-label"></span><h2>Database conversion<a class="headerlink" href="#database-conversion" title="Permalink to this headline">ΒΆ</a></h2>
<p>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"><span class="pre">occ</span></code> to
convert from SQLite to one of these other databases.</p>
<div class="highlight-python"><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>
<p>You need:</p>
<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>
<p>This is example converts SQLite to MySQL/MariaDB:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ db:convert-type mysql oc_dbuser 127.0.0.1
oc_database
</pre></div>
</div>
<p>For a more detailed explanation see
<a class="reference internal" href="../configuration_database/db_conversion.html"><em>Converting database type</em></a></p>
</div>
<div class="section" id="add-missing-indices">
<span id="database-add-indices-label"></span><h2>Add missing indices<a class="headerlink" href="#add-missing-indices" title="Permalink to this headline">ΒΆ</a></h2>
<p>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:</p>
<blockquote>
<div>sudo -u www-data php occ db:add-missing-indices</div></blockquote>
</div>
<div class="section" id="encryption">
<span id="encryption-label"></span><h2>Encryption<a class="headerlink" href="#encryption" title="Permalink to this headline">ΒΆ</a></h2>
<p><code class="docutils literal"><span class="pre">occ</span></code> includes a complete set of commands for managing encryption:</p>
<div class="highlight-python"><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: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>
<p><code class="docutils literal"><span class="pre">encryption:status</span></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"><span class="pre">encryption:enable</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ app:enable encryption
sudo -u www-data php occ encryption:enable
sudo -u www-data php occ encryption:status
- enabled: true
- defaultModule: OC_DEFAULT_MODULE
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">encryption:change-key-storage-root</span></code> is for moving your encryption keys to a
different folder. It takes one argument, <code class="docutils literal"><span class="pre">newRoot</span></code>, which defines your new
root folder:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ encryption:change-key-storage-root /etc/oc-keys
</pre></div>
</div>
<p>You can see the current location of your keys folder:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ encryption:show-key-storage-root
Current key storage root: default storage location (data/)
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">encryption:list-modules</span></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"><span class="pre">encryption:set-default-module</span> <span class="pre">[module</span> <span class="pre">name]</span></code> to set your desired module.</p>
<p><code class="docutils literal"><span class="pre">encryption:encrypt-all</span></code> encrypts all data files for all users. You must first
put your Nextcloud server into <a class="reference internal" href="#maintenance-commands-label"><span>maintenance
mode</span></a> to prevent any user activity until encryption
is completed.</p>
<p><code class="docutils literal"><span class="pre">encryption:decrypt-all</span></code> decrypts all user data files, or optionally a single
user:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ encryption:decrypt freda
</pre></div>
</div>
<p>Users must have enabled recovery keys on their Personal pages. You must first
put your Nextcloud server into <a class="reference internal" href="#maintenance-commands-label"><span>maintenance
mode</span></a> to prevent any user activity until
decryption is completed.</p>
<p>Use <code class="docutils literal"><span class="pre">encryption:disable</span></code> to disable your encryption module. You must first put
your Nextcloud server into <a class="reference internal" href="#maintenance-commands-label"><span>maintenance mode</span></a>
to prevent any user activity.</p>
<p><code class="docutils literal"><span class="pre">encryption:enable-master-key</span></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.</p>
<p>See <a class="reference internal" href="../configuration_files/encryption_configuration.html"><em>Encryption configuration</em></a> to learn more.</p>
</div>
<div class="section" id="federation-sync">
<span id="federation-sync-label"></span><h2>Federation sync<a class="headerlink" href="#federation-sync" title="Permalink to this headline">ΒΆ</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This command is only available when the “Federation” app (<code class="docutils literal"><span class="pre">federation</span></code>) is
enabled.</p>
</div>
<p>Synchronize the addressbooks of all federated Nextcloud servers:</p>
<div class="highlight-python"><div class="highlight"><pre>federation:sync-addressbooks Synchronizes addressbooks of all
federated clouds
</pre></div>
</div>
<p>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:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ federation:sync-addressbooks
</pre></div>
</div>
</div>
<div class="section" id="file-operations">
<span id="file-operations-label"></span><h2>File operations<a class="headerlink" href="#file-operations" title="Permalink to this headline">ΒΆ</a></h2>
<p><code class="docutils literal"><span class="pre">occ</span></code> has three commands for managing files in Nextcloud:</p>
<div class="highlight-python"><div class="highlight"><pre>files
files:cleanup cleanup filecache
files:scan rescan filesystem
files:transfer-ownership All files and folders are moved to another
user - shares are moved as well.
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">files:scan</span></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"><span class="pre">--quiet</span></code>, statistics will be shown at the end of
the scan:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ files:scan --help
Usage:
files:scan [-p|--path="..."] [-q|--quiet] [-v|vv|vvv --verbose] [--all]
[user_id1] ... [user_idN]
Arguments:
user_id will rescan all files of the given user(s)
Options:
--path limit rescan to the user/path given
--all will rescan all files of all known users
--quiet suppress any output
--verbose files and directories being processed are shown
additionally during scanning
--unscanned scan only previously unscanned files
</pre></div>
</div>
<p>Verbosity levels of <code class="docutils literal"><span class="pre">-vv</span></code> or <code class="docutils literal"><span class="pre">-vvv</span></code> are automatically reset to <code class="docutils literal"><span class="pre">-v</span></code></p>
<p>Note for option –unscanned:
In general there is a background job (through cron) that will do that scan periodically.
The –unscanned option makes it possible to trigger this from the CLI.</p>
<p>When using the <code class="docutils literal"><span class="pre">--path</span></code> option, the path must consist of following
components:</p>
<div class="highlight-python"><div class="highlight"><pre>"user_id/files/path"
or
"user_id/files/mount_name"
or
"user_id/files/mount_name/path"
</pre></div>
</div>
<p>where the term <code class="docutils literal"><span class="pre">files</span></code> is mandatory.</p>
<p>Example:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="o">--</span><span class="n">path</span><span class="o">=</span><span class="s2">"/alice/files/Music"</span>
</pre></div>
</div>
<p>In the example above, the user_id <code class="docutils literal"><span class="pre">alice</span></code> is determined implicitly from the
path component given.</p>
<p>The <code class="docutils literal"><span class="pre">--path</span></code>, <code class="docutils literal"><span class="pre">--all</span></code> and <code class="docutils literal"><span class="pre">[user_id]</span></code> parameters and are exclusive - only
one must be specified.</p>
<p><code class="docutils literal"><span class="pre">files:cleanup</span></code> tidies up the server’s file cache by deleting all file
entries that have no matching entries in the storage table.</p>
<p>You may transfer all files and shares from one user to another. This is useful
before removing a user:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ files:transfer-ownership <source-user>
<destination-user>
</pre></div>
</div>
</div>
<div class="section" id="files-external">
<span id="files-external-label"></span><h2>Files external<a class="headerlink" href="#files-external" title="Permalink to this headline">ΒΆ</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These commands are only available when the “External storage support” app
(<code class="docutils literal"><span class="pre">files_external</span></code>) is enabled.</p>
</div>
<p>Commands for managing external storage:</p>
<div class="highlight-python"><div class="highlight"><pre>files_external
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 mounts
files_external:option Manage mount options for a mount
files_external:verify Verify mount configuration
files_external:notify Listen for active update notifications for a configured external mount
</pre></div>
</div>
<p>These commands replicate the functionality in the Nextcloud Web GUI, plus two new
features: <code class="docutils literal"><span class="pre">files_external:export</span></code> and <code class="docutils literal"><span class="pre">files_external:import</span></code>.</p>
<p>Use <code class="docutils literal"><span class="pre">files_external:export</span></code> to export all admin mounts to stdout, and
<code class="docutils literal"><span class="pre">files_external:export</span> <span class="pre">[user_id]</span></code> to export the mounts of the specified
Nextcloud user.</p>
<p>Use <code class="docutils literal"><span class="pre">files_external:import</span> <span class="pre">[filename]</span></code> to import legacy JSON configurations,
and to copy external mount configurations to another Nextcloud server.</p>
</div>
<div class="section" id="integrity-check">
<span id="integrity-check-label"></span><h2>Integrity check<a class="headerlink" href="#integrity-check" title="Permalink to this headline">ΒΆ</a></h2>
<p>Apps which have an official tag MUST be code signed with Nextcloud. Unsigned official apps won’t be installable anymore. Code signing is optional for all third-party applications:</p>
<div class="highlight-python"><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>
<p>After creating your signing key, sign your app like this example:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -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>
<p>Verify your app:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ integrity:check-app --path=/pathto/app appname
</pre></div>
</div>
<p>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.org/server/12/developer_manual/app/code_signing.html#how-to-get-your-app-signed">Code Signing</a> in the Developer manual for more detailed information.
.. TODO ON RELEASE: Update version number above on release</p>
<p><code class="docutils literal"><span class="pre">integrity:sign-core</span></code> is for Nextcloud core developers only.</p>
<p>See <a class="reference internal" href="../issues/code_signing.html"><em>Code signing</em></a> to learn more.</p>
</div>
<div class="section" id="l10n-create-javascript-translation-files-for-apps">
<span id="create-javascript-translation-files-label"></span><h2>l10n, create JavaScript translation files for apps<a class="headerlink" href="#l10n-create-javascript-translation-files-for-apps" title="Permalink to this headline">ΒΆ</a></h2>
<p>This command is for app developers to update their translation mechanism from
ownCloud 7 to Nextcloud.</p>
</div>
<div class="section" id="ldap-commands">
<span id="ldap-commands-label"></span><h2>LDAP commands<a class="headerlink" href="#ldap-commands" title="Permalink to this headline">ΒΆ</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">These commands are only available when the “LDAP user and group backend” app
(<code class="docutils literal"><span class="pre">user_ldap</span></code>) is enabled.</p>
</div>
<p>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"><span class="pre">occ</span></code>:</p>
<div class="highlight-python"><div class="highlight"><pre>ldap
ldap:check-user checks whether a user 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
</pre></div>
</div>
<p>Search for an LDAP user, using this syntax:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:search [--group] [--offset="..."]
[--limit="..."] search
</pre></div>
</div>
<p>Searches will match at the beginning of the attribute value only. This example
searches for givenNames that start with “rob”:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:search "rob"
</pre></div>
</div>
<p>This will find robbie, roberta, and robin. Broaden the search to find, for
example, <code class="docutils literal"><span class="pre">jeroboam</span></code> with the asterisk wildcard:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:search "*rob"
</pre></div>
</div>
<p>User search attributes are set with <code class="docutils literal"><span class="pre">ldap:set-config</span></code>
(below). For example, if your search attributes are
<code class="docutils literal"><span class="pre">givenName</span></code> and <code class="docutils literal"><span class="pre">sn</span></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"><span class="pre">te</span> <span class="pre">ha</span></code>.
Trailing whitespaces are ignored.</p>
<p>Check if an LDAP user exists. This works only if the Nextcloud server is
connected to an LDAP server:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:check-user robert
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">ldap:check-user</span></code> 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"><span class="pre">--force</span></code> option to force it to check all active LDAP connections:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:check-user --force robert
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">ldap:create-empty-config</span></code> creates an empty LDAP configuration. The first
one you create has no <code class="docutils literal"><span class="pre">configID</span></code>, like this example:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:create-empty-config
Created new configuration with configID ''
</pre></div>
</div>
<p>This is a holdover from the early days, when there was no option to create
additional configurations. The second, and all subsequent, configurations
that you create are automatically assigned IDs:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:create-empty-config
Created new configuration with configID 's01'
</pre></div>
</div>
<p>Then you can list and view your configurations:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:show-config
</pre></div>
</div>
<p>And view the configuration for a single configID:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:show-config s01
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">ldap:delete-config</span> <span class="pre">[configID]</span></code> deletes an existing LDAP configuration:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:delete s01
Deleted configuration with configID 's01'
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">ldap:set-config</span></code> command is for manipulating configurations, like this
example that sets search attributes:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:set-config s01 ldapAttributesForUserSearch
"cn;givenname;sn;displayname;mail"
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">ldap:test-config</span></code> tests whether your configuration is correct and can bind to
the server:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ ldap:test-config s01
The configuration is valid and the connection could be established!
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">ldap:show-remnants</span></code> is for cleaning up the LDAP mappings table, and is
documented in <a class="reference internal" href="../configuration_user/user_auth_ldap_cleanup.html"><em>LDAP user cleanup</em></a>.</p>
</div>
<div class="section" id="logging-commands">
<span id="logging-commands-label"></span><h2>Logging commands<a class="headerlink" href="#logging-commands" title="Permalink to this headline">ΒΆ</a></h2>
<p>These commands view and configure your Nextcloud logging preferences:</p>
<div class="highlight-python"><div class="highlight"><pre>log
log:manage manage logging configuration
log:owncloud manipulate Nextcloud logging backend
</pre></div>
</div>
<p>Run <code class="docutils literal"><span class="pre">log:owncloud</span></code> to see your current logging status:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ log:owncloud
Log backend Nextcloud: enabled
Log file: /opt/nextcloud/data/nextcloud.log
Rotate at: disabled
</pre></div>
</div>
<p>Use the <code class="docutils literal"><span class="pre">--enable</span></code> option to turn on logging. Use <code class="docutils literal"><span class="pre">--file</span></code> to set a
different log file path. Set your rotation by log file size in bytes with
<code class="docutils literal"><span class="pre">--rotate-size</span></code>; 0 disables rotation.</p>
<p><code class="docutils literal"><span class="pre">log:manage</span></code> sets your logging backend, log level, and timezone. The defaults
are <code class="docutils literal"><span class="pre">owncloud</span></code>, <code class="docutils literal"><span class="pre">Warning</span></code>, and <code class="docutils literal"><span class="pre">UTC</span></code>. Available options are:</p>
<ul class="simple">
<li>–backend [owncloud, syslog, errorlog]</li>
<li>–level [debug, info, warning, error]</li>
</ul>
</div>
<div class="section" id="maintenance-commands">
<span id="maintenance-commands-label"></span><h2>Maintenance commands<a class="headerlink" href="#maintenance-commands" title="Permalink to this headline">ΒΆ</a></h2>
<p>Use these commands when you upgrade Nextcloud, manage encryption, perform
backups and other tasks that require locking users out until you are finished:</p>
<div class="highlight-python"><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
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">maintenance:mode</span></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:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ maintenance:mode --on
sudo -u www-data php occ maintenance:mode --off
</pre></div>
</div>
<p>After restoring a backup of your data directory or the database, you should always
call <code class="docutils literal"><span class="pre">maintenance:data-fingerprint</span></code> once. This changes the ETag for all files
in the communication with sync clients, allowing them to realize a file was modified.</p>
<p>The <code class="docutils literal"><span class="pre">maintenance:repair</span></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:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ maintenance:repair
</pre></div>
</div>
<p><code class="docutils literal"><span class="pre">maintenance:mimetype:update-db</span></code> updates the Nextcloud database and file cache
with changed mimetypes found in <code class="docutils literal"><span class="pre">config/mimetypemapping.json</span></code>. Run this
command after modifying <code class="docutils literal"><span class="pre">config/mimetypemapping.json</span></code>. If you change a
mimetype, run <code class="docutils literal"><span class="pre">maintenance:mimetype:update-db</span> <span class="pre">--repair-filecache</span></code> to apply the
change to existing files.</p>
<p>Run the <code class="docutils literal"><span class="pre">maintenance:theme:update</span></code> command if the icons of your custom theme are not updated correctly. This updates the mimetypelist.js and cleares the image cache.</p>
</div>
<div class="section" id="security">
<span id="security-commands-label"></span><h2>Security<a class="headerlink" href="#security" title="Permalink to this headline">ΒΆ</a></h2>
<p>Use these commands to manage server-wide SSL certificates. These are useful when you create federation shares with other Nextcloud servers that use self-signed certificates:</p>
<div class="highlight-python"><div class="highlight"><pre>security
security:certificates list trusted certificates
security:certificates:import import trusted certificate
security:certificates:remove remove trusted certificate
</pre></div>
</div>
<p>This example lists your installed certificates:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ security:certificates
</pre></div>
</div>
<p>Import a new certificate:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ security:import /path/to/certificate
</pre></div>
</div>
<p>Remove a certificate:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ security:remove [certificate name]
</pre></div>
</div>
</div>
<div class="section" id="trashbin">
<span id="trashbin-label"></span><h2>Trashbin<a class="headerlink" href="#trashbin" title="Permalink to this headline">ΒΆ</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This command is only available when the “Deleted files” app
(<code class="docutils literal"><span class="pre">files_trashbin</span></code>) is enabled.</p>
</div>
<p>The <code class="docutils literal"><span class="pre">trashbin:cleanup</span></code> command removes the deleted files of the specified
users in a space-delimited list, or all users if none are specified.</p>
<div class="highlight-python"><div class="highlight"><pre>trashbin
trashbin:cleanup Remove deleted files
</pre></div>
</div>
<p>This example removes the deleted files of all users:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ trashbin:cleanup
Remove all deleted files
Remove deleted files for users on backend Database
freda
molly
stash
rosa
edward
</pre></div>
</div>
<p>This example removes the deleted files of users molly and freda:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ trashbin:cleanup molly freda
Remove deleted files of molly
Remove deleted files of freda
</pre></div>
</div>
</div>
<div class="section" id="user-commands">
<span id="user-commands-label"></span><h2>User commands<a class="headerlink" href="#user-commands" title="Permalink to this headline">ΒΆ</a></h2>
<p>The <code class="docutils literal"><span class="pre">user</span></code> commands create and remove users, reset passwords, display a simple
report showing how many users you have, and when a user was last logged in:</p>
<div class="highlight-python"><div class="highlight"><pre>user
user:add adds a user
user:delete deletes the specified user
user:disable disables the specified user
user:enable enables the specified user
user:lastseen shows when the user was logged in last time
user:report shows how many users have access
user:resetpassword Resets the password of the named user
user:setting Read and modify user settings
</pre></div>
</div>
<p>You can create a new user with their display name, login name, and any group
memberships with the <code class="docutils literal"><span class="pre">user:add</span></code> command. The syntax is:</p>
<div class="highlight-python"><div class="highlight"><pre>user:add [--password-from-env] [--display-name[="..."]] [-g|--group[="..."]]
uid
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">display-name</span></code> corresponds to the <strong>Full Name</strong> on the Users page in your
Nextcloud Web UI, and the <code class="docutils literal"><span class="pre">uid</span></code> is their <strong>Username</strong>, which is their
login name. This example adds new user Layla Smith, and adds her to the
<strong>users</strong> and <strong>db-admins</strong> groups. Any groups that do not exist are created:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:add --display-name="Layla Smith"
--group="users" --group="db-admins" layla
Enter password:
Confirm password:
The user "layla" was created successfully
Display name set to "Layla Smith"
User "layla" added to group "users"
User "layla" added to group "db-admins"
</pre></div>
</div>
<p>Go to your Users page, and you will see your new user.</p>
<p><code class="docutils literal"><span class="pre">password-from-env</span></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.</p>
<p>To use <code class="docutils literal"><span class="pre">password-from-env</span></code> you must run as “real” root, rather than <code class="docutils literal"><span class="pre">sudo</span></code>,
because <code class="docutils literal"><span class="pre">sudo</span></code> strips environment variables. This example adds new user Fred
Jones:</p>
<div class="highlight-python"><div class="highlight"><pre>export OC_PASS=newpassword
su -s /bin/sh www-data -c 'php occ user:add --password-from-env
--display-name="Fred Jones" --group="users" fred'
The user "fred" was created successfully
Display name set to "Fred Jones"
User "fred" added to group "users"
</pre></div>
</div>
<p>You can reset any user’s password, including administrators (see
<a class="reference internal" href="../configuration_user/reset_admin_password.html"><em>Resetting a lost admin password</em></a>):</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:resetpassword layla
Enter a new password:
Confirm the new password:
Successfully reset password for layla
</pre></div>
</div>
<p>You may also use <code class="docutils literal"><span class="pre">password-from-env</span></code> to reset passwords:</p>
<div class="highlight-python"><div class="highlight"><pre>export OC_PASS=newpassword
su -s /bin/sh www-data -c 'php occ user:resetpassword --password-from-env
layla'
Successfully reset password for layla
</pre></div>
</div>
<p>You can delete users:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:delete fred
</pre></div>
</div>
<p>View a user’s most recent login:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:lastseen layla
layla's last login: 09.01.2015 18:46
</pre></div>
</div>
<p>Read user settings:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:setting layla
- core:
- lang: en
- login:
- lastLogin: 1465910968
- settings:
- email: layla@example.tld
</pre></div>
</div>
<p>Filter by app:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:setting layla core
- core:
- lang: en
</pre></div>
</div>
<p>Get a single setting:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:setting layla core lang
en
</pre></div>
</div>
<p>Set a setting:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:setting layla settings email "new-layla@example.tld"
</pre></div>
</div>
<p>Delete a setting:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:setting layla settings email --delete
</pre></div>
</div>
<p>Generate a simple report that counts all users, including users on external user
authentication servers such as LDAP:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:report
+------------------+----+
| User Report | |
+------------------+----+
| Database | 12 |
| LDAP | 86 |
| | |
| total users | 98 |
| | |
| user directories | 2 |
+------------------+----+
</pre></div>
</div>
</div>
<div class="section" id="versions">
<span id="versions-label"></span><h2>Versions<a class="headerlink" href="#versions" title="Permalink to this headline">ΒΆ</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">This command is only available when the “Versions” app (<code class="docutils literal"><span class="pre">files_versions</span></code>) is
enabled.</p>
</div>
<p>Use this command to delete file versions for specific users, or for all users
when none are specified:</p>
<div class="highlight-python"><div class="highlight"><pre>versions
versions:cleanup Delete versions
</pre></div>
</div>
<p>This example deletes all versions for all users:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -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>
<p>You can delete versions for specific users in a space-delimited list:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ versions:cleanup
Delete versions of freda
Delete versions of molly
</pre></div>
</div>
</div>
<div class="section" id="command-line-installation">
<span id="command-line-installation-label"></span><h2>Command line installation<a class="headerlink" href="#command-line-installation" title="Permalink to this headline">ΒΆ</a></h2>
<p>These commands are available only after you have downloaded and unpacked the
Nextcloud archive, and taken no further installation steps.</p>
<p>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"><span class="pre">occ</span></code>
commands in place of running the graphical Installation Wizard.</p>
<p>Then choose your <code class="docutils literal"><span class="pre">occ</span></code> options. This lists your available options:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php /var/www/nextcloud/occ
Nextcloud is not installed - only a limited number of commands are available
Nextcloud version 9.0.0
Usage:
[options] command [arguments]
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
Available commands:
check check dependencies of the server environment
help Displays help for a command
list Lists commands
status show some status information
app
app:check-code check code to be compliant
l10n
l10n:createjs Create javascript translation files for a given app
maintenance
maintenance:install install Nextcloud
</pre></div>
</div>
<p>Display your <code class="docutils literal"><span class="pre">maintenance:install</span></code> options:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ help maintenance:install
Nextcloud is not installed - only a limited number of commands are available
Usage:
maintenance:install [--database="..."] [--database-name="..."]
[--database-host="..."] [--database-user="..."] [--database-pass[="..."]]
[--database-table-prefix[="..."]] [--admin-user="..."] [--admin-pass="..."]
[--data-dir="..."]
Options:
--database Supported database type (default: "sqlite")
--database-name Name of the database
--database-host Hostname of the database (default: "localhost")
--database-user User name to connect to the database
--database-pass Password of the database user
--database-table-prefix Prefix for all tables (default: oc_)
--admin-user User name of the admin account (default: "admin")
--admin-pass Password of the admin account
--data-dir Path to data directory (default:
"/var/www/nextcloud/data")
--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>
<p>This example completes the installation:</p>
<div class="highlight-python"><div class="highlight"><pre>cd /var/www/nextcloud/
sudo -u www-data php occ maintenance:install --database
"mysql" --database-name "nextcloud" --database-user "root" --database-pass
"password" --admin-user "admin" --admin-pass "password"
Nextcloud is not installed - only a limited number of commands are available
Nextcloud was successfully installed
</pre></div>
</div>
<p>Supported databases are:</p>
<div class="highlight-python"><div class="highlight"><pre>- sqlite (SQLite3 - Nextcloud Community edition only)
- mysql (MySQL/MariaDB)
- pgsql (PostgreSQL)
- oci (Oracle - Nextcloud Enterprise edition only)
</pre></div>
</div>
</div>
<div class="section" id="command-line-upgrade">
<span id="command-line-upgrade-label"></span><h2>Command line upgrade<a class="headerlink" href="#command-line-upgrade" title="Permalink to this headline">ΒΆ</a></h2>
<p>These commands are available only after you have downloaded upgraded packages or
tar archives, and before you complete the upgrade.</p>
<p>List all options, like this example on CentOS Linux:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u apache php occ upgrade -h
Usage:
upgrade [--no-app-disable]
Options:
--no-app-disable skips the disable of third party apps
--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>
<p>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"><span class="pre">occ</span></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"><em>How to upgrade</em></a>) use this command to upgrade your databases,
like this example on CentOS Linux. Note how it details the steps:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -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 <gallery> ...
Updated <gallery> to 0.6.1
Updating <activity> ...
Updated <activity> to 2.1.0
Update successful
Turned off maintenance mode
</pre></div>
</div>
<p>Enabling verbosity displays timestamps:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -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 <files_sharing> 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>
<p>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:</p>
<div class="highlight-python"><div class="highlight"><pre>Turned on maintenance mode
Checked database schema update
Checked database schema update for apps
Updated database
Updating <files_sharing> ...
Exception
ServerNotAvailableException: LDAP server is not available
Update failed
Turned off maintenance mode
</pre></div>
</div>
</div>
<div class="section" id="two-factor-authentication">
<span id="two-factor-auth-label"></span><h2>Two-factor authentication<a class="headerlink" href="#two-factor-authentication" title="Permalink to this headline">ΒΆ</a></h2>
<p>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 an user losing access to the second factor (e.g. lost phone with
two-factor SMS verification), the admin can temporarily disable the two-factor
check for that user via the occ command:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ twofactor:disable <username>
</pre></div>
</div>
<p>To re-enable two-factor auth again use the following commmand:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ twofactor:enable <username>
</pre></div>
</div>
</div>
<div class="section" id="disable-users">
<span id="disable-user-label"></span><h2>Disable users<a class="headerlink" href="#disable-users" title="Permalink to this headline">ΒΆ</a></h2>
<p>Admins can disable users via the occ command too:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:disable <username>
</pre></div>
</div>
<p>Use the following command to enable the user again:</p>
<div class="highlight-python"><div class="highlight"><pre>sudo -u www-data php occ user:enable <username>
</pre></div>
</div>
<p>Note that once users are disabled, their connected browsers will be disconnected.</p>
</div>
</div>
<ul class="prevnext-title list-unstyled list-inline">
<li class="prev">
<a href="security_setup_warnings.html" title="Previous Chapter: Warnings on admin page"><span class="glyphicon glyphicon-chevron-left visible-sm"></span><span class="hidden-sm">« Warnings on admin page</span>
</a>
</li>
<li class="next">
<a href="activity_configuration.html" title="Next Chapter: Configuring the activity app"><span class="glyphicon glyphicon-chevron-right visible-sm"></span><span class="hidden-sm">Configuring the activity app »</span>
</a>
</li>
</ul>
</div>
</div>
</div>
</main>
</div>
</div>
</body>
</html>