Add new articles about switching DocSpace to HTTPS

This commit is contained in:
Svetlana Maleeva 2023-09-25 11:26:01 +03:00
parent 95b02790bb
commit bfad269e32
14 changed files with 408 additions and 3 deletions

View File

@ -49,6 +49,25 @@
</ul>
</li>
</ul>
</li>
<li><h6>Configuring</h6>
<ul>
<li>1-click install for Docker
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-docker.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS when installing using Docker</a></li>
</ul>
</li>
<li>Linux version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-linux.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS when installing from RPM/DEB packages</a></li>
</ul>
</li>
<li>Windows version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-windows.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS for the Windows version</a></li>
</ul>
</li>
</ul>
</li>
</ul>

View File

@ -54,6 +54,25 @@
<li>Coming soon</li>
</ul>
</li>--%>
<li><h6>Configuring</h6>
<ul>
<li>1-click install for Docker
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-docker.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS when installing using Docker</a></li>
</ul>
</li>
<li>Linux version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-linux.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS when installing from RPM/DEB packages</a></li>
</ul>
</li>
<li>Windows version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-windows.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS for the Windows version</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a href="<%=VirtualPathUtility.ToAbsolute("~/faq/faq.aspx")%>">FAQ</a></h2>

View File

@ -49,7 +49,26 @@
</ul>
</li>
</ul>
</li>
</li>
<li><h6>Configuring</h6>
<ul>
<li>1-click install for Docker
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-docker.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS when installing using Docker</a></li>
</ul>
</li>
<li>Linux version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-linux.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS when installing from RPM/DEB packages</a></li>
</ul>
</li>
<li>Windows version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-windows.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS for the Windows version</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-index.aspx")%>">ONLYOFFICE DocSpace Enterprise</a></h2>
<ul>
@ -84,6 +103,25 @@
<li>Coming soon</li>
</ul>
</li>--%>
<li><h6>Configuring</h6>
<ul>
<li>1-click install for Docker
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-docker.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS when installing using Docker</a></li>
</ul>
</li>
<li>Linux version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-linux.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS when installing from RPM/DEB packages</a></li>
</ul>
</li>
<li>Windows version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-windows.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS for the Windows version</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-cloud-index.aspx")%>">ONLYOFFICE DocSpace Cloud Service (SaaS version)</a></h2>

View File

@ -478,7 +478,26 @@
</ul>
</li>
</ul>
</li>
</li>
<li><h6>Configuring</h6>
<ul>
<li>1-click install for Docker
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-docker.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS when installing using Docker</a></li>
</ul>
</li>
<li>Linux version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-linux.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS when installing from RPM/DEB packages</a></li>
</ul>
</li>
<li>Windows version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-https-windows.aspx")%>">Switching your ONLYOFFICE DocSpace Community to HTTPS for the Windows version</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-index.aspx")%>">ONLYOFFICE DocSpace Enterprise</a></h2>
<ul>
@ -513,6 +532,25 @@
<li>Coming soon</li>
</ul>
</li>--%>
<li><h6>Configuring</h6>
<ul>
<li>1-click install for Docker
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-docker.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS when installing using Docker</a></li>
</ul>
</li>
<li>Linux version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-linux.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS when installing from RPM/DEB packages</a></li>
</ul>
</li>
<li>Windows version
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-https-windows.aspx")%>">Switching your ONLYOFFICE DocSpace Enterprise to HTTPS for the Windows version</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h2><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-cloud-index.aspx")%>">ONLYOFFICE DocSpace Cloud Service (SaaS version)</a></h2>

View File

@ -417,6 +417,11 @@
<td><b>MySQL</b> server host</td>
<td><code>localhost</code></td>
</tr>
<tr>
<td><code>-mysqlport, --mysqlport</code></td>
<td><b>MySQL</b> server port number</td>
<td><code>3306</code></td>
</tr>
</tbody>
</table>
<p>If you do not explicitly specify these parameters, the default values are used.</p>
@ -461,6 +466,42 @@
</div>
</div>
<h2 id="HTTPS">Switching to HTTPS</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
</tr>
<tr>
<td><code>-led, --letsencryptdomain</code></td>
<td>defines the domain for the Let's Encrypt certificate</td>
</tr>
<tr>
<td><code>-lem, --letsencryptmail</code></td>
<td>defines the domain administator mail address for the Let's Encrypt certificate</td>
</tr>
<tr>
<td><code>-cf, --certfile</code></td>
<td>path to the certificate file for the domain</td>
</tr>
<tr>
<td><code>-ckf, --certkeyfile</code></td>
<td>path to the private key file for the certificate</td>
</tr>
</tbody>
</table>
<p>These parameters allow you to switch the portal to HTTPS. They can be used for the Docker version only.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh --letsencryptmail user@example.com --letsencryptdomain yourdomain.com</code></pre>
<p>This will automatically create and install the <a target="_blank" href="https://letsencrypt.org/">letsencrypt.org</a> CA-signed certificate to your server and restart the NGINX service for the changes to take effect.</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh --certfile path --certkeyfile path</code></pre>
<p>This will apply your own SSL certificate.</p>
</div>
</div>
</div>

View File

@ -0,0 +1,59 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Switching your DocSpace to HTTPS when installing using Docker";
MetaKeyWords = "";
MetaDescription = "";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Switching your <%= ((BasePage)Page).EditionVersion %> to HTTPS when installing using Docker</h1>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="block_of_step">
<div class="screen_text">
<p>When you install <b><%= ((BasePage)Page).EditionVersion %></b> using Docker, you can use the <a target="_blank" href="https://letsencrypt.org/">letsencrypt.org</a> service and script to easily create a CA-signed certificate and switch the portal to HTTPS with a single command.</p>
<p>The article below will explain this can be done.</p>
</div>
</div>
</div>
<h2 id="CreateCertificate">Creating and installing CA-signed certificate</h2>
<div class="block_of_step">
<div class="screen_text">
<p>To create the letsencrypt certificate, run the installation script with the following parameters:</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh --letsencryptmail user@example.com --letsencryptdomain yourdomain.com</code></pre>
<p>Where:</p>
<ul>
<li><code>letsencryptmail</code> is the email used for registration and recovery contact. Use comma to register multiple emails, for example: u1@example.com,u2@example.com.</li>
<li><code>letsencryptdomain</code> is the address of the domain where your <b><%= ((BasePage)Page).EditionVersion %></b> portal is installed.</li>
</ul>
<p>The script will automatically create and install the <a target="_blank" href="https://letsencrypt.org/">letsencrypt.org</a> CA-signed certificate to your server and restart the NGINX service for the changes to take effect.</p>
<p>Alternatively, you can launch switching to HTTPS manually from the <code>/app/onlyoffice/config/docspace-ssl-setup</code> file:</p>
<pre><code>bash /app/onlyoffice/config/docspace-ssl-setup --letsencryptmail user@example.com --letsencryptdomain yourdomain.com</code></pre>
<p>Now your portal should be available via the <span class="param-type">https://</span> address.</p>
</div>
</div>
<h2 id="OwnCertificate">Using own certificates</h2>
<div class="block_of_step">
<div class="screen_text">
<p>To use your own certificates, run the installation script with the following parameters:</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh --certfile path --certkeyfile path</code></pre>
<p>Where:</p>
<ul>
<li><code>certfile</code> is the path to the certificate file for the domain.</li>
<li><code>certkeyfile</code> is the path to the private key file for the certificate.</li>
</ul>
<p>Alternatively, you can launch switching to HTTPS manually from the <code>/app/onlyoffice/config/docspace-ssl-setup</code> file:</p>
<pre><code>bash /app/onlyoffice/config/docspace-ssl-setup --certfile path --certkeyfile path</code></pre>
<p>Now your portal should be available via the <span class="param-type">https://</span> address.</p>
</div>
</div>
</div>

View File

@ -0,0 +1,55 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Switching your DocSpace to HTTPS when installing from RPM/DEB packages";
MetaKeyWords = "";
MetaDescription = "";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Switching your <%= ((BasePage)Page).EditionVersion %> to HTTPS when installing from RPM/DEB packages</h1>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="block_of_step">
<div class="screen_text">
<p>When you install <b><%= ((BasePage)Page).EditionVersion %></b> from RPM/DEB packages, you can use the <a target="_blank" href="https://letsencrypt.org/">letsencrypt.org</a> service and script to easily create a CA-signed certificate and switch the portal to HTTPS with a single command.</p>
<p>The article below will explain this can be done.</p>
</div>
</div>
</div>
<h2 id="CreateCertificate">Creating and installing CA-signed certificate</h2>
<div class="block_of_step">
<div class="screen_text">
<p>Run the following script:</p>
<pre><code>bash /usr/bin/docspace-ssl-setup EMAIL DOMAIN</code></pre>
<p>Where:</p>
<ul>
<li><code>EMAIL</code> is the email used for registration and recovery contact. Use comma to register multiple emails, for example: u1@example.com,u2@example.com.</li>
<li><code>DOMAIN</code> is the address of the domain where your <b><%= ((BasePage)Page).EditionVersion %></b> portal is installed.</li>
</ul>
<p>The script will automatically create and install the <a target="_blank" href="https://letsencrypt.org/">letsencrypt.org</a> CA-signed certificate to your server and restart the NGINX service for the changes to take effect.</p>
<p>Now your portal should be available via the <span class="param-type">https://</span> address.</p>
</div>
</div>
<h2 id="OwnCertificate">Using own certificates</h2>
<div class="block_of_step">
<div class="screen_text">
<p>You can use your own certificates via the -f parameter:</p>
<pre><code>bash /usr/bin/docspace-ssl-setup -f CERTIFICATE PRIVATEKEY</code></pre>
<p>Where:</p>
<ul>
<li><code>CERTIFICATE</code> is the path to the certificate file for the domain.</li>
<li><code>PRIVATEKEY</code> is the path to the private key file for the certificate.</li>
</ul>
<p>Now your portal should be available via the <span class="param-type">https://</span> address.</p>
</div>
</div>
</div>

View File

@ -0,0 +1,62 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Switching your DocSpace to HTTPS for the Windows version";
MetaKeyWords = "";
MetaDescription = "";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Switching your <%= ((BasePage)Page).EditionVersion %> to HTTPS for the Windows version</h1>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="block_of_step">
<div class="screen_text">
<p>When you install <b><%= ((BasePage)Page).EditionVersion %></b> on Windows, you can use the <a target="_blank" href="https://letsencrypt.org/">letsencrypt.org</a> service and script to easily create a CA-signed certificate and switch the portal to HTTPS with a single command.</p>
<p>The article below will explain this can be done.</p>
</div>
</div>
</div>
<h2 id="CreateCertificate">Creating and installing CA-signed certificate</h2>
<div class="block_of_step">
<div class="screen_text">
<div class="notehelp">You need <b>PowerShell version 5.1</b> or later installed on your computer.</div>
<p>Run <b>Windows PowerShell</b> as administrator. By default, <b>PowerShell</b> is installed at the following path:</p>
<pre><code>C:\Windows\System32\WindowsPowerShell\v1.0\powershell.exe</code></pre>
<p>In the <b>PowerShell</b> console, go to the <code>\sbin\</code> directory. To do that, use the following command:</p>
<pre><code>cd "C:\Program Files (x86)\Ascensio System SIA\DocSpace\sbin"</code></pre>
<p>Run the following script:</p>
<pre><code>./docspace-ssl-setup.ps1 EMAIL DOMAIN</code></pre>
<p>Where:</p>
<ul>
<li><code>EMAIL</code> is the email used for registration and recovery contact. Use comma to register multiple emails, for example: u1@example.com,u2@example.com.</li>
<li><code>DOMAIN</code> is the address of the domain where your <b><%= ((BasePage)Page).EditionVersion %></b> portal is installed.</li>
</ul>
<div class="notehelp">Check <b>A records</b> for your domain (e.g. using the <code>ping</code> command), otherwise the certificate will not be issued.</div>
<p>The script will create and install the CA-signed certificate to your server.</p>
<p>Now your portal should be available via the <span class="param-type">https://</span> address.</p>
<div class="notehelp">A task of automatic certificate prolongation will be added to the task scheduler. You will not need to re-run the script when the certificate expires.</div>
</div>
</div>
<h2 id="OwnCertificate">Using own certificates</h2>
<div class="block_of_step">
<div class="screen_text">
<p>You can use your own certificates via the -f parameter:</p>
<pre><code>./docspace-ssl-setup.ps1 -f CERTIFICATE PRIVATEKEY</code></pre>
<p>Where:</p>
<ul>
<li><code>CERTIFICATE</code> is the path to the certificate file for the domain.</li>
<li><code>PRIVATEKEY</code> is the path to the private key file for the certificate.</li>
</ul>
<p>Now your portal should be available via the <span class="param-type">https://</span> address.</p>
</div>
</div>
</div>

View File

@ -0,0 +1,13 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocSpaceEEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "ONLYOFFICE DocSpace Community"; %>
<% ((BasePage)Page).CommandName = "docspace"; %>
<body class="docker_version docspace_community_edition">
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:localizecontent runat="Server" controlname="~/Controls/Help/Server/DocSpace/HTTPSDSDocker/HTTPSDSDocker.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>

View File

@ -0,0 +1,12 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocSpaceEEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "ONLYOFFICE DocSpace Community"; %>
<body class="linux_version docspace_community_edition">
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:localizecontent runat="Server" controlname="~/Controls/Help/Server/DocSpace/HTTPSDSLinux/HTTPSDSLinux.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>

View File

@ -0,0 +1,12 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocSpaceEEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "ONLYOFFICE DocSpace Community"; %>
<body class="windows_version docspace_community_edition">
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:localizecontent runat="Server" controlname="~/Controls/Help/Server/DocSpace/HTTPSDSWindows/HTTPSDSWindows.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>

View File

@ -0,0 +1,13 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocSpaceEEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "ONLYOFFICE DocSpace Enterprise"; %>
<% ((BasePage)Page).CommandName = "docspace-enterprise"; %>
<body class="docker_version docspace_enterprise_edition">
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:localizecontent runat="Server" controlname="~/Controls/Help/Server/DocSpace/HTTPSDSDocker/HTTPSDSDocker.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>

View File

@ -0,0 +1,12 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocSpaceEEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "ONLYOFFICE DocSpace Enterprise"; %>
<body class="linux_version docspace_enterprise_edition">
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:localizecontent runat="Server" controlname="~/Controls/Help/Server/DocSpace/HTTPSDSLinux/HTTPSDSLinux.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>

View File

@ -0,0 +1,12 @@
<%@ Page Title="" Language="C#" MasterPageFile="~/Masters/InstallationGuides/InstallationDocSpaceEEArticles.master" %>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<asp:Content ID="Content4" ContentPlaceHolderID="pagebodyidpage" runat="Server">
<% ((BasePage)Page).EditionVersion = "ONLYOFFICE DocSpace Enterprise"; %>
<body class="windows_version docspace_enterprise_edition">
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:localizecontent runat="Server" controlname="~/Controls/Help/Server/DocSpace/HTTPSDSWindows/HTTPSDSWindows.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>