mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-02 09:49:33 +07:00
fix(ExApp): update URLs for repositories transferred to Nextcloud organization
Signed-off-by: Edward Ly <contact@edward.ly>
This commit is contained in:
Edward Ly
@@ -9,7 +9,7 @@ The Deploy Daemon (DaemonConfig) is used to orchestrate the deployment of ExApps
|
||||
|
||||
Currently only ``docker-install`` and ``manual-install`` deployment methods are supported.
|
||||
|
||||
The recommended daemon configuration is using `AppAPI Docker Socket Proxy <https://github.com/cloud-py-api/docker-socket-proxy>`_.
|
||||
The recommended daemon configuration is using `AppAPI Docker Socket Proxy <https://github.com/nextcloud/docker-socket-proxy>`_.
|
||||
|
||||
.. image:: ./img/app_api_3.png
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@ Orchestrates the deployment of applications as Docker containers.
|
||||
|
||||
These schemes are only examples of possible configurations.
|
||||
|
||||
We recommend that you use the `AppAPI Docker Socket Proxy <https://github.com/cloud-py-api/docker-socket-proxy>`_ or `AIO Docker Socket Proxy <#nextcloud-in-docker-aio-all-in-one>`_ container.
|
||||
We recommend that you use the `AppAPI Docker Socket Proxy <https://github.com/nextcloud/docker-socket-proxy>`_ or `AIO Docker Socket Proxy <#nextcloud-in-docker-aio-all-in-one>`_ container.
|
||||
|
||||
There are several Docker Daemon Deploy configurations (example schemes):
|
||||
|
||||
@@ -35,8 +35,8 @@ The simplest configuration is when Nextcloud is installed on the host and Docker
|
||||
.. mermaid::
|
||||
|
||||
stateDiagram-v2
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px
|
||||
|
||||
Host
|
||||
@@ -68,13 +68,13 @@ Suggested config values(template *Custom default*):
|
||||
|
||||
---
|
||||
|
||||
Suggested way to communicate with Docker via `Docker Socket Proxy container <https://github.com/cloud-py-api/docker-socket-proxy>`_.
|
||||
Suggested way to communicate with Docker via `Docker Socket Proxy container <https://github.com/nextcloud/docker-socket-proxy>`_.
|
||||
|
||||
.. mermaid::
|
||||
|
||||
stateDiagram-v2
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px
|
||||
|
||||
Host
|
||||
@@ -124,8 +124,8 @@ In this case, the AppAPI uses a Docker Socket Proxy deployed on remote host to a
|
||||
.. mermaid::
|
||||
|
||||
stateDiagram-v2
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px
|
||||
|
||||
Direction LR
|
||||
@@ -170,8 +170,8 @@ Suggested way to communicate with Docker: via ``docker-socket-proxy``.
|
||||
.. mermaid::
|
||||
|
||||
stateDiagram-v2
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px
|
||||
|
||||
Host
|
||||
@@ -220,9 +220,9 @@ In case of AppAPI is in Docker AIO setup (installed in Nextcloud container).
|
||||
.. mermaid::
|
||||
|
||||
stateDiagram-v2
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef docker2 fill: #1f97ee, color: transparent, font-size: 20px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/cloud-py-api/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef docker fill: #1f97ee, color: transparent, font-size: 34px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef docker2 fill: #1f97ee, color: transparent, font-size: 20px, stroke: #364c53, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/docker.png) no-repeat center center / contain
|
||||
classDef nextcloud fill: #006aa3, color: transparent, font-size: 34px, stroke: #045987, stroke-width: 1px, background: url(https://raw.githubusercontent.com/nextcloud/app_api/main/docs/img/nextcloud.svg) no-repeat center center / contain
|
||||
classDef python fill: #1e415f, color: white, stroke: #364c53, stroke-width: 1px
|
||||
|
||||
Host
|
||||
@@ -260,7 +260,7 @@ Default AIO Deploy Daemon
|
||||
*************************
|
||||
|
||||
Nextcloud AIO has a specifically created Docker Socket Proxy container to be used as the Deploy Daemon in AppAPI.
|
||||
It has `fixed parameters <https://github.com/cloud-py-api/app_api/blob/main/lib/DeployActions/AIODockerActions.php#L52-L74)>`_:
|
||||
It has `fixed parameters <https://github.com/nextcloud/app_api/blob/main/lib/DeployActions/AIODockerActions.php#L52-L74)>`_:
|
||||
|
||||
* Name: ``docker_aio``
|
||||
* Display name: ``AIO Docker Socket Proxy``
|
||||
|
||||
@@ -11,7 +11,7 @@ You can test each Daemon configuration deployment from the AppAPI Admin settings
|
||||
Status Checks
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
The Deploy test installs a `test-deploy <https://github.com/cloud-py-api/test-deploy>`_ ExApp
|
||||
The Deploy test installs a `test-deploy <https://github.com/nextcloud/test-deploy>`_ ExApp
|
||||
to verify each step of the deployment process, including a hardware support check -
|
||||
for each compute device, there is a separate Docker image.
|
||||
|
||||
|
||||
@@ -22,13 +22,13 @@ Clone the latest main branch:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/cloud-py-api/app_api.git && cd app_api
|
||||
git clone https://github.com/nextcloud/app_api.git && cd app_api
|
||||
|
||||
or clone a specific version by specifying the version tag:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://github.com/cloud-py-api/app_api.git --branch <version-tag> && cd app_api
|
||||
git clone https://github.com/nextcloud/app_api.git --branch <version-tag> && cd app_api
|
||||
|
||||
where ``<version-tag>`` is the version you want to install.
|
||||
|
||||
@@ -57,7 +57,7 @@ There are two types of Deploy daemons that can be used for development and testi
|
||||
Docker Socket Proxy
|
||||
*******************
|
||||
|
||||
For development and testing locally, the simplest is to use the `Nextcloud AppAPI DSP HTTP <https://github.com/cloud-py-api/docker-socket-proxy?tab=readme-ov-file#httplocal>`_.
|
||||
For development and testing locally, the simplest is to use the `Nextcloud AppAPI DSP HTTP <https://github.com/nextcloud/docker-socket-proxy?tab=readme-ov-file#httplocal>`_.
|
||||
|
||||
In Place of a Conclusion
|
||||
""""""""""""""""""""""""
|
||||
|
||||
@@ -29,10 +29,10 @@ Next step, is to setup the ExApp skeleton.
|
||||
There are several ExApp examples available so you can have a look at them and start from.
|
||||
The ExApp template and examples:
|
||||
|
||||
- ``[Python]`` `App Skeleton <https://github.com/cloud-py-api/app-skeleton-python>`_
|
||||
- ``[Python]`` `UI Example Skeleton <https://github.com/cloud-py-api/ui_example>`_
|
||||
- ``[Python]`` `App Skeleton <https://github.com/nextcloud/app-skeleton-python>`_
|
||||
- ``[Python]`` `UI Example Skeleton <https://github.com/nextcloud/ui_example>`_
|
||||
- ``[Python]`` `More complex ExApp UI example with 3rdparty service <https://github.com/cloud-py-api/visionatrix>`_
|
||||
- ``[GoLang]`` `Go Lang ExApp example <https://github.com/cloud-py-api/file_to_text_example>`_
|
||||
- ``[GoLang]`` `Go Lang ExApp example <https://github.com/nextcloud/file_to_text_example>`_
|
||||
- etc.
|
||||
|
||||
They contain the basic structure of the ExApp, including:
|
||||
@@ -80,7 +80,7 @@ Currently, there are 3 main compute devices to target with custom Docker images:
|
||||
.. note::
|
||||
|
||||
If the Deploy daemon configured with the GPU compute device,
|
||||
AppAPI will try to pull the Docker image with the GPU support first (``<image_name>:<version>-<cuda|rocm>``, `ref PR <https://github.com/cloud-py-api/app_api/pull/340>`_).
|
||||
AppAPI will try to pull the Docker image with the GPU support first (``<image_name>:<version>-<cuda|rocm>``, `ref PR <https://github.com/nextcloud/app_api/pull/340>`_).
|
||||
If the image is not found, AppAPI will try to pull the base (CPU) image (``<image_name>:<version>``).
|
||||
|
||||
|
||||
|
||||
@@ -37,7 +37,7 @@ It should contain the following fields:
|
||||
<external-app>
|
||||
<docker-install>
|
||||
<registry>ghcr.io</registry>
|
||||
<image>cloud-py-api/skeleton</image>
|
||||
<image>nextcloud/skeleton</image>
|
||||
<image-tag>latest</image-tag>
|
||||
</docker-install>
|
||||
<scopes> // deprecated and removed since AppAPI 3.2.0
|
||||
@@ -93,7 +93,7 @@ To simplify the usage, we declare a few constants:
|
||||
export const APP_API_PROXY_URL_PREFIX = '/apps/app_api/proxy'
|
||||
export const APP_API_ROUTER_BASE = '/apps/app_api/embedded'
|
||||
|
||||
The bootstrap of the Vue app (`UI Example bootstrap <https://github.com/cloud-py-api/ui_example/blob/main/src/bootstrap.js>`_) is changed as follows:
|
||||
The bootstrap of the Vue app (`UI Example bootstrap <https://github.com/nextcloud/ui_example/blob/main/src/bootstrap.js>`_) is changed as follows:
|
||||
|
||||
.. code-block::
|
||||
|
||||
@@ -195,7 +195,7 @@ and can be used to translate ExApp strings on the backend or frontend in the sam
|
||||
|
||||
|
||||
You might need to convert the translation files to the format that is used in your language.
|
||||
And this can be done with simple bash script, as `in our example for Python <https://github.com/cloud-py-api/ui_example/blob/main/scripts/convert_to_locale.sh>`_:
|
||||
And this can be done with simple bash script, as `in our example for Python <https://github.com/nextcloud/ui_example/blob/main/scripts/convert_to_locale.sh>`_:
|
||||
|
||||
|
||||
.. code-block::
|
||||
|
||||
@@ -12,13 +12,13 @@ When running the command:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
php occ app_api:app:register --force-scopes test-deploy docker_socket_proxy --info-xml https://raw.githubusercontent.com/cloud-py-api/test-deploy/main/appinfo/info.xml --test-deploy-mode --no-ansi --no-warnings
|
||||
php occ app_api:app:register --force-scopes test-deploy docker_socket_proxy --info-xml https://raw.githubusercontent.com/nextcloud/test-deploy/main/appinfo/info.xml --test-deploy-mode --no-ansi --no-warnings
|
||||
|
||||
You may receive an error similar to:
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
file_get_contents(https://raw.githubusercontent.com/cloud-py-api/test-deploy/main/appinfo/info.xml): Failed to open stream: Connection timed out at /var/www/html/custom_apps/app_api/lib/Service/ExAppService.php#277
|
||||
file_get_contents(https://raw.githubusercontent.com/nextcloud/test-deploy/main/appinfo/info.xml): Failed to open stream: Connection timed out at /var/www/html/custom_apps/app_api/lib/Service/ExAppService.php#277
|
||||
|
||||
Cause
|
||||
-----
|
||||
@@ -134,7 +134,7 @@ Method 2: Set System-Wide Environment Variables
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
php occ app_api:app:register --force-scopes test-deploy docker_socket_proxy --info-xml https://raw.githubusercontent.com/cloud-py-api/test-deploy/main/appinfo/info.xml --test-deploy-mode --no-ansi --no-warnings
|
||||
php occ app_api:app:register --force-scopes test-deploy docker_socket_proxy --info-xml https://raw.githubusercontent.com/nextcloud/test-deploy/main/appinfo/info.xml --test-deploy-mode --no-ansi --no-warnings
|
||||
|
||||
It should now work without connectivity issues.
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ Docker Socket Proxy
|
||||
===================
|
||||
|
||||
The recommended way to setup AppAPI Deploy daemon
|
||||
is to use our `Docker Socket Proxy implementation <https://github.com/cloud-py-api/docker-socket-proxy>`_.
|
||||
is to use our `Docker Socket Proxy implementation <https://github.com/nextcloud/docker-socket-proxy>`_.
|
||||
|
||||
Nextcloud AppAPI DSP
|
||||
--------------------
|
||||
@@ -11,8 +11,8 @@ Nextcloud AppAPI DSP (Docker Socket Proxy) - is a simple Docker container that p
|
||||
It is secured with haproxy Basic authentication.
|
||||
There are two parts of reverse proxy configuration:
|
||||
|
||||
- HaProxy config for `Docker Engine API <https://github.com/cloud-py-api/docker-socket-proxy/blob/main/haproxy.cfg.template>`_
|
||||
- HaProxy config for `ExApps <https://github.com/cloud-py-api/docker-socket-proxy/blob/main/haproxy_ex_apps.cfg.template>`_
|
||||
- HaProxy config for `Docker Engine API <https://github.com/nextcloud/docker-socket-proxy/blob/main/haproxy.cfg.template>`_
|
||||
- HaProxy config for `ExApps <https://github.com/nextcloud/docker-socket-proxy/blob/main/haproxy_ex_apps.cfg.template>`_
|
||||
|
||||
.. note::
|
||||
|
||||
@@ -51,6 +51,6 @@ In this case, you will have to enable these APIs via the environment variables:
|
||||
|
||||
For local Deploy daemon setup other implementations of Docker Socket Proxy may be enough.
|
||||
But for remote Deploy daemon setup, we recommend using our DSP,
|
||||
as `we allow <https://github.com/cloud-py-api/docker-socket-proxy/blob/main/haproxy.cfg.template>`_ only the Docker Engine APIs we actually use in AppAPI,
|
||||
as `we allow <https://github.com/nextcloud/docker-socket-proxy/blob/main/haproxy.cfg.template>`_ only the Docker Engine APIs we actually use in AppAPI,
|
||||
and it is additionally secured with haproxy authentication.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ Here are some common steps to verify the network configuration:
|
||||
|
||||
.. note::
|
||||
If your case is not documented here, or doesn't exists on GitHub issues,
|
||||
please feel free to ask it by creating an issue in the `AppAPI repository <https://github.com/cloud-py-api/app_api/issues>`_.
|
||||
please feel free to ask it by creating an issue in the `AppAPI repository <https://github.com/nextcloud/app_api/issues>`_.
|
||||
|
||||
|
||||
ExApp deployment issues
|
||||
|
||||
@@ -48,7 +48,7 @@ Options
|
||||
* ``--gpu`` - ``[optional]`` GPU device to expose to the daemon (e.g. ``/dev/dri``)
|
||||
|
||||
.. note::
|
||||
Common configurations are tested by the CI in our repository, see `workflows on GitHub <https://github.com/cloud-py-api/app_api/blob/main/.github/workflows/tests-deploy.yml>`_.
|
||||
Common configurations are tested by the CI in our repository, see `workflows on GitHub <https://github.com/nextcloud/app_api/blob/main/.github/workflows/tests-deploy.yml>`_.
|
||||
|
||||
Example
|
||||
*******
|
||||
@@ -144,7 +144,7 @@ It has the same structure as other Nextcloud appinfo/info.xml files, but with so
|
||||
<external-app>
|
||||
<docker-install>
|
||||
<registry>ghcr.io</registry>
|
||||
<image>cloud-py-api/talk_bot</image>
|
||||
<image>nextcloud/talk_bot</image>
|
||||
<image-tag>latest</image-tag>
|
||||
</docker-install>
|
||||
<scopes> // deprecated since AppAPI 3.2.0
|
||||
|
||||
@@ -17,8 +17,8 @@ The suffix will be added as follows:
|
||||
return $imageParams['image_src'] . '/' .
|
||||
$imageParams['image_name'] . '-' . $daemonConfig['computeDevice']['id'] . ':' . $imageParams['image_tag'];
|
||||
|
||||
For ``cpu``, AppAPI will first try to get the image from ``ghcr.io/cloud-py-api/skeleton-cpu:latest``.
|
||||
In case the image is not found, ``ghcr.io/cloud-py-api/skeleton:latest`` will be pulled.
|
||||
For ``cpu``, AppAPI will first try to get the image from ``ghcr.io/nextcloud/skeleton-cpu:latest``.
|
||||
In case the image is not found, ``ghcr.io/nextcloud/skeleton:latest`` will be pulled.
|
||||
|
||||
If you as an application developer want to have a custom images for any of these values, you can push the extended images to registry in addition to the base one.
|
||||
|
||||
|
||||
@@ -21,7 +21,7 @@ Back-end
|
||||
********
|
||||
|
||||
For the back-end part of ExApp which can be written in different programming languages it is **up to the developer to decide** how to handle and translations files.
|
||||
There is an example repository with translations: `UI example with translations <https://github.com/cloud-py-api/ui_example>`_.
|
||||
There is an example repository with translations: `UI example with translations <https://github.com/nextcloud/ui_example>`_.
|
||||
|
||||
|
||||
Manual install
|
||||
|
||||
@@ -113,7 +113,7 @@ to which AppAPI will attach a ``fileIds`` query parameter with the selected file
|
||||
where the ``first_menu`` is the name of the Top Menu ExApp UI page,
|
||||
and the ``second_page`` relative route handled on the frontend routing of the ExApp,
|
||||
the ``fileIds`` query parameter contains the selected file ids separated by commas.
|
||||
After that you can get the files info via webdav search request, see `ui_example <https://github.com/cloud-py-api/ui_example>`_.
|
||||
After that you can get the files info via webdav search request, see `ui_example <https://github.com/nextcloud/ui_example>`_.
|
||||
|
||||
|
||||
Request flow
|
||||
|
||||
Reference in New Issue
Block a user