Skip to content

Commit 4731bfc

Browse files
committed
fix(exapps_management): update internal references, more grammar fixes
Signed-off-by: Edward Ly <[email protected]>
1 parent 6990817 commit 4731bfc

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

admin_manual/exapps_management/AppAPIAndExternalApps.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Previously, Nextcloud only supported applications written in the PHP programming
88
In order to support a wider range of use cases,
99
an ecosystem for **ExApps** (short for "External Apps") was introduced, allowing for the installation of apps as Docker containers.
1010

11-
Most of our :doc:`../ai/index` (AI) apps are developed as ExApps and thus may require some preparation of your Nextcloud instance before you can install them.
11+
Most of our :doc:`Artificial Intelligence <../ai/index>` (AI) apps are developed as ExApps and thus may require some preparation of your Nextcloud instance before you can install them.
1212

1313
Installing AppAPI
1414
-----------------
1515

1616
All ExApps require the `AppAPI <https://apps.nextcloud.com/apps/app_api>`_ Nextcloud app as a dependency.
17-
As of Nextcloud 30, AppAPI is automatically installed by default.
17+
As of Nextcloud version 30.0.1, AppAPI is automatically installed by default.
1818
If AppAPI is not installed, you can still install it by simply navigating to the Apps management page in your Nextcloud instance and search for AppAPI from the Tools category.
1919

2020
Setup deploy daemon
@@ -50,7 +50,7 @@ A Deploy Daemon is a way for Nextcloud to install, communicate with, and control
5050

5151
.. image:: ./img/app_api_3.png
5252

53-
Deployment configuration examples can be found :ref:`here <deploy-configs>`.
53+
Deployment configuration examples can be found :doc:`here <./DeployConfigurations>`.
5454

5555
Installing ExApps
5656
-----------------

admin_manual/exapps_management/DeployConfigurations.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ Suggested config values(template *Docker Socket Proxy*):
163163
NC & ExApps in the same Docker
164164
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
165165

166-
Applications are deployed in the same docker where Nextcloud resides.
166+
Applications are deployed in the same Docker where Nextcloud resides.
167167

168168
Suggested way to communicate with Docker: via ``docker-socket-proxy``.
169169

@@ -211,7 +211,7 @@ Suggested config values(template *Docker Socket Proxy*):
211211
Nextcloud in Docker AIO (all-in-one)
212212
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
213213

214-
In case of AppAPI is in Docker AIO setup (installed in Nextcloud container).
214+
In the case of AppAPI in Docker AIO setup (installed in Nextcloud container).
215215

216216
.. note::
217217

@@ -249,7 +249,7 @@ In case of AppAPI is in Docker AIO setup (installed in Nextcloud container).
249249
class ExApp2 python
250250
class ExApp3 python
251251

252-
AppAPI will automatically create default default DaemonConfig to use AIO Docker Socket Proxy as orchestrator to create ExApp containers.
252+
AppAPI will automatically create the default DaemonConfig for AIO Docker Socket Proxy in order to use it as an orchestrator to create ExApp containers.
253253

254254
.. note::
255255

@@ -282,7 +282,7 @@ NC to ExApp Communication
282282

283283
Each type of DeployDaemon necessarily implements the ``resolveExAppUrl`` function.
284284

285-
It has such prototype:
285+
It has the prototype:
286286

287287
.. code-block:: php
288288
@@ -309,7 +309,7 @@ where:
309309
Also you can specify something like ``10.10.2.5`` and in this case ``ExApp`` will try to bind to that address and
310310
AppAPI will try to send request s directly to this address assuming that ExApp itself bound on it.
311311

312-
The simplest implementation is in **Manual-Install** deploy type:
312+
The simplest implementation is in the **Manual-Install** deploy type:
313313

314314
.. code-block:: php
315315
@@ -328,9 +328,9 @@ The simplest implementation is in **Manual-Install** deploy type:
328328
return sprintf('%s://%s:%s', $protocol, $host, $port);
329329
}
330330
331-
Here we see that AppAPI send requests to **host**:**port** specified during daemon creation.
331+
Here we see that AppAPI sends requests to the **host**:**port** specified during daemon creation.
332332

333-
Now let's take a look at the Docker Daemon implementation of ``resolveExAppUrl``:
333+
Now, let's take a look at the Docker Daemon implementation of ``resolveExAppUrl``:
334334

335335
.. code-block:: php
336336
@@ -364,21 +364,21 @@ Now let's take a look at the Docker Daemon implementation of ``resolveExAppUrl``
364364
365365
Here we have much more complex algorithm of detecting to where requests should be send.
366366

367-
First of all if protocol is set to ``https`` AppAPI always send requests to daemon host,
368-
and this is in case of ``https`` it is a HaProxy that will forward requests to ExApps that will be listen on ``localhost``
367+
First of all, if the protocol is set to ``https``, AppAPI always sends requests to the daemon host,
368+
and in this case, it is a HaProxy that will forward requests to ExApps that will be listening on ``localhost``.
369369

370-
Briefly it will look like this(*haproxy_host==daemon host value*):
370+
Briefly, it will look like this (*haproxy_host==daemon host value*):
371371

372372
NC --> *https* --> ``haproxy_host:ex_app_port`` --> *http* --> ``localhost:ex_app_port``
373373

374-
When protocol is not ``https`` but ``http``, then what will be the endpoint where to send requests is determined by ``$deployConfig['net']`` value.
374+
When the protocol is not ``https`` but ``http``, then what will be the endpoint where to send requests is determined by ``$deployConfig['net']`` value.
375375

376-
If ``net`` is defined and equal to ``host`` then AppAPI assumes that ExApp is installed somewhere in the current host network and will be available on ``localhost`` loop-back adapter.
376+
If ``net`` is defined and equal to ``host``, then AppAPI assumes that ExApp is installed somewhere in the current host network and will be available on ``localhost`` loop-back adapter.
377377

378378
NC --> *http* --> ``localhost:ex_app_port``
379379

380-
In all other cases ExApp should be available by it's name: e.g. when using docker **custom bridge** network all containers available by DNS.
380+
In all other cases, the ExApp should be available by it's name: e.g. when using docker **custom bridge** network all containers available by DNS.
381381

382382
NC --> *http* --> ``app_container_name:ex_app_port``
383383

384-
This three different types of communication covers all most popular configurations.
384+
These three different types of communication cover most popular configurations.

admin_manual/exapps_management/ManagingDeployDaemons.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,8 @@ Command: ``app_api:daemon:list``
8080
Nextcloud AIO
8181
^^^^^^^^^^^^^
8282

83-
In case of AppAPI installed in AIO, default Deploy Daemon is registered automatically.
84-
It is possible to register additional Deploy Daemons with the same ways as described above.
83+
In the case of AppAPI installed in AIO, a default Deploy Daemon is registered automatically.
84+
It is possible to register additional Deploy Daemons using the same methods as described above.
8585

8686

8787
.. _additional_options_list:

0 commit comments

Comments
 (0)