Merge branch 'feature/redmine' into develop

This commit is contained in:
Svetlana Maleeva 2022-12-14 12:43:07 +03:00
commit 850a362bf5
21 changed files with 50 additions and 14 deletions

View File

@ -28,6 +28,7 @@
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#Install_block")%>">Installing the ONLYOFFICE connector for Redmine</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#Configure_block")%>">Configuring the ONLYOFFICE connector for Redmine</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#JWT_block")%>">Enabling JWT for the ONLYOFFICE and Redmine integration</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#Demo_block")%>">Connecting to the demo ONLYOFFICE Docs</a></li>
</ul>
</li>
<li>
@ -78,17 +79,20 @@
</div>
<div class="gs_content gs_submenu" id="Whatsnew_block">
<h3>What's new in version 1.0.0</h3>
<h3>What's new in version 2.0.0</h3>
<p>Added</p>
<ul>
<li>The plugin configuration page</li>
<li>The ability to co-edit docx, docxf, xlsx, pptx files</li>
<li>The ability to customize the appearance of the document editor</li>
<li>The ability to return to the page with the file from the document editor</li>
<li>ONLYOFFICE favicons on browser tabs</li>
<li>Detecting a mobile browser</li>
<li>Documents conversion.</li>
<li>Connection to a demo document server.</li>
<li>Advanced server settings for specifying internal addresses.</li>
<li>Settings validation.</li>
<li>Ignoring self-signed certificates.</li>
</ul>
<p>The full change log is available <a href="https://github.com/ONLYOFFICE/onlyoffice-redmine/blob/master/CHANGELOG.md" target="_blank"><b>here</b></a>.</p>
<p>Fixed</p>
<ul>
<li>Issues with permissions.</li>
</ul>
<p>The full change log is available <a href="https://github.com/ONLYOFFICE/onlyoffice-redmine/blob/main/CHANGELOG.md" target="_blank"><b>here</b></a>.</p>
</div>
</div>
</div>
@ -105,8 +109,8 @@
Please refer to the official <a href="https://helpcenter.onlyoffice.com/installation/docs-index.aspx" target="_blank"><b>documentation page</b></a> to learn more about installing ONLYOFFICE Docs.
</div>
</li>
<li>Redmine v4.0.0. If you're new to Redmine, install it following these <a href="https://www.redmine.org/projects/redmine/wiki/RedmineInstall" target="_blank">instructions</a>.</li>
<li>ONLYOFFICE connector v1.0.0 for Redmine</li>
<li>Redmine v4.0.0 - v5.0.x. If you're new to Redmine, install it following these <a href="https://www.redmine.org/projects/redmine/wiki/RedmineInstall" target="_blank">instructions</a>.</li>
<li>ONLYOFFICE connector v2.0.0 for Redmine</li>
</ul>
</div>
@ -118,17 +122,18 @@
<ol type="a">
<li>Download the latest archived version from the Redmine <a href="https://www.redmine.org/plugins/onlyoffice_redmine" target="_blank"><b>Marketplace</b></a>.</li>
<li>Download the latest archived version from the ONLYOFFICE <a href="https://github.com/ONLYOFFICE/onlyoffice-redmine" target="_blank"><b>GitHub page</b></a>:
<pre><code>wget https://github.com/ONLYOFFICE/onlyoffice-redmine/archive/refs/tags/v1.0.0.tar.gz</code></pre>
<pre><code>wget https://github.com/ONLYOFFICE/onlyoffice-redmine/archive/refs/tags/vX.X.X.tar.gz</code></pre>
<p>Where vX.X.X is the necessary connector version.</p>
<p>Unzip the archive:</p>
<pre><code>tar -xvzf v1.0.0.tar.gz</code></pre>
<pre><code>tar -xvzf vX.X.X.tar.gz</code></pre>
</li>
<li>Clone the master branch:
<pre><code>git clone https://github.com/ONLYOFFICE/onlyoffice-redmine</code></pre>
</li>
</ol>
<div class="notehelp">The plugin sub-directory must be named as <b>onlyoffice_redmine</b>. Rename the cloned <b>onlyoffice-redmine</b> or unzipped <b>onlyoffice_redmine-x.y.z</b> folder to <b>onlyoffice_redmine</b>.
<div class="notehelp">The plugin sub-directory must be named as <b>onlyoffice_redmine</b>. Rename the cloned <b>onlyoffice-redmine</b> or unzipped <b>onlyoffice_redmine-X.X.X</b> folder to <b>onlyoffice_redmine</b>.
<pre><code>mv onlyoffice-redmine onlyoffice_redmine
mv onlyoffice-redmine-1.0.0 onlyoffice_redmine</code></pre>
mv onlyoffice-redmine-X.X.X onlyoffice_redmine</code></pre>
</div>
<p>Before installing the plugin, make sure that the Redmine instance is stopped.</p>
</li>
@ -159,9 +164,16 @@ mv onlyoffice-redmine-1.0.0 onlyoffice_redmine</code></pre>
<p>Go to the <b>Administration</b> panel -> <b>Plugins</b>, find the ONLYOFFICE integration plugin for Redmine and click <b>Configure</b>. Specify the following parameters:</p>
<ul>
<li><b>Document Editing Service address</b> - enter the URL address and port where ONLYOFFICE Docs is installed (e.g. <code>https://documentserver:8080</code>). This field is obligatory.</li>
<li>The <b>Advanced server settings</b> section can be used if your network configuration does not allow for requests between the installed Redmine and ONLYOFFICE Docs using the public addresses. In this case, specify addresses for internal requests in the corresponding fields:
<ul>
<li><b>ONLYOFFICE Docs address for internal requests from the server</b> - specify the address that is used to access Document Editing Service from Redmine.</li>
<li><b>Server address for internal requests from ONLYOFFICE Docs</b> - specify the address that is used to access Redmine from Document Editing Service.</li>
</ul>
</li>
<li><b>Secret key</b> - specify the secret used to sign the data.
<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 enable it on the Redmine side as well: find your secret key in the ONLYOFFICE Docs configuration file, then specify the same secret key in the connector settings. For more details, see the <a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#JWT_block")%>">Enabling JWT for the ONLYOFFICE and Redmine integration</a> section of this article.</div>
</li>
<li><b>Disable certificate verification (insecure)</b> - check this box to disable the certificate verification and allow Redmine to establish connection with ONLYOFFICE Docs if you are using a self-signed certificate for your ONLYOFFICE Docs (otherwise, Redmine will not validate a self-signed certificate and will not allow for connection to/from ONLYOFFICE Docs). This is an insecure solution, and we strongly recommend that you replace the certificate with the one issued by some CA.</li>
<li>Check the following customization settings if necessary:
<ul>
<li>Display the Chat menu button.</li>
@ -247,6 +259,13 @@ mv onlyoffice-redmine-1.0.0 onlyoffice_redmine</code></pre>
<p><b>Step2</b>: Specify the same secret key in the connector settings</p>
<p>In the connector settings, specify the same secret in the <b>Secret key</b> field and save the settings.</p>
</div>
<div class="gs_content gs_submenu" id="Demo_block">
<h3>Connecting to the demo ONLYOFFICE Docs</h3>
<p>Starting from <a href="https://github.com/ONLYOFFICE/onlyoffice-redmine/releases/tag/v2.0.0" target="_blank"><b>ONLYOFFICE connector version 2.0.0</b></a>, you can try the ONLYOFFICE online editors within Redmine without installing ONLYOFFICE Docs.</p>
<p>To turn the connection on, click the <b>Connect to demo ONLYOFFICE Document Server</b> checkbox and click the <b>Save</b> button.</p>
<div class="notehelp">This is a public test server that will be available during a 30-day period. Dont share your sensitive data there.</div>
</div>
</div>
@ -312,6 +331,22 @@ mv onlyoffice-redmine-1.0.0 onlyoffice_redmine</code></pre>
<img alt="Issues module" id="img_7" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Redmine/big/news.png")%>" />
<div target="img_7" class="screenphoto magnifier"></div>
</div>
<h3>Converting files</h3>
<p>The ability to convert files is available in the following Redmine modules: Issues, Documents, Wiki, and News.</p>
<div class="screen_block">
<img alt="Converting files" target="img_8" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Redmine/small/convert.png")%>" />
<img alt="Converting files" id="img_8" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Redmine/big/convert.png")%>" />
<div target="img_8" class="screenphoto magnifier"></div>
</div>
<p>Click the <img alt="ONLYOFFICE icon" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Redmine/small/converticon.png")%>" /> <b>Convert with ONLYOFFICE</b> button to the right of the file name.</p>
<p>Choose the necessary format from the list. Optionally, you can change the file name.</p>
<div class="screen_block">
<img alt="Converting files" target="img_9" class="screenphoto screen_guides" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Redmine/small/convert2.png")%>" />
<img alt="Converting files" id="img_9" class="bigphoto_screen" src="<%=VirtualPathUtility.ToAbsolute("~/images/help/GettingStarted/Integration/Redmine/big/convert2.png")%>" />
<div target="img_9" class="screenphoto magnifier"></div>
</div>
<p>Click the <b>Convert</b> button to save the converted file within the corresponding Redmine section. Click the <b>Download</b> button to save the converted file on your computer locally.</p>
</div>
</div>
</div>

View File

@ -45,6 +45,7 @@
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#Install_block")%>">Installing the ONLYOFFICE connector for Redmine</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#Configure_block")%>">Configuring the ONLYOFFICE connector for Redmine</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#JWT_block")%>">Enabling JWT for the ONLYOFFICE and Redmine integration</a></li>
<li><a href="<%=VirtualPathUtility.ToAbsolute("~/integration/gettingstarted-redmine.aspx#Demo_block")%>">Connecting to the demo ONLYOFFICE Docs</a></li>
</ul>
</li>
<li>

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 13 KiB

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 16 KiB

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 205 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 12 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 11 KiB

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB