|
26 | 26 | - **[Using a Custom NPM Registry](#using-a-custom-npm-registry)**
|
27 | 27 | - **[Air Gapped Environment](#air-gapped-environment)**
|
28 | 28 | - **[Plugin Configuration](#plugin-configuration)**
|
29 |
| - - [**Frontend Layout Configuration**](frontend-layout-configuration) |
| 29 | + - [**Frontend Layout Configuration**](#frontend-layout-configuration) |
30 | 30 | - **[Extend Internal Library of Available Icons](#extend-internal-library-of-available-icons)**
|
31 | 31 | - **[Dynamic Routes](#dynamic-routes)**
|
32 | 32 | - **[Menu Items](#menu-items)**
|
@@ -77,8 +77,8 @@ These recommended changes to the `package.json` are summarized below:
|
77 | 77 | }
|
78 | 78 | ```
|
79 | 79 |
|
80 |
| -> [!NOTE] |
81 |
| -> The option `--embed-as-dependencies` includes embedded packages as private dependencies of backend plugins. When value is `false` (using `--no-embed-as-dependencies`), source code of embedded plugins is merged with the generated code, so that the embedded plugin packages are completly erased (only available for legacy reasons: use with care). |
| 80 | +> [!NOTE] |
| 81 | +> The option `--embed-as-dependencies` includes embedded packages as private dependencies of backend plugins. When value is `false` (using `--no-embed-as-dependencies`), source code of embedded plugins is merged with the generated code, so that the embedded plugin packages are completly erased (only available for legacy reasons: use with care). |
82 | 82 |
|
83 | 83 | #### Required entry points
|
84 | 84 |
|
@@ -164,7 +164,7 @@ These recommended changes to the `package.json` are summarized below:
|
164 | 164 | ...
|
165 | 165 | ```
|
166 | 166 |
|
167 |
| -> [!NOTE] |
| 167 | +> [!NOTE] |
168 | 168 | > The option `--in-place` can be used to add frontend dynamic plugin assets to the `dist-scalprum` folder of the original plugin package.
|
169 | 169 |
|
170 | 170 | Our CLI can generate the default configuration for Scalprum on the fly. For generated defaults see logs when running `yarn export-dynamic`. We default to the following configuration:
|
@@ -342,10 +342,10 @@ Note: 2.12 is the last version released from <https://github.com/janus-idp/helm-
|
342 | 342 | - `package`: a [package specification](https://docs.npmjs.com/cli/v10/using-npm/package-spec) indicating the dynamic plugin package to install (can be from a local path, OCI registry path or an NPM repository).
|
343 | 343 | - `integrity`: (required for external packages) An integrity checksum in the [format of `<alg>-<digest>`](https://w3c.github.io/webappsec-subresource-integrity/#integrity-metadata-description) specific to the package. Supported algorithms include `sha256`, `sha384`, and `sha512`.
|
344 | 344 |
|
345 |
| -> [!NOTE] |
| 345 | +> [!NOTE] |
346 | 346 | > For OCI images paths the integratiy field can be ommited and the [image digest](https://github.com/opencontainers/image-spec/blob/main/descriptor.md#digests) can be used in the plugin package path.
|
347 | 347 |
|
348 |
| -> [!NOTE] |
| 348 | +> [!NOTE] |
349 | 349 | > For NPM packages You can easily obtain the integrity checksum using the following command:
|
350 | 350 | >
|
351 | 351 | > ```console
|
@@ -445,7 +445,7 @@ global:
|
445 | 445 |
|
446 | 446 | ### Example of external dynamic backend plugins
|
447 | 447 |
|
448 |
| -> [!IMPORTANT] |
| 448 | +> [!IMPORTANT] |
449 | 449 | > This section is a subject to change to be replaced with plugins published in OCI images examples
|
450 | 450 |
|
451 | 451 | If you wish to easily test the installation of dynamic backend plugins from an external NPM registry, you can utilize the example dynamic backend plugins outlined in the [dynamic backend plugin showcase repository](https://github.com/janus-idp/dynamic-backend-plugins-showcase/tree/main#provided-example-dynamic-plugins), which have been published to NPMJS for demonstration purposes.
|
@@ -482,7 +482,7 @@ By sequentially adding these plugins and allowing for a deployment restart after
|
482 | 482 |
|
483 | 483 | ### Using a custom NPM registry
|
484 | 484 |
|
485 |
| -> [!WARNING] |
| 485 | +> [!WARNING] |
486 | 486 | > Using a custom NPM Registry and/or NPMJS is not recommended. A dynamic plugin is a runtime artifact, and that it is not the best usage of an NPM registry to deliver runtime artifacts, especially in a container-based environment such as OCP. Using [Container Registry](#consuming-dynamic-plugins-from-a-container-registry) or [Local Configuration](#local-configuration) is recommended and supported for dynamic plugins production environments.
|
487 | 487 |
|
488 | 488 | To configure the NPM registry URL and authentication information for dynamic plugin packages obtained through `npm pack`, you can utilize a `.npmrc` file. When using the Helm chart, you can add this file by creating a secret named `dynamic-plugins-npmrc` with the following content:
|
|
0 commit comments