Skip to content

Commit e4f3730

Browse files
ejarocki-cloudlinuxejarocki-cloudlinux
authored
Add sections about tuxcare patcher
Add sections about tuxcare patcher
2 parents 7bcd55e + c757755 commit e4f3730

File tree

57 files changed

+2841
-332
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+2841
-332
lines changed

‎docs/.vuepress/config-client/sidebar.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -280,10 +280,6 @@ export default {
280280
path: '/els-for-runtimes-and-libraries/jsonwebtoken/',
281281
icon: '/images/jsonwebtoken-logo.webp',
282282
},
283-
{
284-
path: '/els-for-runtimes-and-libraries/karma/',
285-
icon: '/images/karma-logo.webp',
286-
},
287283
{
288284
path: '/els-for-runtimes-and-libraries/jsonpath-plus/',
289285
icon: '/images/jsonpath-plus-logo.webp',
@@ -292,6 +288,10 @@ export default {
292288
path: '/els-for-runtimes-and-libraries/jspdf/',
293289
icon: '/images/jspdf-logo.webp',
294290
},
291+
{
292+
path: '/els-for-runtimes-and-libraries/karma/',
293+
icon: '/images/karma-logo.webp',
294+
},
295295
{
296296
path: '/els-for-runtimes-and-libraries/lodash/',
297297
icon: '/images/lodash-logo.webp',

‎docs/els-for-runtimes-and-libraries/angular/README.md‎

Lines changed: 31 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,24 @@ TuxCare provides ELS for Angular as an NPM package, hosted on a secure internal
4848
Replace ${TOKEN} with the token you received from [[email protected]](mailto:[email protected]).
4949
:::
5050

51-
4. Update your `package.json` file to replace your Angular dependencies with the TuxCare packages.
51+
4. Update your `package.json` file to replace your Angular dependencies with the TuxCare packages. You can do this in two ways:
52+
53+
* **Option 1: TuxCare Patcher (Automated)**
54+
55+
If you already have dependencies listed in your `package.json`, install the Patcher globally, then run the patcher command:
56+
57+
<CodeWithCopy>
58+
59+
```text
60+
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
61+
tuxcare-patch-js
62+
```
63+
64+
</CodeWithCopy>
65+
66+
The patcher will automatically update your `dependencies` and `overrides` to use the corresponding `@els-js/*` packages based on your Angular version selection below.
67+
68+
* **Option 2: Manual Update**
5269
5370
<TableTabs label="Choose Angular version: " >
5471
@@ -787,7 +804,19 @@ Replace ${TOKEN} with the token you received from [[email protected]](mailto:sal
787804

788805
## How to Upgrade to a Newer Version of TuxCare Packages
789806

790-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), you need to update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
807+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), you have two options:
808+
809+
* **Option 1**. Run TuxCare Patcher to update all TuxCare packages in your `package.json`:
810+
811+
<CodeWithCopy>
812+
813+
```text
814+
tuxcare-patch-js --upgrade
815+
```
816+
817+
</CodeWithCopy>
818+
819+
* **Option 2**. Manually update the version string(s) in your `package.json`, then remove installed files and clear npm cache to avoid conflicts:
791820

792821
<CodeWithCopy>
793822

‎docs/els-for-runtimes-and-libraries/angularjs/README.md‎

Lines changed: 53 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,45 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
4747
Replace ${TOKEN} with the token you received from [[email protected]](mailto:[email protected]).
4848
:::
4949

50-
4. Update your `package.json` file to replace your AngularJS dependencies with the TuxCare packages:
50+
4. Update your `package.json` file to replace your AngularJS dependencies with the TuxCare packages. You can do this in two ways:
5151

52-
<TableTabs label="Choose AngularJS version: " >
52+
* **Option 1: TuxCare Patcher (Automated)**
53+
54+
If you already have dependencies listed in your `package.json`, for example:
55+
56+
```text
57+
"dependencies": {
58+
"angular": "^1.8.3"
59+
}
60+
```
61+
62+
Install the Patcher globally, then run the patcher command:
63+
64+
<CodeWithCopy>
65+
66+
```text
67+
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
68+
tuxcare-patch-js
69+
```
70+
71+
</CodeWithCopy>
72+
73+
The patcher will automatically update your `package.json` to:
74+
75+
```text
76+
"dependencies": {
77+
"angular": "npm:@els-js/[email protected]"
78+
},
79+
"overrides": {
80+
"[email protected]": "npm:@els-js/[email protected]"
81+
}
82+
```
83+
84+
* **Option 2: Manual Update**
85+
86+
Manually update your `package.json` file to use the TuxCare package:
87+
88+
<TableTabs label="Choose AngularJS version: " >
5389
5490
<template #AngularJS_1.5.11>
5591
@@ -121,7 +157,7 @@ TuxCare provides ELS for AngularJS as an NPM package, hosted on a secure interna
121157
122158
</template>
123159
124-
</TableTabs>
160+
</TableTabs>
125161
126162
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:
127163
@@ -161,24 +197,33 @@ TuxCare provides VEX for AngularJS ELS versions: [security.tuxcare.com/vex/cyclo
161197

162198
## How to Upgrade to a Newer Version of TuxCare Packages
163199

164-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.3`), there are two options:
200+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.4`), there are several options:
201+
202+
* **Option 1**. Run TuxCare Patcher to update all TuxCare packages in your `package.json`:
203+
204+
<CodeWithCopy>
205+
206+
```text
207+
tuxcare-patch-js --upgrade
208+
```
209+
210+
</CodeWithCopy>
165211

166-
* **Option 1**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
212+
* **Option 2**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
167213

168214
<CodeWithCopy>
169215

170216
```text
171-
npm install angular@npm:@els-js/[email protected].3
217+
npm install angular@npm:@els-js/[email protected].4
172218
```
173219

174220
</CodeWithCopy>
175221

176-
* **Option 2**. Update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
222+
* **Option 3**. Manually update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
177223

178224
<CodeWithCopy>
179225

180226
```text
181-
rm -rf node_modules package-lock.json && npm cache clean --force
182227
npm install
183228
```
184229

‎docs/els-for-runtimes-and-libraries/base64url/README.md‎

Lines changed: 51 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,13 +47,49 @@ TuxCare provides ELS for base64url as an NPM package, hosted on a secure interna
4747
Replace ${TOKEN} with the token you received from [[email protected]](mailto:[email protected]).
4848
:::
4949

50-
4. Update your `package.json` file to replace your base64url dependencies with the TuxCare packages:
50+
4. Update your `package.json` file to replace your base64url dependencies with the TuxCare packages. You can do this in two ways:
51+
52+
* **Option 1: TuxCare Patcher (Automated)**
53+
54+
If you already have dependencies listed in your `package.json`, for example:
55+
56+
```text
57+
"dependencies": {
58+
"base64url": "^0.0.6"
59+
}
60+
```
61+
62+
Install the Patcher globally, then run the patcher command:
63+
64+
<CodeWithCopy>
65+
66+
```text
67+
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
68+
tuxcare-patch-js
69+
```
70+
71+
</CodeWithCopy>
72+
73+
The patcher will automatically update your `package.json` to:
74+
75+
```text
76+
"dependencies": {
77+
"base64url": "npm:@els-js/[email protected]"
78+
},
79+
"overrides": {
80+
"[email protected]": "npm:@els-js/[email protected]"
81+
}
82+
```
83+
84+
* **Option 2: Manual Update**
85+
86+
Manually update your `package.json` file to use the TuxCare package:
5187
5288
<CodeWithCopy>
5389
5490
```text
5591
"dependencies": {
56-
"base64url": "npm:@els-js/[email protected].1"
92+
"base64url": "npm:@els-js/[email protected].2"
5793
}
5894
```
5995

@@ -97,9 +133,19 @@ TuxCare provides VEX for base64url ELS versions: [security.tuxcare.com/vex/cyclo
97133

98134
## How to Upgrade to a Newer Version of TuxCare Packages
99135

100-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.2`), there are two options:
136+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.2`), there are several options:
137+
138+
* **Option 1**. Run TuxCare Patcher to update all TuxCare packages in your `package.json`:
139+
140+
<CodeWithCopy>
141+
142+
```text
143+
tuxcare-patch-js --upgrade
144+
```
145+
146+
</CodeWithCopy>
101147

102-
* **Option 1**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
148+
* **Option 2**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
103149

104150
<CodeWithCopy>
105151

@@ -109,12 +155,11 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
109155

110156
</CodeWithCopy>
111157

112-
* **Option 2**. Update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
158+
* **Option 3**. Manually update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
113159

114160
<CodeWithCopy>
115161

116162
```text
117-
rm -rf node_modules package-lock.json && npm cache clean --force
118163
npm install
119164
```
120165

‎docs/els-for-runtimes-and-libraries/bootstrap/README.md‎

Lines changed: 52 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,9 +47,45 @@ TuxCare provides ELS for Bootstrap as an NPM package, hosted on a secure interna
4747
Replace ${TOKEN} with the token you received from [[email protected]](mailto:[email protected]).
4848
:::
4949

50-
4. Update your `package.json` file to replace your Bootstrap dependencies with the TuxCare packages:
50+
4. Update your `package.json` file to replace your Bootstrap dependencies with the TuxCare packages. You can do this in two ways:
5151

52-
<TableTabs label="Choose Bootstrap version: " >
52+
* **Option 1: TuxCare Patcher (Automated)**
53+
54+
If you already have dependencies listed in your `package.json`, for example:
55+
56+
```text
57+
"dependencies": {
58+
"bootstrap": "^4.6.2"
59+
}
60+
```
61+
62+
Install the Patcher globally, then run the patcher command:
63+
64+
<CodeWithCopy>
65+
66+
```text
67+
npm install -g @els-js/tuxcare-patcher --userconfig ./.npmrc
68+
tuxcare-patch-js
69+
```
70+
71+
</CodeWithCopy>
72+
73+
The patcher will automatically update your `package.json` to:
74+
75+
```text
76+
"dependencies": {
77+
"bootstrap": "npm:@els-js/[email protected]"
78+
},
79+
"overrides": {
80+
"[email protected]": "npm:@els-js/[email protected]"
81+
}
82+
```
83+
84+
* **Option 2: Manual Update**
85+
86+
Manually update your `package.json` file to use the TuxCare package:
87+
88+
<TableTabs label="Choose Bootstrap version: " >
5389
5490
<template #bootstrap_3.4.1>
5591
@@ -79,7 +115,7 @@ TuxCare provides ELS for Bootstrap as an NPM package, hosted on a secure interna
79115
80116
</template>
81117
82-
</TableTabs>
118+
</TableTabs>
83119
84120
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:
85121
@@ -122,9 +158,19 @@ TuxCare provides VEX for Bootstrap ELS versions: [security.tuxcare.com/vex/cyclo
122158

123159
## How to Upgrade to a Newer Version of TuxCare Packages
124160

125-
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.2`), there are two options:
161+
If you have already installed a package with a `tuxcare.1` suffix and want to upgrade to a newer release (for example, `tuxcare.2`), there are several options:
162+
163+
* **Option 1**. Run TuxCare Patcher to update all TuxCare packages in your `package.json`:
164+
165+
<CodeWithCopy>
166+
167+
```text
168+
tuxcare-patch-js --upgrade
169+
```
170+
171+
</CodeWithCopy>
126172

127-
* **Option 1**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
173+
* **Option 2**. Run the `npm install` command with the specific version. This will automatically update both `package.json` and `package-lock.json`:
128174

129175
<CodeWithCopy>
130176

@@ -134,12 +180,11 @@ If you have already installed a package with a `tuxcare.1` suffix and want to up
134180

135181
</CodeWithCopy>
136182

137-
* **Option 2**. Update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
183+
* **Option 3**. Manually update the version string in your `package.json`, remove installed files and clear npm cache to avoid conflicts:
138184

139185
<CodeWithCopy>
140186

141187
```text
142-
rm -rf node_modules package-lock.json && npm cache clean --force
143188
npm install
144189
```
145190

0 commit comments

Comments
 (0)