Add new article "Installing ONLYOFFICE Docs for Docker on KylinOS"

This commit is contained in:
Svetlana Maleeva 2023-08-03 16:07:45 +03:00
parent c9cf38e313
commit 64f6ab4dd2
11 changed files with 458 additions and 9 deletions

View File

@ -69,7 +69,8 @@
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70003_documents_installation.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70059_docs_install_arm.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70031_document_server_docker_compose.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70031_document_server_docker_compose.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-community-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Community Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version
@ -185,7 +186,8 @@
<li>Docker version
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190001_install_docs_ee_docker.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190019_install_docs_ee_docker_arm.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190019_install_docs_ee_docker_arm.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-enterprise-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Enterprise Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version
@ -300,6 +302,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150003_developer_docker_installation.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150022_docker_installation_arm.ascx" /></li>
<%--<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150018_de_docker_compose/150018_de_docker_compose.ascx" /></li>--%>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-developer-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Developer Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version

View File

@ -67,7 +67,8 @@
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70003_documents_installation.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70059_docs_install_arm.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70031_document_server_docker_compose.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70031_document_server_docker_compose.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-community-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Community Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version

View File

@ -66,6 +66,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150003_developer_docker_installation.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150022_docker_installation_arm.ascx" /></li>
<%--<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150018_de_docker_compose/150018_de_docker_compose.ascx" /></li>--%>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-developer-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Developer Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version

View File

@ -58,7 +58,8 @@
<li>Docker version
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190001_install_docs_ee_docker.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190019_install_docs_ee_docker_arm.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190019_install_docs_ee_docker_arm.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-enterprise-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Enterprise Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version

View File

@ -485,7 +485,8 @@
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70003_documents_installation.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70059_docs_install_arm.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70031_document_server_docker_compose.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerDocker/70031_document_server_docker_compose.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-community-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Community Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version
@ -600,7 +601,8 @@
<li>Docker version
<ul>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190001_install_docs_ee_docker.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190019_install_docs_ee_docker_arm.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190019_install_docs_ee_docker_arm.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-enterprise-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Enterprise Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version
@ -715,6 +717,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150003_developer_docker_installation.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150022_docker_installation_arm.ascx" /></li>
<%--<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150018_de_docker_compose/150018_de_docker_compose.ascx" /></li>--%>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-developer-install-docker-kylinos.aspx")%>">Installing ONLYOFFICE Docs Developer Edition for Docker on KylinOS</a></li>
</ul>
</li>
<li>Linux version

View File

@ -126,9 +126,9 @@ sudo systemctl restart docker.service
Starting from version 7.2, we added a random generation of JWT secret. If JWT secret is not specified with the environment variable, it leads to its re-generation during every VMs or physical server reboot, so there might be problems in integrations. To avoid this issue, specify your own value in <code>-e JWT_SECRET=my_jwt_secret</code>.
<p>If you are not going to use JWT in your installation, use <code>-e JWT_ENABLED=false</code>.</p>
</div>
<p class="community_display">Use this command if you wish to install <b>ONLYOFFICE Docs</b> separately. To install <b>ONLYOFFICE Docs</b> integrated with <b>ONLYOFFICE Groups</b> and <b>ONLYOFFICE Mail</b>, refer to the corresponding instructions below.</p>
<%--<p class="community_display">Use this command if you wish to install <b>ONLYOFFICE Docs</b> separately. To install <b>ONLYOFFICE Docs</b> integrated with <b>ONLYOFFICE Groups</b> and <b>ONLYOFFICE Mail</b>, refer to the corresponding instructions below.--%></p>
<div class="notehelp">
By default <b>ONLYOFFICE Docs</b> listens to the incoming connections using port <b>80</b>. Starting with version <b>4.3</b> you can change the port for <b>ONLYOFFICE Docs</b> if you plan to use it instead of the default one. This can be easily done changing the mapping port during the installation:
By default <b>ONLYOFFICE Docs</b> listens to the incoming connections using port <b>80</b>. Starting from version <b>4.3</b>, you can change the port for <b>ONLYOFFICE Docs</b> if you plan to use it instead of the default one. This can be easily done changing the mapping port during the installation:
<div class="community_display">
<pre><code>sudo docker run -i -t -d -p &lt;PORT_NUMBER&gt;:80 --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver:latest</code></pre>
</div>

View File

@ -126,7 +126,7 @@ sudo systemctl restart docker.service
</div>
<p class="community_display">Use this command if you wish to install <b>ONLYOFFICE Docs</b> separately. To install <b>ONLYOFFICE Docs</b> integrated with <b>ONLYOFFICE Groups</b> and <b>ONLYOFFICE Mail</b>, refer to the corresponding instructions below.</p>
<div class="notehelp">
By default <b>ONLYOFFICE Docs</b> listens to the incoming connections using port <b>80</b>. Starting with version <b>4.3</b> you can change the port for <b>ONLYOFFICE Docs</b> if you plan to use it instead of the default one. This can be easily done changing the mapping port during the installation:
By default <b>ONLYOFFICE Docs</b> listens to the incoming connections using port <b>80</b>. Starting from version <b>4.3</b>, you can change the port for <b>ONLYOFFICE Docs</b> if you plan to use it instead of the default one. This can be easily done changing the mapping port during the installation:
<div class="community_display">
<pre><code>sudo docker run -i -t -d -p &lt;PORT_NUMBER&gt;:80 --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver</code></pre>
</div>

View File

@ -0,0 +1,371 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Installing ONLYOFFICE Docs for Docker on KylinOS";
MetaKeyWords = "";
MetaDescription = "";
var guides = new GuidesModel();
guides.TitleVideo = "How to deploy ONLYOFFICE Docs on your KylinOS server using Docker";
(Page as BasePage).Guides = guides;
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Installing ONLYOFFICE Docs <%= ((BasePage)Page).EditionVersion %> for Docker on KylinOS</h1>
<cc:localizecontent runat="Server" controlname="~/Controls/Help/VariousControls/Versions/DocumentServer/DocumentServerDocker_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/install-ONLYOFFICE/install-ONLYOFFICE.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/document-server/document-server.ascx" /></li>
<li class="enterprise_display">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/docs-enterprise/docs-enterprise.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Tags/docker-version/docker-version.ascx" /></li>
</ul>
</div>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="block_of_step">
<div class="video_text">
<p><b><%= ((BasePage)Page).EditionVersion %></b> allows you to install <b>ONLYOFFICE Docs</b> on your local server and integrate online editors with <span class="developer_display">your web application</span><span class="community_enterprise_display"><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/groups-index.aspx")%>">ONLYOFFICE collaboration platform</a> or <a href="<%=VirtualPathUtility.ToAbsolute("~/integration.aspx")%>">other popular systems</a></span>.</p>
<p><b>ONLYOFFICE Docs</b> is an online office suite comprising viewers and editors for texts, spreadsheets and presentations, fully compatible with Office Open XML formats: .docx, .xlsx, .pptx and enabling collaborative editing in real time.</p>
<p><b>Functionality</b></p>
<ul>
<li>Document Editor</li>
<li>Spreadsheet Editor</li>
<li>Presentation Editor</li>
<li>Mobile web viewers</li>
<li class="developer_enterprise_display">Mobile web editors</li>
<li>Collaborative editing</li>
<li>Hieroglyph support</li>
<li>Support for all the popular formats: DOC, DOCX, TXT, ODT, RTF, ODP, EPUB, ODS, XLS, XLSX, CSV, PPTX, HTML</li>
</ul>
<%--<div class="developer_enterprise_display">
<p><b>Pro features</b></p>
<ul>
<li></li>
</ul>
</div>--%>
<p>See the <a target="_blank" href="https://github.com/ONLYOFFICE/DocumentServer#onlyoffice-document-server-editions">detailed list of features</a> available for <b>ONLYOFFICE Docs</b> <b><%= ((BasePage)Page).EditionVersion %></b>.</p>
<div class="community_enterprise_display">
<p>Integrating it with <b>ONLYOFFICE Groups</b> you will be able to:</p>
<ul>
<li>share files;</li>
<li>manage access rights to documents;</li>
<li>embed documents on a website;</li>
<li>view and edit files stored on Drive, Box, Dropbox, OneDrive, OwnCloud connected to ONLYOFFICE.</li>
</ul>
</div>
<p>Starting from v7.2, <b>ONLYOFFICE Docs</b> Docker images are reworked for running on Kylin Linux Advanced Server OS release V10. This guide will show you how to install <b>ONLYOFFICE Docs</b> <b><%= ((BasePage)Page).EditionVersion %></b> Docker version on KylinOS.</p>
</div>
</div>
</div>
<h2 id="SystemRequirements">System requirements</h2>
<div class="block_of_step">
<div class="screen_text">
<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_RAM1/SysReqs_RAM1.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>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_OS2/SysReqs_OS2.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Common/SystemRequirements/SysReqs_Add_Soft5/SysReqs_Add_Soft5.ascx" /></li>
</ul>
</div>
</div>
<h2 id="Installing">Installing ONLYOFFICE Docs</h2>
<div class="block_of_step">
<div class="screen_text">
<div class="notehelp">You need the latest Docker version installed. If you do not have it, please see the <a target="_blank" href="http://docs.docker.com/installation/#installation">Installation section</a> on Docker website to learn how to get it.</div>
<div class="notehelp">
Docker specifies Google DNS servers by default. If your <b>ONLYOFFICE Docs</b> is not going to have access to the Internet, we recommend that you change the default Docker DNS address to the address of your local DNS server. To do that go to the <code>/etc/default/docker</code> file and change the IP address in the following line to the IP address of a DNS server in your local network:
<pre><code>docker_OPTS="--dns 8.8.8.8"
</code></pre>
<p>For the RPM based operating systems like CentOS:</p>
<ol>
<li>Create the <code>/etc/docker/daemon.json</code> configuration file with the following contents:
<pre><code>{ "dns" : [ "8.8.8.8" ] }
</code></pre>
</li>
<li>Restart the Docker service:
<pre><code>
sudo systemctl restart docker.service
</code></pre>
</li>
</ol>
</div>
<h5>Disable SELinux</h5>
<p>You need to disable <b>SELinux</b> in the <code>/etc/selinux/config</code> configuration file.</p>
<p>Open the <code>/etc/selinux/config</code> file using any text editor, replace the <code>SELINUX=enforcing</code> or <code>SELINUX=permissive</code> string with the <code>SELINUX=disabled</code> one and save the changes.</p>
<p>Reboot your server for the changes to take effect. Make sure that SELinux is disabled:</p>
<pre><code>[root@test ~]# sestatus
SELinux status: disabled
</code></pre>
<h5>Install ONLYOFFICE Docs</h5>
<p>Execute the following command to install <b>ONLYOFFICE Docs</b>:</p>
<div class="community_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver
</code></pre>
</div>
<div class="enterprise_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-ee
</code></pre>
</div>
<div class="developer_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-de
</code></pre>
</div>
<div class="notehelp nh_important">
<span class="important_notice_label">Important</span>
Starting from version 7.2, we added a random generation of JWT secret. If JWT secret is not specified with the environment variable, it leads to its re-generation during every VMs or physical server reboot, so there might be problems in integrations. To avoid this issue, specify your own value in <code>-e JWT_SECRET=my_jwt_secret</code>.
<p>If you are not going to use JWT in your installation, use <code>-e JWT_ENABLED=false</code>.</p>
</div>
<p>The <code>--security-opt seccomp=unconfined</code> key is required to disable security profiles for the container. More details can be found <a target="_blank" href="https://docs.docker.com/engine/security/seccomp/">here</a>.</p>
<%--<p class="community_display">Use this command to install <b>ONLYOFFICE Docs</b> separately. To install <b>ONLYOFFICE Docs</b> integrated with <b>ONLYOFFICE Groups</b> and <b>ONLYOFFICE Mail</b>, refer to the corresponding instructions below.--%></p>
<div class="notehelp">
By default <b>ONLYOFFICE Docs</b> listens to the incoming connections using port <b>80</b>. Starting from version <b>4.3</b>, you can change the port for <b>ONLYOFFICE Docs</b> if you plan to use it instead of the default one. This can be easily done changing the mapping port during the installation:
<div class="community_display">
<pre><code>sudo docker run -i -t -d -p &lt;PORT_NUMBER&gt;:80 --security-opt seccomp=unconfined --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver</code></pre>
</div>
<div class="enterprise_display">
<pre><code>sudo docker run -i -t -d -p &lt;PORT_NUMBER&gt;:80 --security-opt seccomp=unconfined --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-ee</code></pre>
</div>
<div class="developer_display">
<pre><code>sudo docker run -i -t -d -p &lt;PORT_NUMBER&gt;:80 --security-opt seccomp=unconfined --restart=always -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-de</code></pre>
</div>
Where <code>&lt;PORT_NUMBER&gt;</code> is the number of port you want <b>ONLYOFFICE Docs</b> to use.
</div>
<p>This will install <b>ONLYOFFICE Docs</b> and all the dependencies it needs (the list of what is being done by the script can be found <a target="_blank" href="https://github.com/ONLYOFFICE/Docker-DocumentServer/blob/master/Dockerfile">here</a>).</p>
<h5>Add a firewall exception</h5>
<p>You also need to add an exception to the <code>firewalld.service</code> service:</p>
<pre><code>sudo firewall-cmd --zone=public --add-port=80/tcp --permanent
sudo firewall-cmd --reload</code></pre>
<p>Once the configuration is finished, you can enter <a target="_blank" href="http://localhost">http://localhost</a> in your browser address bar to open the <b>ONLYOFFICE Docs</b> welcome page where you will find further instructions on how to enable document examples or integrate online editors into your web application using the <a href="http://api.onlyoffice.com/editors/basic"> provided API</a>.</p>
</div>
</div>
<h2 id="StoringData">Storing data outside containers</h2>
<div class="block_of_step">
<div class="screen_text">
<p>All the data are stored in the specially-designated directories, <b>data volumes</b>, at the following location:</p>
<ul>
<li><code>/var/log/onlyoffice</code> for <b>ONLYOFFICE Docs</b> logs</li>
<li><code>/var/www/onlyoffice/Data</code> for certificates</li>
<li><code>/var/lib/onlyoffice</code> for file cache</li>
<li><code>/var/lib/postgresql</code> for database</li>
</ul>
<div class="notehelp nh_important">
<span class="important_notice_label">We recommend</span>
We strongly recommend that you store the data outside the Docker containers on the host machine as it allows you to easily update <b>ONLYOFFICE Docs</b> once the new version is released without losing your data.
</div>
<p>To get access to your data located outside the container, you need to mount the volumes. It can be done by specifying the <b>-v</b> option in the docker run command.</p>
<div class="community_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/DocumentServer/lib:/var/lib/onlyoffice \
-v /app/onlyoffice/DocumentServer/db:/var/lib/postgresql -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver
</code></pre>
</div>
<div class="enterprise_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/DocumentServer/lib:/var/lib/onlyoffice \
-v /app/onlyoffice/DocumentServer/db:/var/lib/postgresql -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-ee
</code></pre>
</div>
<div class="developer_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/logs:/var/log/onlyoffice \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data \
-v /app/onlyoffice/DocumentServer/lib:/var/lib/onlyoffice \
-v /app/onlyoffice/DocumentServer/db:/var/lib/postgresql -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-de
</code></pre>
</div>
<div class="notehelp">Please note, that in case you are trying to mount the folders which are not yet created, these folders will be created but the access to them will be limited. You will need to change their access rights manually.</div>
<p>Normally, you do not need to store container data because the container operation does not depend on its state. Saving data will be useful:</p>
<ul>
<li>for easy access to container data, such as logs;</li>
<li>to remove the limit on the size of the data inside the container;</li>
<li>when using services launched outside the container such as PostgreSQL, Redis, RabbitMQ.</li>
</ul>
</div>
</div>
<h2 id="RunningHTTPS">Running ONLYOFFICE Docs using HTTPS</h2>
<div class="block_of_step">
<div class="screen_text">
<div class="community_display">
<pre><code>sudo docker run -i -t -d -p 443:443 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver
</code></pre>
</div>
<div class="enterprise_display">
<pre><code>sudo docker run -i -t -d -p 443:443 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-ee
</code></pre>
</div>
<div class="developer_display">
<pre><code>sudo docker run -i -t -d -p 443:443 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-de
</code></pre>
</div>
<p>Access to the onlyoffice application can be secured using SSL so as to prevent unauthorized access. While a CA certified SSL certificate allows for verification of trust via the CA, self signed certificates can also provide an equal level of trust verification as long as each client takes some additional steps to verify the identity of your website. Below the instructions on achieving this are provided.</p>
<p>To secure the application via SSL basically two things are needed:</p>
<ul>
<li><b>Private key (.key)</b></li>
<li><b>SSL certificate (.crt)</b></li>
</ul>
<p>So you need to create and install the following files:</p>
<pre><code>/app/onlyoffice/DocumentServer/data/certs/onlyoffice.key
/app/onlyoffice/DocumentServer/data/certs/onlyoffice.crt
</code></pre>
<p>When using CA certified certificates (e.g <a target="_blank" href="https://letsencrypt.org/">Let's Encrypt</a>), these files are provided to you by the CA. If you are using self-signed certificates, you need to generate these files <a href="#self-signed">yourself</a>.</p>
<h5 id="certbot">Switching ONLYOFFICE Docs to HTTPS using certbot</h5>
<p>The easiest way to switch <b>ONLYOFFICE Docs</b> to HTTPS is to automatically get <a target="_blank" href="https://letsencrypt.org/">Let's Encrypt</a> SSL Certificates using <a target="_blank" href="https://certbot.eff.org/">certbot</a>.</p>
<p>Run the ONLYOFFICE Docs Docker container specifying ports 80 and 443 and setting your own values for the variables:</p>
<div class="community_display">
<pre><code>sudo docker run -i -t -d -p 80:80 -p 443:443 --security-opt seccomp=unconfined --restart=always \
-e LETS_ENCRYPT_DOMAIN=yourdomain.com -e LETS_ENCRYPT_MAIL=email@example.com -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver
</code></pre>
</div>
<div class="enterprise_display">
<pre><code>sudo docker run -i -t -d -p 80:80 -p 443:443 --security-opt seccomp=unconfined --restart=always \
-e LETS_ENCRYPT_DOMAIN=yourdomain.com -e LETS_ENCRYPT_MAIL=email@example.com -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-ee
</code></pre>
</div>
<div class="developer_display">
<pre><code>sudo docker run -i -t -d -p 80:80 -p 443:443 --security-opt seccomp=unconfined --restart=always \
-e LETS_ENCRYPT_DOMAIN=yourdomain.com -e LETS_ENCRYPT_MAIL=email@example.com -e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-de
</code></pre>
</div>
<p>Where:</p>
<ul>
<li><b>LETS_ENCRYPT_DOMAIN</b> - a domain name to use for the certificate.</li>
<li><b>LETS_ENCRYPT_MAIL</b> - an email used for registration and recovery contact.</li>
</ul>
<p>The letsencrypt.org CA-signed certificate will be automatically generated and installed to your server. Now your <b>ONLYOFFICE Docs</b> should be available at the <span class="param-type">https://yourdomain.com</span> address.</p>
<h5 id="self-signed">Generation of self signed certificates</h5>
<p>Generation of self-signed SSL certificates involves a simple 3 step procedure</p>
<h6><b>STEP 1</b>: Create the server private key</h6>
<pre><code>openssl genrsa -out onlyoffice.key 2048
</code></pre>
<h6><b>STEP 2</b>: Create the certificate signing request (CSR)</h6>
<pre><code>openssl req -new -key onlyoffice.key -out onlyoffice.csr
</code></pre>
<h6><b>STEP 3</b>: Sign the certificate using the private key and CSR</h6>
<pre><code>openssl x509 -req -days 365 -in onlyoffice.csr -signkey onlyoffice.key -out onlyoffice.crt
</code></pre>
<p>You have now generated an SSL certificate that's valid for 365 days.</p>
<h5>Strengthening the server security</h5>
<p>This section provides you with instructions to <a target="_blank" href="https://raymii.org/s/tutorials/Strong_SSL_Security_On_nginx.html">strengthen your server security</a>.</p>
<p>To achieve this you need to generate stronger DHE parameters.</p>
<pre><code>openssl dhparam -out dhparam.pem 2048
</code></pre>
<h5>Installation of the SSL certificates</h5>
<p>Out of the four files generated above, you need to install the <code>onlyoffice.key</code>, <code>onlyoffice.crt</code> and <code>dhparam.pem</code> files at the onlyoffice server. The CSR file is not needed, but do make sure you safely backup the file (in case you ever need it again).</p>
<p>The default path that the onlyoffice application is configured to look for the SSL certificates is at <code>/var/www/onlyoffice/Data/certs</code>, this can however be changed using the <code>SSL_KEY_PATH</code>, <code>SSL_CERTIFICATE_PATH</code> and <code>SSL_DHPARAM_PATH</code> configuration options.</p>
<p>The <code>/var/www/onlyoffice/Data/</code> path is the path of the data store, which means that you have to create a folder named certs inside <code>/app/onlyoffice/DocumentServer/data/</code> and copy the files into it and as a measure of security you will update the permission on the <code>onlyoffice.key</code> file to only be readable by the owner.</p>
<pre><code>mkdir -p /app/onlyoffice/DocumentServer/data/certs
cp onlyoffice.key /app/onlyoffice/DocumentServer/data/certs/
cp onlyoffice.crt /app/onlyoffice/DocumentServer/data/certs/
cp dhparam.pem /app/onlyoffice/DocumentServer/data/certs/
chmod 400 /app/onlyoffice/DocumentServer/data/certs/onlyoffice.key
</code></pre>
<p>And restart Docker container:</p>
<pre><code>sudo docker restart {{DOCUMENT_SERVER_ID}}
</code></pre>
<p>You are now just one step away from having our application secured.</p>
<h5>Available configuration parameters</h5>
<div class="notehelp">Please refer the docker run command options for the <code>--env-file</code> flag where you can specify all required environment variables in a single file. This will save you from writing a potentially long docker run command.</div>
<p>Below is the complete list of parameters that can be set using environment variables.</p>
<ul>
<li><b>ONLYOFFICE_HTTPS_HSTS_ENABLED</b>: Advanced configuration option for turning off the HSTS configuration. Applicable only when SSL is in use. Defaults to <code>true</code>.</li>
<li><b>ONLYOFFICE_HTTPS_HSTS_MAXAGE</b>: Advanced configuration option for setting the HSTS max-age in the onlyoffice NGINX vHost configuration. Applicable only when SSL is in use. Defaults to <code>31536000</code>.</li>
<li><b>SSL_CERTIFICATE_PATH</b>: The path to the SSL certificate to use. Defaults to <code>/var/www/onlyoffice/Data/certs/tls.crt</code>.</li>
<li><b>SSL_KEY_PATH</b>: The path to the SSL certificate private key. Defaults to <code>/var/www/onlyoffice/Data/certs/tls.key</code>.</li>
<li><b>SSL_DHPARAM_PATH</b>: The path to the Diffie-Hellman parameter. Defaults to <code>/var/www/onlyoffice/Data/certs/dhparam.pem</code>.</li>
<li><b>SSL_VERIFY_CLIENT</b>: Enable verification of client certificates using the <code>CA_CERTIFICATES_PATH file</code>. Defaults to <code>false</code>.</li>
<li><b>DB_TYPE</b>: The database type. Supported values are <code>postgres</code>, <code>mariadb</code> or <code>mysql</code>. Defaults to <code>postgres</code>.</li>
<li><b>DB_HOST</b>: The IP address or the name of the host where the database server is running.</li>
<li><b>DB_PORT</b>: The database server port number.</li>
<li><b>DB_NAME</b>: The name of a database to be created on the image startup.</li>
<li><b>DB_USER</b>: The new user name with superuser permissions for the database account.</li>
<li><b>DB_PWD</b>: The password set for the database account.</li>
<li><b>AMQP_URI</b>: The <a target="_blank" href="http://www.rabbitmq.com/uri-spec.html">AMQP URI</a> to connect to the message broker server.</li>
<li><b>AMQP_TYPE</b>: The message broker type. Supported values are <code>rabbitmq</code> or <code>activemq</code>. Defaults to <code>rabbitmq</code>.</li>
<li><b>REDIS_SERVER_HOST</b>: The IP address or the name of the host where the Redis server is running.</li>
<li><b>REDIS_SERVER_PORT</b>: The Redis server port number.</li>
<li><b>NGINX_WORKER_PROCESSES</b>: Defines the number of NGINX worker processes.</li>
<li><b>NGINX_WORKER_CONNECTIONS</b>: Sets the maximum number of simultaneous connections that can be opened by a NGINX worker process.</li>
<li><b>SECURE_LINK_SECRET</b>: Defines secret for the nginx config directive <a target="_blank" href="https://nginx.org/en/docs/http/ngx_http_secure_link_module.html#secure_link_md5">secure_link_md5</a>. Defaults to <code>random string</code>.</li>
<li><b>JWT_ENABLED</b>: Specifies the enabling the JSON web token validation by <b>ONLYOFFICE Docs</b>. Defaults to <code>true</code>.</li>
<li><b>JWT_SECRET</b>: Defines the secret key to validate the JSON web token in the request to <b>ONLYOFFICE Docs</b>. Defaults to random value.</li>
<li><b>JWT_HEADER</b>: Defines the HTTP header that will be used to send the JSON web token. Defaults to <code>Authorization</code>.</li>
<li><b>JWT_IN_BODY</b>: Specifies the enabling the token validation in the request body to the <b>ONLYOFFICE Docs</b>. Defaults to <code>false</code>.</li>
<li><b>WOPI_ENABLED</b>: Specifies the enabling the wopi handlers. Defaults to <code>false</code>.</li>
<li><b>USE_UNAUTHORIZED_STORAGE</b>: Set to <code>true</code> if using self-signed certificates for your storage server, e.g. Nextcloud. Defaults to <code>false</code>.</li>
<li><b>GENERATE_FONTS</b>: When <code>true</code>, regenerates fonts list and the fonts thumbnails etc. at each start. Defaults to <code>true</code>.</li>
<li><b>METRICS_ENABLED</b>: Specifies the enabling StatsD for <b>ONLYOFFICE Docs</b>. Defaults to <code>false</code>.</li>
<li><b>METRICS_HOST</b>: Defines StatsD listening host. Defaults to <code>localhost</code>.</li>
<li><b>METRICS_PORT</b>: Defines StatsD listening port. Defaults to <code>8125</code>.</li>
<li><b>METRICS_PREFIX</b>: Defines StatsD metrics prefix for backend services. Defaults to <code>ds.</code>.</li>
<li><b>LETS_ENCRYPT_DOMAIN</b>: Defines the domain for Let's Encrypt certificate.</li>
<li><b>LETS_ENCRYPT_MAIL</b>: Defines the domain administrator mail address for Let's Encrypt certificate.</li>
</ul>
</div>
</div>
<%--<div class="community_display">
<h2 id="IntegratedInstallation">Installing ONLYOFFICE Docs integrated with ONLYOFFICE Groups and ONLYOFFICE Mail</h2>
<div class="block_of_step">
<div class="screen_text">
<p><b>ONLYOFFICE Docs</b> is a part of <b>ONLYOFFICE Workspace</b> that comprises also <b>ONLYOFFICE Community Server</b>, <b>ONLYOFFICE Control Panel</b> and <b>ONLYOFFICE Mail</b>. In case you want to install all of them and integrate with each other, read <a href="<%=VirtualPathUtility.ToAbsolute("~/server/docker/document/install-integrated.aspx")%>">these instructions</a>.</p>
</div>
</div>
<h2 id="AlternativeInstallation">Alternative ways to install ONLYOFFICE Docs</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Alternatively, you can use an automatic installation script to install the whole <b>Workspace</b> at once. For the mail server correct work you need to specify its hostname <code>yourdomain.com</code>.</p>
<h6><b>STEP 1</b>: Download the installation script file</h6>
<p>Execute the following command:</p>
<pre><code>wget https://download.onlyoffice.com/install/workspace-install.sh
</code></pre>
<h6><b>STEP 2</b>: Install Workspace</h6>
<p>Run the following command to do that:</p>
<pre><code>bash workspace-install.sh -md yourdomain.com
</code></pre>
<p>Or you can use <a target="_blank" href="https://docs.docker.com/compose/install/#installing-compose">docker-compose</a> to install <b>ONLYOFFICE Docs</b>. See the <a href="<%=VirtualPathUtility.ToAbsolute("~/server/docker/document/docker-compose.aspx")%>">instructions here</a> on how to do that.</p>
</div>
</div>
</div>--%>
<div class="developer_enterprise_display">
<h2 id="Registering">Registering your <span class="developer_display">Developer Edition</span><span class="enterprise_display">Enterprise Edition</span> version</h2>
<div class="block_of_step">
<div class="screen_text">
<p>If you bought <b class="developer_display">Developer Edition</b><b class="enterprise_display">Enterprise Edition</b> and received the <b>license.lic</b> file, you can place it to your installation to obtain the software full version.</p>
<p>When you are using the docker container, the <b>license.lic</b> file can be placed to any folder (e.g. <code>/app/onlyoffice/DocumentServer/data/license.lic</code>), but you will need to mount this folder when the container starts:</p>
<div class="enterprise_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data \
-e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-ee
</code></pre>
</div>
<div class="developer_display">
<pre><code>sudo docker run -i -t -d -p 80:80 --security-opt seccomp=unconfined --restart=always \
-v /app/onlyoffice/DocumentServer/data:/var/www/onlyoffice/Data \
-e JWT_SECRET=my_jwt_secret onlyoffice/documentserver-de
</code></pre>
</div>
<p>After that your version of <b class="developer_display">Developer Edition</b><b class="enterprise_display">Enterprise Edition</b> will become registered and full-featured.</p>
</div>
</div>
</div>
</div>

View File

@ -0,0 +1,23 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocsArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "Community Edition"; %>
<body class="docker_version document_server docs_community_edition">
</asp:Content>
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/VariousControls/TopControls/DocumentDockerTop/DocumentDockerTop.ascx" />
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Docker/Document/KylinOS/KylinOS.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspage documents">
<div id="SeeAlsoBlockLinks">
<div class="caption guides">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/070_configuration.ascx" />
</div>
<div class="caption video">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/130_docker_install.ascx" />
</div>
</div>
</asp:Content>

View File

@ -0,0 +1,23 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocsDEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "Developer Edition"; %>
<body class="docker_version developer_edition">
</asp:Content>
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/VariousControls/TopControls/DeveloperEditionTop/DeveloperEditionTop.ascx" />
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Docker/Document/KylinOS/KylinOS.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspage documents">
<div id="SeeAlsoBlockLinks">
<div class="caption guides">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/070_configuration.ascx" />
</div>
<div class="caption video">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/130_docker_install.ascx" />
</div>
</div>
</asp:Content>

View File

@ -0,0 +1,23 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocsEEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "Enterprise Edition"; %>
<body class="docker_version docs_enterprise_edition">
</asp:Content>
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/VariousControls/TopControls/DocsEnterpriseDockerTop/DocsEnterpriseDockerTop.ascx" />
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Docker/Document/KylinOS/KylinOS.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspage documents">
<div id="SeeAlsoBlockLinks">
<div class="caption guides">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/070_configuration.ascx" />
</div>
<div class="caption video">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/Video/130_docker_install.ascx" />
</div>
</div>
</asp:Content>