Skip to content

Deployment Prerequisites

Prepare the host, license, network, certificates, SharePoint access, and Redis connection needed to deploy BoldDocServer.

Updated

Before deploying BoldDocServer, prepare the container host, Docker image, license key, HTTPS certificate, SharePoint access, and Redis connection described below.

Container host

BoldDocServer runs in a Linux container based on the .NET 10 ASP.NET Core runtime. It can be hosted on Linux, macOS, or Windows. The host must provide a Docker environment configured to run Linux containers. On Windows, use WSL 2.

Ensure Docker Engine and the Docker Compose plugin are installed and accessible in the environment used to run Linux containers.

Run the following commands in a terminal with Docker access configured:

docker version
docker compose version

docker version should show both Client and Server information. docker compose version should show the Compose version.

Hardware and storage

The documented deployment-test configuration uses:

Resource Testing baseline
CPU 4 vCPU
Memory 16 GiB RAM
Disk 128 GiB Premium SSD

Production sizing depends on document sizes, enabled features, and how many users edit at the same time; the testing baseline is not a capacity guarantee. Allow disk space for the image, logs, certificates, and dictionary files.

Image, license, and dictionary files

Have the following ready:

  • The BoldDocServer Docker image.
  • Your BoldDocServer license key.
  • The spell-check dictionary package, including spellcheck.json and its accompanying files.

The Quick Start shows where to enter the Docker image, license key, and other settings.

HTTPS address and certificates

Choose an HTTPS address such as https://bolddocserver.example.com. The hostname must resolve from the SharePoint server and user’s browsers.

Configure HTTPS access using one of the supported options:

  • NGINX: Supports HTTPS access for deployments on Linux, macOS, and Windows.
  • IIS URL Rewrite: Supports HTTPS access for Windows deployments.

Use a valid TLS certificate for your chosen hostname. The certificate must be trusted by SharePoint and user browsers.

Ensure that:

  • Port 443 is configured for external HTTPS access.
  • The host firewall allows inbound HTTPS traffic on port 443.
  • Access to the TLS certificate’s private key is restricted to authorized accounts.
  • NGINX forwards WebSocket upgrade headers when using NGINX.
  • The WebSocket Protocol feature is installed and enabled in IIS when using IIS URL Rewrite to support real-time collaboration.

When NGINX or IIS runs directly on the host, configure the certificate paths using the certificate and private key locations accessible to that host. These paths are separate from the certificate paths configured inside the BoldDocServer container.

See Deploy BoldDocServer for instructions on configuring the hostname, certificates, ports, firewall rules, and HTTPS access.

Network, ports, and firewall

Allow the following connections. Use your configured ports where they differ from the examples.

From To Port Purpose
User browser SharePoint SharePoint HTTPS port, usually 443 Open the SharePoint site and document library.
User browser BoldDocServer External HTTPS port, usually 443 Load and use the document editor or viewer.
SharePoint Server BoldDocServer External HTTPS port, usually 443 Retrieve WOPI discovery information and launch the editor.
BoldDocServer SharePoint Server SharePoint HTTPS port, usually 443 Retrieve documents and save changes.
BoldDocServer Redis Port configured in the Redis connection string Exchange collaboration data.
Container host Image registry HTTPS 443 Download the container image and updates.

The external HTTPS endpoint is provided by NGINX or IIS. The HTTPS port used between the host and the BoldDocServer container depends on your deployment configuration. For example, the Quick Start publishes the container’s HTTPS port 443 on host port 8443 for NGINX to access.

Configure DNS so SharePoint Server and user’s browsers can resolve the BoldDocServer hostname. Ensure BoldDocServer can resolve and reach the SharePoint Server hostname.

Configure the host firewall and any network firewalls to allow inbound HTTPS traffic on the required external port. Keep Redis access restricted to authorized systems.

Verify each connection from the system listed in the From column.

SharePoint access

Prepare:

  • A SharePoint Server 2016, SharePoint Server 2019, or SharePoint Server Subscription Edition environment.
  • The SharePoint site URL and a document library for the first document workflow.
  • A SharePoint administrator with permission to configure WOPI bindings and the WOPI zone.
  • A user account with edit permission and a simple .docx file.

For collaboration, use two accounts with edit permission on the same document. See Connect SharePoint for configuration.

Redis requirements

Redis is required for collaborative editing, which is enabled in the Quick Start.

Have the Redis hostname, port, and connection string ready, including authentication and TLS settings used by your Redis service. Provide the connection string through REDIS_CACHE_CONNECTION_STRING in the deployment configuration.

Keep the Redis connection string private.

Next step

Follow Quick Start to create the deployment files, start BoldDocServer, and open and save a document from SharePoint. For additional deployment options, follow Deploy BoldDocServer for HTTPS and NGINX or IIS URL Rewrite configuration.

Type to search…

↑↓ navigate↵ selectEsc close