Skip to content
Open
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
2 changes: 1 addition & 1 deletion admin_manual/exapps_management/AppAPIAndExternalApps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ HaRP
| This is the newer and the **recommended** way to install ExApps.
| It requires changes in the proxy of your Nextcloud instance. If you don't have access to the proxy, you can use the usual method :ref:`described below <ai-app_api_dsp>`.

1. Setup a Docker container called `HaRP <https://github.com/nextcloud/HaRP?tab=readme-ov-file#how-to-install-it>`_ that proxies access to Docker and to the ExApps for your Nextcloud instance. Be mindful of changing the values of ``HP_SHARED_KEY`` and ``NC_INSTANCE_URL``.
1. Setup a Docker container called `HaRP <https://github.com/nextcloud/HaRP?tab=readme-ov-file#how-to-install-it>`_ that proxies access to Docker and to the ExApps for your Nextcloud instance. Be mindful of changing the values of ``HP_SHARED_KEY`` and ``NC_INSTANCE_URL``, and :ref:`generate your own shared key <ai-app_api_harp-shared-key>` instead of using the example value.
2. Go to AppAPI admin settings.
3. Click on the "Register Daemon" button.
4. | A filled form should appear. This default configuration ``HaRP Proxy (Host)`` should work for most setups. For Nextcloud AIO, use ``HaRP All-in-One``.
Expand Down
11 changes: 11 additions & 0 deletions admin_manual/exapps_management/DeployConfigurations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,17 @@ In any of the cases, the following connections should succeed:
* ExApp -> HaRP container (on port 8782)
* ExApp -> Nextcloud (through proxy or directly as the ``Nextcloud URL`` in the daemon config dictates)

.. _ai-app_api_harp-shared-key:

.. warning::

The examples below use ``some_very_secure_password`` as the HaRP shared key. This is only a placeholder: generate
your own random key for every installation, for example with ``openssl rand -hex 32``.

Use the same key for ``HP_SHARED_KEY`` of the HaRP container, the **HaRP shared key** field of the deploy daemon
and, for a remote Docker host, ``metadatas.token`` in ``frpc.toml``. Anyone who knows the key can talk to HaRP the
way Nextcloud does, including managing ExApp containers on the Docker host, so keep it secret.

.. _ai-app_api_nc-harp-baremetal:

Nextcloud and Docker on the same host - with Nextcloud bare metal
Expand Down
4 changes: 3 additions & 1 deletion admin_manual/exapps_management/ManagingDeployDaemons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ Options
* ``--set-default`` - ``[optional]`` set created daemon as default for ExApps installation
* ``--harp`` - ``[optional]`` Flag to set daemon to use HaRP for all docker and exapp communication
* ``--harp_frp_address`` - ``[optional]`` [host]:[port] of the HaRP FRP server, default host is same as HaRP host and port is 8782
* ``--harp_shared_key`` - ``[optional]`` HaRP shared key for secure communication between HaRP and AppAPI
* ``--harp_shared_key`` - ``[optional]`` HaRP shared key for secure communication between HaRP and AppAPI. It must
match ``HP_SHARED_KEY`` of the HaRP container. The ``some_very_secure_password`` value in the examples below is only
a placeholder, see :ref:`HaRP shared key <ai-app_api_harp-shared-key>`.
* ``--harp_docker_socket_port`` - ``[optional]`` 'remotePort' of the FRP client of the remote docker socket proxy. There is one included in the harp container so this can be skipped for default setups. (default: "24000")
* ``--harp_exapp_direct`` - ``[optional]`` Flag for the advanced setups only. Disables the FRP tunnel between ExApps and HaRP.

Expand Down
Loading