Skip to content

[stable33] docs: fix stale and inaccurate occ command documentation #14338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
miaulalala merged 1 commit into from
Apr 16, 2026
Merged

[stable33] docs: fix stale and inaccurate occ command documentation #14338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions admin_manual/occ_command.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,11 @@ occ command Directory

.. _http_user_label:

Run occ as your HTTP user
-------------------------
Running occ
-----------

You must run ``occ`` as your HTTP user so that the file ownership and permissions
on your Nextcloud data directory stay consistent with the web server.

The HTTP user is different on the various Linux distributions:

Expand Down Expand Up @@ -170,13 +173,15 @@ and ``encryption:list-modules``
Environment variables
^^^^^^^^^^^^^^^^^^^^^

``sudo`` does not forward environment variables by default. Put the variables before the ``php`` command::
``sudo`` does not forward environment variables by default. You can prepend the
variable and use the ``-E`` switch to pass it through::

NC_debug=true sudo -E -u www-data php occ status

Alternatively, you can ``export`` the variable or use the ``-E`` switch for ``sudo``::
Alternatively, ``export`` the variable first::

NC_debug=true sudo -E -u www-data php occ status
export NC_debug=true
sudo -E -u www-data php occ status

Enabling autocompletion
-----------------------
Expand Down Expand Up @@ -206,7 +211,7 @@ shell's profile (eg. ``~/.bash_profile`` or ``~/.zshrc``).

.. _run_commands_in_maintenance_mode:

Run commands in maintenance mode
Limitations in maintenance mode
--------------------------------

In maintenance mode, apps are not loaded [1]_, so commands from apps are unavailable. Commands integrated into Nextcloud server are available in maintenance mode.
Expand Down Expand Up @@ -323,23 +328,23 @@ To update an app to an unstable release, for instance News::
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
Use the ``background`` commands to select which scheduler you want to use for
controlling background jobs. This is the same as using
the **Cron** section on your Nextcloud 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
background:cron Set background jobs to cron mode
background:ajax Set background jobs to ajax mode
background:webcron Set background jobs to webcron mode

This example selects Ajax::
Example::

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

The other two commands are:

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

See :doc:`configuration_server/background_jobs_configuration` to learn more.
Expand Down Expand Up @@ -796,8 +801,6 @@ convert from SQLite to one of these other databases.
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

You need:

Expand Down Expand Up @@ -2239,6 +2242,9 @@ invisible No No
Antivirus
---------

.. note::
These commands require the `files_antivirus <https://apps.nextcloud.com/apps/files_antivirus>`_ app to be installed and enabled.

Get info about files in the scan queue::

sudo -E -u www-data php occ files_antivirus:status [-v]
Expand Down
Loading