Skip to content

Commit 08c2da2

Browse files
docs(admin): improve apps management wording and structure
Signed-off-by: Josh <josh.t.richards@gmail.com>
1 parent f467ae2 commit 08c2da2

1 file changed

Lines changed: 76 additions & 68 deletions

File tree

admin_manual/apps_management.rst

Lines changed: 76 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22
Apps management
33
===============
44

5-
Nextcloud apps can enhance, customize or even restrict the features and experience
6-
you and your users has with the Nextcloud server. Next to default enabled functions
7-
like Files, Activity and Photos there are other apps like Calendar, Contacts,
8-
Talk and more which are enhancing the features of your Nextcloud server.
5+
Nextcloud apps can enhance, customize, or restrict the features and experience
6+
available to you and your users on the Nextcloud server. In addition to built-in
7+
apps such as Files, Activity, and Photos, other apps such as Calendar, Contacts,
8+
and Talk can further expand its functionality.
99

10-
After installing the Nextcloud server, you might want to consider about enabling,
11-
disabling or even restricting some apps to groups depending on your and your users'
12-
needs.
10+
After installing the Nextcloud server, you might want to consider enabling, disabling,
11+
or restricting some apps for specific groups, depending on your needs and those of
12+
your users.
1313

1414
Apps
1515
----
@@ -21,16 +21,20 @@ During the Nextcloud server installation, some apps are enabled by default.
2121
To see which apps are enabled go to your Apps page.
2222

2323
Those apps are supported and developed by Nextcloud GmbH directly and
24-
have an **Featured**-tag.
24+
have a **Featured** tag.
2525

26-
.. note:: Your Nextcloud server needs to be able to communicate with
27-
``https://apps.nextcloud.com``, ``https://ltd[1-3].nextcloud.com``, ``https://garm[1-5].nextcloud.com`` to list and download apps. Please make sure to whitelist this target in your firewall or proxy if necessary.
26+
.. note::
27+
Your Nextcloud server needs to be able to communicate with ``https://apps.nextcloud.com``,
28+
``https://ltd[1-3].nextcloud.com``, ``https://garm[1-5].nextcloud.com`` to list and download
29+
apps. Please make sure to allow these hosts in your firewall or proxy if necessary.
2830

29-
.. note:: To get access to work-arounds, long-term-support, priority bug fixing
30-
and custom consulting for supported apps, contact our `sales team <https://nextcloud.com/enterprise/>`_.
31+
.. note::
32+
To get access to work-arounds, long-term-support, priority bug fixing and custom consulting
33+
for supported apps, contact `Nextcloud GmbH <https://nextcloud.com/enterprise/>`_.
3134

32-
.. note:: If you would like to develop your own Nextcloud app, you can find out
33-
more information in our `developer manual <https://docs.nextcloud.com/server/latest/go.php?to=developer-manual>`_.
35+
.. note::
36+
If you would like to develop your own Nextcloud app, you can find out more information in
37+
our `developer manual <https://docs.nextcloud.com/server/latest/go.php?to=developer-manual>`_.
3438

3539
All apps must be licensed under AGPLv3+ or any compatible license.
3640

@@ -44,82 +48,82 @@ You will see which apps are enabled, disabled and available. You'll also
4448
see additional app bundles and filters, such as Customization, Security and
4549
Monitoring for finding more apps quickly.
4650

47-
In the Apps page you can enable or disable applications. Some apps have
51+
On the Apps page, you can enable or disable applications. Some apps have
4852
configurable options on the Apps page, such as **Enable only for specific
4953
groups**, but mainly they are enabled or disabled here, and are configured in
5054
your Nextcloud settings (admin and/or user-settings) or in the ``config.php``.
5155

52-
Click the app name to view a description of the app and any of the app settings
53-
in the Application View field. Clicking the **Enable** button will enable the app.
54-
If the app is not part of the Nextcloud installation, it will be downloaded from
55-
the app store, installed and enabled.
56+
Select an app to view its description and available configuration options. Clicking
57+
the **Enable** button will enable the app. If the app is not part of the Nextcloud
58+
installation, it will be downloaded from the app store, installed and enabled.
5659

5760
App updates will also be offered to you on this page. Simply click on the **Update**
5861
button to update a specific app or use the **Update all** button on top of the page to
5962
update all apps.
6063

61-
.. note:: **Beta releases**: You can also install beta releases of apps directly from here by
62-
switching your Nextcloud to the beta channel in the admin overview.
64+
.. note::
65+
**Beta releases**: You can also install beta releases of apps directly from here by
66+
switching your Nextcloud to the beta channel in the admin overview.
6367

6468
Update notifications
6569
^^^^^^^^^^^^^^^^^^^^
6670

67-
The always installed ``updatenotification`` app allows administrators to be notified on available app and Nextcloud updates.
68-
Moreover, since Nextcloud 29, this app also allows to notify users about updated apps and the changes that are included in the update.
69-
This notification is enabled by default if the app provides a changelog.
71+
The default ``updatenotification`` app sends administrators notifications about available
72+
app and Nextcloud updates. Moreover, since Nextcloud 29, this app also allows to notify
73+
users about updated apps and the changes that are included in the update. This notification
74+
is enabled by default if the app provides a changelog.
7075

7176
To disable user notifications use:
7277

73-
::
78+
.. code-block:: console
7479
75-
occ config:app:set --type boolean --value="false" updatenotification app_updated.enabled
80+
occ config:app:set --type boolean --value="false" updatenotification app_updated.enabled
7681
77-
By default guest users, when using the guests app, are not notified, to enable notifications also for them use:
82+
By default. when using the ``guests`` app, guest users are not notified. To enable notifications for them use:
7883

79-
::
84+
.. code-block:: console
8085
81-
occ config:app:set --type boolean --value="true" updatenotification app_updated.notify_guests
86+
occ config:app:set --type boolean --value="true" updatenotification app_updated.notify_guests
8287
83-
Enabling apps via occ command
84-
-----------------------------
88+
Managing apps with ``occ``
89+
^^^^^^^^^^^^^^^^^^^^^^^^^^
8590

86-
In addition to managing apps via the web interface, administrators can also enable or disable apps using the `occ` command.
91+
In addition to managing apps via the web interface, administrators can enable or disable apps with the ``occ`` command.
8792

8893
To enable an app, use the following command:
8994

90-
::
95+
.. code-block:: console
9196
92-
occ app:enable <app-id>
97+
occ app:enable <app-id>
9398
9499
For example, to enable the "files" app, run:
95100

96-
::
97-
98-
occ app:enable files
101+
.. code-block:: console
99102
100-
To enable the app for specific groups, use the `--groups` option:
103+
occ app:enable files
101104
102-
::
105+
To enable the app for specific groups, use the ``--groups`` option:
103106

104-
occ app:enable files --groups=admin
107+
.. code-block:: console
105108
109+
occ app:enable files --groups=admin
106110
107111
This command enables the "files" app only for the "admin" group.
108112

109113
To disable an app, use:
110114

111-
::
115+
.. code-block:: console
112116
113-
occ app:disable <app-id>
117+
occ app:disable <app-id>
114118
115119
Using private API
116-
-----------------
120+
^^^^^^^^^^^^^^^^^
117121

118-
If private API, rather than the public APIs are used in a third-party app, the
119-
installation fails, if ``'appcodechecker' => true,`` is set in ``config.php``.
122+
If a third-party app uses private APIs instead of public APIs, installation
123+
fails when ``'appcodechecker' => true,`` is set in ``config.php``.
120124

121125
Using custom app directories
122-
----------------------------
126+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123127

124128
Use the **apps_paths** array in ``config.php`` to set any custom apps directory
125129
locations. The key **path** defines the absolute file system path to the app
@@ -128,10 +132,10 @@ the Nextcloud web root. The key **writable** indicates if a user can install app
128132
in that folder.
129133

130134
Example: To ensure that the default ``/apps/`` folder only contains apps shipped
131-
with Nextcloud, follow this example to setup an ``/extra-apps/`` folder
132-
which will be used to store any additional apps you install:
135+
with Nextcloud, follow this example to set up an ``/extra-apps/`` folder which
136+
will be used to store any additional apps you install:
133137

134-
::
138+
.. code-block:: php
135139
136140
"apps_paths" => [
137141
[
@@ -157,12 +161,12 @@ which will be used to store any additional apps you install:
157161
you would use the command ``ln`` to create the symbolic link like this:
158162
``ln -sf /var/local/lib/nextcloud/extra-apps ./extra-apps``
159163

160-
Configuring the app store request timeout
161-
-----------------------------------------
164+
Configuring the app store timeout
165+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
162166

163-
The timeout for requests to the Nextcloud app store can be configured with
164-
the ``appstore-timeout`` app setting. The value is specified in seconds.
165-
This setting is configured with ``occ`` and is not a ``config.php`` parameter.
167+
The timeout for requests to fetch app store metadata can be configured with the
168+
``appstore-timeout`` app setting. The value is specified in seconds. This setting is
169+
configured with ``occ`` and is not a ``config.php`` parameter.
166170

167171
For example, to set the timeout to 180 seconds:
168172

@@ -181,27 +185,31 @@ custom setting:
181185
The default app store request timeout was increased from 60 to 120 seconds
182186
and can be configured with ``occ``.
183187

184-
Using a self hosted apps store
185-
------------------------------
186-
187-
Enables the installation of apps from a self hosted apps store. Requires that at least one of the configured apps directories is writeable.
188+
Using a self-hosted app store
189+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
188190

189-
To enable a self hosted apps store:
191+
This section explains how to enable installation of apps from a self-hosted app store.
192+
At least one of the configured apps directories must be writable.
190193

191-
1. Set the **appstoreenabled** parameter to "true".
194+
To enable a self-hosted app store:
192195

193-
This parameter is used to enable the apps store in Nextcloud.
196+
1. Set the ``appstoreenabled`` parameter to ``true``.
194197

195-
2. Set the **appstoreurl** to the URL of your Nextcloud apps store.
198+
This parameter is used to enable the app store in Nextcloud.
196199

197-
This parameter is used to set the http path to your self hosted Nextcloud apps store.
200+
2. Set the ``appstoreurl`` to the URL of your Nextcloud app store.
198201

199-
::
202+
This parameter is used to set the HTTP path to your self-hosted Nextcloud app store.
200203

201-
"appstoreenabled" => true,
202-
"appstoreurl" => "https://my.appstore.instance/v1",
204+
.. code-block:: php
203205
206+
"appstoreenabled" => true,
207+
"appstoreurl" => "https://my.appstore.instance/v1",
204208
205-
By default the apps store is enabled and configured to use ``https://apps.nextcloud.com/api/v1`` as apps store url. Nextcloud will fetch ``apps.json`` and ``categories.json`` from there. To use the defaults again remove **appstoreenabled** and **appstoreurl** from the configuration.
209+
By default the app store is enabled and configured to use ``https://apps.nextcloud.com/api/v1``
210+
as the app store URL. Nextcloud will fetch ``apps.json`` and ``categories.json`` from there. To
211+
use the defaults again, remove the ``appstoreenabled`` and ``appstoreurl`` parameters from the
212+
configuration.
206213

207-
Example: If ``categories.json`` is available at ``https://apps.nextcloud.com/api/v1/categories.json`` the apps store url is ``https://apps.nextcloud.com/api/v1``.
214+
Example: If ``categories.json`` is available at ``https://apps.nextcloud.com/api/v1/categories.json``
215+
the app store URL is ``https://apps.nextcloud.com/api/v1``.

0 commit comments

Comments
 (0)