syncfusion/filemanager-provider repository overview

⁠Syncfusion FileManager Providers

The Syncfusion File Manager⁠ is a component for managing files and folders in a web application. It provides a Windows Explorer-like interface for file operations such as viewing, selecting, uploading, downloading, sorting, filtering, creating, renaming, copying, moving, and deleting files and folders.

The service supports read, details, download, upload, create, delete, copy, move, rename, search, and image preview operations.

The File Manager is supported on multiple platforms including JavaScript⁠, Angular⁠, React⁠, Vue⁠, ASP.NET Core⁠, ASP.NET MVC⁠, and Blazor⁠.

You can deploy the published image directly or create a custom Docker image based on the Syncfusion File Manager providers repository⁠. The unified image supports both Azure Blob Storage and Amazon S3. Select the provider with the FILEMANAGER_PROVIDER environment variable.

⁠Supported Providers

Both providers support these File Manager operations:

⁠Prerequisites

Before deploying the service, install Docker⁠.

⁠Windows

Install Docker Desktop for Windows⁠

⁠macOS

Install Docker Desktop for macOS⁠

⁠Linux

On Linux, install Docker Engine⁠ with the Docker Compose plugin.

Create either an Azure Blob Storage account or an Amazon S3 bucket before starting the service.

⁠Azure Blob Storage Requirements

Create and configure an Azure Storage Account and Blob Container for the File Manager service. You need:

• An active Microsoft Azure subscription.
• An Azure Storage Account.
• A Blob Container.
• The Storage Account Name.
• The Storage Account Access Key.
• The Blob Container Name.
• Permissions to perform file and folder operations.

See the Azure Storage account creation guide⁠.

⁠Amazon S3 Requirements

Create and configure an Amazon S3 bucket for the File Manager service. You need:

• An active AWS account.
• An Amazon S3 bucket.
• An AWS Access Key ID.
• An AWS Secret Access Key.
• The AWS Region where the bucket is hosted.
• Permissions to perform file and folder operations.

See the Amazon S3 bucket creation guide⁠.

⁠Configuration

⁠Azure Blob Storage

Set FILEMANAGER_PROVIDER to azure, then provide:

⁠Amazon S3

Set FILEMANAGER_PROVIDER to amazon-s3, then provide:

⁠Docker Deployment

Step 1: Pull the unified File Manager provider image from Docker Hub when using the published image:

docker pull syncfusion/filemanager-provider:latest

Step 2: Create or update docker-compose.yml with the provider and matching storage credentials.

Step 3: Start the service:

docker compose up

The service is available at:

http://localhost:5000

Verify that the service is running:

http://localhost:5000/api/Test

A successful response confirms that the service is ready to integrate with the File Manager component.

To stop it:

docker compose down

The docker-compose.yml file contains the service configuration. Set FILEMANAGER_PROVIDER explicitly to azure or amazon-s3 and provide only the matching storage settings. Use docker compose up without --build when using the published image directly.

For Amazon S3, the relevant Compose configuration is:

services:
  filemanager-provider:
    image: syncfusion/filemanager-provider:latest
    environment:
      FILEMANAGER_PROVIDER: amazon-s3
      AWS_ACCESS_KEY_ID: YOUR_AWS_ACCESS_KEY_ID
      AWS_SECRET_ACCESS_KEY: YOUR_AWS_SECRET_ACCESS_KEY
      AWS_BUCKET_NAME: YOUR_AWS_BUCKET_NAME
      AWS_BUCKET_REGION: us-east-1
    ports:
      - "5000:80"

For Azure Blob Storage, replace the provider and AWS settings with:

environment:
  FILEMANAGER_PROVIDER: azure
  AZURE_ACCOUNT_NAME: YOUR_AZURE_ACCOUNT_NAME
  AZURE_ACCOUNT_KEY: YOUR_AZURE_ACCOUNT_KEY
  AZURE_BLOB_NAME: YOUR_AZURE_BLOB_NAME
  AZURE_BLOB_PATH: https://<account>.blob.core.windows.net/<container>/
  AZURE_FILE_PATH: https://<account>.blob.core.windows.net/<container>/<folder>

⁠File Manager AjaxSettings

The unified service uses the same endpoint names for both storage providers:

const hostUrl = 'http://localhost:5000/';

const ajaxSettings = {
    url: hostUrl + 'api/FileManager/FileOperations',
    uploadUrl: hostUrl + 'api/FileManager/Upload',
    downloadUrl: hostUrl + 'api/FileManager/Download',
    getImageUrl: hostUrl + 'api/FileManager/GetImage'
};

The service also exposes a health endpoint at GET /api/Test.

⁠Supported Platforms

The File Manager component can be integrated with this service from multiple platforms:

For platform-specific configuration and integration details, refer to the corresponding getting started documentation.

⁠Support

Product support is available through the following mediums:

• Contact Syncfusion support⁠ for expert help.
• Ask and connect with peers in the Syncfusion community forum⁠.
• Create a GitHub issue⁠.
• Ask questions on Stack Overflow⁠ with the syncfusion and ej2 tags.

⁠License

See the Syncfusion license terms⁠.

⁠Changelog

See the File Manager changelog⁠.

Copyright 2026 Syncfusion, Inc. All Rights Reserved. The Syncfusion Essential Studio license and copyright applies to this distribution.