Known issues and Setup:Installation Guide/System Preparation/Windows/Elasticsearch: Difference between pages

Latest revision as of 16:25, 29 November 2023

Elasticsearch is available up to BlueSpice 4.3. Newer versions of BlueSpice 4 support OpenSearch.

	Elasticsearch is a prerequisite for running Advanced Search. The steps listed here are optional and only required if you plan to use them in your BlueSpice installation.

	To run Elasticsearch, OpenJDK is required. If you have not installed it, install it now.

Download

	The content of this section refers to external sources and is current at the time of writing this documentation. We cannot guarantee how long these sources will remain unchanged. Please let us know if you notice any discrepancies to the information provided here.

BlueSpice ist derzeit mit Elasticsearch 6.x ab Version 6.8.21 kompatibel. Elasticsearch > 6.8.x wird derzeit nicht unterstützt.

Die jeweils aktuelle Version können Sie dieser Liste entnehmen. Daraus ergibt sich folgender direkter Download-Link: https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<Versionsnummer>.zip also bspw. https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.8.23.zip.

Folgen Sie dabei den Download-Anweisungen Ihres Browsers.

	In the following, the Elasticsearch version 6.8.23 is used and only serves as an example for the latest version of the 6.x version series, which you can download at the time of your installation.

Unpacking the ZIP archive

Unpack the ZIP archive that you have just downloaded in a Archiv in a suited system path of your hard drive.

	This documentation assumes the folder structure recommended by us. For this reason, Elasticsearch is unpacked at this point in the folder C:\bluespice\bin\elasticsearch-6.8.23. If you have individual wishes, adjust these paths according to your own understanding.

Installing the plugin ingest-attachment

Change to the directory "C:\bluespice\bin\elasticsearch-6.8.23\bin" (1).

Right-click on a free area of the Explorer window with the Shift-key pressed.

Click "Open PowerShell window here" (2):

Execute the command ". \elasticsearch-plugin.bat install -b ingest-attachment":

	If your server does not have an active internet connection, then download the plug-in ingest-attachment as zip archive and install it, as documented directly by the manufacturer.

Installing the Elasticsearch service

Run the "elasticsearch-service.bat install" command and wait for the process to complete:

Configuring and starting the Elasticsearch service

Press the key combination Windows+R.

Enter "services.msc" (1) in the dialog window and click "OK" (2):

Search for the service "Elasticsearch 6.8.23" and open it with a double-click:

Select the startup type "Automatic" (1) and start the service (2).

Click "OK" (3) to close the window after the service is started:

Next step

If you have successfully completed all of the above steps, proceed to the next step: Python.

To submit feedback about this documentation, visit our community forum.

@@ Line 1: / Line 1: @@
-{{TOClimit|limit=2|notitle=1|nonum=0|noborder=1|fontlarge=1}}
+{{BSVersion|bsvTo=4.3|bsvFeature=Elasticsearch|info=Newer versions of BlueSpice 4 support [[Setup:Installation_Guide/System_Preparation/Windows/OpenSearch|OpenSearch]].}}
-<templatestyles src="Collapsible/styles.css" />
+__TOC__
-<div id="bscollapse">
-==BlueSpice 4.3==
-{{Collapsible|cheader=A BlueSpicePrivacy banner is shown to admin users
-|cdescription=Admin users might see a yellow banner indicating that some privacy pages need to be created even if they have already been created for the footer links of the wiki.
-[[File:privacy alert banner.png|alt=screenshot of the alert banner|center|thumb|650x650px|Privacy alert banner]]
+{{Hint|file=icon_optional.png|text=Elasticsearch is a prerequisite for running Advanced Search. The steps listed here are optional and only required if you plan to use them in your BlueSpice installation.}}
-This is to ensure that the confirmation links during a user's first login exist:
+{{Hint|file=hint.png|text=To run Elasticsearch, OpenJDK is required. If you have not installed it, [[Setup:Installation Guide/System_Preparation/Windows/OpenJDK|install it now. ]]}}
-[[File:privacy confirmation links.png|alt=screenshot of login page with privacy acceptance checkboxes|center|thumb|250x250px|Links to the privacy policy and the terms of services]]
+==Download==
+{{Hint|file=hint.png|text=The content of this section refers to external sources and is current at the time of writing this documentation. We cannot guarantee how long these sources will remain unchanged. Please let us know if you notice any discrepancies to the information provided here.}}
-|chelp=To make sure the links to the Privacy Policy and the Disclaimer of your wiki link to the correct pages:
+BlueSpice ist derzeit mit Elasticsearch 6.x ab Version 6.8.21 kompatibel. Elasticsearch > 6.8.x wird derzeit nicht unterstützt.
-# Click on the ''Privacy policy'' (1) and ''Disclaimers'' (2) links in your site footer. These are the pages that need to exist for the notice to disappear:[[File:footer links.png|alt=screenshot of footer bar|center|thumb|650x650px|Footer links to the Privacy page and to the Disclaimer.]]
+Die jeweils aktuelle Version können Sie [https://github.com/elastic/elasticsearch/releases dieser Liste] entnehmen. Daraus ergibt sich folgender direkter Download-Link: https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-<Versionsnummer>.zip also bspw. <code>https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-6.8.23.zip</code>.
-# If you haven't created these pages yet, create them.
-# Once the pages exist, change the content of the following two system messages to the full pagename of these two pages. '''Privacy policy''' link''':'''<br />For the privacy policy link, open the page <code>MediaWiki:bs-privacy-privacypage</code> and change the text to the correct page name for your footer link:[[File:footer links - privacy.png|alt=screenshot of the system message|center|thumb|450x450px|Changing the system message to reflect the correct page name.]]'''Disclaimers''' link''':'''<br />Repeat the same for the Disclaimers link. Open the page <code>MediaWiki:Bs-privacy-termsofservicepage</code> and add the correct name of the linked footer page for Disclaimers (by default, this is <code>Site:General disclaimer</code>)
+Folgen Sie dabei den Download-Anweisungen Ihres Browsers.
-The yellow alert banner should now be gone.
+{{Hint|file=hint.png|text=In the following, the Elasticsearch version 6.8.23 is used and only serves as an example for the latest version of the 6.x version series, which you can download at the time of your installation.}}
-}}
+==Unpacking the ZIP archive==
-{{Collapsible|cheader=Missing language switcher on pages where the title area is hidden
+'''Unpack''' the ZIP archive that you have just downloaded in a Archiv in a suited system path of your hard drive.
-|cdescription=Since the language switcher is now located in the title area of wiki pages, pages that use the option <code><nowiki>__HIDETITLE__</nowiki></code> currently cannot show the language switcher.
+{{Hint|file=hint.png|text=This documentation assumes the  [[Setup:Installation Guide/Advanced/Windows Folder Structure|folder structure recommended by us]]. For this reason, Elasticsearch is unpacked at this point in the folder C:\bluespice\bin\elasticsearch-6.8.23. If you have individual wishes, adjust these paths according to your own understanding.}}
-|chelp=This will be fixed in the next patch update.
+==Installing the plugin ingest-attachment==
-}}
+'''Change''' to the directory "C:\bluespice\bin\elasticsearch-6.8.23\bin" (1).
-{{Collapsible|cheader=Styles that are defined in templates or in ''MediaWiki:Common.css'' might no longer be applied
-|cdescription=Because of necessary forward-compatibility changes in the Discovery-skin, some templates might have to be manually updated to show certain styles correctly.
+'''Right-click''' on a free area of the Explorer window with the Shift-key pressed.
-|chelp=
+'''Click''' "Open  PowerShell window here" (2):
-* Affected Styles in  ''MediaWiki:Common.css:'' <br />The styles in question need to be prepended with the selector<code>#mw-content-text</code>. <br />Before:<syntaxhighlight lang="css">
-.myclass h2 {font-size:1.2em;}
-</syntaxhighlight>After:<syntaxhighlight lang="css">
-#mw-content-text .myclass h2 {font-size:1.2em;}
-</syntaxhighlight>
-* TemplateStyles: <br />Templates that rely on  the extension''TemplateStyles'' need to add a wrapper container with its own ID around the affected content. This ID needs to be prepended to the existing selector. The selector <code>#mw-content-text</code> will not work in that case.<br />Example:<syntaxhighlight lang="css">
-.myclass h2 {font-size:1.2em;}
-</syntaxhighlight>Add the id that you have applied to your new or existing wrapper:<syntaxhighlight lang="css">
-#myID .myclass h2 {font-size:1.2em;}
-</syntaxhighlight>
-}}
-{{Collapsible|cheader=Some wikis might experience styling inconsistencies for the newly added startpage templates
-|cdescription=If a wiki is already using some templates that are included in the new startpage templates (e.g. Image cards), these templates are not overwritten during the upgrade to BlueSpice 4.3.
+[[File:Setup:systempreparation_elasticsearch_01.png|border|center|600px|Elasticsearch 01]]
-|chelp=Any styling issues of any affected templates need to be adjusted manually.}}
-==BlueSpice 4.2==
+'''Execute''' the command ". \elasticsearch-plugin.bat install -b ingest-attachment":
-===The filter on special pages (e.g., "Recent changes") fails to load {{Bsvs|bsvFrom=|bsvTo=4.2.6|bsvFeature=}}===
-In some cases, the page ''Special:RecentChanges'' does not finish loading.
-You can add the following script to ''MediaWiki:Common.js'':
-<syntaxhighlight lang="javascript">
-if ( mw.config.get( 'wgCanonicalSpecialPageName' ) === 'Watchlist' ) {
-document.body.classList.add( 'mw-rcfilters-ui-initialized' );
-}
-if ( mw.config.get( 'wgCanonicalSpecialPageName' ) === 'Recentchanges' ) {
-document.body.classList.add( 'mw-rcfilters-ui-initialized' );
-}
-</syntaxhighlight>
+[[File:Setup:systempreparation_elasticsearch_02.png|border|center|600px|Elasticsearch 02]]
-</div>
-[[en:{{FULLPAGENAME}}]]
+{{Hint|file=hint.png|text=If your server does not have an active internet connection, then [https://artifacts.elastic.co/downloads/elasticsearch-plugins/ingest-attachment/ingest-attachment-6.8.23.zip download the plug-in ingest-attachment as zip archive] and install it, as [https://www.elastic.co/guide/en/elasticsearch/plugins/current/plugin-management-custom-url.html  documented directly by the manufacturer].}}
-[[de:Bekannte Probleme]]
+==Installing the Elasticsearch service==
+'''Run''' the "elasticsearch-service.bat install" command and wait for the process to complete:
+[[File:Setup:systempreparation_elasticsearch_03.png|border|center|600px|Elasticsearch 03]]
+==<span class="mw-headline">Configuring and starting the Elasticsearch service</span>==
+'''Press''' the key combination Windows+R.
+'''Enter''' "services.msc"  (1) in the dialog window  and '''click''' "OK" (2):
+[[File:Setup:systempreparation_elasticsearch_04.png|border|center|Elasticsearch 04]]
+'''Search''' for the service "Elasticsearch 6.8.23" and open it with a double-click:
+[[File:Setup:systempreparation_elasticsearch_05.png|border|center|600px|Elasticsearch 05]]
+'''Select''' the startup type "Automatic" (1) and start the service (2).
+'''Click''' "OK" (3) to close the window after the service is started:
+[[File:Setup:systempreparation_elasticsearch_06.png|border|center|Elasticsearch 06]]
+==Next step==
+If you have successfully completed all of the above steps, proceed to the next step: [[Setup:Installation_Guide/System_Preparation/Windows/Python|Python]].