Troubleshooting
Choose the symptom below. Run Docker commands from the folder containing docker-compose.yaml; the examples use the service name app. Replace the example hostname and port with your deployment values.
Container fails to start
Section titled “Container fails to start”On the container host, run:
docker compose config --quietdocker compose psdocker compose logs --tail 200 appResolve the first startup error in the logs. Check the Docker image name, license key, Redis connection, and certificate and dictionary files. The mounted files must exist and be readable by the application.
After fixing the settings or files, run docker compose up -d and check the service status again.
Port already in use
Section titled “Port already in use”List the ports used by running containers:
docker ps --format "table {{.Names}}\t{{.Ports}}"On Windows, you can also check a listening port in PowerShell:
Get-NetTCPConnection -LocalPort 443 -State ListenIdentify the service using the port. For the NGINX setup in Deploy BoldDocServer, NGINX uses public port 443 and the application uses local port 8443.
WOPI discovery endpoint returns an error
Section titled “WOPI discovery endpoint returns an error”From the SharePoint server, run:
curl.exe -i https://bolddocserver.example.com/hosting/discovery- Cannot connect: Check DNS, firewall rules, the published port, and whether the application is running.
- Certificate error: Follow HTTPS certificate errors.
- 404 or 500 through a proxy: Follow Reverse proxy returns 404 or 500.
- XML contains the wrong hostname: Set
WOPI_HOST_URLto the public HTTPS address and apply the change withdocker compose up -d.
SharePoint cannot open a document
Section titled “SharePoint cannot open a document”- Check discovery from the SharePoint server using the command above.
- In SharePoint Management Shell, run
Get-SPWOPIBindingandGet-SPWOPIZone. - Check that bindings exist for the document type and that the selected zone is available in discovery.
- Check that the user has permission and that their browser can reach BoldDocServer.
If a file opens in a desktop application instead of the browser editor, review the library’s document-opening settings and WOPI bindings with your SharePoint administrator.
For proof-signature errors in SharePoint logs, see Proof-signature errors. For registration steps, see Connect SharePoint.
DOCX editing or saving fails
Section titled “DOCX editing or saving fails”- Open a simple Word document with an account that has edit permission.
- Add one sentence, save, and wait for the save operation to complete.
- Close and reopen the file from SharePoint.
If the sentence is missing or a save error appears, compare the application and SharePoint logs for that time. Check the save response and the user’s edit permission. Keep the editor open while resolving a reported save failure.
XLSX editing or saving fails
Section titled “XLSX editing or saving fails”Repeat the saving checks with a simple workbook and a change to one cell. If only one workbook fails, collect its size, the operation, and reproduction steps for support.
PDF viewing, annotations, or collaboration fail
Section titled “PDF viewing, annotations, or collaboration fail”Check PDF loading first, then try an annotation or form-field change. Save and reopen the PDF from SharePoint to check that the change remains. For multi-user issues, follow Collaborative editing does not work.
Auto-save does not persist
Section titled “Auto-save does not persist”Check AUTO_SAVE_INTERVAL_MS, wait for the interval and the save operation to complete, then reopen the file from SharePoint. If the change is missing, follow the document-saving checks above.
If the content is saved but Version History has no new entry, check the SharePoint library’s versioning settings.
Collaborative editing does not work
Section titled “Collaborative editing does not work”- Set
ENABLE_COLLABORATIVE_EDITINGto"true"and apply changes withdocker compose up -d. - Check
REDIS_CACHE_CONNECTION_STRINGand access from BoldDocServer to Redis. - Open the same file in separate browser sessions using two accounts with edit permission.
- Make a change and check whether it appears in the other session.
For reverse-proxy deployments, check WebSocket forwarding. Review application, Redis, and proxy logs for connection errors.
Comments or Track Changes are missing
Section titled “Comments or Track Changes are missing”Check the document format and the available commands in its editor. Add a comment or tracked change to a simple Word document, save, and reopen it. If it disappears after saving, follow the DOCX saving checks.
Access denied or permission errors
Section titled “Access denied or permission errors”Check the user’s permission in the SharePoint library and whether the error occurs when opening or saving. An account may have view permission without edit permission. Compare the same operation with an authorized test account and review the corresponding SharePoint logs.
HTTPS certificate errors
Section titled “HTTPS certificate errors”Check that the certificate is valid for the hostname and is trusted by the system making the request. Use the public certificate at the component accepting browser connections: BoldDocServer for direct HTTPS, or the proxy for a reverse-proxy setup.
For an HTTPS proxy-to-application connection, also check the application certificate and the proxy’s trust settings. Correct certificate or trust problems rather than bypassing certificate validation.
Reverse proxy returns 404 or 500
Section titled “Reverse proxy returns 404 or 500”Check that the application is running and that the proxy forwards to the correct address, protocol, and port. Preserve request paths and query strings. Compare proxy and application logs for the failed request.
For the documented NGINX setup, the destination is https://127.0.0.1:8443 on the same Linux host. Review NGINX setup for the complete configuration.
Resource or performance issues
Section titled “Resource or performance issues”On the container host, run:
docker statsdocker compose logs --since 30m appRecord CPU and memory usage, document size, and the number of users editing at the same time. Compare a simple document with the affected document to narrow down the issue before changing host resources.
Collect logs for support
Section titled “Collect logs for support”Include:
- The BoldDocServer Docker image name, host OS, and SharePoint version.
- The deployment type: direct HTTPS, NGINX, or IIS.
- The failure time and time zone, error message, and HTTP status if available.
- The document format, size, and steps to reproduce the issue.
- Application, SharePoint, and proxy logs covering the failure, as applicable.
Remove passwords, license keys, access tokens, private keys, and confidential document content before sharing files or screenshots.