Add new article docs-configure-ipfilter.aspx

This commit is contained in:
Svetlana Maleeva 2023-05-16 18:40:03 +03:00
parent 55a9b72804
commit 2afa3aa1ad
7 changed files with 107 additions and 0 deletions

View File

@ -48,6 +48,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerWindows/50031_add_plugins.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/205_configure_jwt.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>System requirements</h6>
@ -163,6 +164,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190005_third_party_domains.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/205_configure_jwt.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>System requirements</h6>
@ -270,6 +272,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150009_third_party_domains.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/205_configure_jwt.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>Developing</h6>

View File

@ -46,6 +46,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerWindows/50031_add_plugins.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/205_configure_jwt.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>System requirements</h6>

View File

@ -39,6 +39,7 @@
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-developer-configuring.aspx")%>">Configuring ONLYOFFICE Docs Developer Edition</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/205_configure_jwt.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>Developing</h6>

View File

@ -38,6 +38,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190005_third_party_domains.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/205_configure_jwt.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>System requirements</h6>

View File

@ -465,6 +465,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerWindows/50031_add_plugins.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/GettingStarted/205_configure_jwt.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>System requirements</h6>
@ -579,6 +580,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190004_docs_ee_openports/190004_docs_ee_openports.ascx" /></li>
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DocsEnterprise/190005_third_party_domains.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>System requirements</h6>
@ -686,6 +688,7 @@
<li><cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/DeveloperEdition/150009_third_party_domains.ascx" /></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-developer-configuring.aspx")%>">Configuring ONLYOFFICE Docs Developer Edition</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-connect-amazon.aspx")%>">Connecting Amazon S3 bucket as a cache to ONLYOFFICE Docs</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-ipfilter.aspx")%>">Configuring IP filter for ONLYOFFICE Docs</a></li>
</ul>
</li>
<li><h6>Developing</h6>

View File

@ -0,0 +1,78 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Configuring IP filter for ONLYOFFICE Docs";
MetaKeyWords = "ONLYOFFICE Docs, ipfilter, IP filter";
MetaDescription = "Configure IP filter for ONLYOFFICE Docs";
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption TipsCaption">Configuring IP filter for ONLYOFFICE Docs</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/document-server/document-server.ascx" /></li>
</ul>
</div>
<div class="block_of_step">
<p>You can configure IP filter for <b>ONLYOFFICE Docs</b>.</p>
<p>The IP filter settings are stored in the ONLYOFFICE Docs configuration file: <code>/etc/onlyoffice/documentserver/default.json</code>. They look like this:</p>
<pre><code>"ipfilter": {
"rules": [
{
"address": "162.243.205.250",
"allowed": true
},
{
"address": "*",
"allowed": false
}
],
"useforrequest": false,
"errorcode": 403
}
</code></pre>
<p>A rule consists of two parts: the host name and the <code>allowed</code> rule itsef which has the <code>true</code> of <code>false</code> value. By default, one rule exists: <code>address * allowed true</code>.</p>
<p>An address can be specified in the following ways:</p>
<ul>
<li>An IP address in the <code>X.X.X.X</code> format for ipv4.</li>
<li>An IP address in the <code>xxxx.xxxx.xxxx.xxxx.xxxx.xxxx.xxxx.xxxx</code> format for ipv6.</li>
<li>A DNS name.</li>
</ul>
<p>It's also possible to use the <code>*</code> wildcard character. It replaces any character any number of times.</p>
<p>The host name in links is checked as a DNS address at first, if it does not match any rule, the IP address is found by the name and the check is performed once again.</p>
<div class="notehelp nh_important"><span class="important_notice_label">Important</span>If the <code>"useforrequest": true</code> check is enabled, the <code>address</code> parameter must be specified as an IP address, not a DNS name.</div>
<h4>"useforrequest": true/false</h4>
<p>By default, the <code>useforrequest</code> parameter is set to <code>false</code>. In this case, the text URLs which come to ONLYOFFICE Docs as parameters are checked:</p>
<ul>
<li>Links for downloading a file: <a target="_blank" href="https://api.onlyoffice.com/editors/config/document#url">opening</a>, <a target="_blank" href="https://api.onlyoffice.com/editors/conversionapi#url">conversion</a>, <a target="_blank" href="https://api.onlyoffice.com/editors/documentbuilderapi#url">docbuilder</a>, etc.</li>
<li>A subscription to the editor events <a target="_blank" href="https://api.onlyoffice.com/editors/config/editor#callbackUrl">callbackUrl</a>.</li>
<li>WOPI <a target="_blank" href="https://api.onlyoffice.com/editors/wopi/hostpage">actionUrl</a>.</li>
</ul>
<p>If the <code>useforrequest</code> parameter is set to <code>true</code> (not recommended), the client IP address in the following http requests is additionally checked:</p>
<ul>
<li><code>coauthoring/CommandService.ashx</code></li>
<li><code>ConvertService.ashx</code></li>
<li><code>converter</code></li>
<li><code>FileUploader.ashx</code></li>
<li><code>healthcheck</code></li>
<li><code>docbuilder</code></li>
<li><code>info/info.json</code></li>
<li><code>internal/cluster/inactive</code></li>
<li><code>hosting/discovery</code></li>
<li><code>hosting/capabilities</code></li>
<li><code>lool/convert-to/:format?</code></li>
<li><code>dummyCallback</code></li>
</ul>
<p>For these requests, an error is returned with the code specified in the <code>errorcode</code> parameter.</p>
<div class="notehelp nh_important"><span class="important_notice_label">Important</span>Only the IP address of the storage that ONLYOFFICE Docs can see (taking into account the x-forwarded headers) is checked.
<p>E.g., if ONLYOFFICE Docs and the test example are installed on the same machine, the client IP address will be the address of the internal network. ONLYOFFICE Docs can't find out the host of the client, so it's not possible to use a DNS name in the <code>address</code> field with this setting. It's recommended to leave this setting with the default value and perform checks at the proxy level.</p>
</div>
</div>
</div>

View File

@ -0,0 +1,20 @@
<%@ 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">
<body class="common_all_os document_server installation_docs">
</asp:Content>
<asp:Content ID="content3" ContentPlaceHolderID="breadstop" runat="server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/VariousControls/TopControls/DocumentServerTop/DocumentServerTop.ascx" />
</asp:Content>
<asp:Content ID="Content1" ContentPlaceHolderID="content" runat="Server">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/Server/Document/ConfigureIPFilter/ConfigureIPFilter.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="guidespage document">
<div id="SeeAlsoBlockLinks">
<div class="caption guides">
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerLinux/60007_connect_document_to_community.ascx" />
<cc:LocalizeContent runat="Server" ControlName="~/Controls/Help/ArticlesCompleteList/ServerLinux/60002_community_installation.ascx" />
</div>
</div>
</asp:Content>