=====================
Using the occ Command
=====================

ownCloud's ``occ`` command (ownCloud console) is ownCloud's command-line interface. 
You can perform many common server operations with ``occ``, such as installing and upgrading ownCloud, managing users and groups, encryption, passwords, LDAP setting, and more.

``occ`` is in the :file:`owncloud/` directory; for example :file:`/var/www/owncloud` on Ubuntu Linux. ``occ`` is a PHP script. 
**You must run it as your HTTP user** to ensure that the correct permissions are maintained on your ownCloud files and directories. 

occ Command Directory
---------------------

* :ref:`http_user_label`
* :ref:`apps_commands_label`
* :ref:`background_jobs_selector_label`
* :ref:`config_commands_label`
* :ref:`dav_label`
* :ref:`database_conversion_label`
* :ref:`encryption_label`
* :ref:`federation_sync_label`
* :ref:`file_operations_label`
* :ref:`files_external_label`
* :ref:`group_commands_label`
* :ref:`integrity_check_label`
* :ref:`create_javascript_translation_files_label`
* :ref:`ldap_commands_label`
* :ref:`logging_commands_label`
* :ref:`maintenance_commands_label`
* :ref:`market_commands_label`
* :ref:`reports_commands_label`
* :ref:`security_commands_label`
* :ref:`ransomware_commands_label`
* :ref:`shibboleth_label`
* :ref:`trashbin_label`
* :ref:`user_commands_label`
* :ref:`versions_label`
* :ref:`command_line_installation_label`
* :ref:`command_line_upgrade_label`
* :ref:`two_factor_auth_label`
* :ref:`disable_user_label`

.. _http_user_label:

Run occ As Your HTTP User
-------------------------

The HTTP user is different on the various Linux distributions. 
See :ref:`strong_perms_label` to learn how to find your HTTP user.
   
* The HTTP user and group in Debian/Ubuntu is www-data.
* The HTTP user and group in Fedora/CentOS is apache.
* The HTTP user and group in Arch Linux is http.
* The HTTP user in openSUSE is wwwrun, and the HTTP group is www.   

If your HTTP server is configured to use a different PHP version than the default (/usr/bin/php), ``occ`` should be run with the same version. 
For example, in CentOS 6.5 with SCL-PHP54 installed, the command looks like this::

  sudo -u apache /opt/rh/php54/root/usr/bin/php /var/www/html/owncloud/occ

Running ``occ`` with no options lists all commands and options, like this example on Ubuntu::

 sudo -u www-data php occ 
 ownCloud 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.

This is the same as ``sudo -u www-data php occ list``.
Run it with the ``-h`` option for syntax help::

 sudo -u www-data php occ -h
 
Display your ownCloud version::

 sudo -u www-data php occ -V
   ownCloud version 9.0.0
   
Query your ownCloud server status::

 sudo -u www-data php occ status
   - installed: true
   - version: 9.0.0.19
   - versionstring: 9.0.0
   - edition: 

``occ`` has *options*, *commands*, and *arguments*. 
Commands are required.
Options are optional.
Arguments can be required *or* optional.
The, generic, syntax is::

 occ [options] command [arguments]
 
Get detailed information on individual commands with the ``help`` command, like this example for the ``maintenance:mode`` command

::

 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

The ``status`` command from above has an option to define the output format.
The default is plain text, but it can also be ``json``::

 sudo -u www-data php occ status --output=json
 {"installed":true,"version":"9.0.0.19","versionstring":"9.0.0","edition":""}

or ``json_pretty``::

 sudo -u www-data php occ status --output=json_pretty
 {
    "installed": true,
    "version": "9.0.0.19",
    "versionstring": "9.0.0",
    "edition": ""
 }

This output option is available on all list and list-like commands, which include ``status``, ``check``, ``app:list``, ``config:list``, ``encryption:status`` and ``encryption:list-modules``.

.. _apps_commands_label:

Apps Commands
-------------

The ``app`` commands list, enable, and disable apps

::

 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

List all of your installed apps or optionally provide a search pattern to restrict the list of apps to those whose name matches the given regular expression.
The output shows whether they are enabled or disabled

::

 sudo -u www-data php occ app:list [<search-pattern>]
 
Enable an app, for example the Market app

::

 sudo -u www-data php occ app:enable market
 market enabled

Disable an app

::

 sudo -u www-data php occ app:disable market
 market disabled

``app:check-code`` has multiple checks: it checks if an app uses ownCloud's public API (``OCP``) or private API (``OC_``), and it also checks for deprecated methods and the validity of the ``info.xml`` file. 
By default all checks are enabled. 
The Activity app is an example of a correctly-formatted app

::

 sudo -u www-data php occ app:check-code notifications
 App is compliant - awesome job!

If your app has issues, you'll see output like this

::

 sudo -u www-data php occ app:check-code foo_app
 Analysing /var/www/owncloud/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

You can get the full file path to an app

::
    
    sudo -u www-data php occ app:getpath notifications
    /var/www/owncloud/apps/notifications

.. _background_jobs_selector_label:   
   
Background Jobs Selector
------------------------

Use the ``background`` 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 ownCloud Admin page.

::

 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

This example selects Ajax::

 sudo -u www-data php occ background:ajax
   Set mode for background jobs to 'ajax'

The other two commands are:

* ``background:cron``
* ``background:webcron``

See :doc:`../../configuration/server/background_jobs_configuration` to learn more.

.. _config_commands_label:

Config Commands
---------------

The ``config`` commands are used to configure the ownCloud server.

::

 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 configuration settings
  config:list            List all configuration settings
  config:system:delete   Delete a system config value
  config:system:get      Get a system config value
  config:system:set      Set a system config value

You can list all configuration values with one command:

::

 sudo -u www-data php occ config:list

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 ``--private`` flag needs to be set:

::

 sudo -u www-data php occ config:list --private

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. 

::

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

It is also possible to import remote files, by piping the input:

::

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

.. note::

  While it is possible to update/set/delete the versions and installation
  statuses of apps and ownCloud itself, it is **not** recommended to do this
  directly. Use the ``occ app:enable``, ``occ app:disable`` and ``occ update``
  commands instead.  

Getting a Single Configuration Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These commands get the value of a single app or system configuration:

::

  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

Setting a Single Configuration Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These commands set the value of a single app or system configuration:

::

  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

The ``config:system:set`` command creates the value, if it does not already exist. 
To update an existing value,  set ``--update-only``:

::

  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.

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 ``config:system:set`` command. The following values are known:

* ``boolean``
* ``integer``
* ``float``
* ``string`` (default)

When you want to e.g., disable the maintenance mode run the following command:

::

  sudo -u www-data php occ config:system:set maintenance --value=false 
  --type=boolean
  ownCloud is in maintenance mode - no app have been loaded
  System config value maintenance set to boolean false

Setting an Array of Configuration Values
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

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 ``config`` names separated by spaces:

::

  sudo -u www-data php occ config:system:get trusted_domains
  localhost
  owncloud.local
  sample.tld

To replace ``sample.tld`` with ``example.com`` trusted_domains => 2 needs to be set:

::

  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
  owncloud.local
  example.com

Deleting a Single Configuration Value
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These commands delete the configuration of an app or system configuration:

::

  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

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 ``--error-if-not-exists`` flag.

::

  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
  
.. _dav_label:  
   
Dav Commands
------------
  
A set of commands to create address books, calendars, and to migrate address books:

::

 dav
  dav:cleanup-chunks            Cleanup outdated chunks
  dav:create-addressbook        Create a dav address book
  dav:create-calendar           Create a dav calendar
  dav:sync-birthday-calendar    Synchronizes the birthday calendar
  dav:sync-system-addressbook   Synchronizes users to the system 
                                address book
                                      
.. note::
  These commands are not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.

``dav:cleanup-chunks`` cleans up outdated chunks (uploaded files) more than a certain number of days old.
By default, the command cleans up chunks more than 2 days old. 
However, by supplying the number of days to the command, the range can be increased.
For example, in the example below, chunks older than 10 days will be removed.

::

 sudo -u www-data php occ dav:cleanup-chunks 10
 
 # example output
 Cleaning chunks older than 10 days(2017-11-08T13:13:45+00:00)
 Cleaning chunks for admin
    0 [>---------------------------]

The syntax for ``dav:create-addressbook`` and  ``dav:create-calendar`` is 
``dav:create-addressbook [user] [name]``. This example creates the addressbook 
``mollybook`` for the user molly::

 sudo -u www-data php occ dav:create-addressbook molly mollybook

This example creates a new calendar for molly:

::

 sudo -u www-data php occ dav:create-calendar molly mollycal
 
Molly will immediately see these on her Calendar and Contacts pages.
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 address books. 
Then run this command to migrate user's contacts:

::

 sudo -u www-data php occ dav:migrate-addressbooks [user]
 
Run this command to migrate calendars:

::

 sudo -u www-data php occ dav:migrate-calendars [user]

``dav:sync-birthday-calendar`` adds all birthdays to your calendar from address books shared with you. 
This example syncs to your calendar from user ``bernie``:

::

 sudo -u www-data php occ dav:sync-birthday-calendar bernie
 
``dav:sync-system-addressbook`` synchronizes all users to the system addressbook.

::

 sudo -u www-data php occ dav:sync-system-addressbook

.. _database_conversion_label:  
  
Database Conversion
-------------------

The SQLite database is good for testing, and for ownCloud 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 ``occ`` to convert from SQLite to one of these other databases.

::

 db
  db:convert-type           Convert the ownCloud database to the newly 
                            configured one
  db:generate-change-script generates the change script from the current 
                            connected db to db_structure.xml

You need:

* Your desired database and its PHP connector installed.
* The login and password of a database admin user.
* The database port number, if it is a non-standard port.

This is example converts SQLite to MySQL/MariaDB:

:: 

 sudo -u www-data php occ db:convert-type mysql oc_dbuser 127.0.0.1 
 oc_database

For a more detailed explanation see :doc:`../../configuration/database/db_conversion`.

.. _encryption_label:

Encryption
----------

``occ`` includes a complete set of commands for managing encryption.

::

 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:migrate                   initial migration to encryption 2.0
  encryption:recreate-master-key       Replace existing master key with new one. 
                                       Encrypt the file system with newly created master key.
  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
  
``encryption:status`` shows whether you have active encryption, and your default encryption module. 
To enable encryption you must first enable the Encryption app, and then run ``encryption:enable``:

::

 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
   
``encryption:change-key-storage-root`` is for moving your encryption keys to a different folder. 
It takes one argument, ``newRoot``, which defines your new root folder. 
The folder must exist, and the path is relative to your root ownCloud directory.

::

 sudo -u www-data php occ encryption:change-key-storage-root ../../etc/oc-keys
 
You can see the current location of your keys folder::

 sudo -u www-data php occ encryption:show-key-storage-root
 Current key storage root:  default storage location (data/)
 
``encryption:list-modules`` displays your available encryption modules. 
You will see a list of modules only if you have enabled the Encryption app. 
Use ``encryption:set-default-module [module name]`` to set your desired module.

``encryption:encrypt-all`` encrypts all data files for all users. 
You must first put your ownCloud server into :ref:`single-user mode<maintenance_commands_label>` to prevent any user activity until encryption is completed.

``encryption:decrypt-all`` decrypts all user data files, or optionally a single user:

::

 sudo -u www-data php occ encryption:decrypt freda

Users must have enabled recovery keys on their Personal pages. 
You must first put your ownCloud server into :ref:`single-user mode <maintenance_commands_label>` to prevent any user activity until decryption is completed.

Use ``encryption:disable`` to disable your encryption module. 
You must first put your ownCloud server into :ref:`single-user mode <maintenance_commands_label>` to prevent any user activity.

``encryption:enable-master-key`` 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.

``encryption:migrate`` migrates encryption keys after a major ownCloud version upgrade. 
You may optionally specify individual users in a space-delimited list.
See :doc:`../../configuration/files/encryption_configuration` to learn more.
 
``encryption:recreate-master-key`` decrypts the ownCloud file system, replaces the existing master key with a new one, and encrypts the entire ownCloud file system with the new master key. Given the size of your ownCloud filesystem, this may take some time to complete. However, if your filesystem is quite small, then it will complete quite quickly. The ``-y`` switch can be supplied to automate acceptance of user input.
 
.. _federation_sync_label:
 
Federation Sync
---------------

Synchronize the address books of all federated ownCloud servers::

 federation:sync-addressbooks  Synchronizes address books of all 
                               federated clouds

Servers connected with federation shares can share user address books, and auto-complete usernames in share dialogs. 
Use this command to synchronize federated servers:

::

  sudo -u www-data php occ federation:sync-addressbooks
  
.. note::
  This command is only available when the "Federation" app (``federation``) is enabled.

.. _file_operations_label:

File Operations
---------------

``occ`` has three commands for managing files in ownCloud::

 files
  files:cleanup              Deletes orphaned file cache entries.
  files:scan                 Rescans the filesystem.
  files:transfer-ownership   All files and folders are moved to another 
                             user - outgoing shares are moved as well (incoming shares are not moved as the sharing user holds the ownership of the respective files).
 
.. note::
  These commands are not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.

The files:scan command
^^^^^^^^^^^^^^^^^^^^^^

The ``files:scan`` command 

- Scans for new files.
- Scans not fully scanned files.
- Repairs file cache holes.
- Updates the file cache.

File scans can be performed per-user, for a space-delimited list of users, and for all users.  

::

 sudo -u www-data php occ files:scan --help
  Usage:
    files:scan [options] [--] [<user_id>]...

  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: "plain"]
    -p, --path=PATH        limit rescan to this path, eg. --path="/alice/files/Music", the user_id is determined by the path and the user_id parameter and --all are ignored
    -q, --quiet            Do not output any message
        --all              will rescan all files of all known users
        --repair           will repair detached filecache entries (slow)
        --unscanned        only scan files which are marked as not fully scanned
    -h, --help             Display this help 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
   
.. note::
  If not using ``--quiet``, statistics will be shown at the end of the scan.

The ``--path`` Option
~~~~~~~~~~~~~~~~~~~~~

When using the ``--path`` option, the path must be in one of the following formats:

::

  "user_id/files/path" 
  "user_id/files/mount_name"
  "user_id/files/mount_name/path"

For example:

::

  --path="/alice/files/Music"

In the example above, the user_id ``alice`` is determined implicitly from the path component given.
The ``--path``, ``--all`` and ``[user_id]`` parameters are exclusive - only one must be specified.

The ``--repair`` Option
~~~~~~~~~~~~~~~~~~~~~~~

As noted above, repairs can be performed for individual users, groups of users, and for all users in an ownCloud installation.
What’s more, repair scans can be run even if no files are known to need repairing and if one or more files are known to be in need of repair.
Two examples of when files need repairing are:

- If folders have the same entry twice in the web UI (known as a "*ghost folder*"), this can also lead to strange error messages in the desktop client.
- If entering a folder doesn't seem to lead into that folder.

The repair command needs to be run in single user mode. 
The following commands show how to enable single user mode, run a repair file scan, and then disable single user mode.

::

  sudo -u www-data php occ maintenance:singleuser --on
  sudo -u www-data php occ files:scan --all --repair
  sudo -u www-data php occ maintenance:singleuser --off

.. note:: 
   We strongly suggest that you backup the database before running this command.

The files:cleanup command
^^^^^^^^^^^^^^^^^^^^^^^^^

``files:cleanup`` tidies up the server's file cache by deleting all file entries that have no matching entries in the storage table. 
You may transfer all files and shares from one user to another. 
This is useful before removing a user. 

For example, to move all files from ``<source-user>`` to ``<destination-user>``, use the following command:

::

 sudo -u www-data php occ files:transfer-ownership <source-user> <destination-user>

You can also move a limited set of files from ``<source-user>`` to ``<destination-user>`` by making use of the ``--path`` switch, as in the example below. 
In it, ``folder/to/move``, and any file and folder inside it will be moved to ``<destination-user>``. 

::

  sudo -u www-data php occ files:transfer-ownership --path="folder/to/move" <source-user> <destination-user>

When using this command, please keep in mind: 

1. The directory provided to the ``--path`` switch **must** exist inside ``data/<source-user>/files``.
2. The directory (and its contents) won't be moved as is between the users. It'll be moved inside the destination user's ``files`` directory, and placed in a directory which follows the format: ``transferred from <source-user> on <timestamp>``. Using the example above, it will be stored under: ``data/<destination-user>/files/transferred from <source-user> on 20170426_124510/``
3. Currently file versions can't be transferred. Only the latest version of moved files will appear in the destination user's account.

.. _files_external_label:

Files External
--------------

These commands replace the ``data/mount.json`` configuration file used in 
ownCloud releases before 9.0.

Commands for managing external storage::

 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

These commands replicate the functionality in the ownCloud Web GUI, plus two new features:  ``files_external:export`` and ``files_external:import``. 

Use ``files_external:export`` to export all admin mounts to stdout, and ``files_external:export [user_id]`` to export the mounts of the specified ownCloud user. 

.. note::
  These commands are only available when the "External storage support" app
  (``files_external``) is enabled.
  It is not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.

.. _group_commands_label:

Group Commands
--------------

The ``group`` commands provide a range of functionality for managing ownCloud groups. 
This includes creating and removing groups and managing group membership.
Group names are case-sensitive, so "Finance" and "finance" are two different groups.

The full list of commands is:

::

 group
  group:add                           adds a group
  group:add-member                    add members to a group
  group:delete                        deletes the specified group
  group:list                          list groups
  group:list-members                  list group members
  group:remove-member                 remove member(s) from a group

Creating Groups
^^^^^^^^^^^^^^^

You can create a new group with the ``group:add`` command. 
The syntax is::

 group:add groupname

This example adds a new group, called "Finance":

:: 
 
 sudo -u www-data php occ group:add Finance
   Created group "Finance"

Listing Groups
^^^^^^^^^^^^^^

You can list the names of existing groups with the ``group:list`` command.
The syntax is::

  group:list [options] [<search-pattern>]

Groups containing the ``search-pattern`` string are listed. Matching is 
not case-sensitive. If you do not provide a search-pattern then all groups 
are listed.

This example lists groups containing the string finance:: 
 
 sudo -u www-data php occ group:list finance
  - All-Finance-Staff
  - Finance
  - Finance-Managers

The output can be formatted in JSON with the output option ``json`` or ``json_pretty``::

 sudo -u www-data php occ --output=json_pretty group:list finance
  [
    "All-Finance-Staff",
    "Finance",
    "Finance-Managers"
  ]

Listing Group Members
^^^^^^^^^^^^^^^^^^^^^

You can list the user IDs of group members with the ``group:list-members`` command.
The syntax is::

  group:list-members [options] <group>

This example lists members of the Finance group:: 
 
 sudo -u www-data php occ group:list-members Finance
  - aaron: Aaron Smith
  - julie: Julie Jones

The output can be formatted in JSON with the output option ``json`` or ``json_pretty``::

 sudo -u www-data php occ --output=json_pretty group:list-members Finance
  {
    "aaron": "Aaron Smith",
    "julie": "Julie Jones"
  }

Adding Members to Groups
^^^^^^^^^^^^^^^^^^^^^^^^

You can add members to an existing group with the ``group:add-member`` command.
Members must be existing users. 
The syntax is::

 group:add-member [-m|--member [MEMBER]] <group>

This example adds members "aaron" and "julie" to group "Finance":: 

 sudo -u www-data php occ group:add-member --member aaron --member julie Finance
   User "aaron" added to group "Finance"
   User "julie" added to group "Finance"

You may attempt to add members that are already in the group, without error.
This allows you to add members in a scripted way without needing to know if the user is already a member of the group. 
For example::

 sudo -u www-data php occ group:add-member --member aaron --member julie --member fred Finance
   User "aaron" is already a member of group "Finance"
   User "julie" is already a member of group "Finance"
   User fred" added to group "Finance"

Removing Members from Groups
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can remove members from a group with the ``group:remove-member`` command.
The syntax is::

 group:remove-member [-m|--member [MEMBER]] <group>

This example removes members "aaron" and "julie" from group "Finance":: 

 sudo -u www-data php occ group:remove-member --member aaron --member julie Finance
   Member "aaron" removed from group "Finance"
   Member "julie" removed from group "Finance"

You may attempt to remove members that have already been removed from the group, without error. 
This allows you to remove members in a scripted way without needing to know if the user is still a member of the group. 
For example:

::

 sudo -u www-data php occ group:remove-member --member aaron --member fred Finance
   Member "aaron" could not be found in group "Finance"
   Member "fred" removed from group "Finance"

Deleting a Group
^^^^^^^^^^^^^^^^^

To delete a group, you use the ``group:delete`` command, as in the example below:

::

 sudo -u www-data php occ group:delete Finance
   
.. _integrity_check_label:

Integrity Check
---------------

Apps which have an official tag MUST be code signed. 
Unsigned official apps won't be installable anymore. 
Code signing is optional for all third-party applications.

::

 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
  
After creating your signing key, sign your app like this example:

:: 
 
 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
 
Verify your app:

::

  sudo -u www-data php occ integrity:check-app --path=/pathto/app appname
  
When it returns nothing, your app is signed correctly. 
When it returns a message then there is an error. 
See `Code Signing <https://doc.owncloud.org/server/latest/developer_manual/app/code_signing.html#how-to-get-your-app-signed>`_ in the Developer manual for more detailed information.

``integrity:sign-core`` is for ownCloud core developers only.

See :doc:`../../issues/code_signing` to learn more.

.. _create_javascript_translation_files_label:
 
l10n, Create Javascript Translation Files for Apps
--------------------------------------------------

This command is for app developers to update their translation mechanism from ownCloud 7 to ownCloud 8 and later.

.. _ldap_commands_label: 
 
LDAP Commands
-------------

.. note::
  These commands are only available when the "LDAP user and group backend" app
  (``user_ldap``) is enabled.

These LDAP commands appear only when you have enabled the LDAP app. 
Then you can run the following LDAP commands with ``occ``:

::

 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:test-config              tests an LDAP configuration
  ldap:update-group             update the specified group membership
                                information stored locally

Search for an LDAP user, using this syntax:

::

 sudo -u www-data php occ ldap:search [--group] [--offset="..."] 
 [--limit="..."] search

Searches will match at the beginning of the attribute value only. 
This example searches for ``givenNames`` that start with "rob":

::

 sudo -u www-data php occ ldap:search "rob"
 
This will find robbie, roberta, and robin. Broaden the search to find, for example, ``jeroboam`` with the asterisk wildcard:

::

 sudo -u www-data php occ ldap:search "*rob"

User search attributes are set with ``ldap:set-config`` (below). 
For example, if your search attributes are ``givenName`` and ``sn`` you can find users by first name + last name very quickly. 
For example, you'll find Terri Hanson by searching for ``te ha``. 
Trailing whitespace is ignored.
 
Check if an LDAP user exists. 
This works only if the ownCloud server is connected to an LDAP server.

::

 sudo -u www-data php occ ldap:check-user robert
 
``ldap:check-user`` 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 ``--force`` option to force it to check all active LDAP connections.

::

 sudo -u www-data php occ ldap:check-user --force robert

``ldap:create-empty-config`` creates an empty LDAP configuration. 
The first one you create has no ``configID``, like this example:

::

 sudo -u www-data php occ ldap:create-empty-config
   Created new configuration with configID ''
   
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.

::
 
 sudo -u www-data php occ ldap:create-empty-config
    Created new configuration with configID 's01' 
 
Then you can list and view your configurations:

::

 sudo -u www-data php occ ldap:show-config
 
And view the configuration for a single ``configID``:

::

 sudo -u www-data php occ ldap:show-config s01
 
``ldap:delete-config [configID]`` deletes an existing LDAP configuration.

:: 

 sudo -u www-data php occ ldap:delete  s01
 Deleted configuration with configID 's01'
 
The ``ldap:set-config`` command is for manipulating configurations, like this example that sets search attributes:

::
 
 sudo -u www-data php occ ldap:set-config s01 ldapAttributesForUserSearch 
 "cn;givenname;sn;displayname;mail"

The command takes the following format:

::

  ldap:set-config <configID> <configKey> <configValue>

All of the available keys, along with default values for `configValue`, are listed in the table below.

================================ ==============================================
Configuration                    Setting
================================ ==============================================
hasMemberOfFilterSupport
hasPagedResultSupport
homeFolderNamingRule
lastJpegPhotoLookup              0 
ldapAgentName                    `cn=admin,dc=owncloudqa,dc=com`
ldapAgentPassword                *\**
ldapAttributesForGroupSearch
ldapAttributesForUserSearch
ldapBackupHost
ldapBackupPort
ldapBase                         `dc=owncloudqa,dc=com`
ldapBaseGroups                   `dc=owncloudqa,dc=com`
ldapBaseUsers                    `dc=owncloudqa,dc=com`
ldapCacheTTL                     600 
ldapConfigurationActive          1
ldapDynamicGroupMemberURL
ldapEmailAttribute
ldapExperiencedAdmin             0 
ldapExpertUUIDGroupAttr
ldapExpertUUIDUserAttr
ldapExpertUsernameAttr                                                                            ldapGroupDisplayName             `cn`
ldapGroupFilter                                                                                  ldapGroupFilterGroups
ldapGroupFilterMode              0
ldapGroupFilterObjectclass
ldapGroupMemberAssocAttr         `uniqueMember`
ldapHost                         `ldap://host`
ldapIgnoreNamingRules
ldapLoginFilter                  `(&((objectclass=inetOrgPerson))(uid=%uid))`
ldapLoginFilterAttributes
ldapLoginFilterEmail             0
ldapLoginFilterMode              0
ldapLoginFilterUsername          1
ldapNestedGroups                 0
ldapOverrideMainServer
ldapPagingSize                   500
ldapPort                         389
ldapQuotaAttribute
ldapQuotaDefault
ldapTLS                          0
ldapUserDisplayName              `displayName`
ldapUserDisplayName2
ldapUserFilter                   `((objectclass=inetOrgPerson))`
ldapUserFilterGroups
ldapUserFilterMode               0
ldapUserFilterObjectclass        `inetOrgPerson`
ldapUuidGroupAttribute           `auto`
ldapUuidUserAttribute            `auto`
turnOffCertCheck                 0
useMemberOfToDetectMembership    1
================================ ==============================================

``ldap:test-config`` tests whether your configuration is correct and can bind to the server.

::

 sudo -u www-data php occ ldap:test-config s01
 The configuration is valid and the connection could be established!

``ldap:update-group`` updates the specified group membership information stored locally.

The command takes the following format:

::

  ldap:update-group <groupID> <groupID <groupID> ...>

The command allows for running a manual group sync on one or more groups, instead of having to wait for group syncing to occur.
If users have been added or removed from these groups in LDAP, ownCloud will update its details.
If a group was deleted in LDAP, ownCloud will also delete the local mapping info about this group.

.. note::
   New groups in LDAP won't be synced with this command.
   The LDAP TTL configuration (by default 10 minutes) still applies. This means
   that recently deleted groups from LDAP might be considered as "active" and
   might not be deleted in ownCloud immediately.

**Configuring the LDAP Refresh Attribute Interval**

You can configure the LDAP refresh attribute interval, but not with the ``ldap`` commands. 
Instead, you need to use the ``config:app:set`` command, as in the following example, which takes a number of seconds to the ``--value`` switch.

::
   
  occ config:app:set user_ldap updateAttributesInterval --value=7200
   
In the example above, the interval is being set to 7200 seconds.
Assuming the above example was used, the command would output the following:

.. code-block:: console
   
  Config value updateAttributesInterval for app user_ldap set to 7200

If you want to reset (or unset) the setting, then you can use the following command:

.. code-block:: console
   
  occ config:app:delete user_ldap updateAttributesInterval

.. _logging_commands_label:

Logging Commands
----------------

These commands view and configure your ownCloud logging preferences.

::

 log
  log:manage     manage logging configuration
  log:owncloud   manipulate ownCloud logging backend

Run ``log:owncloud`` to see your current logging status:

::

 sudo -u www-data php occ log:owncloud 
 Log backend ownCloud: enabled
 Log file: /opt/owncloud/data/owncloud.log
 Rotate at: disabled

Use the ``--enable`` option to turn on logging. Use ``--file`` to set a different log file path. 
Set your rotation by log file size in bytes with ``--rotate-size``; 0 disables rotation. 
``log:manage`` sets your logging backend, log level, and timezone. 
The defaults are ``owncloud``, ``Warning``, and ``UTC``. 
Available options are:

* --backend [owncloud, syslog, errorlog]
* --level [debug, info, warning, error, fatal]

.. _maintenance_commands_label:
   
Maintenance Commands
--------------------

Use these commands when you upgrade ownCloud, manage encryption, perform backups and other tasks that require locking users out until you are finished::

 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:singleuser              set single user mode
  maintenance:update:htaccess         Updates the .htaccess file

.. _maintenance_mode_label:

``maintenance:mode`` 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.

::

 sudo -u www-data php occ maintenance:mode --on
 sudo -u www-data php occ maintenance:mode --off
 
Putting your ownCloud server into single-user mode allows admins to log in and work, but not ordinary users. 
This is useful for performing maintenance and troubleshooting on a running server.

::

 sudo -u www-data php occ maintenance:singleuser --on
 Single user mode enabled
   
Turn it off when you're finished:

::

 sudo -u www-data php occ maintenance:singleuser --off
 Single user mode disabled
 
Run ``maintenance:data-fingerprint`` to tell desktop and mobile clients that a server backup has been restored. 
Users will be prompted to resolve any conflicts between newer and older file versions.

Run ``maintenance:data-fingerprint`` to tell desktop and mobile clients that a server backup has been restored. 
This command changes the ETag for all files in the communication with sync clients, informing them that one or more files were modified.
After the command completes, users will be prompted to resolve any conflicts between newer and older file versions.

The ``maintenance:repair`` command runs automatically during upgrades to clean up the database, so while you can run it manually there usually isn't a need to.

::
  
 sudo -u www-data php occ maintenance:repair
 
``maintenance:mimetype:update-db`` updates the ownCloud database and file cache with changed mimetypes found in ``config/mimetypemapping.json``. 
Run this command after modifying ``config/mimetypemapping.json``. 
If you change a mimetype, run ``maintenance:mimetype:update-db --repair-filecache`` to apply the change to existing files.

.. _market_commands_label:
   
Market
------

The ``market`` commands *install*, *list*, and *upgrade* applications from `the ownCloud Marketplace`_.

.. code-block:: console
   
  market
    market:install    Install apps from the marketplace. If already installed and 
                      an update is available the update will be installed.
    market:list       Lists apps as available on the marketplace.
    market:upgrade    Installs new app versions if available on the marketplace

.. note::
   The user running the update command, which will likely be your webserver user, needs write permission for the ``/apps`` folder. 
   If they don't have write permission, the command may report that the update was successful, but it may silently fail.

.. note::
   These commands are not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.

.. _reports_commands_label:
   
Reports
-------

If you're working with ownCloud support and need to send them a configuration summary, you can generate it using the ``configreport:generate`` command. 
This command generates the same JSON-based report as the Admin Config Report, which you can access under ``admin -> Settings -> Admin -> Help & Tips -> Download ownCloud config report``.

From the command-line in the root directory of your ownCloud installation, run it as your webserver user as follows, (assuming your webserver user is ``www-data``):

::

  sudo -u www-data occ configreport:generate

This will generate the report and send it to ``STDOUT``. 
You can optionally pipe the output to a file and then attach it to an email to ownCloud support, by running the following command:

::

  sudo -u www-data occ configreport:generate > generated-config-report.txt

Alternatively, you could generate the report and email it all in one command, by running:

::

  sudo -u www-data occ configreport:generate | mail -s "configuration report" \ 
      -r <the email address to send from> \
      support@owncloud.com

.. note::
  These commands are not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.

.. _security_commands_label:

Security
--------


Use these commands when you manage security related tasks

Routes dispays all routes of ownCloud. You can use this information to grant strict access via firewalls, proxies or loadbalancers etc.

::

  security:routes [options]

Options:

::

  --output	  Output format (plain, json or json-pretty, default is plain)
  --with-details  Adds more details to the output

Example 1:

::

  sudo  -uwww-data ./occ security:routes

::

  +-----------------------------------------------------------+-----------------+
  | Path                                                      | Methods         |
  +-----------------------------------------------------------+-----------------+
  | /apps/federation/auto-add-servers                         | POST            |
  | /apps/federation/trusted-servers                          | POST            |
  | /apps/federation/trusted-servers/{id}                     | DELETE          |
  | /apps/files/                                              | GET             |
  | /apps/files/ajax/download.php                             |                 |
  ...

Example 2:

::

  sudo  -uwww-data ./occ security:routes --output=json-pretty

::

  [
    {
        "path": "\/apps\/federation\/auto-add-servers",
        "methods": [
            "POST"
        ]
    },
  ...

Example 3:

::

  sudo  -uwww-data ./occ security:routes --with-details

::

  +---------------------------------------------+---------+-------------------------------------------------------+--------------------------------+
  | Path                                        | Methods | Controller                                            | Annotations                    |
  +---------------------------------------------+---------+-------------------------------------------------------+--------------------------------+
  | /apps/files/api/v1/sorting                  | POST    | OCA\Files\Controller\ApiController::updateFileSorting | NoAdminRequired                |
  | /apps/files/api/v1/thumbnail/{x}/{y}/{file} | GET     | OCA\Files\Controller\ApiController::getThumbnail      | NoAdminRequired,NoCSRFRequired |
  ...  

|
  
The following commands manage server-wide SSL certificates. 
These are useful when you create federation shares with other ownCloud servers that use self-signed certificates.

::

  security:certificates         list trusted certificates
  security:certificates:import  import trusted certificate
  security:certificates:remove  remove trusted certificate

This example lists your installed certificates:

::

 sudo -u www-data php occ security:certificates
 
Import a new certificate:

::

 sudo -u www-data php occ security:certificates:import /path/to/certificate
 
Remove a certificate:

::

 sudo -u www-data php occ security:certificates:remove [certificate name]

.. _ransomware_commands_label:

Ransomware Protection
---------------------

Use these commands to help users recover from a Ransomware attack.
You can find more information about the application :doc:`in the documentation <security/ransomeware-protection>`.

.. note:: Ransomware Protection (which is an Enterprise app) needs to be installed and enabled to be able to use these commands.

::

  occ ransomguard:scan <timestamp> <user>    Report all changes in a user's account, starting from timestamp.
  occ ransomguard:restore <timestamp> <user> Revert all operations in a user account after a point in time.

.. _sharing_commands_label:

Sharing
-------

This is an occ command to cleanup orphaned remote storages.
To explain why this is necessary, a little background is required.
While shares are able to be deleted as a normal matter of course, remote storages with "shared::" are not included in this process.

This might not, normally, be a problem.
However, if a user has re-shared a remote share which has been deleted it will.
This is because when the original share is deleted, the remote re-share reference is not.
Internally, the fileid will remain in the file cache and storage for that file will not be deleted.

As a result, any user(s) who the share was re-shared with will now get an error when trying to access that file or folder.
That's why the command is available.

So, to cleanup all orphaned remote storages, run it as follows:

::

  sudo -u www-data php sharing:cleanup-remote-storages

You can also set it up to run as :ref:`a background job <background-jobs-header>`

.. note::
  These commands are not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.

.. _shibboleth_label:

Shibboleth Modes (Enterprise Edition only)
------------------------------------------

``shibboleth:mode`` sets your Shibboleth mode to ``notactive``, 
``autoprovision``, or ``ssoonly``::

 shibboleth:mode [mode]

.. note::
  These commands are only available when the "Shibboleth user backend" app
  (``user_shibboleth``) is enabled.

.. _trashbin_label: 

Trashbin
--------

.. note::
  These commands are only available when the "Deleted files" app
  (``files_trashbin``) is enabled.
  These commands are not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.
 
::

 trashbin
  trashbin:cleanup   Remove deleted files
  trashbin:expire    Expires the users trash bin  

The ``trashbin:cleanup`` command removes the deleted files of the specified users in a space-delimited list, or all users if none are specified. 
This example removes all the deleted files of all users:

::  
  
  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

This example removes the deleted files of users ""molly"" and ""freda"":

::  

 sudo -u www-data php occ trashbin:cleanup molly freda
 Remove deleted files of   molly
 Remove deleted files of   freda
 
``trashbin:expire`` deletes only expired files according to the ``trashbin_retention_obligation`` setting in ``config.php`` (see the Deleted Files section in :doc:`config_sample_php_parameters`). 
The default is to delete expired files for all users, or you may list users in a space-delimited list.

.. _user_commands_label: 
 
User Commands
-------------

The ``user`` commands provide a range of functionality for managing ownCloud users. 
This includes: creating and removing users, resetting user passwords, displaying a report which shows how many users you have, and when a user was last logged in. 

The full list, of commands is:

::

 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:inactive                       reports users who are known to owncloud, 
                                      but have not logged in for a certain number of days
  user:lastseen                       shows when the user was logged in last time
  user:list                           list users
  user:list-groups                    list groups for a user
  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:sync                           Sync local users with an external backend service

Creating Users
^^^^^^^^^^^^^^

You can create a new user with the ``user:add`` command.
This command lets you set the following attributes:

- **uid:** The ``uid`` is the user's username and their login name
- **display name:** This corresponds to the **Full Name** on the Users page in your ownCloud Web UI
- **email address**
- **group**
- **login name**
- **password**

The command's syntax is:

.. code-block:: console

 user:add [--password-from-env] [--display-name [DISPLAY-NAME]] [--email [EMAIL]] [-g|--group [GROUP]] [--] <uid>

This example adds new user Layla Smith, and adds her to the **users** and **db-admins** groups. 
Any groups that do not exist are created.

:: 
 
 sudo -u www-data php occ user:add --display-name="Layla Smith" \
   --group="users" --group="db-admins" --email=layla.smith@example.com layla
   Enter password: 
   Confirm password: 
   The user "layla" was created successfully
   Display name set to "Layla Smith"
   Email address set to "layla.smith@example.com"
   User "layla" added to group "users"
   User "layla" added to group "db-admins"

After the command completes, go to your Users page, and you will see your new user. 

Setting a User's Password
^^^^^^^^^^^^^^^^^^^^^^^^^

``password-from-env`` 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 ``password-from-env`` you must run as "real" root, rather than ``sudo``, because ``sudo`` strips environment variables. 
This example adds new user Fred Jones:

::

 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" 

You can reset any user's password, including administrators (see :doc:`../../configuration/user/reset_admin_password`):

::

 sudo -u www-data php occ user:resetpassword layla
   Enter a new password: 
   Confirm the new password: 
   Successfully reset password for layla
   
You may also use ``password-from-env`` to reset passwords:

::

 export OC_PASS=newpassword
 su -s /bin/sh www-data -c 'php occ user:resetpassword --password-from-env 
   layla'
   Successfully reset password for layla
   
Deleting A User
^^^^^^^^^^^^^^^

To delete a user, you use the ``user:delete`` command, as in the example below:

::

 sudo -u www-data php occ user:delete fred
   
   
Listing Users
^^^^^^^^^^^^^

You can list existing users with the ``user:list`` command.
The syntax is::

  user:list [options] [<search-pattern>]

User IDs containing the ``search-pattern`` string are listed. Matching is 
not case-sensitive. If you do not provide a search-pattern then all users 
are listed.

This example lists user IDs containing the string ron:: 
 
 sudo -u www-data php occ user:list ron
  - aaron: Aaron Smith

The output can be formatted in JSON with the output option ``json`` or ``json_pretty``::

 sudo -u www-data php occ --output=json_pretty user:list
  {
    "aaron": "Aaron Smith",
    "herbert": "Herbert Smith",
    "julie": "Julie Jones"
  }

Listing Group Membership of a User
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You can list the group membership of a user with the ``user:list-groups`` command.
The syntax is::

  user:list-groups [options] <uid>

This example lists group membership of user julie:: 
 
 sudo -u www-data php occ user:list-groups julie
  - Executive
  - Finance

The output can be formatted in JSON with the output option ``json`` or ``json_pretty``::

 sudo -u www-data php occ --output=json_pretty user:list-groups julie
  [
    "Executive",
    "Finance"
  ]

Finding The User's Last Login
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To view a user's most recent login, use the ``user:lastseen`` command, as in the example below:

::   
   
 sudo -u www-data php occ user:lastseen layla 
   layla's last login: 09.01.2015 18:46

User Application Settings
^^^^^^^^^^^^^^^^^^^^^^^^^

To manage application settings for a user, use the ``user:setting`` command. 
This command provides the ability to:

- Retrieve all settings for an application
- Retrieve a single setting
- Set a setting value
- Delete a setting

If you run the command and pass the help switch (``--help``), you will see the following output, in your terminal:

::

  $ ./occ user:setting --help
  Usage:
    user:setting [options] [--] <uid> [<app>] [<key>]

  Arguments:
    uid                                User ID used to login
    app                                Restrict the settings to a given app [default: ""]
    key                                Setting key to set, get or delete [default: ""]

If you're new to the ``user:setting`` command, the descriptions for the ``app`` and ``key`` arguments may not be completely transparent. 
So, here's a lengthier description of both.

======== ======================================================================
Argument Description
======== ======================================================================
app      When an value is supplied, ``user:setting`` limits the settings 
         displayed, to those for that, specific, application — assuming that 
         the application is installed, and that there are settings available 
         for it. Some example applications are "core", "files_trashbin", and 
         "user_ldap". A complete list, unfortunately, cannot be supplied, as it 
         is impossible to know the entire list of applications which a user 
         could, potentially, install.
key      This value specifies the setting key to be manipulated (set, 
         retrieved, or deleted) by the ``user:setting`` command.
======== ======================================================================

Retrieving User Settings
~~~~~~~~~~~~~~~~~~~~~~~~

To retrieve all settings for a user, you need to call the ``user:setting`` command and supply the user's username, as in the example below.

::

 sudo -u www-data php occ user:setting layla
   - core:
     - lang: en
   - login:
     - lastLogin: 1465910968
   - settings:
     - email: layla@example.tld

Here, we see that the user has settings for the application ``core``, when they last logged in, and what their email address is. 

To retrieve the user's settings for a specific application, you have to supply the username and the application's name, which you want to retrieve the settings for; such as in the example below::

 sudo -u www-data php occ user:setting layla core
  - core:
     - lang: en

In the output, you can see that one setting is in effect, ``lang``, which is set to ``en``. 
To retrieve the value of a single application for a user, use the ``user:setting`` command, as in the example below.

::

 sudo -u www-data php occ user:setting layla core lang
 
This will display the value for that setting, such as ``en``.

Setting a Setting
~~~~~~~~~~~~~~~~~

To set a setting, you need to supply four things; these are: 

- the username
- the application (or setting category)
- the ``--value`` switch
- the, quoted, value for that setting

Here's an example of how you would set the email address of the user ``layla``.

::

 sudo -u www-data php occ user:setting layla settings email --value "new-layla@example.tld"

Deleting a Setting
~~~~~~~~~~~~~~~~~~

Deleting a setting is quite similar to setting a setting. 
In this case, you supply the username, application (or setting category) and key as above. 
Then, in addition, you supply the ``--delete`` flag.

::

 sudo -u www-data php occ user:setting layla settings email --delete

Generating a User Count Report
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Generate a simple report that counts all users, including users on external user authentication servers such as LDAP.

::

 sudo -u www-data php occ user:report
 +------------------+----+
 | User Report      |    |
 +------------------+----+
 | Database         | 12 |
 | LDAP             | 86 |
 |                  |    |
 | total users      | 98 |
 |                  |    |
 | user directories | 2  |
 +------------------+----+

.. _syncing_user_accounts_label:

Syncing User Accounts
^^^^^^^^^^^^^^^^^^^^^

This command syncs users stored in external backend services, such as *LDAP*, *Shibboleth*, and *Samba*, with ownCloud's, internal, user database.
However, it's not essential to run it regularly, unless you have a large number of users whose account properties have changed in a backend outside of ownCloud.
When run, it will pick up changes from alternative user backends, such as LDAP where properties like ``cn`` or ``display name`` have changed, and sync them with ownCloud's user database.
If accounts are found that no longer exist in the external backend, you are given the choice of either removing or disabling the accounts. 

.. note:: 
   It's also :ref:`one of the commands <available_background_jobs_label>` that you should run on a regular basis to ensure that your ownCloud installation is running optimally.

.. note::
   This command replaces the old ``show-remnants`` functionality, and brings the LDAP feature more in line with the rest of ownCloud's functionality.

Below are examples of how to use the command with an *LDAP*, *Samba*, and *Shibboleth* backend.

LDAP
~~~~

::

  sudo -u www-data ./occ user:sync "OCA\User_LDAP\User_Proxy"

Samba
~~~~~

::

  sudo -u www-data ./occ user:sync "OCA\User\SMB" -vvv

Shibboleth
~~~~~~~~~~

::

  sudo -u www-data ./occ user:sync "OCA\User_Shibboleth\UserBackend"

Syncing via cron job
~~~~~~~~~~~~~~~~~~~~

Here is an example for syncing with LDAP four times a day on Ubuntu:

::

  crontab -e -u www-data
  
  * */6 * * * /usr/bin/php /var/www/owncloud/occ user:sync -vvv --missing-account-action="remove" -n "OCA\User_LDAP\User_Proxy"
 
.. _versions_label:
 
Versions
--------

::

 versions
  versions:cleanup   Delete versions
  versions:expire    Expires the users file versions  

``versions:cleanup`` can delete all versioned files, as well as the ``files_versions`` folder, for either specific users, or for all users.
The example below deletes all versioned files for all users::

 sudo -u www-data php occ versions:cleanup
 Delete all versions
 Delete versions for users on backend Database
   freda
   molly
   stash
   rosa
   edward

You can delete versions for specific users in a space-delimited list:

::

 sudo -u www-data php occ versions:cleanup freda molly
 Delete versions of   freda
 Delete versions of   molly
 
``versions:expire`` deletes only expired files according to the ``versions_retention_obligation`` setting in ``config.php`` (see the File versions section in :doc:`config_sample_php_parameters`). 
The default is to delete expired files for all users, or you may list users in a space-delimited list.
 
.. note::
  These commands are only available when the "Versions" app (``files_versions``) is
  enabled.
  These commands are not available in :ref:`single-user (maintenance) mode <maintenance_commands_label>`.

.. _command_line_installation_label: 
 
Command Line Installation
-------------------------

ownCloud can be installed entirely from the command line. 
After downloading the tarball and copying ownCloud into the appropriate directories, or after installing ownCloud packages (See :doc:`../../installation/linux_installation` and :doc:`../../installation/source_installation`) you can use ``occ`` commands in place of running the graphical Installation Wizard.

.. note::
   These instructions assume that you have a fully working and configured webserver. If not, please refer to the documentation on :ref:`configuring the Apache web server <apache_configuration_label>` for detailed instructions.

Apply correct permissions to your ownCloud directories; see :ref:`strong_perms_label`. 
Then choose your ``occ`` options. 
This lists your available options:

::

 sudo -u www-data php /var/www/owncloud/occ
 ownCloud is not installed - only a limited number of commands are available
 ownCloud 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 ownCloud
  
Display your ``maintenance:install`` options::

 sudo -u www-data php occ help maintenance:install
 ownCloud 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/owncloud/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

This example completes the installation:

::

 cd /var/www/owncloud/
 sudo -u www-data php occ maintenance:install --database 
 "mysql" --database-name "owncloud"  --database-user "root" --database-pass 
 "password" --admin-user "admin" --admin-pass "password" 
 ownCloud is not installed - only a limited number of commands are available
 ownCloud was successfully installed

Supported databases are:

::

 - sqlite (SQLite3 - ownCloud Community edition only)
 - mysql (MySQL/MariaDB)
 - pgsql (PostgreSQL)
 - oci (Oracle - ownCloud Enterprise edition only)
 
.. _command_line_upgrade_label: 
   
Command Line Upgrade
--------------------

These commands are available only after you have downloaded upgraded packages or tar archives, and before you complete the upgrade.
List all options, like this example on CentOS Linux:

::

 sudo -u www-data php occ upgrade -h
 Usage:
  upgrade [options]

 Options:
      --no-app-disable  skips the disable of third party apps
  -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

 Help:
  run upgrade routines after installation of a new release. The release has to be installed before.


When you are performing an update or upgrade on your ownCloud server (see the Maintenance section of this manual), it is better to use ``occ`` 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 :doc:`../../maintenance/upgrade`) use this command to upgrade your databases, like this example on CentOS Linux:

::

 sudo -u www-data php occ upgrade
 ownCloud 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

Note how it details the steps.
Enabling verbosity displays timestamps:

::

 sudo -u www-data php occ upgrade -v
 ownCloud 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

If there is an error it throws an exception, and the error is detailed in your ownCloud logfile, so you can use the log output to figure out what went wrong, or to use in a bug report.

::

 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

.. _two_factor_auth_label:

Two-factor Authentication
-------------------------

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., a lost phone with two-factor SMS verification), the admin can temporarily disable the two-factor check for that user via the occ command:

::

 sudo -u www-data php occ twofactor:disable <username>

To re-enable two-factor authentication again, use the following commmand:

::

 sudo -u www-data php occ twofactor:enable <username>

.. _disable_user_label:

Disable Users
-------------

Admins can disable users via the occ command too:

::

 sudo -u www-data php occ user:disable <username>

Use the following command to enable the user again:

::

 sudo -u www-data php occ user:enable <username>

.. note::
   Once users are disabled, their connected browsers will be disconnected.

Finding Inactive Users
^^^^^^^^^^^^^^^^^^^^^^

To view a list of users who've not logged in for a given number of days, use the ``user:inactive`` command
The example below searches for users inactive for five days, or more.

.. code-block:: console
   
   sudo -u www-data php occ user:inactive 5 
   
By default, this will generate output in the following format:

.. code-block:: console
   
   - 0:
     - uid: admin
     - displayName: admin
     - inactiveSinceDays: 5

You can see the user's user id, display name, and the number of days they've been inactive.
If you're passing or piping this information to another application for further processing, you can also use the ``--output`` switch to change its format. 
The switch supports three options, these are:

======= =========================================================================
Setting Description
======= =========================================================================
plain   This is the default format.
json    This will render the output as a JSON-encoded, but not formatted, string.
======= =========================================================================

.. code-block:: json

   [{"uid":"admin","displayName":"admin","inactiveSinceDays":5}]

- **json_pretty:** This will render the output as a JSON-encoded string, formatted for ease of readability.

.. code-block:: json

   [
       {
           "uid": "admin",
           "displayName": "admin",
           "inactiveSinceDays": 5
       }
   ]

.. Links
   
.. _the ownCloud Marketplace: https://marketplace.owncloud.com/
   
