Merge branch 'master' into patch-2

Author: Kraligor

admin_manual/ai/app_context_agent.rst

@@ -6,7 +6,7 @@ App: Context Agent (context_agent)
 
 The *context_agent* app is the app that provides AI agent functionality in Nextcloud and acts as a backend for the :ref:`Nextcloud Assistant app<ai-app-assistant>`. Nextcloud can provide customer support upon request, please talk to your account manager for the possibilities.
 
-When the Context Agent app is installed the AI Chat in Nextcloud Assistant will be able to interact with your Nextcloud apps via virtual integrations that are called "tools".
+When the Context Agent app is installed the AI Chat in Nextcloud Assistant will be able to interact with your Nextcloud apps via virtual integrations that are called "tools". They allow the Assistant to perform actions in your Nextcloud upon sending instructions in a chat message.
 
 Currently implemented tools:
 
@@ -26,6 +26,10 @@ Currently implemented tools:
 
   * Example prompt: *"What is Andrew's Email address?"*
 
+* Find the current user's details
+
+  * Example prompt: *"Where do I live?"*
+
 * Ask a question to context chat
 
   * Example prompt: *"What is the company's sick leave process?"*
@@ -46,6 +50,22 @@ Currently implemented tools:
 
   * Example prompt: *"Can you send a joke to Andrew in talk?"*
 
+* Create a deck card
+
+  * Example prompt: *"Create a deck card for 'Buy Groceries' in my Personal board."*
+
+* Access information in deck boards
+
+  * Example prompt: *"Which deck cards are currently in the To do list in my Personal board?"*
+
+* Create a task
+
+  * Example prompt: *"Create a task for 'Renovate flat' in my Personal calendar. The task should be due Monday next week."*
+
+* Search for youtube videos
+
+  * Example prompt: *"Show me the youtube video of the Nextcloud hub 10 launch."*
+
 * Send an email via Nextcloud Mail
 
   * Example prompt *"Send a test email from [email protected] to [email protected] from my account with id 12"*
@@ -57,6 +77,10 @@ These tools can also be combined by the agent to fulfil tasks like the following
 
   * Uses contacts to look up Andrew's address and then checks the weather
 
+ * *"How is the weather where I live?"*
+
+  * Look up the current user's address and then checks the weather
+
  * *"Send an email from [email protected] to Andrew"*
 
   * Uses contacts to look up Andrew's email and then sends an email
@@ -86,6 +110,7 @@ Model requirements
 
 This app requires underlying Large language models to support tool calling. The default model in *llm2* does *not* support tool calling. Instead we recommend:
 
+* Mistral 3 small 24B
 * Qwen 2.5 8B or higher (May not work well with languages other than English)
 * Watt Tool 8B or higher
 

admin_manual/ai/app_context_chat.rst

@@ -21,6 +21,7 @@ Requirements
 * Minimal Nextcloud version: 30
 * Nextcloud AIO is supported
 * We currently support NVIDIA GPUs and x86_64 CPUs
+* CPU that supports AVX and AVX2 instruction
 * CUDA >= v12.2 on your host system
 * GPU Setup Sizing
 
@@ -72,9 +73,24 @@ Installation
 Initial loading of data
 -----------------------
 
-| Context chat will automatically load user data into the Vector DB using background jobs.
+Auto-indexing
+~~~~~~~~~~~~~
+
+| Context chat will automatically load user data into the Vector DB using asynchronous background jobs.
 | The initial loading of data can take a long time depending on the number of files and their size.
-| To speed up the asynchronous indexing or to stop it altogether, see the `Configuration Options (OCC)`_.
+
+The indexing jobs are set up to run during the Nextcloud instance's maintenance window (typically during the night) only. If you have not set a maintenance window, indexing will run 24/7.
+
+You can set up a background job worker explicitly for Context Chat to avoid slowing down normal background job operation on larger instances.
+
+.. code-block::
+
+   php cron.php "OCA\\ContextChat\\BackgroundJobs\\IndexerJob" "OCA\\ContextChat\\BackgroundJobs\\ActionJob" "OCA\\ContextChat\\BackgroundJobs\\SubmitContentJob" "OCA\\ContextChat\\BackgroundJobs\\StorageCrawlJob" "OCA\\ContextChat\\BackgroundJobs\\InitialContentImportJob"
+
+You can set this command to run every 15 minutes on weekends using cron for example.
+
+Synchronous indexing
+~~~~~~~~~~~~~~~~~~~~
 
 | To index all the files synchronously, use the following command:
 | Note: This does not interact with the auto-indexing feature and that list would remain unchanged. However, the indexed files would be skipped when the auto indexer runs.
@@ -83,6 +99,8 @@ Initial loading of data
 
    occ context_chat:scan <user_id>
 
+**Note**: The synchronous command could take several days to complete. On larger systems we thus recommend to use auto-indexing.
+
 Scaling
 -------
 
@@ -131,19 +149,19 @@ Configuration Options (OCC)
 
    occ config:app:set context_chat auto_indexing --value=true --type=boolean
 
-* ``indexing_batch_size`` integer (default: 100)
-   The number of files to index per run of the indexer background job
+* ``indexing_batch_size`` integer (default: 5000)
+   The number of files to index per run of the indexer background job (this is limited by `indexing_max_time`)
 
 .. code-block::
 
    occ config:app:set context_chat indexing_batch_size --value=100 --type=integer
 
-* ``indexing_job_interval`` integer (default: 600)
+* ``indexing_job_interval`` integer (default: 1800)
    The interval at which the indexer jobs run in seconds
 
 .. code-block::
 
-   occ config:app:set context_chat indexing_job_interval --value=600 --type=integer
+   occ config:app:set context_chat indexing_job_interval --value=1800 --type=integer
 
 * ``indexing_max_time`` integer (default: 1800)
    The number of seconds to index files for per run, regardless of batch size
@@ -152,13 +170,6 @@ Configuration Options (OCC)
 
    occ config:app:set context_chat indexing_max_time --value=1800 --type=integer
 
-* ``indexing_max_jobs_count`` integer (default: 3)
-   The maximum number of Indexer jobs allowed to run at the same time
-
-.. code-block::
-
-   occ config:app:set context_chat indexing_max_jobs_count --value=3 --type=integer
-
 * ``request_timeout`` integer (default: 3000)
    Request timeout in seconds for all requests made to the Context chat backend (the external app in AppAPI).
    If a docker socket proxy is used, the ``TIMEOUT_SERVER`` environment variable should be set to a value higher than ``request_timeout``.

admin_manual/ai/app_llm2.rst

@@ -38,6 +38,7 @@ Requirements
 * This app is built as an External App and thus depends on AppAPI v3.1.0 or higher
 * Nextcloud AIO is supported
 * We currently support NVIDIA GPUs and x86_64 CPUs
+* CPU that supports AVX and AVX2 instruction
 * CUDA >= v12.2 on your host system
 * GPU Sizing
 

admin_manual/configuration_files/file_conversion.rst

@@ -0,0 +1,7 @@
+===============
+File conversion
+===============
+
+In the majority of cases, it is recommended that either the Pandoc or :doc:`Nextcloud Office <../office/installation>` apps
+are enabled, as they provide the majority of file conversions available. Other apps may also
+support their own file conversions for other file types if more specific conversions are required.

admin_manual/configuration_files/index.rst

@@ -20,3 +20,4 @@ File sharing and management
     previews_configuration
     file_versioning
     trashbin_configuration
+    file_conversion

admin_manual/configuration_server/config_sample_php_parameters.rst

@@ -3280,7 +3280,7 @@ The maximum Nextcloud desktop client version that will be allowed to sync with
 this server instance. All connections made from later clients will be denied
 by the server.
 
-Defaults to 99.99.99
+Defaults to ``99.99.99``
 
 localstorage.allowsymlinks
 ^^^^^^^^^^^^^^^^^^^^^^^^^^

admin_manual/desktop/envvars.rst

@@ -8,8 +8,8 @@ The environment variables are:
 
 - `OWNCLOUD_CHUNK_SIZE` (default: 5242880; 5 MiB) – Specifies the chunk size of uploaded files in bytes. Increasing this value may help with synchronization problems in certain configurations.  
 - `OWNCLOUD_TIMEOUT` (default: 300 s) – The timeout for network connections in seconds.
-- `OWNCLOUD_CRITICAL_FREE_SPACE_BYTES` (default: 50\*1000\*1000 bytes) - The minimum disk space needed for operation. A fatal error is raised if less free space is available. 
-- `OWNCLOUD_FREE_SPACE_BYTES` (default: 250\*1000\*1000 bytes) - Downloads that would reduce the free space below this value are skipped. More information available under the "Low Disk Space" section. 
+- `OWNCLOUD_CRITICAL_FREE_SPACE_BYTES` (default: 512\*1000\*1000 bytes) - The minimum disk space needed for operation. A fatal error is raised if less free space is available. 
+- `OWNCLOUD_FREE_SPACE_BYTES` (default: 1000\*1000\*1000 bytes) - Downloads that would reduce the free space below this value are skipped. More information available under the "Low Disk Space" section. 
 - `OWNCLOUD_MAX_PARALLEL` (default: 6) - Maximum number of parallel jobs. 
 - `OWNCLOUD_BLACKLIST_TIME_MIN` (default: 25 s) - Minimum timeout for blacklisted files.
 - `OWNCLOUD_BLACKLIST_TIME_MAX` (default: 24\*60\*60 s; one day) - Maximum timeout for blacklisted files.
@@ -19,6 +19,6 @@ Low Disk Space
 
 When disk space is low the Nextcloud Client will be unable to synchronize all files. This section describes its behavior in a low disk space situation as well as the options that influence it.
 
-1. Synchronization of a folder aborts entirely if the remaining disk space falls below 50 MB. This threshold can be adjusted with the ``OWNCLOUD_CRITICAL_FREE_SPACE_BYTES`` environment variable.
+1. Synchronization of a folder aborts entirely if the remaining disk space falls below 512 MB. This threshold can be adjusted with the ``OWNCLOUD_CRITICAL_FREE_SPACE_BYTES`` environment variable.
 
-2. Downloads that would reduce the free disk space below 250 MB will be skipped or aborted. The download will be retried regularly and other synchronization is unaffected. This threshold can be adjusted with the ``OWNCLOUD_FREE_SPACE_BYTES`` environment variable.
+2. Downloads that would reduce the free disk space below 1 GB will be skipped or aborted. The download will be retried regularly and other synchronization is unaffected. This threshold can be adjusted with the ``OWNCLOUD_FREE_SPACE_BYTES`` environment variable.

admin_manual/installation/system_requirements.rst

@@ -22,6 +22,7 @@ For best performance, stability and functionality we have documented some recomm
 |                  | - SUSE Linux Enterprise Server 15                                     |
 |                  | - openSUSE Leap 15.5                                                  |
 |                  | - CentOS Stream                                                       |
+|                  | - Alpine Linux                                                        |
 +------------------+-----------------------------------------------------------------------+
 | Database         | - MySQL 8.0 / **8.4** or MariaDB 10.6/ **10.11** (recommended) / 11.4 |
 |                  | - Oracle Database 11g, 18, 21, 23                                     |

admin_manual/office/example-ubuntu.rst

@@ -1,5 +1,5 @@
 ====================================
-Installation example on Ubuntu 20.04
+Installation example on Ubuntu 24.04
 ====================================
 
 Import signing keys:
@@ -14,7 +14,7 @@ Add repository:
 
 .. code-block:: bash
 
-    sudo echo "deb https://www.collaboraoffice.com/repos/CollaboraOnline/CODE-ubuntu2004 ./" > /etc/apt/sources.list.d/collaboraonline.sources
+    sudo echo "Types: deb\nURIs: https://www.collaboraoffice.com/repos/CollaboraOnline/CODE-deb\nSuites: ./\nSigned-By: /usr/share/keyrings/collaboraonline-release-keyring.gpg" > /etc/apt/sources.list.d/collaboraonline.sources
 
 Install packages
 ****************

admin_manual/webhook_listeners/index.rst

@@ -33,8 +33,11 @@ If you would like to match events fired by a specific user, you can pass ``{ "us
 
 If you would like to enforce multiple criteria, you can simply pass multiple properties ``{ "event.tableId": 42, "event.rowId": 3 }``
 
+If you would like to match values partially, you can use regular expressions: ``{ "user.uid": "/admin_.*/"}`` will match any user whose user ID starts with ``admin_``. This can be especially useful for filesystem events for filtering by path: ``{ "event.node.path": "/^\\/.*\\/files\\/Special folder\\//"}`` will match files inside the ``Special folder`` of any user (Note especially, that the slashes in the path need to be escaped with two back-slashes, once because we're inside a json string and once because we're inside a regular expression).
+
 You can also use additional comparison operators (``$eq, $ne, $gt, $gte, $lt, $lte, $in, $nin``) as well as logical operators (``$and, $or, $not, $nor``). For example use ``{ "time" : { "$lt": 1711971024 } }`` to accept only events prior to April 1st 2024 and ``{ "time" : { "$not": { "$lt": 1711971024 } } }`` to accept events after April 1st 2024.
 
+
 Speeding up webhook dispatch
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -419,3 +422,19 @@ This is an exhaustive list of available events. It features the event ID and the
         "target": array{"id": string, "path": string}
       }
     }
+
+* OCP\\SystemTag\\MapperEvent
+
+  .. code-block:: text
+
+    array {
+      "user": array {"uid": string, "displayName": string},
+      "time": int,
+      "event": array{
+        "class": string,
+        'eventType' => 'OCP\SystemTag\ISystemTagObjectMapper::assignTags' | 'OCP\SystemTag\ISystemTagObjectMapper::unassignTags',
+		'objectType' => string (e.g. 'files'),
+        'objectId' => string,
+        'tagIds' => int[],
+      }
+    }

admin_manual/windmill_workflows/index.rst

@@ -78,6 +78,8 @@ you can run a flow named "Synchronize Hub Resource types with instance" in the W
 
 You can create your own Nextcloud-related scripts by taking one of the existing ones as example.
 In a script, when sending a request to Nextcloud, make sure that the ``EX-APP-ID`` header is set to ``flow``.
+Your custom scripts can make requests to any endpoint of the
+`Nextcloud OCS API <https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html>`_ .
 
 All the scripts we provide have a set of common input parameters:
 
@@ -126,3 +128,15 @@ Of course, you may also use any of the other scripts for sending messages availa
 Windmill has a default approval user interface at a specific URL, but it looks very technical.
 We recommend using the `approve_links <https://apps.nextcloud.com/apps/approve_links>`_ app
 which allows creating a beautiful temporary approval page with a custom message and approve and disapprove buttons.
+
+FAQ
+---
+
+Can I create a script?
+~~~~~~~~~~~~~~~~~~~~~~
+
+If the Windmill Hub does not contain any script to perform the action you have in mind,
+you can take an existing Nextcloud script as example and create your own.
+Your custom scripts can make requests to any endpoint of the
+`Nextcloud OCS API <https://docs.nextcloud.com/server/latest/developer_manual/_static/openapi.html>`_ .
+

conf.py

@@ -40,7 +40,7 @@
 version_start = 29		# THIS IS THE OLDEST SUPPORTED VERSION NUMBER
 
 						# THIS IS THE VERSION THAT IS MAPPED TO https://docs.nextcloud.com/server/stable/
-version_stable = 30		# CHANGING IT MUST RESULT IN A CHANGE OF THE SYMLINK ON THE LIVE SERVER
+version_stable = 31		# CHANGING IT MUST RESULT IN A CHANGE OF THE SYMLINK ON THE LIVE SERVER
 
 # Also search for "TODO ON RELEASE" in the rst files
 

developer_manual/app_publishing_maintenance/app_upgrade_guide/upgrade_to_31.rst

@@ -55,7 +55,8 @@ to check whether the current Files app instance is a public share or not, and if
 Added APIs
 ^^^^^^^^^^
 
-- TBD
+- If an app supports file conversion, it may now register an ``\OCP\Files\Conversion\ConversionProvider`` which will
+  be called automatically based on the supported MIME types. An app may register as many of these as needed.
 
 Changed APIs
 ^^^^^^^^^^^^