Sign inSign up

syncfusion/bolddocserver

Verified Publisher

By syncfusion

•Updated 2 days ago

Image
0

275

syncfusion/bolddocserver repository overview

⁠BoldDocServer

BoldDocServer lets users view and edit documents from SharePoint Server in a browser. It connects the Syncfusion editors and viewers to SharePoint through the Web Application Open Platform Interface (WOPI).

For example, a user opens a Word document in a SharePoint library, edits it in the browser, and saves the changes back to the same library. SharePoint continues to store the document and control who can access it.

⁠Features

  • Open documents from SharePoint and save changes back through WOPI.
  • View, edit, and auto-save Word documents with Syncfusion DOCX Editor.
  • View, edit, and auto-save Excel workbooks with Syncfusion Spreadsheet Editor.
  • View PDFs, add annotations and review changes, and save changes with Syncfusion PDF Viewer.
  • Collaborative editing for Word, Excel, and PDF documents.
  • Spell check for Word documents.
  • Configurable auto-save and version-commit intervals.

⁠Prerequisites

Before deploying BoldDocServer, ensure that you have:

  • Docker Engine and Docker Compose, with a Linux container environment. On Windows, configure this environment through WSL 2.
  • The BoldDocServer Docker image, license key, and spell-check dictionary package.
  • A hostname for BoldDocServer, with a trusted TLS certificate and its private key.
  • NGINX installed, with port 443 available for HTTPS access.
  • A Redis server and connection string for collaborative editing.
  • A SharePoint Server test library, a .docx file, and a user account with edit permission. A SharePoint administrator is needed for step 7.

SharePoint and user browsers must be able to reach the BoldDocServer hostname over HTTPS. BoldDocServer must be able to reach SharePoint and Redis. See Deployment Prerequisites⁠ for the full requirements.

This guide uses NGINX to provide HTTPS access and forward requests to the BoldDocServer application on port 8443. See Deploy BoldDocServer⁠ for instructions on configuring HTTPS, certificates, ports, firewall rules, and NGINX.

⁠1. Create the deployment folder

On the container host, create a folder for the deployment and subfolders for certificates and dictionaries.

Linux/macOS

mkdir -p bolddocserver/certs bolddocserver/data
cd bolddocserver

Windows PowerShell

New-Item -ItemType Directory -Force -Path "bolddocserver/certs", "bolddocserver/data"
Set-Location ./bolddocserver

Run the Docker commands in this guide from this folder.

⁠2. Create the Compose file

Create docker-compose.yaml in the deployment folder with the following settings:

services:
  app:
    image: syncfusion/bolddocserver:latest
    container_name: bolddocserver
    environment:
      BOLDDOCSERVER_LICENSE: "<your-license-key>"
      WOPI_HOST_URL: "https://bolddocserver.example.com"
      WOPI_DISCOVERY_ZONE: external-https
      ENABLE_COLLABORATIVE_EDITING: "true"
      VERSION_COMMIT_INTERVAL: "300000"
      AUTO_SAVE_INTERVAL: "10000"
      SPELLCHECK_DICTIONARY_PATH: /app/data
      SPELLCHECK_JSON_FILENAME: spellcheck.json
      SPELLCHECK_CACHE_COUNT: "2"
      REDIS_CACHE_CONNECTION_STRING: "<your-redis-connection-string>"
      REDIS_CACHE_SAVE_THRESHOLD: 100
      SSL_CERT_PATH: /https/certificate.crt
      SSL_KEY_PATH: /https/private-key.key
    ports:
      - "127.0.0.1:8443:443"
    volumes:
      - ./certs:/https:ro
      - ./data:/app/data:ro

Replace these values directly in docker-compose.yaml:

ValueReplace with
<your-license-key>Your BoldDocServer license key.
https://bolddocserver.example.comYour BoldDocServer HTTPS URL. The hostname must match your certificate.
<your-redis-connection-string>The connection string for the Redis server used for collaboration.

Use your BoldDocServer hostname in place of bolddocserver.example.com in the remaining steps.

⁠3. Add certificates and dictionaries

Copy your certificate chain to certs/certificate.crt and its private key to certs/private-key.key. Copy the spell-check dictionary package into data/, including spellcheck.json and any accompanying dictionary files.

For instructions on creating spellcheck.json, see Word spell check⁠.

Your folder should now contain:

bolddocserver/
├── docker-compose.yaml
├── certs/
│   ├── certificate.crt
│   └── private-key.key
└── data/
    ├── spellcheck.json
    └── (other files from the dictionary package)

Keep docker-compose.yaml and the private key out of source control once they contain your deployment credentials, and restrict access to them.

⁠4. Configure NGINX for HTTPS

Configure NGINX to accept HTTPS requests on port 443 and forward them to the BoldDocServer application on port 8443.

Create or update the NGINX server configuration for your BoldDocServer hostname:

events {
    worker_connections 1024;
}

http {
    server {
        listen 443 ssl;
        server_name bolddocserver.example.com;

        ssl_certificate     /path/to/certificate.crt;
        ssl_certificate_key /path/to/private-key.key;

        location / {
            proxy_pass https://127.0.0.1:8443;

            proxy_http_version 1.1;

            proxy_set_header Host $host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_set_header X-Forwarded-Proto $scheme;
            proxy_set_header X-Forwarded-Host $http_host;
            proxy_set_header X-Forwarded-Port 443;

            proxy_set_header Upgrade $http_upgrade;
            proxy_set_header Connection "upgrade";

            proxy_read_timeout 300s;
            proxy_send_timeout 300s;
        }
    }
}

Replace the following values with your deployment details:

  • server_name: The hostname configured for BoldDocServer.
  • ssl_certificate: The path to your trusted TLS certificate.
  • ssl_certificate_key: The path to the corresponding private key.
  • proxy_pass: The BoldDocServer application endpoint published on the host.

Note: The location of the NGINX configuration depends on the installation. For standalone installations on Windows and macOS, add the server block inside the http {} section of the main nginx.conf file. On Linux, you can either add the server block inside the existing http {} section of /etc/nginx/nginx.conf or create a separate site configuration under /etc/nginx/sites-available/ and enable it through /etc/nginx/sites-enabled/. When using a separate site configuration, include only the server block; do not add separate events {} or http {} sections.

Validate the NGINX configuration and reload NGINX to apply the changes. NGINX must already be running before you reload it. If it is not running, start it first.

Linux

sudo nginx -t
sudo systemctl reload nginx

macOS

sudo nginx -t
sudo nginx -s reload

Windows PowerShell

Run the following commands from the NGINX installation directory:

.\nginx.exe -t
.\nginx.exe -s reload

Expected result: NGINX configuration validation succeeds, and the BoldDocServer HTTPS endpoint is accessible on port 443. Requests are forwarded to the application on port 8443.

For additional NGINX configuration and deployment options, see Deploy BoldDocServer⁠.

⁠5. Start BoldDocServer

Navigate to the deployment folder containing docker-compose.yaml and run the following commands:

docker compose up -d
docker compose ps

Expected result: The app service is listed as running.

If it fails to start, see Container fails to start⁠.

⁠6. Check access from SharePoint

Run this command in PowerShell on the SharePoint server. It checks that SharePoint can reach BoldDocServer over HTTPS and retrieve its list of document types and actions.

curl.exe -i https://bolddocserver.example.com/hosting/discovery

Expected result: The request succeeds over trusted HTTPS and returns XML. The editor URLs in the XML use your BoldDocServer hostname.

If the request fails, see Discovery troubleshooting⁠.

⁠7. Connect SharePoint

Ask your SharePoint administrator to run these commands in SharePoint Management Shell on the test SharePoint server.

First, inspect the existing document bindings and WOPI zone:

Get-SPWOPIBinding
Get-SPWOPIZone

Bindings tell SharePoint which application opens each document type. If bindings for your document types already exist, follow the integration guide⁠ before changing them.

Register BoldDocServer:

New-SPWOPIBinding -ServerName "bolddocserver.example.com"

Use the hostname only, without https:// or a path.

The WOPI zone selects which editor URLs SharePoint uses. If your discovery XML advertises the external-https zone and that zone matches your SharePoint setup, select it:

Set-SPWOPIZone -Zone "external-https"

For other setups, follow Select the WOPI zone⁠. Changing the zone affects the SharePoint farm.

Check the result:

Get-SPWOPIBinding -Server "bolddocserver.example.com"
Get-SPWOPIZone

Expected result: Bindings are listed for viewing and editing supported Word, Excel, and PDF documents, and the zone matches your chosen setup.

For registration errors, see Connect SharePoint⁠.

⁠8. Open, edit, and save a Word document

  1. Sign in to SharePoint with the account that has edit permission.
  2. Upload your test .docx file to the document library.
  3. Open the .docx document from the SharePoint document library in the BoldDocServer DOCX editor.
  4. Add the sentence BoldDocServer save test to the document.
  5. Use the editor’s save action, if available, or wait for auto-save. This example sets auto-save to run every 10 seconds.
  6. Wait for the save to complete, then close the editor.
  7. Reopen the same file from the SharePoint library and check that BoldDocServer save test is still present.

Expected result: Your edit is present after reopening. You have now opened, edited, and saved a document through BoldDocServer.

To try collaborative editing, open the same document in another browser session using a second account with edit permission. Make a change in one session and check that it appears in the other.

If a save error appears, keep the document open and follow Saving troubleshooting⁠. SharePoint Version History depends on the library’s versioning settings; saving a change does not necessarily create a new version.

⁠Next steps

Tag summary

Content type

Image

Digest

sha256:262db4431…

Size

366.7 MB

Last updated

2 days ago

docker pull syncfusion/bolddocserver