Skip to content

Commit 52e6ada

Browse files
Merge pull request #4378 from syncfusion-content/ES5-security-advisories
1046613 - Improve the JavaScript ES5 UG documentation using AI Prompt - Phase 6
2 parents 71e6759 + 6975901 commit 52e6ada

7 files changed

Lines changed: 196 additions & 198 deletions

Document-Processing/Word/Word-Processor/javascript-es5/security-advisories.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ domainurl: ##DomainURL##
1010

1111
# Security Advisories in JavaScript DOCX Editor
1212

13-
Syncfusion<sup style="font-size:70%">&reg;</sup> places the utmost priority on the security of our controls. Users can rest assured about the security of our controls, as we have implemented all necessary measures to mitigate security vulnerabilities such as cross-site scripting and insecure dependencies. To meet security standards, Syncfusion<sup style="font-size:70%">&reg;</sup> utilizes the [ESLint](https://eslint.org/) and [ESLint plugin security](https://github.com/eslint-community/eslint-plugin-security#rules) tools for static code analysis. Additionally, Syncfusion<sup style="font-size:70%">&reg;</sup> packages undergo software composition analysis using the [SOOS](https://soos.io/) security tool.
13+
Syncfusion<sup style="font-size:70%">&reg;</sup> places the utmost priority on the security of our controls. Users can rest assured of the security of our controls, as we have implemented all necessary measures to mitigate security vulnerabilities, such as cross-site scripting and insecure dependencies. To meet security standards, Syncfusion<sup style="font-size:70%">&reg;</sup> utilizes the [ESLint](https://eslint.org/) and [ESLint plugin security](https://github.com/eslint-community/eslint-plugin-security#rules) tools for static code analysis. Additionally, Syncfusion<sup style="font-size:70%">&reg;</sup> packages undergo software composition analysis using the SOOS security tool.
1414

15-
This document provides a description of the security updates available for Syncfusion<sup style="font-size:70%">&reg;</sup> Essential<sup style="font-size:70%">&reg;</sup> JS2 controls for volume release.
15+
This document provides a description of the security updates available for Syncfusion<sup style="font-size:70%">&reg;</sup> Essential<sup style="font-size:70%">&reg;</sup> JS2 controls per volume release.
1616

1717
## Security Updates
1818

19-
The following security updates are available for JavaScript DocumentEditor control and are listed based on the release version.
19+
The following security updates are available for JavaScript (ES5) Document Editor control and are listed based on the release version.
2020

2121
### 2024 Volume 2 (v26.2.4) - July 25, 2024
2222

23-
This release resolves critical and moderate security vulnerabilities affecting the JavaScript Document Editor Docker Image.
23+
This release resolves critical and moderate security vulnerabilities affecting the JavaScript (ES5) Document Editor Docker Image.
2424

2525
**Threat:**
2626

@@ -42,4 +42,4 @@ For details on common security updates related to Syncfusion<sup style="font-siz
4242

4343
## Security Issue
4444

45-
If users discover any security issues or need assistance in resolving them with Syncfusion<sup style="font-size:70%">&reg;</sup> controls, please contact us by creating a support ticket on [our support site](https://syncfusion.com/support) or by posting your query on Stack Overflow with the tag `syncfusion-ej2`.
45+
If users discover any security issues or need assistance resolving them with Syncfusion<sup style="font-size:70%">&reg;</sup> controls, please contact us by creating a support ticket on [our support site](https://syncfusion.com/support) or by posting your query on Stack Overflow with the tag `syncfusion-ej2`.

Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-documenteditor-java-web-api-in-azure.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,52 +11,52 @@ domainurl: ##DomainURL##
1111

1212
## Prerequisites
1313

14-
Have [`Azure account`](https://azure.microsoft.com/en-gb/) and [`Azure CLI`](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest) setup in your environment.
14+
Ensure you have an [`Azure account`](https://azure.microsoft.com/en-gb/) and the [`Azure CLI`](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest) installed in your environment.
1515

16-
You can get the example [`web service project from GitHub`](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-Java-WebService) and then perform the following steps to create the packages and host in azure app service.
16+
You can get the example [`web service project from GitHub`](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-Java-WebService) and then perform the following steps to build the package and host it in an Azure App Service.
1717

18-
**Step 1:** Clean the package using following command.
18+
**Step 1:** Clean and package the application using the following command.
1919

2020
```console
2121
mvn clean package
2222
```
2323

24-
**Step 2:** Run the application locally using following command.
24+
**Step 2:** Run the application locally to verify the build using the following command.
2525

2626
```console
2727
mvn spring-boot:run
2828
```
2929

30-
**Step 3:** Build the package using following command.
30+
**Step 3:** Build the final package using the following command.
3131

3232
```console
3333
mvn package
3434
```
3535

36-
Above package generation command creates the `**tomcat-0.0.1-SNAPSHOT.war**` in the below location in the sample folder.
36+
The above package-generation command creates the `**tomcat-0.0.1-SNAPSHOT.war**` in the following location in the sample folder.
3737

3838
`target/tomcat-0.0.1-SNAPSHOT.war`
3939

40-
**Step 4:** Create a Azure app service with Java & Tomcat. For example, create the app services name as `documenteditorjava`.
40+
**Step 4:** Create an Azure App Service with Java & Tomcat. For example, create an App Service named `documenteditorjava`.
4141

42-
**Step 5:** After creating app service, navigate to `Advanced Tools` options under `Development Tools`.
42+
**Step 5:** After creating the App Service, navigate to the **Advanced Tools** option under **Development Tools**.
4343

4444
![Advanced tools ](../images/azure_java_advancedtools.png)
4545

46-
Then, click `Go` and select the `CMD` options under `Debug console`.
46+
Then, click **Go** and select the **CMD** option under **Debug console**.
4747

4848
![Debug console ](../images/azure_java_debugconsole.png)
4949

50-
**Step 6:** Once the file manager is opened, please navigate to
50+
**Step 6:** Once the file manager is opened, navigate to
5151

5252
`site -> wwwroot -> webapps`
5353

54-
**Step 7:** Now, upload the generated war file `tomcat-0.0.1-SNAPSHOT.war`. Uploaded war file gets extracted automatically, it will uploaded like below:
54+
**Step 7:** Now, upload the generated WAR file `tomcat-0.0.1-SNAPSHOT.war`. The uploaded WAR file is extracted automatically, as shown below:
5555

5656
![Uploaded war](../images/java_azure_uploaded.png)
5757

5858
**Step 8:** Browse to the app.
5959

60-
Browse to the deployed app at `http://<app_name>.azurewebsites.net`, i.e. `http://documenteditorjava.azurewebsites.net`. Browse this link and it navigate to the Document Editor Web API control `http://documenteditorjava.azurewebsites.net/tomcat-0.0.1-SNAPSHOT`. It returns the default get method response.
60+
Browse to the deployed app at `http://<app_name>.azurewebsites.net` (for example, `http://documenteditorjava.azurewebsites.net`). Navigating to this link opens the Document Editor Web API at `http://documenteditorjava.azurewebsites.net/tomcat-0.0.1-SNAPSHOT`, which returns the default GET-method response.
6161

62-
Append the app service running the URL `http://documenteditorjava.azurewebsites.net/tomcat-0.0.1-SNAPSHOT` to the service URL in the client-side Document Editor control. For more information about the Document Editor control, refer to this [`getting started page`](../getting-started).
62+
Append the running App Service URL `http://documenteditorjava.azurewebsites.net/tomcat-0.0.1-SNAPSHOT` to the `serviceUrl` in the client-side Document Editor control. For more information about the Document Editor control, refer to the [`Getting Started` page](../getting-started).

Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-amazon-kubernetes-service.md

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,25 @@ domainurl: ##DomainURL##
1111

1212
## Prerequisites
1313

14-
* `AWS Account` :Have Amazon account
14+
* `AWS Account`: Have an Amazon Web Services (AWS) account.
1515
* `AWS CLI`: Install the AWS Command Line Interface (CLI) on your local machine.
16-
* `Kubectl` : Install the Kubernetes command-line tool kubectl on your local machine.
16+
* `Kubectl`: Install the Kubernetes command-line tool `kubectl` on your local machine.
1717
* `Docker`: Install Docker on your local machine.
1818
* `Word Processor Docker Image`: Have a Docker image of the Word Processor server ready to deploy.
1919

20-
To deploy the Word Processor server docker image, need to follow the below process
20+
To deploy the Word Processor server Docker image, you need to follow the process below:
2121

22-
* Push Docker Image to Registry (Amazon Elastic Registry)
22+
* Push Docker Image to Registry (Amazon Elastic Container Registry)
2323
* Deploy Docker Image on Amazon Kubernetes Service
2424

25-
Lets us discuss briefly about the each process
25+
Let us briefly discuss each process.
2626

27-
## Push the Docker image to the Amazon Elastic Registry
27+
## Push the Docker image to the Amazon Elastic Container Registry
2828

29-
**Step 1:** Dockerize the Word Processor Server Application with the image name [syncfusion/word-processor-server](https://hub.docker.com/r/syncfusion/word-processor-server)
29+
**Step 1:** Dockerize the Word Processor Server application using the [syncfusion/word-processor-server](https://hub.docker.com/r/syncfusion/word-processor-server) image.
3030

3131
```
32-
docker build -t <your-image-name>
32+
docker build -t <your-image-name> .
3333
```
3434

3535
**Step 2:** Create a private repository name ‘documenteditor’ in Amazon Elastic Container Registry (ECR) using the AWS CLI or AWS Console to push the docker image
@@ -43,13 +43,13 @@ aws ecr create-repository --repository-name <repository-name>
4343
```
4444
docker tag <your-image-name>:latest <your_ECR_registry_URI>/<your_repository_name>:latest
4545
```
46-
Refer to the following example to tag the image
46+
Refer to the following example to tag the image:
4747

4848
```
4949
docker tag syncfusion/word-processor-server:latest 123456.dkr.ecr.us-east-1.amazonaws.com/documenteditor:latest
5050
```
5151

52-
> Get the ECR registry URI from AWS console or using the below AWS CLI command
52+
N> Get the ECR registry URI from the AWS console or with the following AWS CLI command:
5353

5454
```
5555
aws ecr describe-repositories --repository-names <repository-name> --query 'repositories[*].repositoryUri' --output text
@@ -61,28 +61,28 @@ aws ecr describe-repositories --repository-names <repository-name> --query 'repo
6161
aws ecr get-login-password --region <region> | docker login --username AWS --password-stdin <your_ECR_registry_URI>
6262
```
6363

64-
Replace <region> with your AWS region and <your_ECR_registry_URI> with your ECR registry URI.
64+
Replace `<region>` with your AWS region and `<your_ECR_registry_URI>` with your ECR registry URI.
6565

6666
**Step 5:** Push the tagged image to ECR
6767

6868
```
69-
docker push <your_ECR_registry_URI>/<your_image_name>:latest
69+
docker push <your_ECR_registry_URI>/<your_repository_name>:latest
7070
```
7171

7272
## Deploy Docker Image on Amazon Kubernetes Service
7373

74-
Follow the below steps to deploy the Docker image from the Amazon Elastic Registry( ECR) to Amazon Kubernetes Services (EKS)
74+
Follow the steps below to deploy the Docker image from the Amazon Elastic Container Registry (ECR) to Amazon Kubernetes Service (EKS).
7575

76-
**Step 1:** DCreate Amazon EKS cluster using the AWS Console
76+
**Step 1:** Create an Amazon EKS cluster using the AWS console.
7777

7878
**Step 2:** Authenticate with AWS ECR
79-
Need to get the authenticate with the AWS ECR to pull the image from the registry
79+
You need to authenticate with AWS ECR to pull the image from the registry.
8080

8181
```
8282
aws ecr get-login-password --region <your-region> | docker login --username AWS --password-stdin <your-aws-account-id>.dkr.ecr.<your-region>.amazonaws.com
8383
```
8484

85-
**Step 3:** : Configure Kubernetes to Communicate with the Cluster
85+
**Step 3:** Configure Kubernetes to communicate with the cluster
8686

8787
```
8888
aws eks --region <region> update-kubeconfig --name <cluster-name>
@@ -104,47 +104,47 @@ In this command:
104104
* <your-region> should be replaced with your AWS region.
105105

106106

107-
**Step 5:** To create Kubernetes deployment write Kubernetes manifest
107+
**Step 5:** To create a Kubernetes deployment, write a Kubernetes manifest.
108108

109-
**i.** Create a Kubernetes Deployment manifest (deployment.yaml) for your application. Specify the Docker image location.
109+
**i.** Create a Kubernetes Deployment manifest (`deployment.yaml`) for your application. Specify the Docker image location.
110110

111-
```
111+
```yaml
112112
apiVersion: apps/v1
113113
kind: Deployment
114114
metadata:
115-
name: ```your-deployment```
115+
name: your-deployment
116116
spec:
117117
replicas: 3
118118
selector:
119119
matchLabels:
120-
app: ```your-app```
120+
app: your-app
121121
template:
122122
metadata:
123123
labels:
124-
app: ```your-app```
124+
app: your-app
125125
spec:
126126
containers:
127127
- name: your-container
128-
image: ```<account-id>.dkr.ecr.<region>.amazonaws.com/your-repository-name:tag```
128+
image: <account-id>.dkr.ecr.<region>.amazonaws.com/your-repository-name:tag
129129
ports:
130130
- containerPort: 80
131131
```
132-
**ii.** Apply the Deployment manifest to create the deployment in your EKS cluster
132+
**ii.** Apply the Deployment manifest to create the deployment in your EKS cluster.
133133
134134
```
135135
kubectl apply -f deployment.yaml
136136
```
137137

138-
**iii.** Use port forwarding to access the Word Processor Server application locally and verify its functionality
138+
**iii.** Use port-forwarding to access the Word Processor Server application locally and verify its functionality.
139139

140140
```
141-
kubectl port-forward pod-name local-port:container-port
141+
kubectl port-forward <pod-name> <local-port>:<container-port>
142142
```
143143

144-
> Get the pod names in AWS Console or using the below AWS CLI command
144+
N> Get the pod names from the AWS console or with the following AWS CLI command:
145145

146146
```
147147
kubectl get pods
148148
```
149149

150-
Finally you can get the sample in the localhost http://```<your-ip>```/api/documenteditor/
150+
Finally, you can access the sample at `http://localhost:<local-port>/api/documenteditor/`.

Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-app-service.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ domainurl: ##DomainURL##
1111

1212
## Prerequisites
1313

14-
* Have [`Azure account`](https://azure.microsoft.com/en-gb/) and [`Azure CLI`](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest) setup in your environment.
14+
* Ensure you have an [`Azure account`](https://azure.microsoft.com/en-gb/) and the [`Azure CLI`](https://docs.microsoft.com/en-us/cli/azure/?view=azure-cli-latest) installed in your environment.
1515

16-
* Run the following command to open the Azure login page. Sign into your [`Microsoft Azure account`](https://azure.microsoft.com/en-gb/).
16+
* Run the following command to open the Azure login page. Sign in to your [`Microsoft Azure account`](https://azure.microsoft.com/en-gb/).
1717

1818
```
1919
az login
@@ -23,7 +23,7 @@ az login
2323

2424
Create a resource group using the [`az group create`](https://docs.microsoft.com/en-us/cli/azure/group#az-group-create) command.
2525

26-
The following example creates a resource group named documenteditorresourcegroup in the eastus location.
26+
The following example creates a resource group named `documenteditorresourcegroup` in the **East US** location.
2727

2828
```
2929
az group create --name documenteditorresourcegroup --location "East US"
@@ -41,16 +41,16 @@ az appservice plan create --name documenteditorappservice --resource-group docum
4141

4242
**Step 3:** Create a Docker Compose app.
4343

44-
Create a multi-container [`web app`](https://docs.microsoft.com/en-us/azure/app-service/containers/app-service-linux-intro) in the documenteditorappservice App Service plan with the [`az webapp create`](https://docs.microsoft.com/en-us/cli/azure/webapp?view=azure-cli-latest#az-webapp-create) command. The following command creates the web app using the provided Docker compose file. Please look into the section for getting started with Docker compose to create the Docker compose file for the Document Editor server and use the created Docker compose file here.
44+
Create a multi-container [`web app`](https://docs.microsoft.com/en-us/azure/app-service/containers/app-service-linux-intro) in the `documenteditorappservice` App Service plan with the [`az webapp create`](https://docs.microsoft.com/en-us/cli/azure/webapp?view=azure-cli-latest#az-webapp-create) command. The following command creates the web app using the provided Docker Compose file. **Step 4:** Create the `documenteditor-server-compose.yml` file before running this command. **Step 5:** Use the created Docker Compose file in this command.
4545

4646
```
4747
az webapp create --resource-group documenteditorresourcegroup --plan documenteditorappservice --name documenteditor-server --multicontainer-config-type compose --multicontainer-config-file documenteditor-server-compose.yml
4848
```
4949

50-
**Step 4:** Browse to the app.
50+
**Step 6:** Browse to the app.
5151

52-
Browse to the deployed app at `http://<app_name>.azurewebsites.net`, i.e. `http://documenteditor-server.azurewebsites.net`. Browse this link and navigate to the Document Editor Web API control `http://documenteditor-server.azurewebsites.net/api/documenteditor`. It returns the default get method response.
52+
Browse to the deployed app at `http://<app_name>.azurewebsites.net` (for example, `http://documenteditor-server.azurewebsites.net`). Navigating to this link opens the Document Editor Web API at `http://documenteditor-server.azurewebsites.net/api/documenteditor/`, which returns the default GET-method response.
5353

54-
Append the app service running the URL `http://documenteditor-server.azurewebsites.net/api/documenteditor/` to the service URL in the client-side Document Editor control. For more information about the Document Editor control, refer to this [`getting started page`](../getting-started).
54+
Append the running App Service URL `http://documenteditor-server.azurewebsites.net/api/documenteditor/` to the `serviceUrl` in the client-side Document Editor control. For more information about the Document Editor control, refer to the [`Getting Started` page](../getting-started).
5555

56-
For more information about the app container service, please look deeper into the [`Microsoft Azure Container Service`](https://docs.microsoft.com/en-us/azure/app-service/containers/quickstart-multi-container) for a production-ready setup.
56+
For more information about the app container service, see the [`Microsoft Azure Container Service`](https://docs.microsoft.com/en-us/azure/app-service/containers/quickstart-multi-container) for a production-ready setup.

0 commit comments

Comments
 (0)