lodash 中文文档

build_tools


Overview


build_toolsallow you to automatically get and install all the components necessary for the compilation process, all the dependencies required for the ONLYOFFICE Document Server, Document Builderand Desktop Editorscorrect work, as well as to get the latest version of ONLYOFFICE productssource code and build all their components.

Important!We can only guarantee the correct work of the products built from the master branch.

How to use - Linux


Note: The solution has been tested on Ubuntu 16.04.

Installing dependencies


You might need to install Python, depending on your version of Ubuntu:

  1. ``` shell
  2. sudo apt-get install -y python
  3. ```

Building ONLYOFFICE products source code


Clone the build_tools repository:

  1. ``` shell
  2. git clone https://github.com/ONLYOFFICE/build_tools.git
  3. ```

Go to the build_tools/tools/linux directory:

  1. ``` shell
  2. cd build_tools/tools/linux
  3. ```

Run the automate.py script:

  1. ``` shell
  2. ./automate.py
  3. ```

If you run the script without any parameters this allows to build ONLYOFFICE Document Server, Document Builderand Desktop Editors.

The result will be available in the ./out directory.

To build ONLYOFFICEproducts separately run the script with the parameter corresponding to the necessary product.

It’s also possible to build several products at once as shown in the example below.

Example: Building Desktop Editorsand Document Server

  1. ``` shell
  2. ./automate.py desktop server
  3. ```

Using Docker


You can also build all ONLYOFFICE productsat once using Docker. Build the onlyoffice-document-editors-builder Docker image using the provided Dockerfile and run the corresponding Docker container.

  1. ``` shell
  2. mkdir out
  3. docker build --tag onlyoffice-document-editors-builder .
  4. docker run -v $PWD/out:/build_tools/out onlyoffice-document-editors-builder
  5. ```

The result will be available in the ./out directory.

Building and running ONLYOFFICE products separately


Document Builder


Building Document Builder

  1. ``` shell
  2. ./automate.py builder
  3. ```

Running Document Builder

  1. ``` shell
  2. cd ../../out/linux_64/onlyoffice/documentbuilder
  3. ./docbuilder
  4. ```

Desktop Editors


Building Desktop Editors

  1. ``` shell
  2. ./automate.py desktop
  3. ```

Running Desktop Editors

  1. ``` shell
  2. cd ../../out/linux_64/onlyoffice/desktopeditors
  3. LD_LIBRARY_PATH=./ ./DesktopEditors
  4. ```

Document Server


Building Document Server

  1. ``` shell
  2. ./automate.py server
  3. ```

Installing and configuring Document Server dependencies

Document Serveruses NGINXas a web server and PostgreSQLas a database. RabbitMQis also required for Document Serverto work correctly.

Installing and configuring NGINX

Install NGINX:

  1. ``` shell
  2. sudo apt-get install nginx
  3. ```

Disable the default website:

  1. ``` shell
  2. sudo rm -f /etc/nginx/sites-enabled/default
  3. ```

Set up the new website. To do that create the /etc/nginx/sites-available/onlyoffice-documentserver file with the following contents:

  1. ``` shell
  2. map $http_host $this_host {
  3.   "" $host;
  4.   default $http_host;
  5. }
  6. map $http_x_forwarded_proto $the_scheme {
  7.   default $http_x_forwarded_proto;
  8.   "" $scheme;
  9. }
  10. map $http_x_forwarded_host $the_host {
  11.   default $http_x_forwarded_host;
  12.   "" $this_host;
  13. }
  14. map $http_upgrade $proxy_connection {
  15.   default upgrade;
  16.   "" close;
  17. }
  18. proxy_set_header Host $http_host;
  19. proxy_set_header Upgrade $http_upgrade;
  20. proxy_set_header Connection $proxy_connection;
  21. proxy_set_header X-Forwarded-Host $the_host;
  22. proxy_set_header X-Forwarded-Proto $the_scheme;
  23. server {
  24.   listen 0.0.0.0:80;
  25.   listen [::]:80 default_server;
  26.   server_tokens off;
  27.   rewrite ^\/OfficeWeb(\/apps\/.*)$ /web-apps$1 redirect;
  28.   location / {
  29.     proxy_pass http://localhost:8000;
  30.     proxy_http_version 1.1;
  31.   }
  32. }
  33. ```

Add the symlink to the newly created website to the /etc/nginx/sites-available directory:

  1. ``` shell
  2. sudo ln -s /etc/nginx/sites-available/onlyoffice-documentserver /etc/nginx/sites-enabled/onlyoffice-documentserver
  3. ```

Restart NGINX to apply the changes:

  1. ``` shell
  2. sudo nginx -s reload
  3. ```

Installing and configuring PostgreSQL

Install PostgreSQL:

  1. ``` shell
  2. sudo apt-get install postgresql
  3. ```

Create the PostgreSQL database and user:

Note: The created database must have onlyofficeboth for user and password.

  1. ``` shell
  2. sudo -i -u postgres psql -c "CREATE DATABASE onlyoffice;"
  3. sudo -i -u postgres psql -c "CREATE USER onlyoffice WITH password 'onlyoffice';"
  4. sudo -i -u postgres psql -c "GRANT ALL privileges ON DATABASE onlyoffice TO onlyoffice;"
  5. ```

Configure the database:

  1. ``` shell
  2. psql -hlocalhost -Uonlyoffice -d onlyoffice -f ../../out/linux_64/onlyoffice/documentserver/server/schema/postgresql/createdb.sql
  3. ```

Note: Upon that, you will be asked to provide a password for the onlyofficePostgreSQL user. Please enter the onlyofficepassword.

Installing RabbitMQ

  1. ``` shell
  2. sudo apt-get install rabbitmq-server
  3. ```

Generate fonts data

  1. ``` shell
  2. cd out/linux_64/onlyoffice/documentserver/
  3. mkdir fonts
  4. LD_LIBRARY_PATH=${PWD}/server/FileConverter/bin server/tools/allfontsgen \
  5.   --input="${PWD}/core-fonts" \
  6.   --allfonts-web="${PWD}/sdkjs/common/AllFonts.js" \
  7.   --allfonts="${PWD}/server/FileConverter/bin/AllFonts.js" \
  8.   --images="${PWD}/sdkjs/common/Images" \
  9.   --selection="${PWD}/server/FileConverter/bin/font_selection.bin" \
  10.   --output-web='fonts' \
  11.   --use-system="true"
  12. ```

Generate presentation themes

  1. ``` shell
  2. cd out/linux_64/onlyoffice/documentserver/
  3. LD_LIBRARY_PATH=${PWD}/server/FileConverter/bin server/tools/allthemesgen \
  4.   --converter-dir="${PWD}/server/FileConverter/bin"\
  5.   --src="${PWD}/sdkjs/slide/themes"\
  6.   --output="${PWD}/sdkjs/common/Images"
  7. ```

Running Document Server

Note: All Document Servercomponents run as foreground processes. Thus you need separate terminal consoles to run them or specific tools which will allow to run foreground processes in background mode.

Start the FileConverterservice:

  1. ``` shell
  2. cd out/linux_64/onlyoffice/documentserver/server/FileConverter
  3. LD_LIBRARY_PATH=$PWD/bin \
  4. NODE_ENV=development-linux \
  5. NODE_CONFIG_DIR=$PWD/../Common/config \
  6. ./converter
  7. ```

Start the DocServiceservice:

  1. ``` shell
  2. cd out/linux_64/onlyoffice/documentserver/server/DocService
  3. NODE_ENV=development-linux \
  4. NODE_CONFIG_DIR=$PWD/../Common/config \
  5. ./docservice
  6. ```