Editing TEHCC Wiki:Maintenance

{{#arraydefine:phpcommand|/opt/cpanel/ea-php73/root/usr/bin/php}}<!-- Load with any special directory specifying required to access desired version of php -->
{{#arraydefine:mwInstallVersion|mediawiki-1.34.1}}<!-- Use to update examples to be useful -->
'''Note!''' While using <kbd>php</kbd> uses PHP v7.0 which appears sufficient, the site actually runs on PHP v7.3. To ensure no oddity of running update scripts with a different version of php, when instructions call for <kbd>php</kbd> you instead use <kbd>{{#arrayprint:phpcommand}}</kbd>.

==Installed Extensions Reference==
The following extensions are used for the listed purposes
* Composer based extensions
** [https://getcomposer.org/download/ Composer] - per [https://www.mediawiki.org/wiki/Composer/For_extensions Mediawiki] site in wiki root folder. Used to install Composer packages and dependencies
** [https://www.semantic-mediawiki.org/wiki/Help:Installation/Quick_guide Semantic MediaWiki] - whole site revolves around it
** [https://github.com/JeroenDeDauw/Maps/blob/master/INSTALL.md Maps] - For the embedded interactive maps
** [https://www.semantic-mediawiki.org/wiki/Semantic_Result_Formats Semantic result formats] - permits semantic queries to other formats, I know array type is used by complex templates but I'm sure others have been used as well
** [https://www.mediawiki.org/wiki/Extension:Semantic_Compound_Queries Semantic Compound Queries] - permits advanced queries notably used in complex map templates
* Manually installed extensions
** [https://www.mediawiki.org/wiki/Extension:NumberFormat NumberFormat] - Used to format numbers. SMW sum'd results are not natively able to be formatted. 
** [https://www.mediawiki.org/wiki/Extension:Page_Forms/Download_and_installation Page Forms] - Makes the form editing of pages possible
** [https://www.mediawiki.org/wiki/Extension:Arrays Arrays] - Used for array creation and manipulation, including this page
** [https://www.mediawiki.org/wiki/Extension:Header_Tabs Header Tabs] - Allows turning form pages (or really any page) into tabbed pages
** [https://www.mediawiki.org/wiki/Extension:MyVariables MyVariables] - Allows referencing logged in user for form automation
** [https://www.mediawiki.org/wiki/Extension:SimpleTable SimpleTable] - Allows simple table definition, specifically easily working with a CSV list
** [https://www.mediawiki.org/wiki/Extension:UrlGetParameters UrlGetParameters] - Allows use of a GET parameter in a link to be used by the page code. Used for Hike Logs.

==System Maintenance==

===Upgrade/Reinstall===
Use to upgrade across major versions or to reinstall after a borked update.
<p>General wisdom is to wait for the x.1 release before upgrading.
<p>'''Note!''' The example commands below are using a page array variable. Edit the page to update the variable for your target installation to ease copy-n-paste of commands. Examples currently using <kbd>{{#arrayprint:mwInstallVersion}}</kbd>.
# Precheck!
## These steps have worked for upgrades in the past, but a reality check with any new versions and [https://www.mediawiki.org/wiki/Manual:Upgrading MediaWiki's Upgrade Procedure] is always prudent.
## Check requirements vs. what the current [[Special:Version|Version Page]] is showing! Primarily PHP as the host's slow version updating and PHP's aggressive deprecation have been a problem.
## Run the [[#Update extensions|Update extensions]] procedure below to ensure everything is up to date prior to upgrade. We will copy Composer and manual extensions from the current installation for ease of upgrade.
## Include running the maintenance update and runJobs.
# Get MediaWiki (per [https://www.mediawiki.org/wiki/Manual:Upgrading MediaWiki site])
## Download desired version from the [https://www.mediawiki.org/wiki/Download MediaWiki Site] using <kbd>wget</kbd> to the home directory
## Unpack using <kbd>tar -xvzf</kbd> (''e.g.'', <code>tar -xvzf ''{{#arrayprint:mwInstallVersion}}.tar.gz''</code>)
## Delete zipped tarball (''e.g.'', <code>rm ''{{#arrayprint:mwInstallVersion}}.tar.gz''</code>)
# Copy customized files to new install (per [https://www.mediawiki.org/wiki/Manual:Upgrading MediaWiki site])
## Copy Localsettings.php (''e.g.'', <code>cp public_html/clubwiki/LocalSettings.php ~/''{{#arrayprint:mwInstallVersion}}''/</code>)
## Copy kml folder (''e.g.'', <code>cp -R public_html/clubwiki/kml/ ~/''{{#arrayprint:mwInstallVersion}}''/</code>)
## Copy Images folder (''e.g.'', <code>cp -R public_html/clubwiki/images/ ~/''{{#arrayprint:mwInstallVersion}}''/</code>)
# Migrate manual extensions (Confirm this list is still accurate with the more actively used update procedure below)
## Copy Arrays (''e.g.'', <code>cp -R public_html/clubwiki/extensions/Arrays/ ~/{{#arrayprint:mwInstallVersion}}/extensions/</code>)
## Copy HeaderTabs (''e.g.'', <code>cp -R public_html/clubwiki/extensions/HeaderTabs/ ~/{{#arrayprint:mwInstallVersion}}/extensions/</code>)
## Copy MyVariables (''e.g.'', <code>cp -R public_html/clubwiki/extensions/MyVariables/ ~/{{#arrayprint:mwInstallVersion}}/extensions/</code>)
## Copy NumberFormat (''e.g.'', <code>cp -R public_html/clubwiki/extensions/NumberFormat/ ~/{{#arrayprint:mwInstallVersion}}/extensions/</code>)
## Copy PageForms (''e.g.'', <code>cp -R public_html/clubwiki/extensions/PageForms/ ~/{{#arrayprint:mwInstallVersion}}/extensions/</code>)
## Copy SimpleTabs (''e.g.'', <code>cp public_html/clubwiki/extensions/SimpleTable.php ~/{{#arrayprint:mwInstallVersion}}/extensions/</code>)
# Migrate Composer (can also follow Mediawiki recommendations, but if you updated extensions first, this should be fine)
## Copy composer.local.json (''e.g.'', <code>cp public_html/clubwiki/composer.local.json ~/''{{#arrayprint:mwInstallVersion}}''/</code>)
## Copy composer.phar (''e.g.'', <code>cp public_html/clubwiki/composer.phar ~/''{{#arrayprint:mwInstallVersion}}''/</code>)
# Move over to new install (per [https://www.mediawiki.org/wiki/Manual:Upgrading MediaWiki site])
##Move the existing installation to a temporary backup folder <code>mv ~/public_html/clubwiki/ ~/OLD.yyyymmdd.clubwiki</code>
## Move the new installation to the public folder <code>mv ~/''{{#arrayprint:mwInstallVersion}}/'' ~/public_html/clubwiki</code>
# Finish by repeating [[#Update extensions|Update extensions]] again. This will force composer to install composer packages and needed dependencies. Again include running the maintenance update and runJobs to complete the upgrade (instead of the web based upgrade).
# Check [[Special:Version]] and a page or two to confirm things are still working.
# Lessons of the past...
## If upgrade stalls to white screen, likely a specified extension is not installed, check list and add as needed
## May need to ctrl-shift-R to force reload pages to avoid seeing errors
# Done!

===Update MediaWiki===
Patch - Available for point releases. Details on the [https://www.mediawiki.org/wiki/Manual:Upgrading#Using_patch MediaWiki site]
# Download patch from the [http://dumps.wikimedia.org/mediawiki/ dumps site]
# <kbd>cd</kbd> to <code>cd ~/public_html/clubwiki/</code> directory (the one with LocalSettings.php).
# Download (<kbd>wget</kbd>) the patch file from the [http://dumps.wikimedia.org/mediawiki/ dumps site] and <kbd>gunzip</kbd> it <code>gunzip ''{{#arrayprint:mwInstallVersion}}.patch''.gz</code>.
# Use <code>patch -p1 --dry-run</code> to check what will be changed (''e.g.'', <code>patch -p1 --dry-run -i ''{{#arrayprint:mwInstallVersion}}.patch''</code>)
# If all is well, run <kbd>patch</kbd> again without <code>--dry-run</code> (''e.g.'', <code>patch -p1 -i ''{{#arrayprint:mwInstallVersion}}.patch''</code>).
# Check [[Special:Version]] and you should see the new version number in place.
# Delete patch files <code>rm ''{{#arrayprint:mwInstallVersion}}.patch''*</code>

===Update extensions===
'''NOTE''': I have often got errors or configuration screens from the site after updating extensions. These are typically resolved by running the maintenance routine below. Sometimes a single browser temporarily refused to work, yet a different browser behaved normally.
#Composer based (Semantic MediaWiki, Maps, and Semantic Result Formats)
## <kbd>cd</kbd> to <code>cd ~/public_html/clubwiki/</code> directory (the one with LocalSettings.php).
## Update composer <code>{{#arrayprint:phpcommand}} composer.phar self-update</code>
## Update using composer <code>{{#arrayprint:phpcommand}} composer.phar update --no-dev</code>
# Composer extensions that need version number updated in <kbd>composer.local.json</kbd> <code>vi composer.local.json</code>
## [https://www.semantic-mediawiki.org/wiki/Semantic_MediaWiki Semantic MediaWiki]
## [https://github.com/JeroenDeDauw/Maps/blob/master/RELEASE-NOTES.md Maps]
## [https://github.com/SemanticMediaWiki/SemanticResultFormats/blob/master/RELEASE-NOTES.md Semantic Result Formats]
## [https://github.com/SemanticMediaWiki/SemanticCompoundQueries/blob/master/RELEASE-NOTES.md Semantic Compound Queries]
## [https://github.com/ProfessionalWiki/ModernTimeline ModernTimeline]
## Rerun composer update if there were any updates to perform <code>{{#arrayprint:phpcommand}} composer.phar update --no-dev</code>
# Manual extensions - Go to [[Special:Version]] and compare what's shown on extension page
## [https://www.mediawiki.org/wiki/Extension:NumberFormat NumberFormat] - Download needed updates and extract into the extension directory <code>tar -xzf extension.tar.gz -C public_html/clubwiki/extensions/</code>
## [https://www.mediawiki.org/wiki/Extension:Page_Forms/Download_and_installation Page Forms] - Download extension and extract into the extension directory <code>tar -xzf extension.tar.gz -C public_html/clubwiki/extensions/</code>
## [https://www.mediawiki.org/wiki/Extension:Arrays Arrays] - Upload new version into extension folder
## [https://www.mediawiki.org/wiki/Extension:Header_Tabs Header Tabs] - Upload new version into extension folder
## [https://www.mediawiki.org/wiki/Extension:MyVariables MyVariables] - Upload new version into extension folder
## [https://www.mediawiki.org/wiki/Extension:SimpleTable SimpleTable] - Upload new version into extension folder
## [https://www.mediawiki.org/wiki/Extension:UrlGetParameters UrlGetParameters] - Upload new version into extension folder
# Remaining extensions are part of MediaWiki and upgraded with it
# Update completion - run maintenance routine from <code>cd ~/public_html/clubwiki/</code> directory: <code>{{#arrayprint:phpcommand}} maintenance/update.php</code>
# Finish any residual jobs - run manual maintenance runJobs from <code>cd ~/public_html/clubwiki/</code> directory: <code>{{#arrayprint:phpcommand}} maintenance/runJobs.php --maxjobs 1000</code>

==Site Maintenance==
Cleanup after a spam/vandalism battle
# <kbd>cd</kbd> to <code>cd ~/public_html/clubwiki/</code> directory (the one with LocalSettings.php)
# Delete archived revisions (deleted page revisions) <code>{{#arrayprint:phpcommand}} maintenance/deleteArchivedRevisions.php</code> for dry run, then execute <code>{{#arrayprint:phpcommand}} maintenance/deleteArchivedRevisions.php --delete</code>
# Delete users older than 7 days with no edits <code>{{#arrayprint:phpcommand}} maintenance/removeUnusedAccounts.php --ignore-touched 7</code> for dry run, then execute <code>{{#arrayprint:phpcommand}} maintenance/removeUnusedAccounts.php --ignore-touched 7 --delete</code>