Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Binary file modified server/latest/Nextcloud_Server_Administration_Manual.pdf
Binary file not shown.
Binary file modified server/latest/Nextcloud_User_Manual.pdf
Binary file not shown.
7 changes: 6 additions & 1 deletion server/latest/admin_manual/ai/overview.html
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@
<li class="toctree-l4"><a class="reference internal" href="#context-agent">Context Agent</a></li>
<li class="toctree-l4"><a class="reference internal" href="#document-generation">Document generation</a></li>
<li class="toctree-l4"><a class="reference internal" href="#live-transcription">Live transcription</a></li>
<li class="toctree-l4"><a class="reference internal" href="#windmill-workflows">Windmill workflows</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#improve-ai-task-pickup-speed">Improve AI task pickup speed</a><ul>
Expand Down Expand Up @@ -900,9 +901,13 @@ <h4>Backend apps<a class="headerlink" href="#id86" title="Link to this heading">
</ul>
</section>
</section>
<section id="windmill-workflows">
<span id="ai-overview-improve-ai-task-pickup-speed"></span><h3>Windmill workflows<a class="headerlink" href="#windmill-workflows" title="Link to this heading"></a></h3>
<p>You can use the AI endpoints in your <a class="reference internal" href="../windmill_workflows/index.html#windmill-workflows"><span class="std std-ref">Windmill workflows</span></a>. Some example workflows showcasing the possibilities of combining Windmill workflows with Nextcloud AI are available on the <a class="reference external" href="https://hub.windmill.dev/integrations/nextcloud/flows">Windmill Hub</a></p>
</section>
</section>
<section id="improve-ai-task-pickup-speed">
<span id="ai-overview-improve-ai-task-pickup-speed"></span><h2>Improve AI task pickup speed<a class="headerlink" href="#improve-ai-task-pickup-speed" title="Link to this heading"></a></h2>
<h2>Improve AI task pickup speed<a class="headerlink" href="#improve-ai-task-pickup-speed" title="Link to this heading"></a></h2>
<p>Most AI tasks will be run as part of the background job system in Nextcloud which only runs jobs every 5 minutes by default.
To pick up scheduled jobs faster you can set up background job workers inside your Nextcloud main server/container that process AI tasks as soon as they are scheduled.
If the PHP code or the Nextcloud settings values are changed while a worker is running, those changes won’t be effective inside the runner. For that reason, the worker needs to be restarted regularly. It is done with a timeout of N seconds which means any changes to the settings or the code will be picked up after N seconds (worst case scenario). This timeout does not, in any way, affect the processing or the timeout of the AI tasks.</p>
Expand Down
4 changes: 3 additions & 1 deletion server/latest/admin_manual/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -1596,6 +1596,7 @@ <h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Link
<li class="toctree-l3"><a class="reference internal" href="windmill_workflows/index.html#authentication">Authentication</a></li>
<li class="toctree-l3"><a class="reference internal" href="windmill_workflows/index.html#passing-values-between-blocks">Passing values between blocks</a></li>
<li class="toctree-l3"><a class="reference internal" href="windmill_workflows/index.html#approval-suspend-steps">Approval/Suspend steps</a></li>
<li class="toctree-l3"><a class="reference internal" href="windmill_workflows/index.html#example-workflows">Example workflows</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="windmill_workflows/index.html#faq">FAQ</a><ul>
Expand Down Expand Up @@ -2060,6 +2061,7 @@ <h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Link
<li class="toctree-l5"><a class="reference internal" href="ai/overview.html#id86">Backend apps</a></li>
</ul>
</li>
<li class="toctree-l4"><a class="reference internal" href="ai/overview.html#windmill-workflows">Windmill workflows</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="ai/overview.html#improve-ai-task-pickup-speed">Improve AI task pickup speed</a><ul>
Expand Down Expand Up @@ -2764,7 +2766,7 @@ <h1>Table of contents<a class="headerlink" href="#table-of-contents" title="Link
<li class="toctree-l4"><a class="reference internal" href="office/configuration.html#previews">Previews</a></li>
<li class="toctree-l4"><a class="reference internal" href="office/configuration.html#custom-fonts">Custom fonts</a></li>
<li class="toctree-l4"><a class="reference internal" href="office/configuration.html#secure-view-settings">Secure view settings</a></li>
<li class="toctree-l4"><a class="reference internal" href="office/configuration.html#wopi-settings">Wopi settings</a></li>
<li class="toctree-l4"><a class="reference internal" href="office/configuration.html#id1">Wopi configuration</a></li>
</ul>
</li>
</ul>
Expand Down
49 changes: 35 additions & 14 deletions server/latest/admin_manual/installation/source_installation.html
Original file line number Diff line number Diff line change
Expand Up @@ -303,32 +303,53 @@ <h2>Prerequisites for manual installation<a class="headerlink" href="#prerequisi
</div>
<section id="additional-apache-configurations">
<h3>Additional Apache configurations<a class="headerlink" href="#additional-apache-configurations" title="Link to this heading"></a></h3>
<p><strong>Required modules:</strong></p>
<ul>
<li><p>For Nextcloud to work correctly, we need the module <code class="docutils literal notranslate"><span class="pre">mod_rewrite</span></code>. Enable
it by running:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a2enmod</span> <span class="n">rewrite</span>
</pre></div>
</div>
<p>Additional recommended modules are <code class="docutils literal notranslate"><span class="pre">mod_headers</span></code>, <code class="docutils literal notranslate"><span class="pre">mod_env</span></code>, <code class="docutils literal notranslate"><span class="pre">mod_dir</span></code> and <code class="docutils literal notranslate"><span class="pre">mod_mime</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a2enmod</span> <span class="n">headers</span>
<span class="n">a2enmod</span> <span class="n">env</span>
<span class="n">a2enmod</span> <span class="nb">dir</span>
<span class="n">a2enmod</span> <span class="n">mime</span>
</li>
<li><p>If you’re using <code class="docutils literal notranslate"><span class="pre">mod_fcgi</span></code> or <code class="docutils literal notranslate"><span class="pre">php-fpm</span></code> (PHP FastCGI Process Manager),
you must enable the proxy modules:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a2enmod</span> <span class="n">proxy</span>
<span class="n">a2enmod</span> <span class="n">proxy_fcgi</span>
</pre></div>
</div>
<p>If you’re running <code class="docutils literal notranslate"><span class="pre">mod_fcgi</span></code> instead of the standard <code class="docutils literal notranslate"><span class="pre">mod_php</span></code> also enable:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">a2enmod</span> <span class="n">setenvif</span>
</li>
</ul>
<p><strong>Recommended modules</strong> are <code class="docutils literal notranslate"><span class="pre">mod_headers</span></code>, <code class="docutils literal notranslate"><span class="pre">mod_env</span></code>, <code class="docutils literal notranslate"><span class="pre">mod_dir</span></code> and <code class="docutils literal notranslate"><span class="pre">mod_mime</span></code>:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span> a2enmod headers
a2enmod env
a2enmod dir
a2enmod mime

If you&#39;re running ``mod_fcgi`` instead of the standard ``mod_php`` also enable::

a2enmod setenvif

and apply the following modifications to the configuration::

ProxyFCGIBackendType FPM

&lt;FilesMatch remote.php&gt;
SetEnvIf Authorization &quot;(.*)&quot; HTTP_AUTHORIZATION=$1
&lt;/FilesMatch&gt;
</pre></div>
</div>
<p>and apply the following modifications to the configuration:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>ProxyFCGIBackendType FPM

&lt;FilesMatch remote.php&gt;
SetEnvIf Authorization &quot;(.*)&quot; HTTP_AUTHORIZATION=$1
&lt;/FilesMatch&gt;
<p><strong>Verifying modules are enabled:</strong></p>
<blockquote>
<div><p>To verify that required modules are enabled, use the <code class="docutils literal notranslate"><span class="pre">apache2ctl</span></code> command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">apache2ctl</span> <span class="o">-</span><span class="n">M</span> <span class="o">|</span> <span class="n">grep</span> <span class="o">-</span><span class="n">E</span> <span class="s2">&quot;rewrite|proxy|proxy_fcgi&quot;</span>
</pre></div>
</div>
</li>
<p>If you see matching output for the modules you’ve enabled, they are active.
If any required module is missing, troubleshoot your OS package manager to
ensure the Apache modules are installed (package names may vary by distribution;
for example, on Debian/Ubuntu look for <code class="docutils literal notranslate"><span class="pre">libapache2-mod-fcgid</span></code> or similar).</p>
</div></blockquote>
<ul>
<li><p>You must disable any server-configured authentication for Nextcloud, as it
uses Basic authentication internally for DAV services. If you have turned on
authentication on a parent folder (via e.g. an <code class="docutils literal notranslate"><span class="pre">AuthType</span> <span class="pre">Basic</span></code>
Expand Down
19 changes: 18 additions & 1 deletion server/latest/admin_manual/maintenance/migrating.html
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,24 @@ <h1>Migrating to a different server<a class="headerlink" href="#migrating-to-a-d
configuration and all relevant PHP extensions are installed. Also set up
the database and make sure it is a Nextcloud supported configuration. If
your original machine was installed recently just copying that base
configuration is a safe best practice.</p></li>
configuration is a safe best practice.</p>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Before beginning the migration, <strong>check the ``config/config.php`` file
on your ORIGINAL system</strong> to identify any optional services that are configured,
such as:</p>
<ul class="simple">
<li><p>Redis or Memcached (for caching/sessions)</p></li>
<li><p>External object storage (S3, etc.)</p></li>
<li><p>LDAP</p></li>
<li><p>Mail server settings</p></li>
<li><p>Full-text search backends (Elasticsearch, etc.)</p></li>
</ul>
<p><strong>You must also install and configure these same services on the NEW machine
before copying the Nextcloud files.</strong> Failure to do so may cause errors such
as “Redis server went away” or connection failures during Nextcloud startup.</p>
</div>
</li>
<li><p>On the original machine then stop Nextcloud. First activate the
maintenance mode. After waiting for 6-7 minutes for all sync clients to
register the server is in maintenance mode stop the application and/or
Expand Down
Binary file modified server/latest/admin_manual/objects.inv
Binary file not shown.
8 changes: 4 additions & 4 deletions server/latest/admin_manual/office/configuration.html
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@
<li class="toctree-l4"><a class="reference internal" href="#previews">Previews</a></li>
<li class="toctree-l4"><a class="reference internal" href="#custom-fonts">Custom fonts</a></li>
<li class="toctree-l4"><a class="reference internal" href="#secure-view-settings">Secure view settings</a></li>
<li class="toctree-l4"><a class="reference internal" href="#wopi-settings">Wopi settings</a></li>
<li class="toctree-l4"><a class="reference internal" href="#id1">Wopi configuration</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -245,11 +245,11 @@ <h3>Secure view settings<a class="headerlink" href="#secure-view-settings" title
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>To enforce the confidentiality of your files it is crucial to restrict the ability to download the documents.</p>
<p>This includes ensuring that your <a class="reference external" href="#wopi-settings">WOPI configuration</a> is configured to only serve documents between Nextcloud and Collabora.</p>
<p>This includes ensuring that your <a class="reference external" href="#wopi-configuration">WOPI configuration</a> is configured to only serve documents between Nextcloud and Collabora.</p>
</div>
</section>
<section id="wopi-settings">
<h3>Wopi settings<a class="headerlink" href="#wopi-settings" title="Link to this heading"></a></h3>
<section id="id1">
<h3>Wopi configuration<a class="headerlink" href="#id1" title="Link to this heading"></a></h3>
<p>It is highly recommended to restrict WOPI requests to the IP addresses of the Collabora servers that are expected to request files from the Nextcloud installation. This can be done by setting the <code class="docutils literal notranslate"><span class="pre">Allow</span> <span class="pre">list</span> <span class="pre">for</span> <span class="pre">WOPI</span> <span class="pre">requests</span></code> option from the Office admin settings.</p>
<p>Similarly, it is advised to configure <a class="reference external" href="https://sdk.collaboraonline.com/docs/installation/Configuration.html#multihost-configuration">Collabora’s WOPI host configuration</a> to only serve IPs from expected hosts.</p>
</section>
Expand Down
2 changes: 1 addition & 1 deletion server/latest/admin_manual/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion server/latest/admin_manual/webhook_listeners/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ <h3>Filters<a class="headerlink" href="#filters" title="Link to this heading">
<code class="docutils literal notranslate"><span class="pre">NodeCreatedEvent</span></code> events (backslashes must be escaped in JSON strings).</p>
</section>
<section id="speeding-up-webhook-dispatch">
<h3>Speeding up webhook dispatch<a class="headerlink" href="#speeding-up-webhook-dispatch" title="Link to this heading"></a></h3>
<span id="webhook-dispatch"></span><h3>Speeding up webhook dispatch<a class="headerlink" href="#speeding-up-webhook-dispatch" title="Link to this heading"></a></h3>
<p>This app uses background jobs to trigger registered webhooks. By default, webhooks
are triggered every 5 minutes, as the default cron interval is set to 5 minutes.
To trigger webhooks sooner, you can set up a background job worker.</p>
Expand Down
Loading