The backend server software layer which is the part of ONLYOFFICE Document Server and ONLYOFFICE Desktop Editors and is the base for all other components.
This instruction describes document service deployment for Windows based platform.
For the document service to work correctly it is necessary to install the following components for your Windows system (if not specified additionally, the latest version for 32 or 64 bit Windows can be installed with default settings):
-
Node.js version 8.0.0 or later
-
Java. Necessary for the sdk build.
-
Database (MySQL or PostgreSQL). When installing use the
onlyoffice
password for theroot
user.-
MySQL Server version 5.5 or later
-
PostgreSQL Server version 9.1 or later
-
-
Microsoft Visual C++ Express 2010 (necessary for the spellchecker modules build)
-
Database setup:
-
Database setup for MySQL
Run theschema/mysql/createdb.sql
script for MySQL -
Database setup for PostgreSQL
-
Enter in
psql
(PostgreSQL interactive terminal) with login and password introduced during installation, then enter commands:CREATE DATABASE onlyoffice; CREATE USER onlyoffice WITH PASSWORD 'onlyoffice'; \c onlyoffice \i 'schema/postgresql/createdb.sql'; GRANT ALL PRIVILEGES ON DATABASE onlyoffice to onlyoffice; GRANT ALL PRIVILEGES ON ALL TABLES IN SCHEMA public TO onlyoffice;
-
Delete from
server\Common\config\development-windows.json
optionsql
.
-
-
-
Install the Web Monitor for RabbitMQ (see the details for the installation here)
-
Open the command line
cmd
executable. -
Switch to the installation directory using the
cd /d Installation-directory/sbin
command. -
Run the following command:
rabbitmq-plugins.bat enable rabbitmq_management
-
The Web Monitor is located at the http:https://localhost:15672/ address. Use the
guest:guest
for the login:password combination. -
If Redis does not start or crashes after the start for some reason, try to change the
maxheap
parameter in the config settings. For 64 bit version of Windows 7 the config file can be found here:C:\Program Files\Redis\redis.windows-service.conf
. Find the# maxheap <bytes>
line and change it to, e.g.maxheap 128MB
and restart the service
Run the run.bat
script to start the service.
Notes
All config files for the server part can be found in the Common\config
folder
default.json
- common config files similar for all production versions.production-windows.json
- config files for the production version running on a Windows based platform.production-linux.json
- config files for the production version running on a Linux based platform.development-windows.json
- config files for the development version running on a Windows based platform (this configuration is used when running the 'run.bat' script).
In case it is necessary to temporarily edit the config files, create the local.json file and reassign the values there. It will allow to prevent from uploading local changes and losing config files when updating the repository. See Configuration Files for more information about the configuration files.
If you have any problems with or questions about ONLYOFFICE Document Server, please visit our official forum to find answers to your questions: dev.onlyoffice.org or you can ask and answer ONLYOFFICE development questions on Stack Overflow.
Server is released under an GNU AGPL v3.0 license. See the LICENSE file for more information.