Setup:Installation Guide/Upgrade and Startpage templates download/Startpage SME: Difference between pages

(Difference between pages)
No edit summary
 
No edit summary
 
Line 1: Line 1:
{{DISPLAYTITLE:Upgrade from BlueSpice 3 to 4}}
<div class="downloadarea">
<span class="getButton">[[Media:Startpage SME.zip|Download]]</span>


==System requirements==
[[File:Startpage SME.png|350x350px]]
===Browser===
</div>This template provides a good starting layout for the homepage of the wiki for a small or medium-sized company.  
{{#dpl:title=Setup:System requirements|include=#Browser}}
==Importing the template==
===Server environment===
{{Templateimport|Startpage SME}}
{{#dpl:title=Setup:System requirements|include=#Server Environment}}
{{Messagebox|boxtype=note|icon=|Note text=You might need to add external repos to get the correct php on your server! Please check your package manager for the available php versions on your system.|bgcolor=}}
==Back up the old wiki==
In BlueSpice 3, create a temporary migration folder and copy all necessary data:<syntaxhighlight lang="bash">
mkdir /tmp/migration
cd /tmp/migration
wikifolder=/path/to/wikifolder
cp -r $wikifolder/images .
cp -r $wikifolder/extensions/BlueSpiceFoundation/config .
cp -r $wikifolder/LocalSettings.* .
#check for for locals in settings.d
find $wikifolder/settings.d/ -iname '*.local.php' -exec cp --parent {} /tmp/migration \;


==Pages included in the import==
The xml import creates the following files in your wiki:


</syntaxhighlight>Also search for specialized php files in <code>settings.d</code>  (normally <code>090-</code> or <code>099-</code> ).
*Help:Startpage SME
==Upgrade step 1==
*Help:Startpage SME/Banner
This step has to be completed before the ''Upgrade step 2'' further below.{{Messagebox|boxtype=warning|icon=|Note text=BlueSpice 4.x cannot process wiki pages and files that were uploaded and edited by '''deleted users'''. To prevent data loss, don't skip any upgrade steps!|bgcolor=}}
*Help:Startpage SME/Contact
===Create a "substitute user" for deleted users===
*Help:Startpage SME/Iconnav
In BlueSpice 3.x, create a user with a random password:
*Help:Startpage SME/New employees
php maintenance/createAndPromote.php --force DeletedUser someR4ndomPass
*Help:Startpage SME/Blog
{{Messagebox|boxtype=note|icon=|Note text=You may need to temporarily disable authentication plugins like LDAP-Stack, SAML  or OpenIDConnect extensions.|bgcolor=}}
*Help:Startpage SME/Minutes
Get the <code>user_id</code>  of the substitute user by running the following command in the database:
*Help:Startpage SME/Recent changes
SELECT user_id FROM user WHERE user_name = "DeletedUser";
*Minutes
==Sql dump==
*MediaWiki:Dpl-parserfunc-tracking-category
Create the backup of your data:<syntaxhighlight lang="bash">
*MediaWiki:Dpl-tag-tracking-category
mysqldump -u root -p bluespice > migrationdump.sql
*Template:Banner
</syntaxhighlight>
*Template:Banner/styles.css
==Optional files for migration==
*Template:Dropdown
If any of the following features apply to your installation, check if migration steps are necessary. In that case, add everything to your ''tar'' file and send it to the new server.
*Template:Employee
*Template:Employee/styles.css
*Template:Startpage/styles.css
===Sections of Startpage SME===
{| class="wikitable" style="width: 100%;" data-ve-attributes="{&quot;style&quot;:&quot;width: 100%;&quot;}"
! style="width:200px;" data-ve-attributes="{&quot;style&quot;:&quot;width:200px;&quot;}" |Section
! Subpage
!Content type
!Description
|-
| style="width:200px;" data-ve-attributes="{&quot;style&quot;:&quot;width:200px;&quot;}" | Banner
| Banner
|Template
|The banner parameters are described on the [[Templates download/Banner|Banner download page]].
|-
| Iconnav
| Iconnav
|Template
| The icon nav uses FontAwesome icons out of the box. Up to BlueSpice 4.2, those are not included as an extension. In this case they have to be replaced with Bootstrap Icons or an external reference to FontAwesome has to be added to MediaWiki:Common.css (if allowed by the security policies of the company). The parameters and links to the icon libraries are described on the [[Templates download/Image cards|Image cards download page]].
|-
| style="width:200px;" data-ve-attributes="{&quot;style&quot;:&quot;width:200px;&quot;}" |Announcements
|Blog
|Timeline parser function
|Simple wiki table. To add or remove news, just edit the table.
|-
| style="width:200px;" data-ve-attributes="{&quot;style&quot;:&quot;width:200px;&quot;}" |Contacts
|Contact
|Text,


Examples of files that you might have to consider:
<code><nowiki><profileimage></nowiki></code>-tag
 
|Content can be edited directly on the page. Double-click on the profile image tag to change the user name for the contact avatar.
* ssl-certs
|-
* apache.conf
|Meeting minutes
* ldapprovider.json
|Minutes
* kerberos files (krb5.conf/keyfile)
|<code><nowiki><inputbox></nowiki></code>-tag, <code><nowiki><dpl></nowiki></code>- tag, subpages query
 
|The meeting minutes are created via an  [[Manual:Extension/InputBox|InputBox]]. They are created as subpages of a ''Minutes'' page in the main namespace.
==Migrate to the new wiki==
|-
''Grep'' <code>LocalSettings.php</code> for <code>wgDB</code><syntaxhighlight lang="bash">
|Recent changes
grep wgDB LocalSettings.*
|Recent changes
LocalSettings.local.php:$wgDBserver = "Your-IP";
|<code><nowiki><smartlist></nowiki></code>-tag
LocalSettings.local.php:$wgDBname = "Your-datbase-name";
|The [[Manual:Extension/BlueSpiceSmartList|smartlist]] tag is used by default. You can choose any other way of [[Page lists|creating page lists]].
LocalSettings.local.php:$wgDBuser = "Your-database-user";
|-
LocalSettings.local.php:$wgDBpassword = "Your-password";
| style="width:200px;" data-ve-attributes="{&quot;style&quot;:&quot;width:200px;&quot;}" |New employees
 
|New employees
</syntaxhighlight>and create the '''database'''  and '''DBuser''' with the '''DBpassword'''. Grant <code>all</code> on database to the '''DBuser''' in mysql.
|Template
 
|Employees can be shown with their user images or custom uploaded images. Links go to the profile page or, alternatively, to a custom wiki page. The template parameters are described on the [[Templates download/Employee|Employees]] download page.
Migrate the data:<syntaxhighlight lang="bash">
|}
mysql -u root -p bluespice < migration.sql
cp -r images $wikifolder
cp -r extensions $wikifolder
cp -r LocalSettings.php $wikifolder
setWikiPerm $wikifolder
 
</syntaxhighlight>
====Modify LocalSettings.php====
Replace:<syntaxhighlight lang="php">
$wgLogo = "$wgResourceBasePath/resources/assets/wiki.png";
</syntaxhighlight>with:<syntaxhighlight lang="php">
$wgLogos = [ '1x' => "$wgResourceBasePath/resources/assets/wiki.png" ];
 
</syntaxhighlight>
*Check other <code>LocalSettings.*</code> for individual configurations from the old BlueSpice installation.
*Compare the <code>migrated settings.d/*.local.php</code> with the new <code>settings.d/*.php</code> and check for individual (probably deprecated) configurations.  Do the same with <code>09*-xx.php</code>.
*Copy to <code>$wikifolder/settings.d/</code> what is needed.
==Upgrade step 2==
Assign all pages and files without a valid editor user to your newly created substitute user:<syntaxhighlight lang="bash">
cd $wikifolder
php extensions/BlueSpiceFoundation/maintenance/PrepareActorMigration.php --unknownUserId=<user-id-from-step I. > --unknownUserName=DeletedUser
</syntaxhighlight>
==Optional==
*Copy the following files (if applicable in your case):<code>apache.conf</code>, <code>krb5.conf,</code> <code>Kerberos-key</code>, <code>ldapprovider.json</code>
*Add to VirtualHost in <code>Apache.conf</code> after rewrite rules:
AllowEncodedSlashes NoDecode
==Last steps==
Run the following maintenance scripts:<syntaxhighlight lang="bash">
cd $wikifolder
php maintenance/update.php --quick
php extensions/BlueSpiceExtendedSearch/maintenance/initBackends.php --quick
php extensions/BlueSpiceExtendedSearch/maintenance/rebuildIndex.php --quick
 
screen
    while  [ "$(php maintenance/showJobs.php)" != "0" ]; do php maintenance/runJobs.php --maxjobs 100; done
 
</syntaxhighlight>The last step will take a while.
==Known possible issues after the update==
===Problems with VisualEditor===
<div>
Add in  <span style="color: rgb(4, 30, 73)"><code>includes/libs/http/MultiHttpClient.php</code> after line 327:</span>
<span class="nb" style="color: rgb(0, 128, 0)">curl_setopt</span><span class="p">(</span> <span class="nv" style="color: rgb(25, 23, 124)">$ch</span><span class="p">,</span> <span class="nx">CURLOPT_SSL_VERIFYHOST</span><span class="p">,</span> <span class="mi" style="color: rgb(102, 102, 102)">0</span> <span class="p">);</span>
<span class="nb" style="color: rgb(0, 128, 0)">curl_setopt</span><span class="p">(</span> <span class="nv" style="color: rgb(25, 23, 124)">$ch</span><span class="p">,</span> <span class="nx">CURLOPT_SSL_VERIFYPEER</span><span class="p">,</span> <span class="mi" style="color: rgb(102, 102, 102)">0</span> <span class="p">);</span>
</div>
 
[[en:{{FULLPAGENAME}}]]
[[de:Setup:Installationsanleitung/Upgrade]]

Revision as of 13:58, 15 May 2023

This template provides a good starting layout for the homepage of the wiki for a small or medium-sized company.

Importing the template

Importing the template

The import file is included in the archive file Startpage SME.zip. Unpack the zip file first.

On the page Special:Import follow these steps:

  1. Select file and choose Startpage SME.xml.
  2. Enter an Interwiki prefix. Since this field is required, simply add hw (for hallowelt).
  3. Keep the selection Import to default locations.
  4. Click Upload file... .

The template is now available in your wiki.


Pages included in the import

The xml import creates the following files in your wiki:

  • Help:Startpage SME
  • Help:Startpage SME/Banner
  • Help:Startpage SME/Contact
  • Help:Startpage SME/Iconnav
  • Help:Startpage SME/New employees
  • Help:Startpage SME/Blog
  • Help:Startpage SME/Minutes
  • Help:Startpage SME/Recent changes
  • Minutes
  • MediaWiki:Dpl-parserfunc-tracking-category
  • MediaWiki:Dpl-tag-tracking-category
  • Template:Banner
  • Template:Banner/styles.css
  • Template:Dropdown
  • Template:Employee
  • Template:Employee/styles.css
  • Template:Startpage/styles.css

Sections of Startpage SME

Section Subpage Content type Description
Banner Banner Template The banner parameters are described on the Banner download page.
Iconnav Iconnav Template The icon nav uses FontAwesome icons out of the box. Up to BlueSpice 4.2, those are not included as an extension. In this case they have to be replaced with Bootstrap Icons or an external reference to FontAwesome has to be added to MediaWiki:Common.css (if allowed by the security policies of the company). The parameters and links to the icon libraries are described on the Image cards download page.
Announcements Blog Timeline parser function Simple wiki table. To add or remove news, just edit the table.
Contacts Contact Text,

<profileimage>-tag

Content can be edited directly on the page. Double-click on the profile image tag to change the user name for the contact avatar.
Meeting minutes Minutes <inputbox>-tag, <dpl>- tag, subpages query The meeting minutes are created via an InputBox. They are created as subpages of a Minutes page in the main namespace.
Recent changes Recent changes <smartlist>-tag The smartlist tag is used by default. You can choose any other way of creating page lists.
New employees New employees Template Employees can be shown with their user images or custom uploaded images. Links go to the profile page or, alternatively, to a custom wiki page. The template parameters are described on the Employees download page.



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

No categories assignedEdit

Discussions