spire.officejs-service-win-test
v1.0.1
Published
The `spire.officejs-service-win` package provides the **Spire.OfficeJS backend server service** for **Windows (x64)** platforms. It is the server-side companion to the [Spire.OfficeJS](https://www.e-iceblue.com/Introduce/spire-office-js.html) front-end li
Maintainers
Readme
spire.officejs-service-win
The spire.officejs-service-win package provides the Spire.OfficeJS backend server service for Windows (x64) platforms. It is the server-side companion to the Spire.OfficeJS front-end library, enabling document processing capabilities such as collaborative editing and persistent storage on Windows systems.
What's Included
- Native Server Binary —
officeserver-win.exe, the core Office document server compiled for Windows x64 - SQLite Native Addon —
node_sqlite3.nodefor local data persistence - Default Configuration — pre-configured server settings (port, storage, logging, database, security, etc.)
- Auto-Config Setup — a postinstall script that copies the default configuration to your project root as
spire.officejs-server-config.json
Installation
npm install spire.officejs-service-winDuring installation, the postinstall script will automatically copy a default server configuration file (spire.officejs-server-config.json) to your project root. If the file already exists, it will not be overwritten — this prevents accidental overwrites of your custom configuration.
Platform Support
| Platform | Architecture | Package |
|----------|-------------|---------|
| Windows | x64 | spire.officejs-service-win |
| Linux | x64 | spire.officejs-service-linux |
| Linux | ARM | spire.officejs-service-arm |
Running the Server: Development vs Production
The run_servers.bat script — the runtime environment is entirely controlled by the spire.officejs-server-config.json configuration file. The workflow for both environments is: configure first, then run.
Development Environment
Step 1 — Prepare the development config
Edit spire.officejs-server-config.json in your project root.
Step 2 — Start the server
Run your project in development environment.
Step 3 — Stop the server
stop your project in development environment.
Production Environment
Step 1 — Prepare the production config
Before building, edit spire.officejs-server-config.json in your project root and ensure the following production settings are properly configured:
Step 2 — Start the server
Switch the directory to /dist/spire.officejs/service, double-click run_servers.bat to launch the server. The script starts officeserver-win.exe as a background process.
Step 3 — Stop the server
To stop the server in production:
- If the server was launched via
run_servers.batinteractively, close the console window or pressCtrl + Cin the terminal where it is running. - If the server is running as a background process, open Task Manager, locate
officeserver-win.exe, and end the task. - For unattended deployments (e.g., Windows Service), stop the service via
services.mscorsc stop <service-name>.
Getting More Help
- Visit the Spire.OfficeJS home page: https://www.e-iceblue.com/Introduce/spire-office-js.html
- Forum: https://www.e-iceblue.com/forum/
- Temporary License: https://www.e-iceblue.com/TemLicense.html
