Here are some notes intended for site administrators.
The site administrator has a "SuperUser" Joomla account, called suttonpoyntz; this gives access to all of the Joomla features (most of the accounts that have been created give a subset of features, and do not, for example, allow the modification of all the user accounts).
In addition, the site administrator will need access to features provided by the site host (currently One.com), and so has a One.com Control Panel account. This Control Panel is accessed via https://login.one.com/cp/ , using account
Separate passwords are needed for the SuperUser account, the Control Panel, and FileZilla. These are known by Bill Egerton and Jez Cunningham.
Our website hosts, One.com, provide a backup & restore service, but nevertheless our Site policy is to perform our own Backups sufficiently frequently to ensure that we have an independent means of recovering, and also a means of porting to another host should this ever be wished.
Backing up:
A Joomla package called Akeeba has been chosen for the purpose of making backups; Akeeba provides extensive documentation, but the following is intended to cover everything likely too be necessary here.
Backups can (and should) also be done from time to time, but in particular before any system update of the Joomla software. To create a backup of the system, follow these steps:
- You need to log in as a Super Administrator (for example user "suttonpoyntz").
- In the Components menu, select Akeeba Backup.
- Now click the Backup Now button;
- If you want, enter text in the Backup Comment box;
- Click the Backup Now button again to start the backup.
- Wait for the backup to finish successfully. This takes time but you get good feedback on progress.
If the backup fails, check the configuration of the Akeeba Backup component (go to Akeeba Backup as above, and click the Configuration button). Akeeba have provided some special notes on how to Akeeba Backup must be configured for those using the one.com server.
Saving and clearing the backup files:
By clicking the Manage Backups button for Akeeba, you can see a list of the backups that have been done, and the files created. Each backup is spread over several files, with extensions .JPA, .J01, .J02, etc.
In principle, you can download the backup files to your computer from Akeeba's Backup Manager, but Akeeba warn that this is not recommended. There are two alternative methods of downloading the files:
- by logging in to One.com's Control Panel and using their File Manager;
- or by using an FTP client such as FileZilla to connect to One.com's FTP server.
In each case, you will need a password to gain access. You will need to navigate to folder \backups, where the backup files are held.
It is recommended for safety that backup files are copied in this way to an administrator's own computer. Old backup files can then be deleted from the backup store; this is done by going to the Backup Manager, selecting the old backup and using the Delete Files button.
Restoring the website:
You will want to restore a backup if the website has become corrupted in some way, or if you are porting the site to a new service provider, or if you are creating a temporary working location either on your own computer or as a sub-site. The process is as follows:
- You first need to create (if necessary) and access the top level directory for the site. The following are some very brief guidance notes on this:
- Overwriting the existing site: you need access to the site's existing top level directory. At present, the site is hosted by One.com, who provide a File Manager available by logging in to the One.com Control Panel. Other website hosts will provide equivalent tools. Access is also available using an FTP client such as Filezilla.
- Porting the site to a new host: you will have asked the new service provider to create the site; they will give you information about their equivalent of One.com's File Manager, or you can use an FTP client such as Filezilla.
- Creating a temporary subsite: use the File Manager or FTP client to create a new folder in the site's existing top level directory. For example, creating a new folder called myworkarea will allow you to create a subsite called http://suttonpoyntz.org.uk/myworkarea.
- Creating a temporary site on your own computer: you will first need to create an environment using a tool such as XAMPP. You can then access the site using Windows File Explorer, at (for example) C:/xampp/httdocs. The site is available on a web browser as /localhost.
- If necessary, ensure you have the necessary write access (access code 777) to the top-level directory - this cannot be done using One.com's File Manager.
- If necessary, delete any existing files and sub-directories from the top-level directory. If you are overwriting the existing site, you may want to do this at the last possible moment to maintain site access for as long as possible.
- Now, copy the backup files (files with extensions .JPA, .J01, .J02 etc.) to the top level directory. You also need to copy a file called kickstart.php; this is available via a Kickstart Zip file from the Akeeba Backup website.
- Now run kickstart.php on the server, by typing the address suttonpoyntz.org.uk/kickstart.php (or suttonpoyntz.org.uk/myworkarea/kickstart.php, or /localhost/kickstart.php, as appropriate), in your web browser;
- Dismiss the explanatory text box.
- In the Kickstart wizard, select the backup file you want to restore from (if there is only one, it will already be selected);
- If you are working on /localhost, set Write mode to Directly, otherwise leave it as Hybrid;
- Click the Start button;
- This will unpack the contents of the backup file into a temporary directory on the server. You must wait for it to finish.
- Now click the Run button to run the Akeeba Backup Installer;
- The first page displays the result of checks on the server setup. All the required settings should be green or amber, so click Next;
- The second page displays the setup for the site's database. The following table lists the values that should be shown here:
Database type mysqli Server host name localhost User name suttonpoyntz_or Password (for suttonpoyntz_or) Database name suttonpoyntz_or Existing tables Drop existing tables Table prefix (see below) Foreign keys suppressed Yes Replace No UTF8 collation Yes Max execution time 5 seconds - Table prefix - If you are restoring to a new sub-site, you must change this to something new, a string of 4 or 5 characters (of your choosing but must not duplicate an existing prefix) plus an underscore. If you are restoring the main site, leave this as it is.
- Having made sure the settings are correct, click the Next button to start restoring the site;
- Wait for this to be completed; click OK when finished. While this is happening, the site will be unavailable;
- The next page displays information about the restored site. Changes should not be necessary, so click Next;
- Close the window with the Akeeba Backup Installer.
- Now click the Cleanup button to remove temporary files.
- If you changed the access rights for a directory, PLEASE now set it back to 755 to remove public write access.
Log in as SuperUser. Joomla will advise you whether there is a Joomla update available, or extension updates.
Before carrying out any update, it is very important that you take a backup of the website - see the instructions above. This will ensure that if anything goes wrong during the update, you can get back to a working system.
If there is a Joomla update available and extension updates, we advise that you update the system first, and then the extensions, one by one.
Updating Joomla
There is a problem with Joomla which the developers are aware of but seem to see as other peoples' problems [N.B. It is possible this has now been fixed for Joomla - see https://issues.joomla.org/tracker/joomla-cms/41156 - but it continues to affect jDownloads, so the action in this note still needs to be taken). Various actions, including especially a Joomla update, will fail unless you modify some Joomla code before carrying out the update; this needs to be done EVERY TIME you do a Joomla update. You need, to log in to the one.com Console, and use the File Manager to edit the file \libraries\vendor\joomla\database\src\Mysqli\MysqliDriver.php. After the instruction
$this->connection->query('SET @@SESSION.sql_mode = \'' . implode(',', $this->options['sqlModes']) . '\';');
add a new instruction
mysqli_query($this->connection,"SET SQL_BIG_SELECTS = 1;" );
Now save this file, close the one.com Console, and log in to the website again. N.B. This software edit should be done immediately after every Joomla update.
To update the Joomla software, click the Joomla Update button, and confirm that you have done a backup. The Joomla system will update - you will still get an error message at the end (when the software you modified has been overwritten by the update!), but the update will be complete, and the new version of Joomla will be shown at the top right of the window. Now edit the new code, as described just above.
Updating extensions
Once the Joomla version is up to date, click the Update Extensions button. This will take you to the Extensions Update window, and will display a list of Joomla extensions for which updates are available. We suggest you select these extensions one by one and click the Update button to update them. At the end, click Check for Updates to see if there are any more extension updates that have been missed.
Joomla fails to find some updates that are available, giving an error message showing it failed to open the file with the software update specification. Under these circumstances, it is necessary first to check what version of the extension is currently installed, finding the extension via System > Extensions. Now go to the Joomla Extensions website, find the documentation for that extension, and check the latest version that has been issued. If this shows that an update is available, download the ZIP file for the latest version. Back in the Joomla back-end, go to System, then Install Extensions, in order to install the latest version of the extension (which is done by dragging the ZIP file into the Joomla window). This will have the effect of updating the extension.
As well as updating Joomla and its extensions, it is necessary from time to time to update the PHP software that runs on the server. You will get a warning when logging in to the Joomla backend as a SuperUser, if the PHP version in use is out of date. To update the PHP version:
- Go to the one.com Control Panel at https://www.one.com/admin, and log in.
- Scan down to Services, and in Advanced settings, click PHP and database settings
- In the PHP section, find Update PHP version. Click the down arrow and select the most recent version of PHP on offer.
- Click the Update button.
- Log out using the Log out option under My account.
The template for this website is based on the Cassiopeia template which is delivered as a standard component of Joomla 4. A note has been written, describing the steps that were taken to personalise Joomla and the Cassiopeia template - these should allow the site to be re-created if for any reason this becomes necessary in the future.