khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-02 09:49:33 +07:00
Code Issues Packages Projects Releases Wiki Activity

fix(admin): remove duplicate AppAPI deploy daemon setup instructions

Browse Source 
Signed-off-by: Edward Ly <contact@edward.ly>
This commit is contained in:
Edward Ly
2024-11-12 12:00:10 -08:00
parent 0ef1c1daa6
commit 8d66a9051e
3 changed files with 12 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
admin_manual/exapps_management/AppAPIAndExternalApps.rst
View File

@@ -20,7 +20,7 @@ If AppAPI is not installed, you can still install it by simply navigating to the
Setup deploy daemon
-------------------
A Deploy Daemon is a way for Nextcloud to install and communicate with and control ExApps.
A Deploy Daemon is a way for Nextcloud to install, communicate with, and control ExApps.
.. note::
If you are using Nextcloud AIO with the "Docker Socket Proxy" container enabled, a Deploy Daemon will be automatically created and configured to work out-of-the-box.
@@ -32,7 +32,7 @@ A Deploy Daemon is a way for Nextcloud to install and communicate with and contr
4. Fill in the required fields:
- ``Name``: unique name of the Deploy daemon
- ``Display name``: the name that will be displayed in the UI
- ``Deployment method``: by default you will need to choose ``docker_install``, ``manual_install`` is for development or custom use case of manual ExApp installation
- ``Deployment method``: by default, you will need to choose ``docker_install`` (``manual_install`` is for development or custom use case of manual ExApp installation)
- ``Daemon Host``: hostname/IP address + port of the Deploy daemon
- ``Nextcloud URL``: autofilled with current domain, you might need to change the protocol to http/https depending on your setup
- ``Set as default daemon``: check if you want set new Deploy daemon as default
@@ -45,6 +45,11 @@ A Deploy Daemon is a way for Nextcloud to install and communicate with and contr
5. Click "Check connection" to verify that the configuration is correct.
6. Click "Register" to save the Deploy Daemon configuration.
.. note::
For remote DSP setup, it should expose the ports on the host.
.. image:: ./img/app_api_3.png
Deployment configuration examples can be found :ref:`here <deploy-configs>`.
Installing ExApps

46
admin_manual/exapps_management/CreationOfDeployDaemon.rst → admin_manual/exapps_management/ManagingDeployDaemons.rst
View File

@@ -1,50 +1,12 @@
.. _create-deploy-daemon:
.. _managing-deploy-daemons:
Creation of Deploy Daemon
=========================
The Deploy Daemon (DaemonConfig) is used to orchestrate the deployment of ExApps.
.. note::
Currently only ``docker-install`` and ``manual-install`` deployment methods are supported.
The recommended daemon configuration is using `AppAPI Docker Socket Proxy <https://github.com/nextcloud/docker-socket-proxy>`_.
.. image:: ./img/app_api_3.png
You can choose one of the basic configuration templates and adjust to your needs.
.. note:: We highly recommend to use UI to create Deploy Daemons.
Register Deploy daemon form
^^^^^^^^^^^^^^^^^^^^^^^^^^^
1. ``Name``: unique name of the Deploy daemon
2. ``Display name``: the name that will be displayed in the UI
3. ``Deployment method``: by default you will need to choose ``docker_install``, ``manual_install`` is for development or custom use case of manual ExApp installation
4. ``Daemon Host``: hostname/IP address + port of the Deploy daemon
5. ``Nextcloud URL``: autofilled with current domain, you might need to change the protocol to http/https depending on your setup
6. ``Set as default daemon``: check if you want set new Deploy daemon as default
7. ``Enable https``: check if your Deploy daemon (Docker Socket Proxy) is configured with TLS
8. Deploy Config:
9. ``Network``: Docker network name, depends on your networking setup, enforces to "host" if "Enable https" is checked
10. ``HaProxy password``: password for Docker Socket Proxy, if it is configured with TLS
11. ``Compute Device``: CPU, CUDA or ROCm, depending on your hardware config on Deploy daemon host machine
12. ``Add additional option`` (see :ref:`additional_options_list`): setup additional KEY + VALUE deploy config options
.. note::
For remote DSP setup, it should expose the ports on the host.
.. _create-deploy-daemon-cli:
Managing Deploy Daemons
=======================
OCC CLI
^^^^^^^
There are a few commands to manage Deploy Daemons:
There are a few OCC CLI commands to manage Deploy Daemons:
1. Register ``occ app_api:daemon:register``
2. Unregister ``occ app_api:daemon:unregister``

2
admin_manual/exapps_management/index.rst
View File

@@ -7,6 +7,6 @@ ExApps management
AppAPIAndExternalApps
DeployConfigurations
CreationOfDeployDaemon
ManagingDeployDaemons
TestDeploy
ManagingExApps