Skip to content

Commit 88b4f01

Browse files
committed
[docs] Updated settings instructions in integrations page
1 parent 33ac32b commit 88b4f01

File tree

1 file changed

+24
-30
lines changed

1 file changed

+24
-30
lines changed

docs/user/integrations.rst

Lines changed: 24 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -28,45 +28,39 @@ important events in the network.
2828
.. include:: /partials/settings-note.rst
2929

3030
In order to use this module simply add
31-
``openwisp_network_topology.integrations.device`` to ``INSTALLED_APPS``:
31+
``openwisp_network_topology.integrations.device`` to ``INSTALLED_APPS`` in
32+
the Django project settings, e.g.:
3233

3334
.. code-block:: python
3435
35-
INSTALLED_APPS = [
36-
# other apps (e.g.: openwisp-controller, openwisp-monitoring)
37-
"openwisp_network_topology",
38-
"openwisp_network_topology.integrations.device",
39-
"openwisp_users.accounts",
40-
"allauth",
41-
"allauth.account",
42-
"openwisp_users",
43-
"rest_framework",
44-
]
36+
INSTALLED_APPS.append("openwisp_network_topology.integrations.device")
4537
4638
If you have enabled WiFI Mesh integration, you will also need to update
4739
the ``CELERY_BEAT_SCHEDULE`` as follow:
4840

4941
.. code-block:: python
5042
51-
CELERY_BEAT_SCHEDULE = {
52-
"create_mesh_topology": {
53-
# This task generates the mesh topology from monitoring data
54-
"task": "openwisp_network_topology.integrations.device.tasks.create_mesh_topology",
55-
# Execute this task every 5 minutes
56-
"schedule": timedelta(minutes=5),
57-
"args": (
58-
# List of organization UUIDs. The mesh topology will be
59-
# created only for devices belonging these organizations.
60-
[
61-
"4e002f97-eb01-4371-a4a8-857faa22fe5c",
62-
"be88d4c4-599a-4ca2-a1c0-3839b4fdc315",
63-
],
64-
# The task won't use monitoring data reported
65-
# before this time (in seconds)
66-
6 * 60, # 6 minutes
67-
),
68-
},
69-
}
43+
CELERY_BEAT_SCHEDULE.update(
44+
{
45+
"create_mesh_topology": {
46+
# This task generates the mesh topology from monitoring data
47+
"task": "openwisp_network_topology.integrations.device.tasks.create_mesh_topology",
48+
# Execute this task every 5 minutes
49+
"schedule": timedelta(minutes=5),
50+
"args": (
51+
# List of organization UUIDs. The mesh topology will be
52+
# created only for devices belonging these organizations.
53+
[
54+
"4e002f97-eb01-4371-a4a8-857faa22fe5c",
55+
"be88d4c4-599a-4ca2-a1c0-3839b4fdc315",
56+
],
57+
# The task won't use monitoring data reported
58+
# before this time (in seconds)
59+
6 * 60, # 6 minutes
60+
),
61+
},
62+
}
63+
)
7064
7165
If you are enabling this integration on a preexisting system, use the
7266
:ref:`create_device_nodes <network_topology_create_device_nodes>`

0 commit comments

Comments
 (0)