Commit a8c247ab authored by Robert Lyon's avatar Robert Lyon
Browse files

Bug 1970356: Updating the Readme for main



Change-Id: I1d5781e904be617206c8e03be96ddb24821db6cc
Signed-off-by: Robert Lyon's avatarRobert Lyon <robertl@catalyst.net.nz>
parent 618248fd
......@@ -3,109 +3,99 @@
# Mahara Readme
Mahara is an open source ePortfolio system. An ePortfolio is a type of
web application that allows users to record and share evidence of lifelong learning.
web application that allows learners to record and share evidence of their
learning and reflect on their learning. Mahara can be used to create different
types of portfolios, including learning portfolio, development portfolio,
presentation / showcase portfolio, employability portfolio.
For more information about Mahara and ePortfolios, see the Mahara user manual's
introduction chapter:
For more information about Mahara and ePortfolios, see the Mahara manual's
[introduction chapter](https://manual.mahara.org/en/22.10/intro/introduction.html#what-is-mahara).
* https://manual.mahara.org/en/22.10/intro/introduction.html#what-is-mahara
## SUPPORT
# SUPPORT
The best ways for obtaining support are:
The best ways of obtaining support are:
* [Mahara online manual](https://manual.mahara.org)
* [Mahara community forums](https://mahara.org/forums)
* [Mahara wiki](https://wiki.mahara.org)
* [Live chat](https://matrix.to/#/#mahara:matrix.org) with others, in particular developers
* https://manual.mahara.org - the Mahara online user manual
* https://mahara.org/forums - the Mahara project community forums
* https://wiki.mahara.org - the Mahara wiki
* #mahara on freenode (IRC) - live chat with other users and developers
## INSTALLATION
# INSTALLATION
For detailed installation instructions see the [installation page](https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Installing_Mahara) on our wiki.
For detailed installation instructions see the installation page on our wiki:
The following is a check list of the high level installation and setup steps.
Please refer to the installation instructions for the details:
* https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Installing_Mahara
The following is a check list of the steps you need to take. Please refer to the installation instructions for the details:
1. Create a Postgres or MySQL database for Mahara.
2. Copy the Mahara files under "htdocs" into your web root.
3. Create a Mahara "dataroot" directory outside of your web root.
1. Create a PostgreSQL or MySQL database for Mahara.
2. Copy the Mahara files under 'htdocs' into your web root.
3. Create a Mahara 'dataroot' directory outside of your web root.
4. Copy htdocs/config-dist.php to config.php.
5. Edit config.php with the correct details for your installation.
# UPGRADING
Mahara 22.10 supports direct upgrades from previous Mahara versions 18.04.0 and later.
If you are upgrading from an earlier version you will need to upgrade
in either two or three steps:
if site version begins with 1.X first upgrade to 15.04
* Upgrade version 'X' -> 15.04.X (latest 15.04 version)
then/else upgrade version to 17.04
* Upgrade version 'X' -> 17.04.X (latest 17.04 version)
then/else upgrade version to 18.04
* Upgrade version 'X' -> 18.04.X (latest 18.04 version)
Mahara 22.10 supports direct upgrades from previous Mahara versions 20.04.0 and later.
then/else upgrade version to 20.04
If you are upgrading from an earlier version, you will need to upgrade
in steps:
* Upgrade version 'X' -> 20.04.X (latest 20.04 version)
then
* Upgrade version 20.04.X -> 'Y'
* if site version begins with 1.X, first upgrade to 15.04
* then/else upgrade version to 17.04.10
* then/else upgrade version to 18.04.6
* then/else upgrade version to 20.04.5
* then upgrade to 22.04.X (latest stable release)
Note: Older versions of Mahara are not compatible with latest versions
of PHP so you will need to do intermediate upgrade steps before
updating your server's PHP
To upgrade an existing Mahara installation, follow the instructions here:
of PHP. You will need to do intermediate upgrade steps before
updating your server's PHP.
* https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
To upgrade an existing Mahara installation, follow the [upgrade instructions](https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara).
If you are upgrading from Mahara 15.10 or earlier, you will need to add a "urlsecret"
value to your config.php file if you wish to use the web-based upgrade and/or cron
scripts. See:
* https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara#Q:_I.27m_getting_an_error_about_a_.22urlsecret.22
If you upgrade from Mahara 15.10 or earlier, you will need to [add a 'urlsecret'
value to your config.php file](https://manual.mahara.org/en/22.10/administration/config_php.html#urlsecret-run-the-cron-or-upgrade-only-when-you-are-authorised) if you wish to use the web-based upgrade and/or
cron scripts. See:
# SYSTEM REQUIREMENTS
Here are the system requirements needed to run Mahara 22.10.
### OS
### Operating system for the server
Mahara is officially supported on Ubuntu (18.04/"Bionic Beaver" LTS or later)
and Debian (9.0/"Stretch" LTS or later). However, it will run on other Linux-
based operating systems or even Windows servers. You may run into issues though
that the Mahara core project team may not be able to fix. Patches are welcome
to.
Mahara is only officially supported on Debian (8.0/"Jessie" LTS or later) and
Ubuntu (16.04/"Xenial Xerus" LTS or later), however it will probably run in any
OS with a suitable web server.
Note: This version of Mahara has **not** been tested on Debian 12+ or Ubuntu 22.04+.
Note: This version of Mahara has NOT been tested on Debian 10+ / Ubuntu 19.04+
Any operating system that supports modern web browsers with JavaScript can be
used to interact with Mahara.
### Web Server
### Web server
Mahara is only officially supported on Apache 2 or later, although it will
probably run in any web server with the proper PHP extensions.
Mahara is supported on Apache 2 or later and tested on Nginx,
although it will probably run on any web server with the proper PHP extensions.
### Database
Mahara requires either Postgres or MySQL. It would require extensive
Mahara requires either PostgreSQL or MySQL/MariaDB. It would require extensive
modification to support other databases.
* Postgres 9.4 or later
* PostgreSQL 9.4 or later
* MySQL 5.7 or later
* MariaDB 10.1 or later
Note: This version of Mahara has NOT been tested on Postgres 12+,
MariaDB 10.3+ versions.
Note: This version of Mahara has **not** been tested on PostgreSQL 13+ and
MariaDB 10.8+ versions.
### PHP
Mahara requires PHP version 7.2.X. The "magic_quotes" and "register_globals"
settings should be turned *off* (which is the default on modern PHP installations).
Mahara can be used with PHP version 7.2.X, 7.3.X, or 7.4.X. The 'magic_quotes'
and 'register_globals' settings should be turned *off* (which is the default on
modern PHP installations).
Note: Mahara has **not** been fully tested with PHP 8.X. Some aspects of Mahara may not function as expected. [Plans are in place](https://mahara.org/interaction/forum/topic.php?id=8989) to support PHP 8.1.
The following PHP extensions are also required:
* curl
......@@ -127,41 +117,32 @@ The following PHP extensions are also required:
* adodb (optional; improves performance)
* enchant or pspell (optional; for TinyMCE spellcheck button)
Note: This version of Mahara has not been fully tested on all latest versions of PHP.
Some aspects of Mahara may not function as expected
### Web Browser
### Web browser
Mahara should be accessible in any modern web browser with Javascript support.
However, it is only actively tested in the most recent versions of Firefox,
Chrome (also for Android), Safari (also for iOS), and Opera. Microsoft browsers,
i.e. Microsoft Edge, are supported to a maximum of the
Mahara should be accessible in any modern web browser with JavaScript support.
However, it is only actively tested in the most recent versions of Firefox and Chrome (also on Android). Testing on Safari (also for iOS) is done on occasion,
Microsoft browsers, i.e. Microsoft Edge, are supported to a maximum of the
three most recent versions that are officially supported by Microsoft.
You can still use Mahara on older browsers, but may not have all functionality
available.
For Mahara 22.10, the supported browser versions are:
* Firefox - 75.0
* Chrome - 81.0
* Safari - 13.1
* Opera - 67.0
* MS Edge - 81.0
* Firefox 99.0
* Chrome 88.0
* Safari 13.1
* MS Edge 100.0
* Safari for iOS
* Chrome for Android
# TRANSLATIONS
Mahara has been translated into many languages. You can get language packs from:
* https://wiki.mahara.org/wiki/Language_Packs
Mahara has been translated into many languages. You can download [language packs](https://langpacks.mahara.org/), [install and update them via CLI](https://manual.mahara.org/en/22.10/administration/cli.html#install-and-update-language-packs), or [install and update them via the administration area](https://manual.mahara.org/en/22.10/administration/development.html#languages) in Mahara.
------------------
# Copyright notice
# COPYRIGHT NOTICE
Copyright (C) 2006-2022 Catalyst IT and others; see:
https://wiki.mahara.org/wiki/Contributors
Copyright (C) 2006-2022 Catalyst IT and others
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
......@@ -172,8 +153,9 @@ but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
You should have received a copy of the GNU General Public License 3.0+
along with this program (see the file 'COPYING'). If not, [view the GNU GLP
v.3+ online](https://www.gnu.org/licenses/gpl-3.0.html).
Additional permission under GNU GPL version 3 section 7:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment