Setup:Installation Guide/Patch Update: Difference between revisions

Revision as of 15:19, 9 February 2023

This page contains instructions for a patch update (e.g., from version 4.1.x to a higher version 4.1.x+).

Back-up

First, you need to make a back-up of your database:

mysqldump -u root -p --all-databases > all_databases.sql

To make your code base more secure, save it to a secure location of your choice:

#Linux bash
cp -r codebase your_secure_place

# Win bash
xcopy codebase your_secure_place\ /E

Renew the code base

Unzip the archive (new Wiki version). Overwrite the old wiki code base with the new wiki version code:

#Linux bash
cp -r new_version_codebase old_version_codebase
rm -rf new_version_codebase

#Win bash
xcopy new_version_codebase old_version_codebase\ /E/H #path/ -  to tell xcopy that path is a directory.
rmdir new_version_codebase /Q/S

Local settings and data

Compare local files and some manual made settings

The following files and folders contain local changes:

skins/ folder
settings files
- settings.d/ folder OR
- all files that contain 'local.php' in settings.d/ folder
extension/BlueSpiceFoundation/config/ folder
images/ folder
all LocalSettings.php files

Copy from your backup Local files and some manual made settings

For a fast copy, use this bash command:

#Linux Bash
cd your_secure_place
cp -r images/ LocalSettings.* settings.d/ codebase/
cp -r /extensions/BlueSpiceFoundation/config /codebase/extensions/BlueSpiceFoundation/

#Win Bash
cd your_secure_place
for %I in (images/ LocalSettings.* settings.d/) do copy %I codebase/
for %I in (config/ data/) do copy %I codebase/extensions/BlueSpiceFoundation/

Run the update

After all preparations are done and code base is overwritten, do the following steps:

open a console and go to the installation folder (LocalSettings.php directory-level, see: right-image)
enter the following command:
```
php maintenance/update.php
```

Note:If you use Linux for your BlueSpice installation, please note that the file system permissions may be lost when overwriting the code base!

Check your current Version

Open the page Special:Version in your Wiki and check BlueSpice(Credits):

Version information on special page "Version"

If problems occur

Visit our SourceForge support forum or report a bug.
For general questions regarding the installation, maintenance, and usage of BlueSpice free, go to our SourceForge help forum.

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

@@ Line 1: / Line 1: @@
-This page contains instructions for a patch update (e.g. from version 4.1.x to a higher version 4.1.x+).
+This page contains instructions for a patch update (e.g., from version 4.1.x to a higher version 4.1.x+).
-== Back-up ==
+==Back-up==
-Firstly, you need to make a back-up of your database<syntaxhighlight lang="bash">
+First, you need to make a back-up of your database:<syntaxhighlight lang="bash">
 mysqldump -u root -p --all-databases > all_databases.sql
-</syntaxhighlight>To make your code base more secure, save it to a secure location of your choice<syntaxhighlight lang="bash">
+</syntaxhighlight>To make your code base more secure, save it to a secure location of your choice:<syntaxhighlight lang="bash">
 #Linux bash
 cp -r codebase your_secure_place
@@ Line 13: / Line 13: @@
 </syntaxhighlight>
-== Renew the code base ==
+==Renew the code base==
-Unzip archive (new Wiki version). Overwrite the old wiki code base with the new wiki version code.<syntaxhighlight lang="bash">
+Unzip the archive (new Wiki version). Overwrite the old wiki code base with the new wiki version code:<syntaxhighlight lang="bash">
 #Linux bash
 cp -r new_version_codebase old_version_codebase
@@ Line 24: / Line 24: @@
 </syntaxhighlight>
-== Local settings and Data ==
+==Local settings and data==
 [[File:cutedResult.png|right|1025x1025px|alt=Screenshot of the file structure of the cuted result]]
-====== Compare Local files and some manual made settings ======
+===Compare local files and some manual made settings===
 The following files and folders contain local changes:
-* skins/ folder
+*skins/ folder
-* settings files
+*settings files
-** settings.d/ folder<span><span /><span /><span /><span /><span /><br /></span>       OR <span /><span />
+**settings.d/ folder<span><span /><span /><span /><span /><span /></span> '''OR'''
-** all files that contain 'local.php' in settings.d/ folder <span /><span /><span /><span /><span /><span /><br />[[File:File localMathPHP.png|alt=screenshot of localMathPHP folder]]
+** all files that contain 'local.php' in settings.d/ folder <span /><span /><span /><span /><span /><span /><span /><span /><br />[[File:File localMathPHP.png|alt=screenshot of localMathPHP folder]]
-* extension/BlueSpiceFoundation/config/ folder
+*extension/BlueSpiceFoundation/config/ folder
-* images/ folder
+*images/ folder
-* all LocalSettings.php  files<span><span /><span /><span /><span /><span /><br /></span> [[File:File settingsPHP.png|alt=example screenshot of a list of LocalSettings.php files.]] <span /><span /><span /><span /><span /><span /><br />
+*all LocalSettings.php  files<span><span /><span /><span /><span /><span /><span /><span /><br /></span> [[File:File settingsPHP.png|alt=example screenshot of a list of LocalSettings.php files.]] <span /><span /><span /><span /><span /><span /><span /><span /><br />
-====== Copy from your backup Local files and some manual made settings ======
+===Copy from your backup Local files and some manual made settings===
 For a fast copy, use this bash command:
 <syntaxhighlight lang="bash">
@@ Line 51: / Line 51: @@
 </syntaxhighlight>
-== Run the update ==
+==Run the update==
 After all preparations are done and code base is overwritten, do the following steps:
-# open a console and go to the installation folder   (LocalSettings.php directory-level, see: right-image)
+#open a console and go to the installation folder   (LocalSettings.php directory-level, see: right-image)
-# enter the following command:<syntaxhighlight lang="bash">
+#enter the following command:<syntaxhighlight lang="bash">
 php maintenance/update.php
 </syntaxhighlight>
-<blockquote>Note: If you use Linux for your BlueSpice installation, please note that the file system permissions may be lost when overwriting the code base!</blockquote>
+{{Messagebox|boxtype=note|Note text=If you use Linux for your BlueSpice installation, please note that the file system permissions may be lost when overwriting the code base!}}
-== Check your current Version ==
+==Check your current Version==
 Open the page <code>Special:Version</code> in your Wiki and check ''BlueSpice(Credits)'':[[File:version43_cuted.png|alt=Version information on special page "Version"|center]]
-== If problems occur ==
+==If problems occur==
-* Visit our [https://sourceforge.net/p/bluespice/support-requests/ SourceForge] support forum or  [http://sourceforge.net/tracker/?func=add&group_id=358032&atid=1494709 report a bug].
+*Visit our [https://sourceforge.net/p/bluespice/support-requests/ SourceForge] support forum or  [http://sourceforge.net/tracker/?func=add&group_id=358032&atid=1494709 report a bug].
-* For general questions regarding the installation, maintenance, and usage of BlueSpice free, go to our [https://sourceforge.net/p/bluespice/discussion/1249668/ SourceForge help forum].
+*For general questions regarding the installation, maintenance, and usage of BlueSpice free, go to our [https://sourceforge.net/p/bluespice/discussion/1249668/ SourceForge help forum].
-<span><span /><span /><br /></span>
+<span><span /><span /><span /><span /><br /></span>
 [[de:Setup:Installationsanleitung/Patch_Update]]
 [[en:{{FULLPAGENAME}}]]