Skip to content

Configuration Reference

Find the settings for licensing, HTTPS, collaboration, saving, and spell check.

Updated

Enter these settings in the environment section of your private docker-compose.yaml. The Quick Start Compose example shows the complete file. The values below are examples, not defaults.

Settings

Setting Purpose Example value
BOLDDOCSERVER_LICENSE Your BoldDocServer license key. <your-license-key>
WOPI_HOST_URL The BoldDocServer HTTPS address used by SharePoint and browsers. https://bolddocserver.example.com
WOPI_DISCOVERY_ZONE Specifies the WOPI zone for SharePoint connectivity external-https
ENABLE_COLLABORATIVE_EDITING Allow multiple users to edit the same document together. Requires Redis when enabled. true
REDIS_CACHE_CONNECTION_STRING Connection string for the Redis service used by collaboration. <your-redis-connection-string>
REDIS_CACHE_SAVE_THRESHOLD Threshold that controls Redis-backed collaboration save behavior. 100
AUTO_SAVE_INTERVAL Time between automatic saves, in milliseconds. 10000 (10 seconds)
VERSION_COMMIT_INTERVAL Time between version commits, in milliseconds. 300000 (5 minutes)
SPELLCHECK_DICTIONARY_PATH Folder containing the Word spell-check dictionaries inside the container. /app/data
SPELLCHECK_JSON_FILENAME Spell-check dictionary filename. spellcheck.json
SPELLCHECK_CACHE_COUNT Spell-check cache count. 2
SSL_CERT_PATH Certificate-chain file inside the container. /https/certificate.crt
SSL_KEY_PATH Certificate private-key file inside the container. /https/private-key.key

Keep the configured file private and out of source control once it contains your license key or credentials. Managed deployments can supply these values through a secret store.

Public URL and WOPI

Set WOPI_HOST_URL to the HTTPS address users and SharePoint use to reach BoldDocServer:

WOPI_HOST_URL: "https://bolddocserver.example.com"

Include the port if it is not 443. This setting is the BoldDocServer address; SharePoint supplies a separate document-specific URL called WOPISrc when opening a file.

Certificate and dictionary paths

The paths in the table are inside the container. The Quick Start mounts these host folders:

Host folder Container folder Contents
./certs /https Certificate chain and private key.
./data /app/data Spell-check dictionary package.

Keep the files in these host folders when replacing or updating a container. Documents are stored in SharePoint. For proxy certificate setup, see Deploy BoldDocServer.

Apply changes

After editing docker-compose.yaml, run these commands from its folder:

docker compose up -d
docker compose ps

Check that app is running. Open a document and try the feature you changed. If the service fails to start, see Container fails to start.

See Features and document support for collaboration, spell check, auto-save, and SharePoint Version History behavior.

Type to search…

↑↓ navigate↵ selectEsc close