Difference between revisions of "Setup:Installation Guide/Upgrade"

{{DISPLAYTITLE:Update to BlueSpice 2.27.2}}
        
        __TOC__
        
        
        
        
        
        This document describes the update of BlueSpice from version 2.23.x-2.27.x to version 2.27.2.
        
        
        
        ==Notes==
        
        * Please read this manual completely and follow the installation steps in the given order.
        
        * For editing the configuration files in a text editor, it is necessary to save the files in UTF-8 code without BOM (Byte Order Mark).
        
        * The placeholder <code>&lt;installpath-bluespice&gt;</code> is representative for the path to your BlueSpice installation, e.g. <code>C:\inetpub\wwwroot\bluespice</code> (Windows) oder <code>/var/www/bluespice</code> (Linux).
        
        * The placeholder <code>&lt;bluespice-url&gt;</code> is representative for the URL of your BlueSpice installation, e.g. http://localhost/bluespice.
        
        
        
        ==Requirements==
        
        For the update of BlueSpice to the BlueSpice version 2.27.2, an already installed and fully configured MediaWiki 1.27.x is required. This must be accessable at <code>&lt;bluespice-url&gt;</code> in your browser. If your current BlueSpice installation does not use MediaWiki 1.27.x, visit the [[Setup:Installation Manual/MediaWiki/Update|Update Manual for MediaWiki 1.23.x to 1.27.x]] for more information.
        
        
        
        ==Backup==
        
        It is absolutely necessary to create a backup copy of your current installation before updating the wiki.
        
        
        
        ===Backup Database===
        
        To back up your database, use the on-board "mysqldump" program from MySQL / MariaDB:
        
        To do this, please open a console, change the directory <code>&lt;installpath-bluespice&gt;</code> and save the database using the following command:
        
        
        
         mysqldump -u &lt;username&gt; -p --lock-tables &lt;database&gt; &gt; database.sql
        
        
        
        For <code>&lt;username&gt;</code> please use your administrative database user (usually "root"). For <code>&lt;database&gt;</code> use the database name of your MediaWiki/BlueSpice installation.<br /><br />
        
        
        
        [[File:Hint.jpg|left]]'''Under Windows, please make sure that the [[Setup:Installation_Manual/System_Configuration/Environment_Variables|environment variables]] are set correctly to access the mysqldump command.'''<br style="clear: left;" /><br />
        
        
        
        ===Backup File System===
        
        Save the complete directory <code>&lt;installpath-bluespice&gt;</code>, which now contains the database image, to a different location on your server.<br />
        
        '''For security reasons, immediately delete the file <code>&lt;installpath-bluespice&gt;/database.sql</code>.'''
        
        
        
        ==Download BlueSpice==
        
        Download the current version of BlueSpice from [https://sourceforge.net/projects/bluespice/files/ Sourceforge].<br />The package corresponding to this manual bears the name '''BlueSpice-free-2.27.2.zip'''.<br /><br />
        
        
        
        [[File:Hint.jpg|left]] '''If you purchased BlueSpice pro, this step is omitted. The corresponding package will be provided directly by the distributor.'''<br style="clear: left;" /><br />
        
        
        
        ==Unzip and Copy BlueSpice==
        
        Unzip the downloaded BlueSpice archive. Please make sure that all relevant content is placed in '''one''' subfolder (e.g. bluespice-free). This subfolder contains the following directories and files:<br />
        
        
        
        [[File:Setup:Setup_bluespice_packagecontent.jpg|right|150x172px|border]]
        
        
        
            
            
        * extensions
        
        * settings.d
        
        * skins
        
        * BLUESPICE-INSTALL
        
        * BLUESPICE-LICENSE
        
        * BLUESPICE-RELEASE-HISTORY
        
        * BLUESPICE-RELEASE-NOTES
        
        * installcheck.php
        
        * LocalSettings.BlueSpice.php
        
        * ''nsfr_img_auth.php '''(BlueSpice pro only)'''''
        
        
        
        Copy the unzipped subfolders into the <code>&lt;installpath-bluespice&gt;</code> and overwrite the exsting files.
        
        
        
        Delete the directory <code>&lt;installpath-bluespice&gt;/extensions/BlueSpiceDistribution</code> as long as it is still available from an old BlueSpice installation.
        
        
        
        ==Setup LocalSettings.php==
        
        Open the file <code>&lt;installpath-bluespice&gt;/LocalSettings.php</code>. Look for the following lines:
        
        
        
         # End of automatically generated settings.
        
         # Add more configuration options below.
        
        
        
        Delete all following lines.
        
        If you have made additional configurations - apart from steps outlined in the old installation manual - under these lines, please keep these additional configurations in each case.
        
        
        
        Insert the following lines instead at the end of LocalSettings.php:
        
        
        
         require_once "$IP/LocalSettings.BlueSpice.php";
        
        
        
        Close and save the file.<br /><br />
        
        
        
        [[File:Hint.jpg|left]] '''Starting with BlueSpice 2.27.1, all default settings as well as the individual modules of BlueSpice are stored. Thus BlueSpice is only integrated with this one line in MediaWiki. For technical information, visit the [[Setup:Installation Manual/Advanced/Configuration Folder settings.d|documentation for advanced users]].'''<br style="clear: left;" /><br />
        
        
        
        ==Optional: Setup BlueSpiceExtensions==
        
        If you have already created the file <code>&lt;installpath-bluespice&gt;/extensions/BlueSpiceExtensions/BlueSpiceExtensions.local.php</code> in your current BlueSpice version, please switch to the directory <code>&lt;installpath-bluespice&gt;/extensions/BlueSpiceExtensions</code> and rename this mentioned file into <code>BlueSpiceExtensions.bak.php</code>.
        
        
        
        In the next step, copy the file <code>BlueSpiceExtensions.default.php</code> to <code>BlueSpiceExtensions.local.php</code>
        
        
        
        Please compare the files <code>BlueSpiceExtensions.local.php</code> and <code>BlueSpiceExtensions.bak.php</code> and make any uncomments/comments to the individual extensions made by you in the past. This is especially applicable to [[Setup:Installation Manual/Webservices/Extended Search|Extended Search]] and [[Setup:Installation Manual/Webservices/PDF-Export|PDF Export]].
        
        
        
        ==Update BlueSpice==
        
        Open your command line or terminal an change to the directory <code>&lt;installpath-bluespice&gt;</code>. run the following command there:
        
        
        
         php maintenance/update.php ''(Linux)''
        
         php maintenance\update.php ''(Windows))''
        
        
        
        [[File:Hint.jpg|left]] '''Under Windows, make sure that the [[Setup:Installation_Manual/System_Configuration/Environment_Variables|environment variables]] are set correctly to access the php command.'''<br style="clear: left;" /><br /><br />
        
        
        
        [[File:Hint.jpg|left]] '''Under Linux, please note that you have to adjust the [[Setup:Installation Manual/Security Settings/File System Permissions|file system permissions]] after running the update.php.'''<br style="clear: left;" /><br />
        
        
        
        When the script is finished with the "Done" message, proceed to the next step.<br /><br />
        
        
        
        [[File:Setup:Setup_bluespice_maintenance_update.jpg|center|400x556px]]<br />
        
        
        
        If the script should stop running, restart it.
        
        
        
        ==Installation of the webservice to use the LatexRenderer (only BlueSpice pro only)==
        
        Starting with BlueSpice 2.27.2 the extension "BlueSpiceLatexRenderer" replaces the extension "Math". <br />'''Please note: LatexRenderer is a part of the BlueSpice pro edition only!'''
        
        
        
        Please note that you have to install the [[Setup:Installation_Manual/Webservices/LatexRenderer|webservice]] to use this extension.
        
        
        
        When updating please also delete the folder <code>&lt;installpath-bluespice&gt;/extensions/Math</code>.
        
        
        
        The usage of the tag <math> will not be changed, BlueSpiceLatexRenderer will use this tag as it is documented for the Math extension.</math>
        
        
        
        ==Check installation==
        
        Open <code>&lt;bluespice-url&gt;</code> in your browser. BlueSpice should now be successfully updated to version 2.27.2 and a login with your access data should be possible.