New article: compiling Document Builder

This commit is contained in:
Svetlana Maleeva 2020-03-26 18:13:11 +03:00
parent 2f7159a67c
commit ed020b460d
3 changed files with 228 additions and 0 deletions

View File

@ -0,0 +1,103 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Compiling Document Builder";
MetaKeyWords = "";
MetaDescription = "";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Compiling Document Builder</h1>
<cc:localizecontent runat="Server" controlname="~/Controls/Help/VariousControls/Versions/DocumentServer/DocumentServer_Current.ascx" />
<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/local-server/local-server.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/server-version/server-version.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/linux-version/linux-version.ascx" /></li>
</ul>
</div>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="block_of_step">
<div class="screen_text">
<p><a href="https://api.onlyoffice.com/docbuilder/basic"><b>Document Builder</b></a> is a tool that allows you to generate text documents, spreadsheet, presentation and PDF files and automate document building using the templates. It can be easily integrated into your document management system using its JavaScript API.</p>
<p>You can easily compile <b>Document Builder</b> from source codes and deploy the solution on your local server using the specially designed <b>build_tools</b>. The <b>build_tools</b> allow to automatically get and install all the components necessary for the compilation process, all the dependencies required for the <b>Document Builder</b> correct work, as well as to get the latest version of <b>Document Builder</b> source code and build all its components.</p>
</div>
</div>
</div>
<h2 id="SystemRequirements">System requirements</h2>
<div class="block_of_step">
<div class="screen_text">
<p><b>Hardware</b></p>
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_CPU/SysReqs_CPU.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_RAM/SysReqs_RAM.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_HDD3/SysReqs_HDD3.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_Add_Hard/SysReqs_Add_Hard.ascx" /></li>
</ul>
<p><b>Software</b></p>
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_OS9/SysReqs_OS9.ascx" /></li>
</ul>
<div class="notehelp">The solution has been tested on <b>Ubuntu 14.04</b>. Other distributions might require some specific actions which are not described here.</div>
</div>
</div>
<h2 id="Compiling">Installing dependencies</h2>
<div class="block_of_step">
<div class="screen_text">
<p>You might need to install <b>Python</b>, depending on your version of Ubuntu. This can be done using the following command:</p>
<pre><code>sudo apt-get install -y python
</code></pre>
</div>
</div>
<h2 id="Getting&Building">Building Document Builder source code</h2>
<div class="block_of_step">
<div class="screen_text">
<ol>
<li>Clone the <b>build_tools</b> repository:
<pre><code>git clone https://github.com/ONLYOFFICE/build_tools.git
</code></pre>
<div class="notehelp">To execute this command you need to have <b>git</b> installed on your computer. You can install <b>git</b> using the following command:
<pre><code>sudo apt-get install git
</code></pre>
</div>
</li>
<li>Go to the <code>build_tools/tools/linux</code> directory:
<pre><code>cd build_tools/tools/linux
</code></pre>
</li>
<li>Run the <code>automate.py</code> script specifying the <code>builder</code> parameter to compile the <b>Document Builder</b>:
<pre><code>./automate.py builder
</code></pre>
<div class="notehelp">If you run the script without any parameters, this will build <b>Document Builder</b> alongside with <b>Document Server</b> and <b>Desktop Editors</b>.
<pre><code>./automate.py
</code></pre>
If necessary, you can build several products at once by running the script with the parameters corresponding to the necessary products. To learn more about compiling <b>Document Server</b> you can read <a href="<%=VirtualPathUtility.ToAbsolute("~/server/linux/document/compile-source-code.aspx")%>">this article</a>. To learn more about compiling <b>Desktop Editors</b> please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/desktop/documents/linux/compile-desktop.aspx")%>">this article</a>.
</div>
</li>
</ol>
<p>Wait while the script is being executed. Depending on your computer capabilities, this process may take considerable time. For example, this takes 3 hours at least on <code>Intel Core i7-7700</code>.</p>
<p>The script will compile all the dependencies and components which are a part of <b>Document Builder</b>.</p>
<p>The build will be available in the <code>../../out/linux_64/onlyoffice/documentbuilder/</code> directory. Now you can proceed to running <b>Document Builder</b> on your server.</p>
</div>
</div>
<h2 id="Running">Running Document Builder</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Go to the <code>../../out/linux_64/onlyoffice/documentbuilder/</code> directory</p>
<pre><code>cd ../../out/linux_64/onlyoffice/documentbuilder
</code></pre>
<p>Execute the following command:</p>
<pre><code>./docbuilder
</code></pre>
</div>
</div>
</div>

View File

@ -0,0 +1,102 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Компиляция Document Builder";
MetaKeyWords = "";
MetaDescription = "";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Компиляция Document Builder</h1>
<cc:localizecontent runat="Server" controlname="~/Controls/Help/VariousControls/Versions/DocumentServer/DocumentServer_Current.ascx" />
<div class="keyword_block">
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/local-server/local-server.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/server-version/server-version.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/linux-version/linux-version.ascx" /></li>
</ul>
</div>
<div class="video_ground video_trips">
<h2 id="introduction">Введение</h2>
<div class="block_of_step">
<div class="screen_text">
<p><a href="https://api.onlyoffice.com/docbuilder/basic"><b>Document Builder</b></a> - это инструмент, позволяющий генерировать текстовые документы, электронные таблицы, презентации и PDF-файлы и автоматизировать сборку документов с помощью шаблонов. Его можно легко интегрировать с системой управления документами при помощи JavaScript API.</p>
<p>Вы можете легко собрать <b>Document Builder</b> из исходных кодов и развернуть решение на локальном сервере с помощью специально предназначенных для этого инструментов <b>build_tools</b>, которые позволяют автоматически получить и установить все компоненты, необходимые для процесса компиляции, все зависимости, которые требуются для корректной работы <b>Document Builder</b>, получить последнюю версию исходного кода <b>Document Builder</b> и собрать все его компоненты.</p>
</div>
</div>
</div>
<h2 id="SystemRequirements">Системные требования</h2>
<div class="block_of_step">
<div class="screen_text">
<p><b>Аппаратное обеспечение</b></p>
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_CPU/SysReqs_CPU.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_RAM/SysReqs_RAM.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_HDD3/SysReqs_HDD3.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_Add_Hard/SysReqs_Add_Hard.ascx" /></li>
</ul>
<p><b>Программное обеспечение</b></p>
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_OS9/SysReqs_OS9.ascx" /></li>
</ul>
<div class="notehelp">Решение протестировано на <b>Ubuntu 14.04</b>. Для других дистрибутивов могут потребоваться особые действия, не описанные здесь.</div>
</div>
</div>
<h2 id="Compiling">Установка зависимостей</h2>
<div class="block_of_step">
<div class="screen_text">
<p>В зависимости от вашей версии Ubuntu, может потребоваться установка <b>Python</b>. Это можно сделать с помощью следующей команды:</p>
<pre><code>sudo apt-get install -y python
</code></pre>
</div>
</div>
<h2 id="Getting&Building">Сборка исходного кода Document Builder</h2>
<div class="block_of_step">
<div class="screen_text">
<ol>
<li>Клонируйте репозиторий <b>build_tools</b>:
<pre><code>git clone https://github.com/ONLYOFFICE/build_tools.git
</code></pre>
<div class="notehelp">Для выполнения этой команды на компьютере должен быть установлен <b>git</b>. Вы можете установить <b>git</b> с помощью следующей команды:
<pre><code>sudo apt-get install git
</code></pre>
</div>
</li>
<li>Перейдите в папку <code>build_tools/tools/linux</code>:
<pre><code>cd build_tools/tools/linux
</code></pre>
</li>
<li>Для сборки <b>Document Builder</b> запустите скрипт <code>automate.py</code>, указав параметр <code>builder</code>:
<pre><code>./automate.py builder
</code></pre>
<div class="notehelp">При запуске скрипта без параметров будут собраны <b>Document Builder</b>, <b>Сервер документов</b> и <b>десктопные редакторы</b>.
<pre><code>./automate.py
</code></pre>
В случае необходимости можно собрать несколько продуктов одновременно, запустив скрипт с параметрами, соответствующими нужным продуктам. Для получения дополнительной информации о сборке <b>Сервера документов</b> можно прочитать <a href="<%=VirtualPathUtility.ToAbsolute("~/server/linux/document/compile-source-code.aspx")%>">эту статью</a>. Для получения дополнительной информации о сборке <b>десктопных редакторов</b> обратитесь к <a href="<%=VirtualPathUtility.ToAbsolute("~/desktop/documents/linux/compile-desktop.aspx")%>">этой статье</a>.
</div>
</li>
</ol>
<p>Дождитесь завершения работы скрипта. В зависимости от мощности компьютера, этот процесс может занять значительное время. Например, он занимает не менее 3 часов на <code>Intel Core i7-7700</code>.</p>
<p>Скрипт соберет все зависимости и компоненты, входящие в состав <b>Document Builder</b>.</p>
<p>Сборка будет доступна в папке <code>../../out/linux_64/onlyoffice/documentbuilder/</code>. Теперь вы можете переходить к запуску <b>Document Builder</b>.</p>
</div>
</div>
<h2 id="Running">Запуск Document Builder</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Перейдите в папку <code>../../out/linux_64/onlyoffice/documentbuilder/</code></p>
<pre><code>cd ../../out/linux_64/onlyoffice/documentbuilder
</code></pre>
<p>Выполните следующую команду:</p>
<pre><code>./docbuilder
</code></pre>
</div>
</div>
</div>

View File

@ -0,0 +1,23 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/Server/DS_Articles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<body class="linux_version document_server">
</asp:Content>
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/VariousControls/TopControls/DocumentLinuxTop/DocumentLinuxTop.ascx" />
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<% ((BasePage)Page).EditionVersion = "Document Server"; %>
<% ((BasePage)Page).CommandName = "DocumentServer"; %>
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Linux/Document/CompileDocBuilder/CompileDocBuilder.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="guidespage documents">
<div id="SeeAlsoBlockLinks">
<div class="caption guides">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerLinux/60003_documents_installation/60003_documents_installation.ascx" />
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerLinux/60007_connect_document_to_community/60007_connect_document_to_community.ascx" />
</div>
</div>
</asp:Content>