Setup:Installation Guide/Patch Update: Difference between revisions

Latest revision as of 11:52, 27 March 2024

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

Backup

First, you need to make a backup 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:

settings files
- settings.d/ folder OR
- all files that contain 'local.php' in settings.d/ folder
extension/BlueSpiceFoundation/config/ folder (only available until BlueSpice 4.2.x) -v4.2.x
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: @@
-For large version jumps (e.g., BlueSpice 3.2.x to 4.2.x), a new installation is generally recommended.
+This page contains instructions for a patch update (e.g., from version 4.1.x to a higher version 4.1.x+).
-For a patch update (for example, version 4.1.x to a higher version 4.1.x+) you can simply follow these steps:
+==Backup==
+First, you need to make a backup of your database:<syntaxhighlight lang="bash">
+mysqldump -u root -p --all-databases > all_databases.sql
-#'''Create a backup:''' Pull a dump of the database and save it together with the complete codebase to a backup location of your choice.
+</syntaxhighlight>To make your code base more secure, save it to a secure location of your choice:<syntaxhighlight lang="bash">
-#'''Renew the codebase:''' Overwrite the codebase of the current version with the new codebase of the higher version.
+#Linux bash
-#'''Compare''': After the overwrite, please compare the following files and folder. Copy from your backup location if necessary
+cp -r codebase your_secure_place
-##If you have a custom skin, please check the <code>skins/</code> folder.
+</syntaxhighlight><syntaxhighlight lang="bash">
-##<code>LocalSettings.php</code>
+# Win bash
-##<code>extensions/BlueSpiceFoundation/config</code>
+xcopy codebase your_secure_place\ /E
-##<code>settings.d/</code>In <code>settings.d</code>, especially <code>*.local.php</code> files. Copy from your backup if necessary.
+</syntaxhighlight>
-#'''Run the update:'''
-##Open a console and go to the installation folder (on the LocalSettings.php level)
-##Then enter the following command: <code>php maintenance/update.php</code>
-<br />If you use Linux as the basis of your BlueSpice installation, please note that file system permissions may be lost when overwriting the codebase. More information can be found under [[setup:Installation Guide/Security Settings/File System Permissions|File System Permissions]].
+==Renew the code base==
+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
+rm -rf new_version_codebase
+</syntaxhighlight><syntaxhighlight lang="bash">
+#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
+</syntaxhighlight>
-{{Messagebox|boxtype=note|Note text=In a patch update, usually no database schemas have changed. It may not be necessary to run update.php.}}<br />
+==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===
+The following files and folders contain local changes:
+*settings files
+**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 /><span /><span /><span /><br />
+*extension/BlueSpiceFoundation/config/ folder (only available until BlueSpice 4.2.x){{Bsvs|bsvTo=4.2.x}}
+*images/ folder
+*all LocalSettings.php  files<span><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 /><span /><br />
+===Copy from your backup Local files and some manual made settings===
+For a fast copy, use this bash command:
+<syntaxhighlight lang="bash">
+#Linux Bash
+cd your_secure_place
+cp -r images/ LocalSettings.* settings.d/ codebase/
+cp -r /extensions/BlueSpiceFoundation/config /codebase/extensions/BlueSpiceFoundation/
+</syntaxhighlight><syntaxhighlight lang="bash">
+#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/
+</syntaxhighlight>
+==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:<syntaxhighlight lang="bash">
+php maintenance/update.php
+</syntaxhighlight>
+{{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==
+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==
+*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].
+<span><span /><span /><span /><span /><span /><br /></span>
+[[de:Setup:Installationsanleitung/Patch_Update]]
 [[en:{{FULLPAGENAME}}]]
-[[de:Setup:Installationsanleitung/Patch_Update]]