How to Deploy Syncfusion Spreadsheet Docker Image with ASP.NET Core 8.0
#ej2#aspnetcore#dockerdeployment#dockerimage
Lucy Muturi

Lucy Muturi @lucy_muturi

About: As a content editor at Syncfusion, I stay updated on tech trends, especially in business intelligence and AI.” Keep up the great work

Joined:
Jul 22, 2024

How to Deploy Syncfusion Spreadsheet Docker Image with ASP.NET Core 8.0

Publish Date: Aug 22
0 0

TL;DR: Learn how to deploy the Syncfusion® EJ2 Spreadsheet image using Docker and ASP.NET Core 8.0. This guide simplifies backend setup and connects your client-side app to a scalable, Excel-like spreadsheet API.

The Syncfusion® EJ2 Spreadsheet is a powerful, Excel-like UI component that enables developers to build rich, interactive spreadsheet experiences in web applications. With features like data binding, formatting, Excel import/export, and more, it delivers seamless spreadsheet functionality across platforms.

Developers often struggle with backend setup when integrating Excel-like functionality into web apps. The Syncfusion® EJ2 Spreadsheet Docker image solves this by offering a ready-to-deploy backend powered by ASP.NET Core 8.0.

This guide walks you through deploying and integrating the Docker image with your client-side application.

Prerequisites

Before you begin, ensure the following tools are installed and properly set up on your system:

Once these tools are installed, you’re ready to proceed with the full deployment workflow.

Quick start: Deployment via Docker Hub

Step 1: Pull the Docker image

Open your terminal and pull the official Syncfusion® Spreadsheet server image:

docker pull syncfusion/spreadsheet-server
Enter fullscreen mode Exit fullscreen mode

Step 2: Create a Docker Compose file

Create a docker-compose.yml file in your project directory with the following content:

version: '3.4' 

services:
  spreadsheet-server:
    image: syncfusion/spreadsheet-server
    environment:

      # Provide your license key for activation
      SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY
    ports:
      - "6002:8080"
Enter fullscreen mode Exit fullscreen mode

Note: Syncfusion® Spreadsheet is a commercial product. You must provide a valid license key to run it in production. Replace YOUR_LICENSE_KEY with your actual key.

Step 3: Start the Docker Container

Navigate to the directory containing your docker-compose.yml and run:

docker-compose up
Enter fullscreen mode Exit fullscreen mode

Once running, the Spreadsheet server APIs will be available at:

Step 4: Connect the Client-Side Spreadsheet

In your client-side app ( JavaScript, React, Angular, Vue, ASP.NET Core, and ASP.NET MVC ), configure the Spreadsheet component to use the Docker-hosted API:

<SpreadsheetComponent 
  openUrl='http://localhost:6002/api/spreadsheet/open' 
  saveUrl='http://localhost:6002/api/spreadsheet/save'/>
Enter fullscreen mode Exit fullscreen mode

Configure culture preferences in Docker Compose

By default, the Spreadsheet Docker container uses the en_US culture. To change it, set the LC_ALL, LANGUAGE, and LANG environment variables in your docker-compose.yml file. These values configure the server to run with the specified locale.

Here’s an example that sets the culture to German (de_DE.UTF-8):

version: '3.4' 

services:
  spreadsheet-server:
    image: syncfusion/spreadsheet-server
    environment:

      # Provide your license key for activation
      SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY

      # Specify the culture to configure for the Spreadsheet server
      LC_ALL: de_DE.UTF-8
      LANGUAGE: de_DE.UTF-8
      LANG: de_DE.UTF-8
    ports:
      - "6002:8080"
Enter fullscreen mode Exit fullscreen mode

Customize & build Spreadsheet Docker image locally

Create your own Docker image if you want to add or customize functionalities.

Step 1: Set up your development environment

Make sure Docker Desktop and .NET 8.0 SDK are installed

Step 2: Clone the Docker service app

Clone or download the Docker service application from GitHub

Step 3: Build and run the Docker image

Open a terminal in the root folder of the sample and run the commands below.

docker build -t spreadsheet-image
docker run -d -p 6002:8080 --name spreadsheet-container spreadsheet-image
Enter fullscreen mode Exit fullscreen mode

Step 4: (Optional) Use Docker Compose

Instead of manually running the container, you can use Docker Compose:

  • Open a terminal in the root folder of the Docker sample.
  • Build the image: 
docker build -t spreadsheet-image
Enter fullscreen mode Exit fullscreen mode
  • Create a docker-compose.yml file: 
version: '3.4' 

services:
  spreadsheet-container:
    image: spreadsheet-image
    environment:

      # Provide your license key for activation
      SYNCFUSION_LICENSE_KEY: YOUR_LICENSE_KEY
    ports:
      - "6002:8080"
Enter fullscreen mode Exit fullscreen mode
  • Run the service: 
docker-compose up
Enter fullscreen mode Exit fullscreen mode

Step 5: Connect the client app

Ensure your client app uses the correct API endpoints:

openUrl: 'http://localhost:6002/api/spreadsheet/open',                                                           
saveUrl: 'http://localhost:6002/api/spreadsheet/save',
Enter fullscreen mode Exit fullscreen mode

Conclusion

Deploying the Syncfusion® EJ2 Spreadsheet backend using Docker and ASP.NET Core 8.0 provides a scalable and modular solution for enterprise-grade spreadsheet applications. By leveraging Docker Compose, developers can configure culture settings, manage environment variables (including license keys), and streamline deployment across environments. This setup ensures a smooth and consistent experience whether you’re using JavaScript, React, Angular, Vue, ASP.NET Core or ASP.NET MVC.

For more platform-specific guides, check out our Open and Save functionality tutorials below:

Customers with an active license can download the latest release of Essential Studio® from the license and downloads page. New users are invited to start a 30-day free trial to explore the latest features.

Need help? Reach out through our support forum, support portal, or feedback portal. We’re here to help you build modern, feature-rich applications with confidence and ease.

Related Blogs

This article was originally published at Syncfusion.com.

Comments 0 total

    Add comment