https://docs.ulyssis.org/api.php?action=feedcontributions&user=Yoa&feedformat=atomULYSSIS documentation - User contributions [en]2024-03-29T12:57:29ZUser contributionsMediaWiki 1.39.6https://docs.ulyssis.org/index.php?title=Securing_MediaWiki_using_Centrale_KU_Leuven_Login&diff=1575Securing MediaWiki using Centrale KU Leuven Login2021-10-08T15:47:22Z<p>Yoa: /* Translations */</p>
<hr />
<div>==About==<br />
MediaWikiShibboleth is a MediaWiki extension created by ULYSSIS to allow for login through the Central KU Leuven Login (Shibboleth). The extension disables editing and creating of (talk) pages by anonymous users, and requires Shibboleth authentication for account creation and login.<br />
<br />
==Prerequisites==<br />
Before installing, you need to have SSL and Shibboleth (Central KU Leuven Login) enabled on your domain.<br />
* For instructions on how to get SSL: https://docs.ulyssis.org/Getting_SSL<br />
* Information about requesting Shibboleth: https://docs.ulyssis.org/Shibboleth<br />
Once you know everything is installed properly, you can proceed to install the extension.<br />
<br />
==Installation==<br />
First, download the latest release from [https://github.com/ULYSSIS-KUL/MediaWikiShibboleth/releases/latest/download/MediaWikiShibboleth.zip github]. Unzip the zip file in the <code>extensions/</code> directory in your MediaWiki installation folder. Make sure there is now a <code>MediaWikiShibboleth</code> folder in <code>extensions/</code>. Finally, locate the <code>LocalSettings.php</code> file in your MediaWiki installation folder and add the following lines to it:<br />
<br />
wfLoadExtension('MediaWikiShibboleth');<br />
$wgGroupPermissions['*']['createaccount'] = false;<br />
$wgRevokePermissions['Shibboleth']['editmyprivateinfo'] = true;<br />
<br />
$wgGroupPermissions['*']['edit'] = false;<br />
$wgGroupPermissions['*']['writeapi'] = false;<br />
<br />
If you want to allow anonymous editing, you should <b>not</b> add the last 2 lines of the previous paragraph. This really defeats the purpose of the extension though.<br />
<br />
==Configuration==<br />
MediaWikiShibboleth has some configuration options which allow for restricting who can log in to your wiki. These restrictions are cumulative. For example, it is possible to allow only students enrolled in a specific degree or programme to log in. These options work especially well with restricting the access of the wiki to logged-in users only.<br />
<br />
=== Restricting access to logged-in users only ===<br />
This option is not an option provided by the extension, but very useful in its context. If you do not want guest visitors to be able to view any page of your wiki, add the following line to your <code>LocalSettings.php</code>: <br />
<br />
$wgGroupPermissions['*']['read'] = false;<br />
<br />
=== MWSStudentsOnly ===<br />
This option tells MediaWikiShibboleth to only allow students to log in. KU Leuven employees, alumni, doctoral students, teaching assistants etc. will not be able to log in using their employee account. Do keep in mind doctoral students also have a student account, which will still work. Set this option by adding <br />
<br />
$wgMWSStudentsOnly = true;<br />
<br />
to <code>LocalSettings.php</code>. If you combine this option with "Restricting access to logged-in users only", only students will be able to view, log in and edit your wiki.<br />
<br />
=== MWSAllowedKULids ===<br />
This option can be used to only allow specific KUL ids to log in. An example KUL id is "r0653730". If this option is set to "", no KUL id checking will be performed. Set this option by adding <br />
<br />
$wgMWSAllowedKULids = "r0653730, r0300342, KUL id 3...";<br />
<br />
to <code>LocalSettings.php</code>. You can add as many KUL ids as you like, separated by a comma.<br />
<br />
=== MWSAllowedDegrees ===<br />
This option can be used to only allow students enrolled in specific degrees/programmes to log in. An example KUL degree number is "51016742". If this option is set to "", no degree number checking will be performed. Set this option by adding <br />
<br />
$wgMWSAllowedDegrees = "51016742, 51016835, 51016753...";<br />
<br />
to <code>LocalSettings.php</code>. You can add as many degree numbers as you like, separated by a comma.<br />
<br />
=== Translations ===<br />
It's possible to translate and modify all public MediaWikiShibboleth messages. The translations can be found in the <code>extensions/MediaWikiShibboleth/i18n/</code>. Dutch (<code>nl.json</code>) and English (<code>en.json</code>) translations are already provided. Even the provided translations can be customized, and we strongly advise you to do so, in order to match them with your wiki situation.<br />
<br />
==Operation==<br />
When the extension is installed successfully, anonymous users will not be able to create an account and the account creation page will be removed from the home page. On the log in page, a new image is added: if you click on this image, you will be logged in using Shibboleth. If you want to log in with an explicit username/password combination, you can click "Login without Central KU Leuven login" to expand a login menu.<br />
<br />
The new log in page looks like this with "Login without Central KU Leuven login" expanded:<br />
<br />
[[File:Login.png|thumb|none]]<br />
<br />
==Creating accounts==<br />
If you want to create password accounts, you can navigate to the CreateAccount special page (make sure you are logged in using an administrator account). This is necessary to create accounts for users without a KU Leuven login. You should select "Use a temporary random password and send it to the specified email address".<br />
<br />
[[File:CreateAccount.png|thumb|none]]<br />
<br />
[[Category:Security & anti-spam]]<br />
[[Category:CMSs]]</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1531Updating MediaWiki2021-08-17T19:13:33Z<p>Yoa: /* Finalizing the update */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you did not receive an email from our [[Software Version Checker]], follow the instructions in the next subsection. Otherwise, you can skip to the subsection [[#Downloading the right version using the Software Version Checker | Downloading the right version using the Software Version Checker]].<br />
<br />
=== Downloading the right version based on your wiki ===<br />
You can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on [https://en.wikipedia.org/wiki/MediaWiki_version_history wikipedia]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
=== Downloading the right version using the Software Version Checker ===<br />
The email you received will contain a link to the correct MediaWiki version. This link looks something like:<br />
https://releases.wikimedia.org/mediawiki/1.xx/mediawiki-core-1.xx.yy.tar.gz<br />
<br />
Simply click this link to download the archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy certain other other files and directories from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically. However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box (of course, replace <code><wiki installation location></code> with the location of your new installation):<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
If you get the error <code>Could not open input file</code>, you might have misspelled the installation location. Double check the path to make sure everything is correct.<br />
<br />
If you encounter any other errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1530Updating MediaWiki2021-08-17T19:06:35Z<p>Yoa: /* Finalizing the update */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you did not receive an email from our [[Software Version Checker]], follow the instructions in the next subsection. Otherwise, you can skip to the subsection [[#Downloading the right version using the Software Version Checker | Downloading the right version using the Software Version Checker]].<br />
<br />
=== Downloading the right version based on your wiki ===<br />
You can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on [https://en.wikipedia.org/wiki/MediaWiki_version_history wikipedia]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
=== Downloading the right version using the Software Version Checker ===<br />
The email you received will contain a link to the correct MediaWiki version. This link looks something like:<br />
https://releases.wikimedia.org/mediawiki/1.xx/mediawiki-core-1.xx.yy.tar.gz<br />
<br />
Simply click this link to download the archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy certain other other files and directories from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically. However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box (of course, replace <code><wiki installation location></code> with the location of your new installation):<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1512Updating MediaWiki2021-08-08T20:26:49Z<p>Yoa: /* Downloading the right version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you did not receive an email from our [[Software Version Checker]], follow the instructions in the next subsection. Otherwise, you can skip to the subsection [[#Downloading the right version using the Software Version Checker | Downloading the right version using the Software Version Checker]].<br />
<br />
=== Downloading the right version based on your wiki ===<br />
You can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
=== Downloading the right version using the Software Version Checker ===<br />
The email you received will contain a link to the correct MediaWiki version. This link looks something like:<br />
https://releases.wikimedia.org/mediawiki/1.xx/mediawiki-core-1.xx.yy.tar.gz<br />
<br />
Simply click this link to download the archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy certain other other files and directories from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically. However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1511Updating MediaWiki2021-08-08T20:24:05Z<p>Yoa: /* Downloading the right version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
=== Downloading the right version based on your wiki ===<br />
You can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
=== Downloading the right version using the Software Version Checker ===<br />
The email you received will contain a link to the correct MediaWiki version. This link looks something like:<br />
https://releases.wikimedia.org/mediawiki/1.xx/mediawiki-core-1.xx.yy.tar.gz<br />
<br />
Simply click this link to download the archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy certain other other files and directories from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically. However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1510Updating MediaWiki2021-08-08T13:06:12Z<p>Yoa: /* Updating extensions */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy certain other other files and directories from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically. However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1509Updating MediaWiki2021-08-08T13:05:59Z<p>Yoa: /* Updating extensions */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy certain other other files and directories from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically.<br />
<br />
However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1508Updating MediaWiki2021-08-08T13:05:21Z<p>Yoa: /* Installing the new files */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy certain other other files and directories from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically. However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1507Updating MediaWiki2021-08-08T12:56:49Z<p>Yoa: </p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this archive and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the archive file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the archive and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The <code>images/</code> directory, containing the uploaded files to the wiki.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins, these extensions will be updated automatically. However, for example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the update instructions are different for each extension, you will have to refer to the update instructions of the extension you want to update. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the archive files: similar to the MediaWiki tar.gz archive files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. Your MediaWiki installation contains a script, called <code>update.php</code>, to perform the necessary database upgrades. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: you should remove the previously created <code>www/wiki_old</code> directory, using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_new_browser.png&diff=1506File:Cyberduck new browser.png2021-08-08T12:43:52Z<p>Yoa: Yoa uploaded a new version of File:Cyberduck new browser.png</p>
<hr />
<div>Creating a new browser using Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_rename.png&diff=1505File:Cyberduck rename.png2021-08-08T12:43:42Z<p>Yoa: Yoa uploaded a new version of File:Cyberduck rename.png</p>
<hr />
<div>Cyberduck renaming</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_expand.png&diff=1504File:Cyberduck expand.png2021-08-08T12:43:36Z<p>Yoa: Yoa uploaded a new version of File:Cyberduck expand.png</p>
<hr />
<div>Expanding archives using Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_send_command.png&diff=1503File:Cyberduck send command.png2021-08-08T12:43:30Z<p>Yoa: Yoa uploaded a new version of File:Cyberduck send command.png</p>
<hr />
<div>Sending an SSH command to a server using Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1502Updating MediaWiki2021-08-08T12:17:26Z<p>Yoa: </p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the right version ==<br />
To start updating MediaWiki, you will need to download the archive file of the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column. '''Make sure this LTS branch is not older than your current branch!'''<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your computer.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' the wiki folder to <code>wiki_old</code>.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1501Updating MediaWiki2021-08-04T21:48:42Z<p>Yoa: /* Updating extensions */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". Extensions will often link to a website where you can download the latest versions. For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1500Updating MediaWiki2021-08-04T21:48:06Z<p>Yoa: /* Updating extensions */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki itself, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1499Updating MediaWiki2021-08-04T21:47:43Z<p>Yoa: /* Updating extensions */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. A list of bundled extensions can be found at https://www.mediawiki.org/wiki/Bundled_extensions_and_skins. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". For example, for this wiki, you can find the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Installed_extensions.png&diff=1498File:Installed extensions.png2021-08-04T21:47:38Z<p>Yoa: </p>
<hr />
<div></div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1497Updating MediaWiki2021-08-04T21:33:57Z<p>Yoa: /* Updating extensions */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As with MediaWiki, you can find the versions of your installed extensions on the <code>Special:Version</code> page, under "Installed extensions". For example, for this wiki, you can the installed extensions at [[Special:Version]]. At the time of writing, it looks like this: <br />
<br />
[[File:Installed extensions.png|center|frame]]<br />
<br />
Because the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1496Updating MediaWiki2021-08-04T21:32:12Z<p>Yoa: /* Installing the new files */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1495Updating MediaWiki2021-08-04T21:21:57Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.3, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1494Updating MediaWiki2021-08-04T21:21:22Z<p>Yoa: </p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.2, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.yy.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.yy.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.yy.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.yy</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.yy</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1493Updating MediaWiki2021-08-04T21:20:46Z<p>Yoa: </p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.2, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.y.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-1.xx.y.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-1.xx.y.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-1.xx.y</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-1.xx.y</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1492Updating MediaWiki2021-08-04T21:20:04Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version ('''the first two numbers''', like <code>1.xx</code>) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.2, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1491Updating MediaWiki2021-08-04T21:19:37Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version (the first two numbers, like 1.xx) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.2, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1490Updating MediaWiki2021-08-04T21:19:18Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version (the first two numbers, like 1.xx) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.2, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should choose the newest supported branch (green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.y.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1489Updating MediaWiki2021-08-04T21:18:22Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://en.wikipedia.org/wiki/MediaWiki_version_history the official table]. Currently supported versions are indicated by a green or yellow color in the first column. To determine which version you want to download, follow these steps:<br />
* If the ''branch'' of your version (the first two numbers, like 1.xx) is currently supported (green or yellow), you should choose the latest version for this branch. For example, for version 1.35.2, the branch is 1.35.<br />
* If this branch is not supported anymore, you should choose the most recent LTS branch. This is indicated by '''(LTS)''' in the second column.<br />
* If the most recent LTS branch is older than your current branch, you should download the most recent supported branch (in green).<br />
<br />
Now, click on the link of the branch you want to download. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-1.xx.y.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1481Updating MediaWiki2021-08-03T21:32:09Z<p>Yoa: </p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
{{info|In this guide, we assume you are familiar with the files on your ULYSSIS account. If you don't know how to access these files, please read [[Accessing your files]] first.}}<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. If you arrived at this page after receiving an email from our [[Software Version Checker]], follow the instructions in the next paragraph. Otherwise, you can skip the next paragraph.<br />
<br />
The email you received might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version</code> page on your wiki (simply paste this in the search box) and looking for the "MediaWiki" version under "Installed software". For example, for this wiki, you can find the current version at [[Special:Version]]. At the time of writing, it looks like this:<br />
<br />
[[File:Installed software.png|center|frame]]<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''. Click on the link of the version you want to download (if you need to choose a version, make sure to choose a supported, newer, preferably LTS version). This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Renaming the old installation ==<br />
An important step in the update process is to rename the old installation directory. This way, you can simply copy your data from the old installation directory to the new installation directory during the update. Additionally, you can easily restore your old wiki if something goes wrong.<br />
<br />
The easiest way to do this, is to '''rename''' your wiki location (the directory containing your <code>LocalSettings.php</code> configuration file) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_old</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 next to the old installation directory. For example, if your old installation directory is located in <code>www/wiki_old</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from the old installation. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any <code>.htaccess</code> file, if present. '''Make sure you can view hidden files'''; to enable this for Cyberduck, you can look at [[Accessing_your_files#Viewing_hidden_files|Accessing your files]].<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. For example, you might have the ULYSSIS extensions [[Securing MediaWiki using Centrale KU Leuven Login|MediaWikiShibboleth]] or [https://github.com/ULYSSIS-KUL/CompressUploads CompressUploads] installed. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the old installation: for example, if this is stored in <code>www/wiki_old</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing_your_files#Creating_and_Deleting_files_and_folders|Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Installed_software.png&diff=1480File:Installed software.png2021-08-03T20:31:53Z<p>Yoa: </p>
<hr />
<div></div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1479Updating MediaWiki2021-08-03T20:25:17Z<p>Yoa: Remove refresh instructions</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version#Installed_software</code> page on your wiki. For example, for this wiki, you can find the current version at [[Special:Version#Installed_software]].<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''. Click on the link of the version you want to download (if you need to choose a version, make sure to choose a supported, newer, preferably LTS version). This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1375Updating MediaWiki2021-05-06T23:02:50Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version#Installed_software</code> page on your wiki. For example, for this wiki, you can find the current version at [[Special:Version#Installed_software]].<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''. Click on the link of the version you want to download (if you need to choose a version, make sure to choose a supported, newer, preferably LTS version). This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
If you used Cyberduck to rename the directory, you should refresh it by right clicking the directory and pressing "Refresh".<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by right clicking the directory and pressing "Refresh".<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1374Updating MediaWiki2021-05-06T23:02:37Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version#Installed_software</code> page on your wiki. For example, for this wiki, you can find the current version at [[Special:Version#Installed_software]].<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''. Click on the link of the version you need to download (if you need to choose a version, make sure to choose a supported, newer, preferably LTS version). This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
If you used Cyberduck to rename the directory, you should refresh it by right clicking the directory and pressing "Refresh".<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by right clicking the directory and pressing "Refresh".<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1373Updating MediaWiki2021-05-06T22:59:28Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version#Installed_software</code> page on your wiki. For example, for this wiki, you can find the current version at [[Special:Version#Installed_software]].<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''. Click on the link of the version you want to download, either provided by the Software Version Checker, or a newer version compared to your current version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
If you used Cyberduck to rename the directory, you should refresh it by right clicking the directory and pressing "Refresh".<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by right clicking the directory and pressing "Refresh".<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1372Updating MediaWiki2021-05-06T22:59:10Z<p>Yoa: /* Downloading the latest version */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can find your current MediaWiki version by going to the <code>Special:Version#Installed_software</code> page on your wiki. For example, for this wiki, you can find the current version at [[Special:Version#Installed_software]].<br />
<br />
A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
Click on the link of the version you want to download, either provided by the Software Version Checker, or a newer version compared to your current version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
If you used Cyberduck to rename the directory, you should refresh it by right clicking the directory and pressing "Refresh".<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by right clicking the directory and pressing "Refresh".<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1363Updating MediaWiki2021-05-01T22:44:52Z<p>Yoa: /* Finalizing the update */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
If you used Cyberduck to rename the directory, you should refresh it by right clicking the directory and pressing "Refresh".<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by right clicking the directory and pressing "Refresh".<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
[[File:Cyberduck send command.png|thumb|center]]<br />
<br />
Enter the following command in the pop-up box:<br />
<br />
php <wiki installation location>/maintenance/update.php<br />
<br />
For example, if your wiki is located at <code>www/wiki</code>, the command should be as follows:<br />
<br />
[[File:Cyberduck update.png|center|750px]]<br />
<br />
After pressing "Send", the command will be executed on the server. If everything went well, you should see a lot of output, ending with something like:<br />
<br />
[[File:Cyberduck update output.png|center|750px]]<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_update_output.png&diff=1362File:Cyberduck update output.png2021-05-01T22:42:30Z<p>Yoa: </p>
<hr />
<div>MediaWiki update command using Cyberduck (output)</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_update.png&diff=1361File:Cyberduck update.png2021-05-01T22:40:02Z<p>Yoa: </p>
<hr />
<div>MediaWiki update command using Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_send_command.png&diff=1360File:Cyberduck send command.png2021-05-01T22:37:24Z<p>Yoa: </p>
<hr />
<div>Sending an SSH command to a server using Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1359Updating MediaWiki2021-05-01T22:36:17Z<p>Yoa: /* Making a backup */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
If you used Cyberduck to rename the directory, you should refresh it by right clicking the directory and pressing "Refresh".<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by right clicking the directory and pressing "Refresh".<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
<br />
<br />
Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1358Updating MediaWiki2021-05-01T22:35:43Z<p>Yoa: /* Installing the new files */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by right clicking the directory and pressing "Refresh".<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
<br />
<br />
Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1357Updating MediaWiki2021-05-01T22:35:12Z<p>Yoa: /* Installing the new files */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Make sure to refresh after renaming by pressing the "Refresh button in Cyberduck the toolbar.<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
<br />
<br />
Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1356Updating MediaWiki2021-05-01T22:34:24Z<p>Yoa: /* Finalizing the update */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. This script can be executed using the Cyberduck "Send Command" feature.<br />
<br />
<br />
<br />
Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1355Updating MediaWiki2021-05-01T22:32:05Z<p>Yoa: /* Installing the new files */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to upload the <code>mediawiki-xxx.tar.gz</code> file you downloaded in step 1 to the same path as where your wiki backup directory is located. For example, if your wiki backup directory is located in <code>www/wiki_backup</code>, upload <code>mediawiki-xxx.tar.gz</code> to <code>www/</code>.<br />
<br />
After uploading, you can extract the file on the server by using the Cyberduck "Expand Archive" feature. Simply right click the file and click "Expand Archive".<br />
<br />
[[File:Cyberduck expand.png|thumb|center]]<br />
<br />
This will create a directory named <code>mediawiki-xxx</code>. Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if the original name was <code>wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>. This can be done using Cyberduck by right clicking the directory and clicking "Rename".<br />
<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. The easiest way to do this using Cyberduck is by creating a "New Browser". Right click the '''new''' directory, and click "New Browser".<br />
<br />
[[File:Cyberduck new browser.png|thumb|center]]<br />
<br />
Then, you can simply place both windows next to each other, and drag-and-drop files or directories to copy them from the '''old''' directory to the '''new''' directory. For example, copying <code>LocalSettings.php</code>:<br />
<br />
[[File:Cyberduck drag and drop.png|center|750px]]<br />
<br />
Although the exact files you need to copy are different depending on your wiki, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_drag_and_drop.png&diff=1354File:Cyberduck drag and drop.png2021-05-01T22:27:50Z<p>Yoa: </p>
<hr />
<div>Copying files or directories using drag-and-drop between browsers in Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_new_browser.png&diff=1353File:Cyberduck new browser.png2021-05-01T22:26:28Z<p>Yoa: </p>
<hr />
<div>Creating a new browser using Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_expand.png&diff=1352File:Cyberduck expand.png2021-05-01T22:18:06Z<p>Yoa: </p>
<hr />
<div>Expanding archives using Cyberduck</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1351Updating MediaWiki2021-05-01T22:13:42Z<p>Yoa: /* Making a backup */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
<br />
== Installing the new files ==<br />
Now, you will need to extract the zip file you downloaded in step 1. This should result in a directory which looks something like:<br />
mediawiki-xxx/<br />
├── cache/<br />
├── docs/<br />
├── ...<br />
├── api.php<br />
├── autoload.php<br />
└── ...<br />
<br />
Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if your wiki was located at <code>www/wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>.<br />
<br />
Next, you should upload this directory to your ULYSSIS account, to the original location of your wiki. If you followed step 2 correctly, the old files should be moved to a backup directory. As a result, after uploading, your ULYSSIS acocunt should contain the new files in something like <code>www/wiki</code>, and the old files in <code>www/wiki_backup</code>. Please refer to [[Accessing your files]] if you don't know how to upload files. Because MediaWiki contains a lot of (small) files, this might take a long time, up to 15 minutes.<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. Although only you know exactly which files these are, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1350Updating MediaWiki2021-05-01T22:13:13Z<p>Yoa: /* Making a backup */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
[[File:Cyberduck rename.png|thumb|center]]<br />
<br />
== Installing the new files ==<br />
Now, you will need to extract the zip file you downloaded in step 1. This should result in a directory which looks something like:<br />
mediawiki-xxx/<br />
├── cache/<br />
├── docs/<br />
├── ...<br />
├── api.php<br />
├── autoload.php<br />
└── ...<br />
<br />
Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if your wiki was located at <code>www/wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>.<br />
<br />
Next, you should upload this directory to your ULYSSIS account, to the original location of your wiki. If you followed step 2 correctly, the old files should be moved to a backup directory. As a result, after uploading, your ULYSSIS acocunt should contain the new files in something like <code>www/wiki</code>, and the old files in <code>www/wiki_backup</code>. Please refer to [[Accessing your files]] if you don't know how to upload files. Because MediaWiki contains a lot of (small) files, this might take a long time, up to 15 minutes.<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. Although only you know exactly which files these are, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=Updating_MediaWiki&diff=1349Updating MediaWiki2021-05-01T22:11:22Z<p>Yoa: /* Making a backup */</p>
<hr />
<div>The MediaWiki project provides an official [https://www.mediawiki.org/wiki/Manual:Upgrading wiki page] which explains the procedure to update a wiki. Unfortunately, their instructions are complex, and the page contains a lot of information that is outdated or irrelevant for our users. To make it easier for our users to update, this documentation page aims to be more accessible and easier to understand. However, this page is not an authoritative source on the subject. If the instructions on this page are unclear at any point, you should always refer back to the official instructions.<br />
<br />
== Downloading the latest version ==<br />
To start updating MediaWiki, you will need to download the version you want to update to. A table of all recent MediaWiki versions can be found on the [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the official table]. In this table, currently supported versions are in '''bold'''.<br />
<br />
If you arrived at this page after receiving an email from our [[Software Version Checker]]. This email might contain a line similar to:<br />
- MediaWiki in <path>. Installed version: <version1>. Latest version: <version2>.<br />
This line tells you where the MediaWiki installation is located, its current version, and the version you need to download.<br />
<br />
If you don't have an email from our Software Version Checker, you can simply choose any supported ('''bold''') version from [https://www.mediawiki.org/wiki/Version_lifecycle#Versions_and_their_end-of-life the table].<br />
<br />
Click on the link of the newer version. This will redirect you to a page with information about this version. The first paragraph on this page contains a link to <code>mediawiki-xxx.tar.gz</code>. Download this file and save it somewhere on your PC.<br />
<br />
== Making a backup ==<br />
An important step in the update process is to create a backup of your data on the ULYSSIS server, to prevent data loss if something goes wrong. Additionally, this backup will be used to copy files from your old installation to the new installation. Consequently, '''this step is mandatory'''.<br />
<br />
The easiest way to create a backup is to '''rename''' the directory containing your <code>LocalSettings.php</code> configuration file (your wiki location) to a new directory. If you don't know how to access your files on your ULYSSIS account, refer to [[Accessing your files]] for easy instructions. For example, if <code>LocalSettings.php</code> is stored in <code>www/wiki</code>, you should '''rename''' this directory to <code>www/wiki_backup</code>, or something similar.<br />
[[File:Cyberduck rename.png|thumb|centre]]<br />
<br />
== Installing the new files ==<br />
Now, you will need to extract the zip file you downloaded in step 1. This should result in a directory which looks something like:<br />
mediawiki-xxx/<br />
├── cache/<br />
├── docs/<br />
├── ...<br />
├── api.php<br />
├── autoload.php<br />
└── ...<br />
<br />
Rename this directory to the original name of your wiki directory on your ULYSSIS account. For example, if your wiki was located at <code>www/wiki</code>, rename this directory from <code>mediawiki-xxx</code> to <code>wiki</code>.<br />
<br />
Next, you should upload this directory to your ULYSSIS account, to the original location of your wiki. If you followed step 2 correctly, the old files should be moved to a backup directory. As a result, after uploading, your ULYSSIS acocunt should contain the new files in something like <code>www/wiki</code>, and the old files in <code>www/wiki_backup</code>. Please refer to [[Accessing your files]] if you don't know how to upload files. Because MediaWiki contains a lot of (small) files, this might take a long time, up to 15 minutes.<br />
<br />
Finally, you need to copy the configuration files and other files or directories you modified from the '''old''' directory to the '''new''' directory. Although only you know exactly which files these are, here are some suggestions from the [https://www.mediawiki.org/wiki/Manual:Upgrading#Other_files official instructions]:<br />
* <code>LocalSettings.php</code>, which contains your old configuration settings.<br />
* The directory containing the uploaded files to the wiki. Most likely, this is <code>images/</code>, unless you set the value <code>$wgUploadDirectory</code> in <code>LocalSettings.php</code><br />
* In case you use a custom logo or favicon, this file also needs to be restored from backup. You can find the locations of these files by checking the <code>$wgLogo</code> and <code>$wgFavicon</code> values in <code>LocalSettings.php</code>.<br />
* Custom extensions from within the <code>extensions/</code> directory. Be careful not to overwrite the default extensions that are bundled with the new MediaWiki version.<br />
* Custom skins from within the <code>skins/</code> directory. Be careful not to overwrite the default skins that are bundled with the new MediaWiki version.<br />
* Any modifications made to the old installation files, extensions, or skins. For example, this includes miscellaneous modifications to the configuration of extensions or skins.<br />
* Any <code>.htaccess</code> file, if present.<br />
<br />
== Updating extensions ==<br />
If you use any extensions that are not bundled with MediaWiki by default, you should update them too. As the installation instructions for each extension are different for each extension, this page can't help you with this process. However, most extensions follow the same template as the MediaWiki upgrade itself:<br />
* Downloading the latest version: make sure to download the correct update for your new MediaWiki version.<br />
* Making a backup of the extension: you should already have a backup in the directory you created in step 2.<br />
* Extracting the files: similar to the MediaWiki zip files, you might have to copy the new extension files to a directory in the new <code>extension/</code> directory.<br />
<br />
== Finalizing the update ==<br />
The final step in the update process is to update the database structure of your wiki. The MediaWiki developers were kind enough to create a script, called <code>update.php</code>. Unfortunately, this script must be executed using the command line. If you are not familiar with the command line or SSH, please read [[Accessing shell servers over SSH]] first.<br />
<br />
After connecting to your account using SSH, navigate to the directory containing your new wiki installation. For example, if your wiki is located at <code>www/wiki</code>, execute:<br />
cd ~/www/wiki<br />
This directory should contain all your wiki files, such as <code>LocalSettings.php</code>. Now, navigate to the <code>maintenance/</code> directory:<br />
cd maintenance<br />
This directory contains the <code>update.php</code> file. To run this script, execute:<br />
php update.php<br />
The script will first display a 5 second countdown to execution, just in case you want to abort. After the countdown, you should not interrupt the execution of the script. If everything went well, you should see a lot of text, ending with:<br />
Done in x s.<br />
<br />
Congratulations! You successfully updated MediaWiki. Still, there are two more important steps you must perform:<br />
* Test your new MediaWiki installation: make sure all basic functionality (viewing, editing pages, file upload) works and all your extensions function properly.<br />
* Delete the backup installation: for example, if your backup is stored in <code>www/wiki_backup</code>, you can remove it using the command line or through a GUI. A simple GUI explanation can be found on [[Accessing your files]].<br />
<br />
However, if you did encounter any errors while executing the script, you could try taking a look at the [https://www.mediawiki.org/wiki/Manual:Upgrading#Command_line_2 official instructions]. If this does not resolve your problems, feel free to send us an email. We will try to assist you in completing the update.</div>Yoahttps://docs.ulyssis.org/index.php?title=File:Cyberduck_rename.png&diff=1348File:Cyberduck rename.png2021-05-01T22:10:50Z<p>Yoa: </p>
<hr />
<div>Cyberduck renaming</div>Yoa