From 4f746e3330ae3905bd6b57d5fcff76ada2960200 Mon Sep 17 00:00:00 2001 From: Kalaivannan-Ganesan <93248069+Kalaivannan-Ganesan@users.noreply.github.com> Date: Thu, 13 Aug 2026 18:13:13 +0530 Subject: [PATCH 1/2] Resolved error reports for yhe Server deployment --- ...oy-documenteditor-java-web-api-in-azure.md | 26 +-- ...-container-in-amazon-kubernetes-service.md | 56 +++--- ...r-docker-container-in-azure-app-service.md | 16 +- ...r-container-in-azure-kubernetes-service.md | 99 ++++++----- ...in-azure-app-service-from-visual-studio.md | 20 +-- ...-processor-server-docker-image-overview.md | 164 +++++++++--------- 6 files changed, 190 insertions(+), 191 deletions(-) diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-documenteditor-java-web-api-in-azure.md b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-documenteditor-java-web-api-in-azure.md index 0c4e520eb8..ed79f1629c 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-documenteditor-java-web-api-in-azure.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-documenteditor-java-web-api-in-azure.md @@ -11,52 +11,52 @@ domainurl: ##DomainURL## ## Prerequisites -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. +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. -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. +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. -**Step 1:** Clean the package using following command. +**Step 1:** Clean and package the application using the following command. ```console mvn clean package ``` -**Step 2:** Run the application locally using following command. +**Step 2:** Run the application locally to verify the build using the following command. ```console mvn spring-boot:run ``` -**Step 3:** Build the package using following command. +**Step 3:** Build the final package using the following command. ```console mvn package ``` -Above package generation command creates the `**tomcat-0.0.1-SNAPSHOT.war**` in the below location in the sample folder. +The above package-generation command creates the `**tomcat-0.0.1-SNAPSHOT.war**` in the following location in the sample folder. `target/tomcat-0.0.1-SNAPSHOT.war` -**Step 4:** Create a Azure app service with Java & Tomcat. For example, create the app services name as `documenteditorjava`. +**Step 4:** Create an Azure App Service with Java & Tomcat. For example, create an App Service named `documenteditorjava`. -**Step 5:** After creating app service, navigate to `Advanced Tools` options under `Development Tools`. +**Step 5:** After creating the App Service, navigate to the **Advanced Tools** option under **Development Tools**. ![Advanced tools ](../images/azure_java_advancedtools.png) -Then, click `Go` and select the `CMD` options under `Debug console`. +Then, click **Go** and select the **CMD** option under **Debug console**. ![Debug console ](../images/azure_java_debugconsole.png) -**Step 6:** Once the file manager is opened, please navigate to +**Step 6:** Once the file manager is opened, navigate to `site -> wwwroot -> webapps` -**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: +**Step 7:** Now, upload the generated WAR file `tomcat-0.0.1-SNAPSHOT.war`. The uploaded WAR file is extracted automatically, as shown below: ![Uploaded war](../images/java_azure_uploaded.png) **Step 8:** Browse to the app. -Browse to the deployed app at `http://.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. +Browse to the deployed app at `http://.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. -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). \ No newline at end of file +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). \ No newline at end of file diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-amazon-kubernetes-service.md b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-amazon-kubernetes-service.md index 2e1c2cb6ce..077b6ab8a7 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-amazon-kubernetes-service.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-amazon-kubernetes-service.md @@ -11,25 +11,25 @@ domainurl: ##DomainURL## ## Prerequisites -* `AWS Account` :Have Amazon account +* `AWS Account`: Have an Amazon Web Services (AWS) account. * `AWS CLI`: Install the AWS Command Line Interface (CLI) on your local machine. -* `Kubectl` : Install the Kubernetes command-line tool kubectl on your local machine. +* `Kubectl`: Install the Kubernetes command-line tool `kubectl` on your local machine. * `Docker`: Install Docker on your local machine. * `Word Processor Docker Image`: Have a Docker image of the Word Processor server ready to deploy. -To deploy the Word Processor server docker image, need to follow the below process +To deploy the Word Processor server Docker image, you need to follow the process below: -* Push Docker Image to Registry (Amazon Elastic Registry) +* Push Docker Image to Registry (Amazon Elastic Container Registry) * Deploy Docker Image on Amazon Kubernetes Service -Lets us discuss briefly about the each process +Let us briefly discuss each process. -## Push the Docker image to the Amazon Elastic Registry +## Push the Docker image to the Amazon Elastic Container Registry -**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) +**Step 1:** Dockerize the Word Processor Server application using the [syncfusion/word-processor-server](https://hub.docker.com/r/syncfusion/word-processor-server) image. ``` -docker build -t +docker build -t . ``` **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 ``` docker tag :latest /:latest ``` -Refer to the following example to tag the image +Refer to the following example to tag the image: ``` docker tag syncfusion/word-processor-server:latest 123456.dkr.ecr.us-east-1.amazonaws.com/documenteditor:latest ``` -> Get the ECR registry URI from AWS console or using the below AWS CLI command +N> Get the ECR registry URI from the AWS console or with the following AWS CLI command: ``` aws ecr describe-repositories --repository-names --query 'repositories[*].repositoryUri' --output text @@ -61,28 +61,28 @@ aws ecr describe-repositories --repository-names --query 'repo aws ecr get-login-password --region | docker login --username AWS --password-stdin ``` -Replace with your AWS region and with your ECR registry URI. +Replace `` with your AWS region and `` with your ECR registry URI. **Step 5:** Push the tagged image to ECR ``` -docker push /:latest +docker push /:latest ``` ## Deploy Docker Image on Amazon Kubernetes Service -Follow the below steps to deploy the Docker image from the Amazon Elastic Registry( ECR) to Amazon Kubernetes Services (EKS) +Follow the steps below to deploy the Docker image from the Amazon Elastic Container Registry (ECR) to Amazon Kubernetes Service (EKS). -**Step 1:** DCreate Amazon EKS cluster using the AWS Console +**Step 1:** Create an Amazon EKS cluster using the AWS console. **Step 2:** Authenticate with AWS ECR -Need to get the authenticate with the AWS ECR to pull the image from the registry +You need to authenticate with AWS ECR to pull the image from the registry. ``` aws ecr get-login-password --region | docker login --username AWS --password-stdin .dkr.ecr..amazonaws.com ``` -**Step 3:** : Configure Kubernetes to Communicate with the Cluster +**Step 3:** Configure Kubernetes to communicate with the cluster ``` aws eks --region update-kubeconfig --name @@ -104,47 +104,47 @@ In this command: * should be replaced with your AWS region. -**Step 5:** To create Kubernetes deployment write Kubernetes manifest +**Step 5:** To create a Kubernetes deployment, write a Kubernetes manifest. -**i.** Create a Kubernetes Deployment manifest (deployment.yaml) for your application. Specify the Docker image location. +**i.** Create a Kubernetes Deployment manifest (`deployment.yaml`) for your application. Specify the Docker image location. -``` +```yaml apiVersion: apps/v1 kind: Deployment metadata: - name: ```your-deployment``` + name: your-deployment spec: replicas: 3 selector: matchLabels: - app: ```your-app``` + app: your-app template: metadata: labels: - app: ```your-app``` + app: your-app spec: containers: - name: your-container - image: ```.dkr.ecr..amazonaws.com/your-repository-name:tag``` + image: .dkr.ecr..amazonaws.com/your-repository-name:tag ports: - containerPort: 80 ``` -**ii.** Apply the Deployment manifest to create the deployment in your EKS cluster +**ii.** Apply the Deployment manifest to create the deployment in your EKS cluster. ``` kubectl apply -f deployment.yaml ``` -**iii.** Use port forwarding to access the Word Processor Server application locally and verify its functionality +**iii.** Use port-forwarding to access the Word Processor Server application locally and verify its functionality. ``` -kubectl port-forward pod-name local-port:container-port +kubectl port-forward : ``` -> Get the pod names in AWS Console or using the below AWS CLI command +N> Get the pod names from the AWS console or with the following AWS CLI command: ``` kubectl get pods ``` -Finally you can get the sample in the localhost http://``````/api/documenteditor/ \ No newline at end of file +Finally, you can access the sample at `http://localhost:/api/documenteditor/`. \ No newline at end of file diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-app-service.md b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-app-service.md index 3bc72c11fd..9d69ea0326 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-app-service.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-app-service.md @@ -11,9 +11,9 @@ domainurl: ##DomainURL## ## Prerequisites -* 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. +* 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. -* Run the following command to open the Azure login page. Sign into your [`Microsoft Azure account`](https://azure.microsoft.com/en-gb/). +* Run the following command to open the Azure login page. Sign in to your [`Microsoft Azure account`](https://azure.microsoft.com/en-gb/). ``` az login @@ -23,7 +23,7 @@ az login Create a resource group using the [`az group create`](https://docs.microsoft.com/en-us/cli/azure/group#az-group-create) command. -The following example creates a resource group named documenteditorresourcegroup in the eastus location. +The following example creates a resource group named `documenteditorresourcegroup` in the **East US** location. ``` az group create --name documenteditorresourcegroup --location "East US" @@ -41,16 +41,16 @@ az appservice plan create --name documenteditorappservice --resource-group docum **Step 3:** Create a Docker Compose app. -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. +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. ``` az webapp create --resource-group documenteditorresourcegroup --plan documenteditorappservice --name documenteditor-server --multicontainer-config-type compose --multicontainer-config-file documenteditor-server-compose.yml ``` -**Step 4:** Browse to the app. +**Step 6:** Browse to the app. -Browse to the deployed app at `http://.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. +Browse to the deployed app at `http://.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. -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). +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). -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. +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. diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-kubernetes-service.md b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-kubernetes-service.md index 5e629e23d3..a87492e16a 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-kubernetes-service.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-deploy-word-processor-server-docker-container-in-azure-kubernetes-service.md @@ -11,9 +11,9 @@ domainurl: ##DomainURL## ## Prerequisites -* 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. +* 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. -* Run the following command to open the Azure login page. Sign into your [`Microsoft Azure account`](https://azure.microsoft.com/en-gb/). +* Run the following command to open the Azure login page. Sign in to your [`Microsoft Azure account`](https://azure.microsoft.com/en-gb/). ``` az login @@ -23,15 +23,15 @@ az login Create a resource group using the [`az group create`](https://docs.microsoft.com/en-us/cli/azure/group#az-group-create) command. -The following example creates a resource group named documenteditorresourcegroup in the eastus location. +The following example creates a resource group named `documenteditorresourcegroup` in the **East US** location. ``` az group create --name documenteditorresourcegroup --location "East US" ``` -**Step 2:** Create AKS cluster. +**Step 2:** Create an AKS cluster. -Use the [`az aks create`](https://docs.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-create) command to create an AKS cluster. The following example creates a cluster named documenteditorcluster with one node. +Use the [`az aks create`](https://docs.microsoft.com/en-us/cli/azure/aks?view=azure-cli-latest#az-aks-create) command to create an AKS cluster. The following example creates a cluster named `documenteditorcluster` with one node. ``` az aks create --resource-group documenteditorresourcegroup --name documenteditorcluster --node-count 1 @@ -39,7 +39,7 @@ az aks create --resource-group documenteditorresourcegroup --name documenteditor **Step 3:** Connect to the cluster. -Install the [`kubectl`](https://kubernetes.io/docs/reference/kubectl/kubectl/) into the workspace using the following command. +Install [`kubectl`](https://kubernetes.io/docs/reference/kubectl/kubectl/) in your workspace using the following command. ``` az aks install-cli @@ -51,66 +51,65 @@ To configure kubectl to connect to your Kubernetes cluster, use the [`az aks get az aks get-credentials --resource-group documenteditorresourcegroup --name documenteditorcluster ``` -**Step 4:** Create Kubernetes Services and Deployments +**Step 4:** Create the Kubernetes Service and Deployment -[`Kubernetes Services`](https://kubernetes.io/docs/concepts/services-networking/service/) and [`Deployments`](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) can be configured in a file. To run the Document Editor server, you must define a Service and a Deployment documenteditorserver. To do this, create the documenteditor-server.yml file in the current directory using the following code. +[`Kubernetes Services`](https://kubernetes.io/docs/concepts/services-networking/service/) and [`Deployments`](https://kubernetes.io/docs/concepts/workloads/controllers/deployment/) can be configured in a file. To run the Document Editor server, you must define a Service and a Deployment named `documenteditorserver`. To do this, create the `documenteditor-server.yml` file in the current directory using the following code. ```yaml - apiVersion: apps/v1 - kind: Deployment - metadata: - labels: +apiVersion: apps/v1 +kind: Deployment +metadata: + labels: + app: documenteditorserver + name: documenteditorserver +spec: + replicas: 1 + selector: + matchLabels: app: documenteditorserver - name: documenteditorserver - spec: - replicas: 1 - selector: - matchLabels: + template: + metadata: + labels: app: documenteditorserver - strategy: {} - template: - metadata: - labels: - app: documenteditorserver - spec: - containers: - - image: syncfusion/word-processor-server:latest - name: documenteditorserver - ports: - - containerPort: 80 - env: - - name: SYNCFUSION_LICENSE_KEY - value: "YOUR_LICENSE_KEY" - --- - apiVersion: v1 - kind: Service - metadata: - labels: - app: documenteditorserver - name: documenteditorserver - spec: - ports: - - port: 80 - targetPort: 80 - selector: - app: documenteditorserver - type: LoadBalancer + spec: + containers: + - image: syncfusion/word-processor-server:latest + name: documenteditorserver + ports: + - containerPort: 80 + env: + - name: SYNCFUSION_LICENSE_KEY + value: "YOUR_LICENSE_KEY" +--- +apiVersion: v1 +kind: Service +metadata: + labels: + app: documenteditorserver + name: documenteditorserver +spec: + ports: + - port: 80 + targetPort: 80 + selector: + app: documenteditorserver + type: LoadBalancer ``` -**Step 5:** To create all Services and Deployments needed to run the Document Editor server, execute the following. +**Step 5:** To create all Services and Deployments needed to run the Document Editor server, run the following command. ```console kubectl create -f ./documenteditor-server.yml ``` -Run the following command to get the Kubernetes cluster deployed service details and copy the external IP address of the Document Editor service. +Run the following command to get the deployed Kubernetes Service details and copy the external IP address of the Document Editor Service. ```console kubectl get all ``` -Browse the copied external IP address and navigate to the Document Editor Web API control `http:///api/documenteditor`. It returns the default get method response. +Browse to the copied external IP address and navigate to the Document Editor Web API at `http:///api/documenteditor/`. It returns the default GET-method response. -**Step 6:** Append the Kubernetes service running the URL `http:///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). +**Step 6:** Append the running Kubernetes Service URL `http:///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). -For more details about the Azure Kubernetes service, please look deeper into [`Microsoft Azure Kubernetes Service`](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough) for a production-ready setup. +For more details about the Azure Kubernetes Service, see [`Microsoft Azure Kubernetes Service`](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough) for a production-ready setup. diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-publish-documenteditor-web-api-application-in-azure-app-service-from-visual-studio.md b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-publish-documenteditor-web-api-application-in-azure-app-service-from-visual-studio.md index cfc36f27c1..114dd75ec1 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-publish-documenteditor-web-api-application-in-azure-app-service-from-visual-studio.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/how-to-publish-documenteditor-web-api-application-in-azure-app-service-from-visual-studio.md @@ -4,7 +4,7 @@ title: How to publish documenteditor web api application in azure app service fr description: Learn here all about How to publish documenteditor web api application in azure app service from visual studio in Syncfusion ##javascript-es5## Document editor control of Syncfusion Essential JS 2 and more. platform: document-processing control: How to publish documenteditor web api application in azure app service from visual studio -publishingplatform: ##javascript-es5## +publishingplatform: JavaScript (ES5) documentation: ug domainurl: ##DomainURL## --- @@ -13,32 +13,32 @@ domainurl: ##DomainURL## ## Prerequisites -* Visual Studio 2017 or 2019. +* Visual Studio 2017, 2019, or 2022. * An [`Azure subscription`](https://azure.microsoft.com/en-gb/). * The Document Editor Web API controller application from [`here`](https://github.com/SyncfusionExamples/EJ2-DocumentEditor-WebServices). -Make sure you build the project using the Build > Build Solution menu command before following the deployment steps. +Make sure you build the project using the **Build > Build Solution** menu command before following the deployment steps. ## Publish to Azure App Service -**Step 1:** In Solution Explorer, right-click the project and click Publish (or use the Build > Publish menu item). +**Step 1:** In Solution Explorer, right-click the project and click **Publish** (or use the **Build > Publish** menu item). ![azure publish ](../images/azure_publish.png) -**Step 2:** If you have previously configured any publishing profiles, the Publish pane appears, in which case select Create new profile. +**Step 2:** If you have previously configured any publishing profiles, the **Publish** pane appears; in that case, select **Create a new profile**. **Step 3:** In the Pick a publish target dialog box, select App Service. ![azure target](../images/azure_target.png) -**Step 4:** Select Publish. The Create App Service dialog box appears. Sign in with your Azure account, if necessary, and then the default app service settings populate the fields. +**Step 4:** Select **Publish**. The **Create App Service** dialog box appears. Sign in with your Azure account, if necessary, and then the default App Service settings populate the fields. ![azure documenteditor](../images/azure_documenteditor.png) -**Step 5:** Select Create. Visual Studio deploys the app to your Azure App Service, and the web app loads in your browser with the app name at `http://.azurewebsites.net` (i.e. `http://ej2-documenteditor-server20200514102909.azurewebsites.net`). +**Step 5:** Select **Create**. Visual Studio deploys the app to your Azure App Service, and the web app loads in your browser at `http://.azurewebsites.net` (for example, `http://ej2-documenteditor-server20200514102909.azurewebsites.net`). -**Step 6:** Navigate to Document Editor Web API control `http://ej2-documenteditor-server20200514102909.azurewebsites.net/api/documenteditor`. It returns the default get method response. +**Step 6:** Navigate to the Document Editor Web API at `http://.azurewebsites.net/api/documenteditor/`. It returns the default GET-method response. -Append the app service running the URL `http://ej2-documenteditor-server20200514102909.azurewebsites.net/api/documenteditor` to the service URL in the client-side Document Editor control. For more information about how to get started with the Document Editor control, refer to this [`getting started page`](../getting-started). +Append the running App Service URL `http://.azurewebsites.net/api/documenteditor/` to the `serviceUrl` in the client-side Document Editor control. For more information about how to get started with the Document Editor control, refer to the [`Getting Started` page](../getting-started). -For more information about the app container service, please look deeper into the [`Microsoft Azure App Service`](https://docs.microsoft.com/en-us/visualstudio/deployment/) for a production-ready setup. +For more information about a production-ready setup, see the [`Microsoft Azure App Service`](https://docs.microsoft.com/en-us/visualstudio/deployment/) documentation. diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/word-processor-server-docker-image-overview.md b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/word-processor-server-docker-image-overview.md index a215e0ee94..72a20cc3f6 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/word-processor-server-docker-image-overview.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/server-deployment/word-processor-server-docker-image-overview.md @@ -9,11 +9,11 @@ domainurl: ##DomainURL## --- # Word processor server docker image overview in JavaScript (ES5) Document editor control -The [JavaScript DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/javascript-docx-editor) (Document Editor) (also known as Document Editor)** is a component with editing capabilities like Microsoft Word. It is used to create, edit, view, and print Word documents. It provides all the common word processing abilities, including editing text; formatting contents; resizing images and tables; finding and replacing text; importing, exporting, and printing Word documents; and using bookmarks and tables of contents. +The [JavaScript DOCX Editor](https://www.syncfusion.com/docx-editor-sdk/javascript-docx-editor) (Document Editor) (also known as Document Editor) is a component with editing capabilities like Microsoft Word. It is used to create, edit, view, and print Word documents. It provides all the common word processing abilities, including editing text; formatting contents; resizing images and tables; finding and replacing text; importing, exporting, and printing Word documents; and using bookmarks and tables of contents. -This Docker image is the predefined Docker container of Syncfusion’s Word Processor backend. You can deploy it quickly to your infrastructure. +This Docker image is the preconfigured Docker container of Syncfusion's Word Processor backend. You can deploy it quickly to your infrastructure. -Word Processor is a commercial product, and it requires a valid license to use it in a production environment [`(request license or trial key).`](https://help.syncfusion.com/common/essential-studio/licensing/licensing-faq/where-can-i-get-a-license-key) +Word Processor is a commercial product, and it requires a valid license for use in a production environment [`(request a license or trial key).`](https://help.syncfusion.com/common/essential-studio/licensing/licensing-faq/where-can-i-get-a-license-key) The Word Processor is supported in the JavaScript, Angular, React, Vue, ASP.NET Core, ASP.NET MVC, and Blazor platforms. @@ -21,7 +21,7 @@ The Word Processor is supported in the JavaScript, Angular, React, Vue, ASP.NET Have [`Docker`](https://www.docker.com/products/container-runtime#/download) installed in your environment: * On Windows, install [`Docker for Windows`](https://hub.docker.com/editions/community/docker-ce-desktop-windows). -* On macOS, install [`Docker for Mac`](https://hub.docker.com/editions/community/docker-ce-desktop-windows). +* On macOS, install [`Docker for Mac`](https://hub.docker.com/editions/community/docker-ce-desktop-mac). ## How to deploy Word Processor Docker image @@ -31,30 +31,30 @@ Have [`Docker`](https://www.docker.com/products/container-runtime#/download) ins docker pull syncfusion/word-processor-server ``` -**Step 2:** Create the docker-compose.yml file with the following code in your file system. +**Step 2:** Create the `docker-compose.yml` file with the following code in your working directory. ```yaml - version: '3.4' +version: '3.4' - services: +services: word-processor-server: - image: syncfusion/word-processor-server:latest - environment: - #Provide your license key for activation - SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY - ports: - - "6002:80" + image: syncfusion/word-processor-server:latest + environment: + # Provide your license key for activation + SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY + ports: + - "6002:80" ``` -**Step 3:** In a terminal tab, navigate to the directory where you’ve placed the docker-compose.yml file and execute the following. +**Step 3:** In a terminal tab, navigate to the directory where you've placed the `docker-compose.yml` file and run the following command. ```console docker-compose up ``` -Now the Word Processor server Docker instance runs in the localhost with the provided port number `http://localhost:6002`. Open this link in a browser and navigate to the Word Processor Web API control `http://localhost:6002/api/documenteditor`. It returns the default get method response. +Now the Word Processor Server Docker instance runs on localhost at `http://localhost:6002`. Open this link in a browser and navigate to the Word Processor Web API at `http://localhost:6002/api/documenteditor/`. It returns the default GET-method response. -**Step 4:** Append the Docker instance running the URL `(http://localhost:6002/api/documenteditor)` to the service URL in the client-side Word Processor control. For more information about how to get started with the Word Processor control, refer to this [`getting started page.`](../getting-started) +**Step 4:** Append the running Docker instance URL `http://localhost:6002/api/documenteditor/` to the `serviceUrl` in the client-side Word Processor control. For more information about how to get started with the Word Processor control, refer to the [`Getting Started` page](../getting-started). ``` @@ -62,17 +62,17 @@ Now the Word Processor server Docker instance runs in the localhost with the pro Essential JS 2 - - - - - - - - - + + + + + + + + + - + @@ -115,88 +115,88 @@ Now the Word Processor server Docker instance runs in the localhost with the pro ``` -## How to configure spell checker dictionaries path in Docker compose file +## How to configure spell checker dictionaries path in Docker Compose file -**Step 1:** In the Docker compose file, mount the local directory as a container volume using the following code. +**Step 1:** In the Docker Compose file, mount the local directory as a container volume using the following code. ```yaml - version: '3.4' - services: +version: '3.4' +services: word-processor-server: - image: syncfusion/word-processor-server:latest - environment: - #Provide your license key for activation - SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY - volumes: - - ./data:/app/data - ports: - - "6002:80" + image: syncfusion/word-processor-server:latest + environment: + # Provide your license key for activation + SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY + volumes: + - ./data:/app/data + ports: + - "6002:80" ``` -This YAML definition binds the data folder that is available in the Docker compose file directory. +This YAML definition mounts the `data` folder located in the same directory as the Docker Compose file. -**Step 2:** In the data folder, include the dictionary files (.dic, .aff) and JSON file. The JSON file should contain the language based dictionary file configuration in the following format. +**Step 2:** In the `data` folder, include the dictionary files (`.dic`, `.aff`) and a JSON file. The JSON file should contain the language-based dictionary file configuration in the following format. ```yaml - [ - { - "LanguadeID": 1036, - "DictionaryPath": "fr_FR.dic", - "AffixPath": "fr_FR.aff", - "PersonalDictPath": "customDict.dic" - }, - { - "LanguadeID": 1033, - "DictionaryPath": "en_US.dic", - "AffixPath": "en_US.aff", - "PersonalDictPath": "customDict.dic" - } - ] +[ + { + "LanguageID": 1036, + "DictionaryPath": "fr_FR.dic", + "AffixPath": "fr_FR.aff", + "PersonalDictPath": "customDict.dic" + }, + { + "LanguageID": 1033, + "DictionaryPath": "en_US.dic", + "AffixPath": "en_US.aff", + "PersonalDictPath": "customDict.dic" + } +] ``` ->Note: By default, the json file name should be "spellcheck.json". You can also use different file name by mounting the file name to 'SPELLCHECK_JSON_FILENAME' attribute in Docker compose file as below, +N> By default, the JSON file name should be `spellcheck.json`. You can also use a different file name by setting the `SPELLCHECK_JSON_FILENAME` attribute in the Docker Compose file as shown below: ```yaml - version: '3.4' +version: '3.4' - services: +services: word-processor-server: - image: syncfusion/word-processor-server:latest - environment: - #Provide your license key for activation - SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY - SPELLCHECK_DICTIONARY_PATH: data - SPELLCHECK_JSON_FILENAME: spellcheck1.json - volumes: - - ./data:/app/data - ports: - - "6002:80" + image: syncfusion/word-processor-server:latest + environment: + # Provide your license key for activation + SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY + SPELLCHECK_DICTIONARY_PATH: data + SPELLCHECK_JSON_FILENAME: spellcheck1.json + volumes: + - ./data:/app/data + ports: + - "6002:80" ``` -**Step 3:** For handling the personal dictionary, place an empty .dic file (e.g.,. customDict.dic file) in the data folder. +**Step 3:** To handle the personal dictionary, place an empty `.dic` file (e.g., `customDict.dic`) in the `data` folder. -**Step 4:** Provide the configured volume path to the environment variable like in the following in the Docker compose file. +**Step 4:** Provide the configured volume path to the environment variable as shown in the following Docker Compose file. ```yaml - version: '3.4' - services: +version: '3.4' +services: word-processor-server: - image: syncfusion/word-processo -server:latest - environment: - #Provide your license key for activation - SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY - SPELLCHECK_DICTIONARY_PATH: data - volumes: - - ./data:/app/data - ports: - - "6002:80" + image: syncfusion/word-processor-server:latest + environment: + # Provide your license key for activation + SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY + SPELLCHECK_DICTIONARY_PATH: data + volumes: + - ./data:/app/data + ports: + - "6002:80" ``` ## How to copy template Word documents to Docker image -You can copy the required template Word documents into docker container while deploying the docker image to server. You can open these Word documents present in the server by passing the document path (name with relative path) to LoadDocument() web API. +You can copy the required template Word documents into the Docker container when deploying the Docker image to the server. You can open these Word documents that are present on the server by passing the document path or name with a relative path to the `LoadDocument()` web API. ->Note: Place the word files in the data folder mentioned in the volumes section(i.e., C:/Docker/Data) of the docker-compose.yml file. All the files present in the folder path (C:/Docker/Data) mentioned in the volumes section of ‘docker-compose.yml’ file will be copied to the respective folder (/app/Data) of docker container. The Word documents copied to docker container can be processed using the 'LoadDocument' web API. +N> Place the Word files in the `data` folder mentioned in the `volumes` section (i.e., `C:/Docker/Data`) of the `docker-compose.yml` file. All the files present in the folder path (`C:/Docker/Data`) mentioned in the `volumes` section of the `docker-compose.yml` file will be copied to the corresponding folder (`/app/Data`) of the Docker container. The Word documents copied to the Docker container can be processed using the `LoadDocument` web API. The following code example shows how to use LoadDocument() API in Document Editor. From d105e0e6a0c00ea786a283b5a4afd950d7dc9c50 Mon Sep 17 00:00:00 2001 From: Kalaivannan-Ganesan <93248069+Kalaivannan-Ganesan@users.noreply.github.com> Date: Thu, 13 Aug 2026 18:19:51 +0530 Subject: [PATCH 2/2] Resolved the error logs --- .../javascript-es5/security-advisories.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Document-Processing/Word/Word-Processor/javascript-es5/security-advisories.md b/Document-Processing/Word/Word-Processor/javascript-es5/security-advisories.md index b3e16eb18c..f34ae29a59 100644 --- a/Document-Processing/Word/Word-Processor/javascript-es5/security-advisories.md +++ b/Document-Processing/Word/Word-Processor/javascript-es5/security-advisories.md @@ -10,17 +10,17 @@ domainurl: ##DomainURL## # Security Advisories in Syncfusion® EJ2 Controls -Syncfusion® 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® 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® packages undergo software composition analysis using the [SOOS](https://soos.io/) security tool. +Syncfusion® 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® 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® packages undergo software composition analysis using the [SOOS](https://soos.io/) security tool. -This document provides a description of the security updates available for Syncfusion® Essential® JS2 controls for volume release. +This document provides a description of the security updates available for Syncfusion® Essential® JS2 controls per volume release. ## Security Updates -The following security updates are available for JavaScript DocumentEditor control and are listed based on the release version. +The following security updates are available for JavaScript (ES5) Document Editor control and are listed based on the release version. ### 2024 Volume 2 (v26.2.4) - July 25, 2024 -This release resolves critical and moderate security vulnerabilities affecting the JavaScript Document Editor Docker Image. +This release resolves critical and moderate security vulnerabilities affecting the JavaScript (ES5) Document Editor Docker Image. **Threat:** @@ -42,4 +42,4 @@ For details on common security updates related to Syncfusion® 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`. +If users discover any security issues or need assistance resolving them with Syncfusion® 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`.