Add new article DocSpaceScriptParameters.ascx

This commit is contained in:
Svetlana Maleeva 2023-06-05 19:04:06 +03:00
parent 483c0f0f02
commit bc7fe56359
7 changed files with 508 additions and 8 deletions

View File

@ -29,6 +29,7 @@
<li>1-click install
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-install-script.aspx")%>">Installing ONLYOFFICE DocSpace Community using the provided script</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-install-script-parameters.aspx")%>">Installing ONLYOFFICE DocSpace Community with additional script parameters</a></li>
</ul>
</li>
<%--<li>Docker version
@ -56,6 +57,7 @@
<li>1-click install
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-install-script.aspx")%>">Installing ONLYOFFICE DocSpace Enterprise using the provided script</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-install-script-parameters.aspx")%>">Installing ONLYOFFICE DocSpace Enterprise with additional script parameters</a></li>
</ul>
</li>
<%--<li>Docker version

View File

@ -29,6 +29,7 @@
<li>1-click install
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-install-script.aspx")%>">Installing ONLYOFFICE DocSpace Community using the provided script</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-install-script-parameters.aspx")%>">Installing ONLYOFFICE DocSpace Community with additional script parameters</a></li>
</ul>
</li>
<%--<li>Docker version

View File

@ -28,6 +28,7 @@
<li>1-click install
<ul>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-install-script.aspx")%>">Installing ONLYOFFICE DocSpace Enterprise using the provided script</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-install-script-parameters.aspx")%>">Installing ONLYOFFICE DocSpace Enterprise with additional script parameters</a></li>
</ul>
</li>
<%--<li>Docker version

View File

@ -122,12 +122,12 @@
<pre><code>bash docspace-enterprise-install.sh package -h
</code></pre>
</div>
<%--<div class="community_display">
<p>To learn more on how to use all the available script RPM/DEB parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/docspace-community-install-rpm-deb-parameters.aspx")%>">this article</a>.</p>
<div class="community_display">
<p>To learn more on how to use all the available script RPM/DEB parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-install-script-parameters.aspx")%>">this article</a>.</p>
</div>
<div class="enterprise_display">
<p>To learn more on how to use all the available script RPM/DEB parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/docspace-enterprise-install-rpm-deb-parameters.aspx")%>">this article</a>.</p>
</div>--%>
<p>To learn more on how to use all the available script RPM/DEB parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-install-script-parameters.aspx")%>">this article</a>.</p>
</div>
</div>
</div>
@ -144,12 +144,12 @@
<pre><code>bash docspace-enterprise-install.sh docker -h
</code></pre>
</div>
<%--<div class="community_display">
<p>To learn more on how to use all the available script Docker parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/docspace-community-install-docker-parameters.aspx")%>">this article</a>.</p>
<div class="community_display">
<p>To learn more on how to use all the available script Docker parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-community-install-script-parameters.aspx")%>">this article</a>.</p>
</div>
<div class="enterprise_display">
<p>To learn more on how to use all the available script Docker parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/docspace-enterprise-install-docker-parameters.aspx")%>">this article</a>.</p>
</div>--%>
<p>To learn more on how to use all the available script Docker parameters, please refer to <a href="<%=VirtualPathUtility.ToAbsolute("~/installation/docspace-enterprise-install-script-parameters.aspx")%>">this article</a>.</p>
</div>
</div>
</div>
</div>

View File

@ -0,0 +1,466 @@
<%@ Control Language="C#" Inherits="BaseContentUserControls"%>
<%@ Register Namespace="TeamLab.Controls" Assembly="__Code" TagPrefix="cc" %>
<script runat="server">
protected override void Init()
{
PageTitle = PageCaption = "Installing ONLYOFFICE DocSpace with additional script parameters";
MetaKeyWords = "";
MetaDescription = "";
var guides = new GuidesModel();
guides.TitleVideo = "How to install ONLYOFFICE DocSpace using the provided script parameters";
(Page as BasePage).Guides = guides;
}
</script>
<div class="MainHelpCenter">
<h1 class="subHeaderFeaturesCaption Guides_Video_Captions">Installing <%= ((BasePage)Page).EditionVersion %> with additional script parameters</h1>
<div class="video_ground video_trips">
<h2 id="introduction">Introduction</h2>
<div class="video_ground video_trips">
<div class="video_text">
<p><b><%= ((BasePage)Page).EditionVersion %></b> is a <span class="enterprise_display">paid</span><span class="community_display">free</span> version of a document hub where you can connect users and documents in one place to boost collaboration.</p>
<p><b><%= ((BasePage)Page).EditionVersion %></b> is shipped as an automatic installation script for Linux operating systems with Docker installed. The script will set up Docker containers with all the components necessary for <b><%= ((BasePage)Page).EditionVersion %></b> correct work and is easy to run, manage and update.</p>
<p>After you download the <b><%= ((BasePage)Page).EditionVersion %></b> installation script, you might need to run it specifying some additional parameters, for example, if you want to install each component on a separate machine.</p>
<p> Use the following command to display the list of all the available Docker script parameters:</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh docker -h
</code></pre>
<p>Use the following command to display the list of all the available DEB/RPM script parameters:</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh package -h
</code></pre>
<p>You can find a short description and some usage examples for these parameters below.</p>
<p>When you run the script with parameters, you will be prompted to select the way you want to install ONLYOFFICE DocSpace. Type <b>Y</b> and press <b>Enter</b> to install ONLYOFFICE Docs using Docker. Type <b>N</b> and press <b>Enter</b> to install ONLYOFFICE DocSpace from DEB/RPM packages.</p>
</div>
</div>
</div>
<h2 id="Credentials">Credentials</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>-hub, --hub</code></td>
<td>dockerhub name</td>
</tr>
<tr>
<td><code>-un, --username</code></td>
<td>dockerhub username</td>
</tr>
<tr>
<td><code>-p, --password</code></td>
<td>dockerhub password</td>
</tr>
</tbody>
</table>
<p>These parameters are used in case we provide you credentials to access a test repository so that you can run containers from images stored in it.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -hub name -un username -p password
</code></pre>
</div>
</div>
<h2 id="InstallationType">Installation type</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
<th>Default</th>
</tr>
<tr>
<td><code>-it, --installation_type</code></td>
<td>installation type</td>
<td><code>community|enterprise</code></td>
<td><span class="enterprise_display"><code>enterprise</code></span><span class="community_display"><code>community</code></span></td>
</tr>
</tbody>
</table>
<p>This parameter allows you to install the specified solution: <b>ONLYOFFICE DocSpace Community</b> or <b>ONLYOFFICE DocSpace Enterprise</b>. </p>
<h4>Example</h4>
<div class="enterprise_display">
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -it community
</code></pre>
<p>This will install the <b>ONLYOFFICE DocSpace Community</b> solution.</p>
</div>
<div class="community_display">
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -it enterprise
</code></pre>
<p>This will install the <b>ONLYOFFICE DocSpace Enterprise</b> solution.</p>
</div>
</div>
</div>
<h2 id="Hardware">Hardware check</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
<th>Default</th>
</tr>
<tr>
<td><code>-skiphc, --skiphardwarecheck</code></td>
<td>use to skip hardware check</td>
<td><code>true|false</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>
<p>This parameter allows you to skip checking if the system meets the minimal hardware requirements.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -skiphc true
</code></pre>
<p>This will skip hardware check.</p>
</div>
</div>
<h2 id="Update">Component update</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
<th>Default</th>
</tr>
<tr>
<td><code>-u, --update</code></td>
<td>use to update existing components</td>
<td><code>true|false</code></td>
<td><code>false</code></td>
</tr>
</tbody>
</table>
<p>This parameter allows you to install the latest versions of the necessary components if the corresponding components installed on your machine are outdated.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -u true
</code></pre>
<p>This will consequently stop those containers that need to be updated, remove them and then run the latest versions of the corresponding <b><%= ((BasePage)Page).EditionVersion %></b> components. If the current component version coincides with the latest available one, such a container will not be affected. If you have skipped some components during the previous installation, they will also be skipped. The DocSpace data should be picked up automatically.</p>
<p>Update Docs only to version 7.2.1.34 and skip the update for all other components:</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -u true -docsi onlyoffice/documentserver-ee -docsv 7.2.1.34 -idocs true -ids false -irbt false -irds false
</code></pre>
<p>Update DocSpace only to version 1.2.0 and skip the update for all other components::</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -u true -dsv v1.2.0 -idocs false -irbt false -irds false
</code></pre>
</div>
</div>
<h2 id="ComponentInstallation">Component installation</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Values</th>
<th>Default</th>
</tr>
<tr>
<td><code>-ids, --installdocspace</code></td>
<td>install <b>ONLYOFFICE DocSpace</b></td>
<td><code>true|false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>-idocs, --installdocs</code></td>
<td>install <b>ONLYOFFICE Docs</b></td>
<td><code>true|false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>-irbt, --installrabbitmq</code></td>
<td>install <b>RabbitMQ</b></td>
<td><code>true|false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>-irds, --installredis</code></td>
<td>install <b>Redis</b></td>
<td><code>true|false</code></td>
<td><code>true</code></td>
</tr>
<tr>
<td><code>-imysql, --installmysql</code></td>
<td>install <b>MySQL</b></td>
<td><code>true|false</code></td>
<td><code>true</code></td>
</tr>
</tbody>
</table>
<p>These parameters allow you to specify whether you need to install a certain component or not. They can be used if you want to install each component on a separate machine. </p>
<ul>
<li>Use the <code>true</code> value to install a component.</li>
<li>Use the <code>false</code> value to skip a component installation.</li>
</ul>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -idocs false
</code></pre>
<p>This will install all the <b><%= ((BasePage)Page).EditionVersion %></b> components without <b>ONLYOFFICE Docs</b>.</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -ids false -idocs true -imysql false -irbt false -irds false
</code></pre>
<p>This will skip the installation of <b>ONLYOFFICE DocSpace</b>, <b>MySQL</b>, <b>RabbitMQ</b>, and <b>Redis</b> and will install <b>ONLYOFFICE Docs</b> only.</p>
</div>
</div>
<h2 id="Version">Component version</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>-dsv, --docspaceversion</code></td>
<td><b>ONLYOFFICE DocSpace</b> version</td>
</tr>
<tr>
<td><code>-docsv, --docsversion</code></td>
<td><b>ONLYOFFICE Docs</b> version</td>
</tr>
</tbody>
</table>
<p>These parameters can be used to install a certain <b>ONLYOFFICE DocSpace</b> or <b>ONLYOFFICE Docs</b> version if for some reasons you do not want to install the latest version available in the repository. By default, an image tagged as <code>latest</code> is used to run the component container.</p>
<h4>Example</h4>
<p>Open the <a target="_blank" class="links" href="https://hub.docker.com/<%= ((BasePage)Page).VersionName %>/">Docker Hub</a> repository in your browser, select ONLYOFFICE Docs and go to the <b>Tags</b> tab to view all the tags available in the repository. Specify the version you want to install:</p>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -docsv 7.2.1.34
</code></pre>
<p>This will install <b>ONLYOFFICE DocSpace</b> with the <b>ONLYOFFICE Docs</b> 7.2.1.34 version.</p>
</div>
</div>
<h2 id="ImageName">ONLYOFFICE Docs image name</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>-docsi, --docsimage</code></td>
<td><b>ONLYOFFICE Docs</b> image name</td>
</tr>
</tbody>
</table>
<p>This parameter can be used to specify a name of the <b>ONLYOFFICE Docs</b> image that a container should be started from. The specified image should be stored in our official public repository on <a target="_blank" class="links" href="https://hub.docker.com/<%= ((BasePage)Page).VersionName %>/">Docker Hub</a>.</p>
<h4>Example</h4>
<span class="enterprise_display">
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -docsi onlyoffice4enterprise/documentserver-ee
</code></pre>
</span>
<span class="community_display">
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -docsi onlyoffice/documentserver
</code></pre>
</span>
<p>This will run a container from the specified <b>ONLYOFFICE Docs</b> image stored in the repository.</p>
</div>
</div>
<h2 id="Hosts">Setting for hosts</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>-dsh, --docspacehost</code></td>
<td><b>ONLYOFFICE DocSpace</b> host</td>
</tr>
<tr>
<td><code>-esh, --elastichost</code></td>
<td><b>Elasticsearch</b> hosts</td>
</tr>
</tbody>
</table>
<p>These parameters can be used to connect the components if you install them on separate machines.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -esh 192.168.3.202
</code></pre>
<p>This will install <b>ONLYOFFICE DocSpace</b> and connect it with <b>Elasticsearch</b> installed on a different machine which has the <code>192.168.3.202</code> IP address.</p>
</div>
</div>
<h2 id="Machinekey">Setting for core.machinekey</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>-mk, --machinekey</code></td>
<td>Setting for the core.machinekey key</td>
</tr>
</tbody>
</table>
<p>This parameter allows you to specify your own machinekey when installing <%= ((BasePage)Page).EditionVersion %>.</p>
<%-- <div class="notehelp">This parameter is written to the <code>/app/onlyoffice/CommunityServer/data/.private/machinekey</code> configuration file.</div>--%>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -mk yourmachinekey
</code></pre>
</div>
</div>
<h2 id="DocSpacePort">ONLYOFFICE DocSpace external port</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>-ep, --externalport</code></td>
<td><b>ONLYOFFICE DocSpace</b> external port</td>
<td><code>80</code></td>
</tr>
</tbody>
</table>
<p>This parameter allows you to change the port on which <b>ONLYOFFICE DocSpace</b> will run. By default, port 80 is used.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -cp 8080
</code></pre>
</div>
</div>
<h2 id="JWTSecret">Settings for JWT header and secret</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>-jh, --jwtheader</code></td>
<td>Setting for the JWT header</td>
</tr>
<tr>
<td><code>-js, --jwtsecret</code></td>
<td>Setting for the JWT secret key</td>
</tr>
</tbody>
</table>
<p>These parameters allow you you to specify the JWT header and your own JWT secret key when installing <%= ((BasePage)Page).EditionVersion %>. The JWT header defines the http header that will be used to send the JWT. The secret key is used to sign the JSON web token and validate the token upon the request to ONLYOFFICE Docs.</p>
<div class="notehelp">These parameters are written to the following configuration files (the paths are specified within containers):
<ul>
<%--<li>For Community Server - <code>/var/www/onlyoffice/WebStudio/web.appsettings.config</code></li>--%>
<li>For Document Server - <code>/etc/onlyoffice/documentserver/local.json</code></li>
</ul>
</div>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -js yoursecret
</code></pre>
</div>
</div>
<h2 id="MySQLserver">MySQL server</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>-mysqlrp, --mysqlrootpassword</code></td>
<td><b>MySQL</b> server root password</td>
<td><code>my-secret-pw</code></td>
</tr>
<tr>
<td><code>-mysqlh, --mysqlhost</code></td>
<td><b>MySQL</b> server host</td>
<td><code>localhost</code></td>
</tr>
</tbody>
</table>
<p>If you do not explicitly specify these parameters, the default values are used.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -mysqlrp new-secret-pw
</code></pre>
<p>This command allows you to set your own password for the <b>MySQL</b> root account during the <b><%= ((BasePage)Page).EditionVersion %></b> installation.</p>
</div>
</div>
<h2 id="DocSpaceDB">ONLYOFFICE DocSpace database</h2>
<div class="block_of_step">
<div class="screen_text">
<table class="table_portslist script_parameters">
<tbody>
<tr>
<th>Parameter</th>
<th>Description</th>
<th>Default</th>
</tr>
<tr>
<td><code>-mysqld, --mysqldatabase</code></td>
<td><b>ONLYOFFICE DocSpace</b> database name</td>
<td><code>onlyoffice</code></td>
</tr>
<tr>
<td><code>-mysqlu, --mysqluser</code></td>
<td><b>ONLYOFFICE DocSpace</b> database user</td>
<td><code>onlyoffice_user</code></td>
</tr>
<tr>
<td><code>-mysqlp, --mysqlpassword</code></td>
<td><b>ONLYOFFICE DocSpace</b> database password</td>
<td><code>onlyoffice_pass</code></td>
</tr>
</tbody>
</table>
<p>These parameters allow you you to create the <b>ONLYOFFICE DocSpace</b> database specifying custom database name, as well as a username and password for the account with superuser permissions on the created database. If you do not explicitly specify these parameters, the default values are used.</p>
<h4>Example</h4>
<pre><code>bash <%= ((BasePage)Page).CommandName %>-install.sh -mysqld docspacedatabase -mysqlu username -mysqlp password
</code></pre>
</div>
</div>
</div>

View File

@ -0,0 +1,15 @@
<%@ 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"; %>
<% ((BasePage)Page).VersionName = "r/onlyoffice"; %>
<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/DocSpaceScriptParameters/DocSpaceScriptParameters.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>

View File

@ -0,0 +1,15 @@
<%@ 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"; %>
<% ((BasePage)Page).VersionName = "u/onlyoffice4enterprise"; %>
<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/DocSpaceScriptParameters/DocSpaceScriptParameters.ascx" />
</asp:Content>
<asp:Content ID="content2" ContentPlaceHolderID="leftmenupage" runat="server">
<div class="installationdocspace">
</asp:Content>