README.md 6 KB
Newer Older
1 2
@TODO This is only a draft. Review before the final .0 release and update the information accordingly.

3
# Mahara Readme
Nigel McNie's avatar
Nigel McNie committed
4

5
Mahara is an open source ePortfolio system. An ePortfolio is a type of
6 7
web application that allows users to record and share evidence of lifelong learning.

8
For more information about Mahara and ePortfolios, see the Mahara user manual's
9 10
introduction chapter:

Robert Lyon's avatar
Robert Lyon committed
11
 * https://manual.mahara.org/en/20.10/intro/introduction.html#what-is-mahara
12 13

# SUPPORT
14

15
The best ways of obtaining support are:
16

17
 * https://manual.mahara.org - the Mahara online user manual
18
 * https://mahara.org/forums - the Mahara project community forums
19
 * https://wiki.mahara.org - the Mahara wiki
20 21
 * #mahara on freenode (IRC) - live chat with other users and developers

22 23
# INSTALLATION

24
For detailed installation instructions see the installation page on our wiki:
25

26
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Installing_Mahara
Nigel McNie's avatar
Nigel McNie committed
27

28
The following is a check list of the steps you need to take. Please refer to the installation instructions for the details:
Nigel McNie's avatar
Nigel McNie committed
29

30 31 32 33 34 35 36
 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.
 4. Copy htdocs/config-dist.php to config.php.
 5. Edit config.php with the correct details for your installation.

# UPGRADING
37

Robert Lyon's avatar
Robert Lyon committed
38
Mahara 20.10 supports direct upgrades from previous Mahara versions 18.04.0 and later.
39 40

If you are upgrading from an earlier version you will need to upgrade
41 42 43
in either two or three steps:

if site version begins with 1.X first upgrade to 15.04
44 45 46

 * Upgrade version 'X' -> 15.04.X (latest 15.04 version)

47 48 49 50
then/else upgrade version to 17.04

 * Upgrade version 'X' -> 17.04.X (latest 17.04 version)

51 52 53 54
then/else

 * Upgrade version 'X' -> 18.04.X

55 56
then

57
 * Upgrade version 18.04.X -> 'Y'
58

59 60 61 62
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

63
To upgrade an existing Mahara installation, follow the instructions here:
64

65
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
66

67 68 69 70 71 72
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

73
# SYSTEM REQUIREMENTS
74

Robert Lyon's avatar
Robert Lyon committed
75
Here are the system requirements needed to run Mahara 20.10.
76

Aaron Wells's avatar
Aaron Wells committed
77
### OS
78

79 80
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
Aaron Wells's avatar
Aaron Wells committed
81
OS with a suitable web server.
82

83
Note: This version of Mahara has NOT been tested on Debian 10+ / Ubuntu 19.04+
84

85 86
### Web Server

87
Mahara is only officially supported on Apache 2 or later, although it will
88 89
probably run in any web server with the proper PHP extensions.

Aaron Wells's avatar
Aaron Wells committed
90 91
### Database

92
Mahara requires either Postgres or MySQL. It would require extensive
Aaron Wells's avatar
Aaron Wells committed
93
modification to support other databases.
94 95
 * Postgres 9.4 or later
 * MySQL 5.6 or later
96
 * MariaDB 10.1 or later
97

98
Note: This version of Mahara has NOT been tested on Postgres 12+,
99
MariaDB 10.3+ versions.
Aaron Wells's avatar
Aaron Wells committed
100

101 102
### PHP

103
Mahara requires PHP version 7.2.X. The "magic_quotes" and "register_globals"
Aaron Wells's avatar
Aaron Wells committed
104 105 106
settings should be turned *off* (which is the default on modern PHP installations).

The following PHP extensions are also required:
107 108 109 110 111 112 113 114 115 116 117 118 119 120
 * curl
 * gd (including Freetype support)
 * json
 * ldap
 * libxml
 * mbstring
 * mcrypt
 * mime_magic; or fileinfo
 * pgsql; or mysqli; or mysql
 * session
 * SimpleXML
 * bz2 (optional)
 * imagick (optional)
 * openssl and xmlrpc (optional; for networking support)
Robert Lyon's avatar
Robert Lyon committed
121
 * memcache (optional; for SAML auth plugin)
122 123 124 125
 * zlib (optional)
 * adodb (optional; improves performance)
 * enchant or pspell (optional; for TinyMCE spellcheck button)

126 127
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
128

129 130
### Web Browser

131 132 133
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,
Robert Lyon's avatar
Robert Lyon committed
134
i.e. Microsoft Edge, are supported to a maximum of the
135 136 137 138 139
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.

Robert Lyon's avatar
Robert Lyon committed
140
For Mahara 20.10, the supported browser versions are:
141 142 143 144 145
 * Firefox - 75.0
 * Chrome - 81.0
 * Safari - 13.1
 * Opera - 67.0
 * MS Edge - 81.0
Aaron Wells's avatar
Aaron Wells committed
146 147
 * Safari for iOS
 * Chrome for Android
148 149 150

# TRANSLATIONS

151
Mahara has been translated into many languages. You can get language packs from:
152

Aaron Wells's avatar
Aaron Wells committed
153
* https://wiki.mahara.org/wiki/Language_Packs
154

155

156 157
------------------
# Copyright notice
158

159
Copyright (C) 2006-2020 Catalyst IT and others; see:
Aaron Wells's avatar
Aaron Wells committed
160
https://wiki.mahara.org/wiki/Contributors
161 162 163

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
164
the Free Software Foundation, version 3 or later of the License.
165 166 167 168 169 170 171

This program is distributed in the hope that it will be useful,
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
172
along with this program.  If not, see <https://www.gnu.org/licenses/>.
173 174 175 176 177 178 179 180 181 182 183

Additional permission under GNU GPL version 3 section 7:

If you modify this program, or any covered work, by linking or
combining it with the OpenSSL project's OpenSSL library (or a
modified version of that library), containing parts covered by the
terms of the OpenSSL or SSLeay licenses, the Mahara copyright holders
grant you additional permission to convey the resulting work.
Corresponding Source for a non-source form of such a combination
shall include the source code for the parts of OpenSSL used as well
as that of the covered work.