From b5be51d1025a10c3f1e01d74dd98c51713b78324 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Proch=C3=A1zka?= Date: Wed, 16 Dec 2020 09:40:45 +0100 Subject: [PATCH] UNMS to UISP rename docs --- docs/file-structure.md | 8 ++++---- docs/manifest.md | 8 ++++---- docs/security.md | 2 +- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/file-structure.md b/docs/file-structure.md index 409de897b..3114e2c0d 100644 --- a/docs/file-structure.md +++ b/docs/file-structure.md @@ -28,12 +28,12 @@ This directory should be placed in the plugin's root, next to the `public.php` f - https://github.com/Ubiquiti-App/UCRM-plugins/blob/master/plugins/invoice-csv-export/src/templates/form.php#L10 ### public/admin-zone.js -*Available since UNMS 1.1.0-beta2.* +*Available since UISP 1.1.0-beta2.* If this file exists, it will be automatically loaded on every admin zone page in CRM. ### public/client-zone.js -*Available since UNMS 1.1.0-beta2.* +*Available since UISP 1.1.0-beta2.* If this file exists, it will be automatically loaded on every client zone page in CRM. @@ -72,7 +72,7 @@ The configuration is automatically refreshed, when changes are made in UCRM sett The following options are available: - `ucrmPublicUrl` - URL under which UCRM is publicly accessible, this will be `null` if the `Server domain name` or `Server IP` options are not configured in UCRM. - `ucrmLocalUrl` - URL under which UCRM is locally accessible. This should be used to call UCRM API to prevent issues with self-signed certificates. Available since UCRM 2.14.0-beta3. -- `unmsLocalUrl` - URL under which UNMS is locally accessible. This should be used to call UNMS API to prevent issues with self-signed certificates. Available since UNMS 1.0.0-beta.2. +- `unmsLocalUrl` - URL under which UISP (formerly UNMS) is locally accessible. This should be used to call UISP API to prevent issues with self-signed certificates. Available since UISP 1.0.0-beta.2. - `pluginPublicUrl` - URL under which the `public.php` file is publicly accessible, this will be `null` if the plugin does not have `public.php` file or if the `Server domain name` or `Server IP` options are not configured in UCRM. - `pluginAppKey` - An App key automatically generated for the plugin (with write permissions), which can be used to access UCRM API. - `pluginId` - ID of the plugin in UCRM. Available since UCRM 2.15.0-beta6. @@ -82,7 +82,7 @@ Example of the `ucrm.json` file: { "ucrmPublicUrl": "http://ucrm.example.com/", "ucrmLocalUrl":"http://localhost/", - "unmsLocalUrl":"http://unms:8081/nms/", + "unmsLocalUrl":"http://uisp:8081/nms/", "pluginPublicUrl": "http://ucrm.example.com/_plugin/dummy-plugin", "pluginAppKey": "5YbpCSto7ffl/P/veJ/GK3U7K7zH6ZoHil7j5dorerSN8o+rlJJq6X/uFGZQF2WL", "pluginId": 1 diff --git a/docs/manifest.md b/docs/manifest.md index 45526186b..71349ceb5 100644 --- a/docs/manifest.md +++ b/docs/manifest.md @@ -122,8 +122,8 @@ Contains information describing the plugin. - `url` - link to the plugin page - `version` - version of the plugin as displayed on CRM frontend - `ucrmVersionCompliancy` - defines minimum and maximum version of UCRM this plugin supports, minimum must be always defined, maximum can be `null` -- `unmsVersionCompliancy` - works the same as `ucrmVersionCompliancy` and is required for plugins to work since UNMS 1.0 (integrated version) - - If you want to support both UCRM 2.x and UNMS 1.x, you can include both `ucrmVersionCompliancy` and `unmsVersionCompliancy` in your manifest. If you want to support only UNMS 1.0 (integrated version), do **not** include `ucrmVersionCompliancy` in your manifest. +- `unmsVersionCompliancy` - works the same as `ucrmVersionCompliancy` and is required for plugins to work since UISP 1.0 (formerly UNMS integrated version) + - If you want to support both UCRM 2.x and UISP 1.x, you can include both `ucrmVersionCompliancy` and `unmsVersionCompliancy` in your manifest. If you want to support only UISP 1.0 (integrated version), do **not** include `ucrmVersionCompliancy` in your manifest. - `author` - author of the plugin as displayed on CRM frontend ### configuration @@ -168,7 +168,7 @@ Contains an array of items. Each item is defined as follows: *Note: The target pages should typically be protected to be available only to authorized clients or admins. Read [this](security.md) for details.* ### widgets -*Note: This feature is available since UNMS 1.0.0-beta7* +*Note: This feature is available since UISP (formerly UNMS) 1.0.0-beta7* Adds iframe widgets showing the plugin's public page to specified positions. @@ -187,7 +187,7 @@ Contains an array of items. Each item is defined as follows: *Note: The target pages should typically be protected to be available only to authorized clients or admins. Read [this](security.md) for details.* ### paymentButton -*Note: This feature is available since UNMS 1.0.0-beta7* +*Note: This feature is available since UISP (formerly UNMS) 1.0.0-beta7* Add payment button to one-time online payment page. - `label` - required, label of the payment button [1] diff --git a/docs/security.md b/docs/security.md index 93c735d91..d477a8114 100644 --- a/docs/security.md +++ b/docs/security.md @@ -5,7 +5,7 @@ The `public.php` file can be used to provide a customized public page or even mo However you might want to restrict some or all of these pages to only be available to the admins of the UCRM installation and/or to the clients. Since the plugin is running on the same domain as UCRM itself, it will also receive the UCRM cookies. In this case you can use the `PHPSESSID` cookie to ask UCRM about the current session. This is done by calling the `/current-user` URL and forwarding the `PHPSESSID` cookie. -> *Note that, the URL and the required cookies changed in UNMS 1.0 (integrated version).* +> *Note that, the URL and the required cookies changed in UISP 1.0 (formerly UNMS integrated version).* > The new URL is `/crm/current-user`. > The required cookies are `nms-crm-php-session-id` and `nms-session`. > You can use [UCRM Plugin SDK](https://github.com/Ubiquiti-App/UCRM-Plugin-SDK), which supports the new way since version 0.5.1.