Edit DocSpaceWebhooks.ascx, DocSpaceSSODescription.ascx, DocSpaceSettings.ascx

This commit is contained in:
Svetlana Maleeva 2023-10-19 15:50:07 +03:00
parent d88d9c269c
commit 5e7dd9f149
12 changed files with 106 additions and 8 deletions

View File

@ -452,7 +452,7 @@
<li>in the <b>Check period (sec)</b> field, set up the time interval for counting unsuccessful login attempts.</li>
</ol>
<p>When the specified limit of unsuccessful login attempts is reached, attempts coming from the associated IP address will be banned (or, in the SaaS version, captcha will be requested) for the chosen period of time.</p>
<p>By default, this feature is disabled in the server version. If the you want to use it, it's necessary to enable the feature in the configuration file. To learn more, read the following <a class="links" target="_blank" href="<%=VirtualPathUtility.ToAbsolute("~/administration/configure-recaptcha.aspx")%>">article</a>.</p>
<p>By default, this feature is disabled in the server version. If you want to use it, it's necessary to enable the feature in the configuration file. To learn more, read the following <a class="links" target="_blank" href="<%=VirtualPathUtility.ToAbsolute("~/administration/configure-recaptcha.aspx")%>">article</a>.</p>
<div class="inner_delimiter"></div>
<h5 id="administratormessage">Administrator message settings</h5>

View File

@ -27,6 +27,7 @@
<li><span class="gs_link" id="CreatingBackup">Creating backup</span></li>
<li><span class="gs_link" id="RestoringBackup">Restoring backup</span></li>
<li><span class="gs_link" id="AdjustingIntegrationSettings">Adjusting Integration settings</span></li>
<li><span class="gs_link" id="AdjustingDeveloperTools">Using Developer Tools</span></li>
<li><span class="gs_link" id="DeactivatingDeletingDocSpace">Deactivating/deleting DocSpace</span></li>
</ul>
@ -58,6 +59,7 @@
<li>turn on <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#tfauthentication")%>">two-factor authentication</a>;</li>
<li>specify <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#TrustedDomain")%>">mail servers</a> allowed for user self-registration;</li>
<li>adjust the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#ipsecurity")%>">IP security</a> settings;</li>
<li>set up the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#BruteForceProtection")%>">Brute Force Protection</a> settings;</li>
<li>change the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#administratormessage")%>">administrator message</a> settings;</li>
<li>set the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#sessionlifetime")%>">session lifetime</a>;</li>
</ul>
@ -78,11 +80,14 @@
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#thirdparty")%>"><b>Third-party services</b></a> - connect third-party services for storing documents and accessing DocSpace via these services;</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#sso")%>"><b>Single Sign-On</b></a> - enable the SSO settings;</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#smtp")%>"><b>SMTP settings</b></a> - adjust the SMTP settings so that the email notifications to be sent using your own SMTP server;</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#smtp")%>"><b>SMTP settings</b></a> - adjust the SMTP settings so that the email notifications to be sent using your own SMTP server;</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#documentservice")%>"><b>Document Service</b></a> - (in the server version only) connect ONLYOFFICE Docs;</li>
</ul>
<p><b>Developer Tools</b></p>
<ul>
<li><b>Developer Tools</b> use the ONLYOFFICE DocSpace SDK based on JavaScript which allows developers to use all the DocSpace possibilities with api.js. You can integrate ONLYOFFICE DocSpace into your own web application, allowing users to create and submit documents directly from your website. For more details, please refer to <a class="see_also" href="https://api.onlyoffice.com/"><b>api.onlyoffice.com</b></a>.</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#jssdk")%>"><b>JavaScript SDK</b></a> use the <b>ONLYOFFICE DocSpace SDK</b> based on JavaScript which allows developers to use all the DocSpace possibilities with api.js.</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#webhooks")%>"><b>Webhooks</b></a> use webhooks to perform custom actions on the side of any application or website you are using based on various events in ONLYOFFICE DocSpace.</li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#plugins")%>"><b>Plugins</b></a> (BETA) add plugins to extend the functionality of DocSpace with extra features.</li>
</ul>
<p><b>DocSpace Deletion</b></p>
<ul>
@ -309,6 +314,18 @@
</ol>
<p>If necessary, you can delete the added IP addresses by clicking the corresponding <img alt="Remove Icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsdelete.png")%>" /> icon to the right of the IP address. To disable this option again, just check the <b>Disable</b> radio button and click the <b>Save</b> button.</p>
<div class="inner_delimiter"></div>
<h5 id="BruteForceProtection">Brute Force Protection Settings</h5>
<p>This section allows you to protect the portal against brute-force attacks.</p>
<ol>
<li>in the <b>Number of attempts</b> field, set up the limit of unsuccessful login attempts by the user;</li>
<li>in the <b>Blocking time (sec)</b> field, set up the time interval for blocking new login attempts;</li>
<li>in the <b>Check period (sec)</b> field, set up the time interval for counting unsuccessful login attempts.</li>
</ol>
<p>When the specified limit of unsuccessful login attempts is reached, attempts coming from the associated IP address will be banned (or, in the SaaS version, captcha will be requested) for the chosen period of time.</p>
<p>By default, this feature is disabled in the server version. If you want to use it, it's necessary to enable the feature in the configuration file. To learn more, read the following <a class="links" target="_blank" href="<%=VirtualPathUtility.ToAbsolute("~/administration/configure-recaptcha.aspx")%>">article</a>.</p>
<div class="inner_delimiter"></div>
<h5 id="administratormessage">Administrator message settings</h5>
<p>This section allows you to display the contact form on the <b>Sign In</b> page so that people can send a message to the DocSpace administrator in case they have troubles while accessing DocSpace.</p>
<p>To enable it, just check the corresponding radio button and click the <b>Save</b> button at the bottom of the section to apply the changes you made.</p>
@ -446,7 +463,7 @@
<div class="gs_content" id="AdjustingIntegrationSettings_block">
<h2>Integration settings</h2>
<div class="PortalHelp">
<p>The <b>Integration</b> section is used to integrate DocSpace with <b>third-party services</b>, enable the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#sso")%>"><b>SSO</b></a> settings and adjust the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#smtp")%>"><b>SMTP</b></a> settings.</p>
<p>The <b>Integration</b> section is used to integrate DocSpace with <b>third-party services</b>, enable the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#sso")%>"><b>SSO</b></a> settings and adjust the <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#smtp")%>"><b>SMTP</b></a> settings. In the server version, you can also <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#documentservice")%>"><b>connect ONLYOFFICE Docs</b></a>.</p>
<h5 id="thirdparty">Third-party service integration</h5>
<p>Use Authorization keys to connect your DocSpace with third-party services: <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-amazon-docspace.aspx")%>">Amazon AWS S3</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-box-docspace.aspx")%>">Box.com</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-dropbox-docspace.aspx")%>">DropBox</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-facebook-docspace.aspx")%>">Facebook</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-google-docspace.aspx")%>">Google</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-google-cloud-storage-docspace.aspx")%>">Google Cloud Storage</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-linkedin-docspace.aspx")%>">LinkedIn</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-onedrive-docspace.aspx")%>">OneDrive</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-rackspace-docspace.aspx")%>">Rackspace Cloud Storage</a>, <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/connect-selectel-docspace.aspx")%>">Selectel Cloud Storage</a>.</p>
@ -497,11 +514,77 @@
<img alt="Adjusting SMTP Settings" target="img12_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/small/SMTP.png")%>" />
<img alt="Adjusting SMTP Settings" id="img12_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/big/SMTP.png")%>" />
<div target="img12_eventcom_guides" class="screenphoto magnifier"></div>
</div>
</div>
<div class="inner_delimiter"></div>
<h5 id="documentservice">Document Service settings</h5>
<p>The <b>Document Service</b> subsection allows you to connect ONLYOFFICE Docs (in the server version only). To do that: </p>
<ol>
<li>Go to the DocSpace <b>Settings</b> and select the <b>Integration</b> -> <b>Document Service</b> section.</li>
<li>Fill in all the fields with the appropriate <b>ONLYOFFICE Docs</b>/<b>ONLYOFFICE DocSpace</b> addresses.
<ul>
<li>If your <b>ONLYOFFICE Docs</b>/<b>ONLYOFFICE DocSpace</b> installations are not switched to https, please, make sure that you specify <code>http</code> in the addresses.</li>
</ul>
</li>
<li>Save the settings by clicking the <b>Save</b> button.</li>
</ol>
<div class="screen_block">
<img alt="Connecting ONLYOFFICE Docs" target="img13_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/small/ConnectDocs.png")%>" />
<img alt="Connecting ONLYOFFICE Docs" id="img13_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/big/ConnectDocs.png")%>" />
<div target="img13_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<div class="notehelp">Starting from ONLYOFFICE Docs <b>v7.2</b>, JWT is enabled by default and the secret key is generated automatically. You need to specify the JWT parameters in the ONLYOFFICE Groups configuration file as well. For more details, see this <a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docs-configure-jwt.aspx")%>">article</a>.</div>
</div>
</div>
<div class="gs_content" id="DeveloperTools_block">
<h2>Developer Tools</h2>
<div class="PortalHelp">
<p>The <b>Developer Tools</b> section is used to integrate ONLYOFFICE DocSpace into your own web application, use <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#webhooks")%>"><b>webhooks</b></a> and add <a href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-settings.aspx#plugins")%>"><b>plugins</b></a>.</p>
<h5 id="jssdk">JavaScript SDK</h5>
<p>Use the <b>ONLYOFFICE DocSpace SDK</b> based on JavaScript which allows developers to use all the DocSpace possibilities with api.js. You can integrate ONLYOFFICE DocSpace into your own web application, allowing users to create and submit documents directly from your website.</p>
<p>To embed the DocSpace room or folder to your website,</p>
<ol>
<li>On the <b>JavaScript SDK</b> page, go to the <b>Create sample DocSpace embed</b> section.</li>
<li>Customize the display options: set the frame Width, Height, Interface elements (Left menu, Header, Search, Filter and Sort, Navigate and Title (only for mobile devices)), Data display settings (select the section, room or folder you want to display), and Advanced display settings, such as Sort term, Sort by parameter, Sort order, the number of files / folders displayed on one page, etc.</li>
<li>Preview the result in the <b>Preview</b> section.</li>
<li>Switch to the <b>Code to insert</b> tab and copy the generated code.</li>
<li>Insert the copied code into your websites <b>index.html</b> file.</li>
<li>In the <b>Embed DocSpace as iframe</b> section, paste the link to your website and press the + icon.</li>
</ol>
<div class="screen_block">
<img alt="Developer Tools" target="img14_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/small/jssdk.png")%>" />
<img alt="Developer Tools" id="img14_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/big/jssdk.png")%>" />
<div target="img14_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>For more details on JavaScript SDK, please refer to <a class="see_also" href="https://api.onlyoffice.com/docspace/jssdk/"><b>api.onlyoffice.com</b></a>.</p>
<div class="inner_delimiter"></div>
<h5 id="webhooks">Webhooks</h5>
<p>Use webhooks to perform custom actions on the side of any application or website you are using based on various events in ONLYOFFICE DocSpace. You can create and manage all your webhooks, configure them, and browse history of every webhook to audit their performance. To learn more about using webhooks, read <a class="links" target="_blank" href="<%=VirtualPathUtility.ToAbsolute("~/administration/docspace-webhooks.aspx")%>"><b>this guide</b></a>.</p>
<div class="screen_block">
<img alt="Developer Tools" target="img15_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/DocSpace/small/webhooks.png")%>" />
<img alt="Developer Tools" id="img15_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/DocSpace/big/webhooks.png")%>" />
<div target="img15_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>For more details on DocSpace API, please refer to <a class="see_also" href="https://api.onlyoffice.com/docspace/basic"><b>api.onlyoffice.com</b></a>.</p>
<div class="inner_delimiter"></div>
<h5 id="plugins">Plugins</h5>
<p>Add plugins to extend the functionality of DocSpace with extra features.</p>
<p>There are two types of plugins: system ones, which we develop ourselves, and custom ones. You can download a custom plugin on this page if this option is enabled in the config (in the SaaS version, only system plugins are available).</p>
<p>Currently, the following plugins are available: <a class="see_also" href="https://github.com/ONLYOFFICE/onlyoffice-docspace-plugin-sdk/tree/develop/samples/draw-io">Draw.io</a>, <a class="see_also" href="https://github.com/ONLYOFFICE/onlyoffice-docspace-plugin-sdk/tree/develop/samples/PDF-Converter">PDF-Converter</a>, <a class="see_also" href="https://github.com/ONLYOFFICE/onlyoffice-docspace-plugin-sdk/tree/develop/samples/speech-to-text">Speech-to-text</a>.</p>
<div class="screen_block">
<img alt="Developer Tools" target="img16_eventcom_guides" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/small/plugins.png")%>" />
<img alt="Developer Tools" id="img16_eventcom_guides" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/gettingstarted/DocSpace/big/plugins.png")%>" />
<div target="img16_eventcom_guides" class="screenphoto magnifier"></div>
</div>
<p>For more details on DocSpace plugin SDK, please refer to <a class="see_also" href="https://api.onlyoffice.com/docspace/basic"><b>api.onlyoffice.com</b></a></p>
</div>
</div>
<div class="gs_content" id="DeactivatingDeletingDocSpace_block">
<h2>Deactivating/deleting DocSpace</h2>
<div class="PortalHelp">

View File

@ -139,7 +139,7 @@
</ul>
<h5>Advanced Settings</h5>
<p>The <b>Hide auth page</b> option allows you to hide the default authentication page and automatically redirect to the SSO service.</p>
<div class="notehelp nh_important"><span class="important_notice_label">Important</span>If you need to restore the default authentication page (to be able to access DocSpace if you your IDP server fails), you can add the <code>/Auth.aspx?skipssoredirect=true</code> key after the domain name of your DocSpace in the browser address bar.</div>
<div class="notehelp nh_important"><span class="important_notice_label">Important</span>If you need to restore the default authentication page (to be able to access DocSpace if you your IDP server fails), you can add the <code>/login?skipssoredirect=true</code> key after the domain name of your DocSpace in the browser address bar.</div>
<p>When all the settings are specified in your DocSpace, click the <b>Save</b> button. The <b>ONLYOFFICE SP Metadata</b> section will open.</p>
<h2 id="RegisterSP">Registering ONLYOFFICE as a trusted Service Provider in your Identity Provider</h2>
<p>Now you need to add ONLYOFFICE as a trusted Service Provider in your IdP account specifying the ONLYOFFICE SP metadata in the IdP.</p>

View File

@ -139,7 +139,7 @@
</ul>
<h5>Erweiterte Einstellungen</h5>
<p>Mit der Option <b>Anmeldeseite ausblenden</b> können Sie die Standard-Authentifizierungsseite ausblenden und automatisch zum SSO-Dienst umleiten.</p>
<div class="notehelp nh_important"><span class="important_notice_label">Wichtig</span>Wenn Sie die Standardauthentifizierungsseite wiederherstellen müssen (um auf DocSpace zugreifen zu können, wenn Ihr IDP-Server ausfällt), können Sie den Schlüssel <code>/Auth.aspx?skipssoredirect=true</code> nach dem Domänennamen Ihrer DocSpace in der Adressleiste des Browsers hinzufügen.</div>
<div class="notehelp nh_important"><span class="important_notice_label">Wichtig</span>Wenn Sie die Standardauthentifizierungsseite wiederherstellen müssen (um auf DocSpace zugreifen zu können, wenn Ihr IDP-Server ausfällt), können Sie den Schlüssel <code>/login?skipssoredirect=true</code> nach dem Domänennamen Ihrer DocSpace in der Adressleiste des Browsers hinzufügen.</div>
<p>Wenn alle Einstellungen in Ihrem DocSpace festgelegt sind, klicken Sie auf die Schaltfläche <b>Speichern</b>. Der Abschnitt <b>ONLYOFFICE SP-Metadaten</b> wird geöffnet.</p>
<h2 id="RegisterSP">Registrierung von ONLYOFFICE als vertrauenswürdiger Dienstanbieter bei Ihrem Identity Provider</h2>
<p>Jetzt müssen Sie ONLYOFFICE als vertrauenswürdigen Dienstanbieter in Ihrem IdP-Konto hinzufügen und die ONLYOFFICE SP-Metadaten im IdP angeben.</p>

View File

@ -134,7 +134,7 @@
</ul>
<h5>Paramètres avancés</h5>
<p>L'option <b>Masquer la page d'authentification</b> permet de masquer la page d'authentification par défaut et rediriger vers le service d'authentification unique.</p>
<div class="notehelp nh_important"><span class="important_notice_label">Important</span>Si vous souhaitez restaurer la page d'authentification par défaut (pour pouvoir accéder à DocSpace quand le serveur de votre fournisseur d'identité tombe en panne), vous pouvez ajouter la clé <code>/Auth.aspx?skipssoredirect=true</code> après le nom de domaine de votre espace DocSpace dans la barre d'adresse du navigateur.</div>
<div class="notehelp nh_important"><span class="important_notice_label">Important</span>Si vous souhaitez restaurer la page d'authentification par défaut (pour pouvoir accéder à DocSpace quand le serveur de votre fournisseur d'identité tombe en panne), vous pouvez ajouter la clé <code>/login?skipssoredirect=true</code> après le nom de domaine de votre espace DocSpace dans la barre d'adresse du navigateur.</div>
<p>Une fois votre DocSpace paramétré, cliquez sur <b>Enregistrer</b>. La section <b>Les métadonnées du fournisseur de service ONLYOFFICE</b> s'affiche.</p>
<h2 id="RegisterSP">Enregistrer ONLYOFFICE en tant que fournisseur de service fiable.</h2>
<p>Maintenant, il faut ajouter ONLYOFFICE en tant que fournisseur de service fiable depuis votre compte chez fournisseur d'identifiant en fournissant les métadonnées du fournisseur de service ONLYOFFICE à votre fournisseur d'identifiant.</p>

View File

@ -102,4 +102,19 @@
<p>Use the <img alt="Retry icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/Help/GettingStarted/dsretry2.png")%>" /> icon next to the <b>Webhook details</b> caption to redeliver the webhook.</p>
</div>
</div>
<h2 id="step3"><span class="style_step"></span>Technical details</h2>
<div class="block_of_step">
<div class="screen_text">
<p>The following two services are used for work:</p>
<ol>
<li><b>ASC.Web.Studio</b> provides methods for sending webhooks, launches <b>WorkerService</b>.
<p><b>WorkerService</b> subscribes for receiving messages from a broker (for example, <em>kafka</em>), which stores information about new webhooks waiting to be sent. Messages received from the broker are placed in a queue, after that the queue is constantly queried and asynchronously contacts <b>ASC.Webhoks.Service</b> to send webhooks.</p>
</li>
<li><b>ASC.Webhooks.Core</b> provides methods for publishing webhooks to the database and the message broker, as well as methods for working with the database.</li>
</ol>
<p>Currently, webhooks are triggered by any requests to the API, such as <em>post</em>, <em>update</em>, and <em>delete</em>.</p>
<p>For more details on DocSpace API, please refer to <a href="https://api.onlyoffice.com/docspace/basic"><b>api.onlyoffice.com</b></a>.</p>
</div>
</div>
</div>

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 33 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 17 KiB