diff --git a/docs/.vuepress/config-client/sidebar.ts b/docs/.vuepress/config-client/sidebar.ts index e64064d2a..17d4959f5 100644 --- a/docs/.vuepress/config-client/sidebar.ts +++ b/docs/.vuepress/config-client/sidebar.ts @@ -365,6 +365,10 @@ export default { path: '/els-for-libraries/jsonwebtoken/', icon: '/images/jsonwebtoken-logo.webp', }, + { + path: '/els-for-libraries/karma/', + icon: '/images/karma-logo.webp', + }, { path: '/els-for-libraries/knockout/', icon: '/images/knockout-logo.webp', @@ -373,10 +377,6 @@ export default { path: '/els-for-libraries/koa/', icon: '/images/koa-logo.webp', }, - { - path: '/els-for-libraries/karma/', - icon: '/images/karma-logo.webp', - }, { path: '/els-for-libraries/lodash/', icon: '/images/lodash-logo.webp', @@ -421,10 +421,6 @@ export default { path: '/els-for-libraries/react/', icon: '/images/react-logo.webp', }, - { - path: '/els-for-libraries/react-dom/', - icon: '/images/react-logo.webp', - }, { path: '/els-for-libraries/react-pdf/', icon: '/images/react-logo.webp', @@ -453,22 +449,22 @@ export default { path: '/els-for-libraries/vite/', icon: '/images/vite-logo.webp', }, - { - path: '/els-for-libraries/vuetify/', - icon: '/images/vuetify-logo.webp', - }, { path: '/els-for-libraries/vue/', icon: '/images/vue-logo.webp', }, { - path: '/els-for-libraries/webpack-dev-server/', - icon: '/images/webpack-dev-server.webp', + path: '/els-for-libraries/vuetify/', + icon: '/images/vuetify-logo.webp', }, { path: '/els-for-libraries/webpack/', icon: '/images/webpack-logo.webp', }, + { + path: '/els-for-libraries/webpack-dev-server/', + icon: '/images/webpack-dev-server.webp', + }, { path: '/els-for-libraries/yui/', icon: '/images/yui-logo.webp', diff --git a/docs/els-for-libraries/angular/README.md b/docs/els-for-libraries/angular/README.md index 660d3d745..c7d838335 100644 --- a/docs/els-for-libraries/angular/README.md +++ b/docs/els-for-libraries/angular/README.md @@ -6,38 +6,24 @@ Endless Lifecycle Support (ELS) for Angular from TuxCare provides security fixes Angular versions from 4 to 18 are supported. -## Connection to ELS for Angular Repository +## Installation -This guide outlines the steps needed to integrate the TuxCare ELS for Angular repository. + -## Prerequisites +* **npm** version 9.6.3 or later + *Check current version:* `npm --version` + *Update npm:* `npm install -g npm@latest` +* TuxCare registry token — contact [sales@tuxcare.com](mailto:sales@tuxcare.com) +* To browse available artifacts, visit TuxCare [Nexus](https://nexus.repo.tuxcare.com/#browse/browse:els_angular) and click Sign in in the top right corner. You may need to refresh the page after logging in. -Before you begin, ensure you have **npm** up to date and you use version 9.6.3 or later for security and compatibility reasons. + -* To check your current versions, run: + - ```text - npm --version - ``` -* To update npm globally on your system, you can run: +1. **Navigate to the project root directory** - ```text - npm install -g npm@latest - ``` - -## Step 1: Get Token - -You need a token in order to use TuxCare ELS Angular repository. Anonymous access is disabled. To receive the token, please contact [sales@tuxcare.com](mailto:sales@tuxcare.com). - -## Step 2: Set Up ELS for Angular - -TuxCare provides ELS for Angular as an NPM package, hosted on a secure internal registry. Follow the steps below to add it to your project and get started. - -1. Navigate to the root directory of your Angular project. -2. Create a `.npmrc` file or update it if it already exists. - - **Example:** + Example structure: ```text my-angular-project/ @@ -48,7 +34,9 @@ TuxCare provides ELS for Angular as an NPM package, hosted on a secure internal └── tsconfig.json ``` -3. Use an editor of your choice (e.g., VS Code) to add the following registry address line: +2. **Configure the npm registry** + + Create or update the `.npmrc` file in your project root: ```text registry=https://registry.npmjs.org/ @@ -57,10 +45,12 @@ TuxCare provides ELS for Angular as an NPM package, hosted on a secure internal ``` :::warning - Replace ${TOKEN} with the token you received from [sales@tuxcare.com](mailto:sales@tuxcare.com). + Replace `${TOKEN}` with the token you received from [sales@tuxcare.com](mailto:sales@tuxcare.com). ::: -4. Manually update your `package.json` file by replacing your Angular dependencies with the TuxCare packages. +3. **Update dependencies** + + Manually update your `package.json` file by replacing Angular dependencies with TuxCare-maintained packages. @@ -828,401 +818,46 @@ TuxCare provides ELS for Angular as an NPM package, hosted on a secure internal -5. You need to remove the `node_modules` directory and the `package-lock.json` file, and also clear the `npm cache` before installing the patched packages. Use the following commands: +4. **Clean and install** + + Remove `node_modules`, `package-lock.json`, and clear the npm cache: ```text rm -rf node_modules package-lock.json && npm cache clean --force ``` -6. Run the following command to install ELS for Angular dependencies (token for the TuxCare repository will be automatically picked up from your `.npmrc` file): + Install dependencies: ```text npm install ``` -## Step 3: Verify Installation + The token for the TuxCare repository is automatically picked up from your `.npmrc` file. + +5. **Verify the setup** -1. To confirm the TuxCare Angular repository is set up correctly, use npm to list the project's dependencies: + Use npm to list the project's dependencies and confirm TuxCare packages are resolved correctly: ```text npm list ``` -2. After reviewing the dependencies, run your application to ensure everything works correctly. - -The `npm` tool should be able to identify and resolve dependencies from the TuxCare ELS for Angular repository. - -## Vulnerability Exploitability eXchange (VEX) - -VEX is a machine-readable format that tells you if a known vulnerability is actually exploitable in your product. It reduces false positives, helps prioritize real risks. - -TuxCare provides VEX for Angular ELS versions: [security.tuxcare.com/vex/cyclonedx/els_lang_javascript/](https://security.tuxcare.com/vex/cyclonedx/els_lang_javascript/). - -## Software Bill of Materials (SBOM) - -For each published ELS package and version, TuxCare generates SBOM files. Those artifacts are published to TuxCare Nexus. + After reviewing the dependencies, run your application to ensure everything works correctly. The `npm` tool should be able to identify and resolve dependencies from the TuxCare ELS for Angular repository. -You can browse SBOM files for Angular here: + -[https://nexus.repo.tuxcare.com/#browse/browse:els-js-sbom:angular](https://nexus.repo.tuxcare.com/#browse/browse:els-js-sbom:angular) +## What's Next? -Use the credentials you received for TuxCare ELS ([Step 1: Get Token](#step-1:-get-token)) to access Nexus. + -## How to Upgrade to a Newer Version of TuxCare Packages +* ![](/images/eye.webp) [CVE tracker](https://tuxcare.com/cve-tracker/?product=Angular) — Track vulnerability fixes and updates +* ![](/images/shield.webp) [Available fixes](https://tuxcare.com/cve-tracker/fixes?product=Angular) — Patched versions and changelogs +* ![](/images/clipboard-notes.webp) [Supported components](https://tuxcare.com/cve-tracker/products?product=Angular) — Full list of product parts covered by ELS +* ![](/images/shield-alert.webp) [VEX feed](https://security.tuxcare.com/vex/cyclonedx/els_lang_javascript/) — Vulnerability Exploitability eXchange feed +* ![](/images/unlock-alt.webp) [SBOM](https://nexus.repo.tuxcare.com/#browse/browse:els-js-sbom:angular) — Software Bill of Materials (Nexus, credentials required) +* ![](/images/wrench.webp) [Managing the ELS repository](/els-for-libraries/managing-els-repository/) — Update to newer versions -If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), remove node_modules, clear the npm cache to avoid conflicts, and then run the installation command: - - ```text - rm -rf node_modules package-lock.json && npm cache clean --force - npm install - ``` - -## Resolved CVEs - -Fixes for the following vulnerabilities are available in ELS for Angular from TuxCare versions: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -If you are interested in the TuxCare Endless Lifecycle Support, contact [sales@tuxcare.com](mailto:sales@tuxcare.com). +