README.md 5.92 KB
Newer Older
1
# Mahara Readme
Nigel McNie's avatar
Nigel McNie committed
2

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

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

9
 * http://manual.mahara.org/en/19.04/intro/introduction.html#what-is-mahara
10 11

# SUPPORT
12

13
The best ways of obtaining support are:
14

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

20 21
# INSTALLATION

22
For detailed installation instructions see the installation page on our wiki:
23

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

26
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
27

28 29 30 31 32 33 34
 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
35

36
Mahara 19.04 supports direct upgrades from previous Mahara versions 15.04.0 and later.
37 38

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

if site version begins with 1.X first upgrade to 15.04
42 43 44

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

45 46 47 48
then/else upgrade version to 17.04

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

49 50
then

51
 * Upgrade version 17.04.X -> 'Y'
52

53
To upgrade an existing Mahara installation, follow the instructions here:
54

55
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
56

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

63
# SYSTEM REQUIREMENTS
64

65
Here are the system requirements needed to run Mahara 19.04.
66

Aaron Wells's avatar
Aaron Wells committed
67
### OS
68

69 70
Mahara is only officially supported on Debian (7.0/"Wheezy" or later) and
Ubuntu (14.04/"Trusty Tahr" or later), however it will probably run in any
Aaron Wells's avatar
Aaron Wells committed
71
OS with a suitable web server.
72

73 74
Note: This version of Mahara has NOT been tested on Debian 9+ / Ubuntu 17.10+

75 76
### Web Server

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

Aaron Wells's avatar
Aaron Wells committed
80 81
### Database

82
Mahara requires either Postgres or MySQL. It would require extensive
Aaron Wells's avatar
Aaron Wells committed
83
modification to support other databases.
84 85 86 87 88 89
 * Postgres 9.4 or later
 * MySQL 5.6 or later
 * MariaDB 10.0 or later

Note: This version of Mahara has NOT been tested on Postgres 10+, MySQL 8.0+,
MariaDB 10.3+ versions.
Aaron Wells's avatar
Aaron Wells committed
90

91 92
### PHP

93
Mahara requires PHP version 7.0.X. The "magic_quotes" and "register_globals"
Aaron Wells's avatar
Aaron Wells committed
94 95 96
settings should be turned *off* (which is the default on modern PHP installations).

The following PHP extensions are also required:
97 98 99 100 101 102 103 104 105 106 107 108 109 110
 * 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
111
 * memcache (optional; for SAML auth plugin)
112 113 114 115
 * zlib (optional)
 * adodb (optional; improves performance)
 * enchant or pspell (optional; for TinyMCE spellcheck button)

116 117
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
118

119 120
### Web Browser

121 122 123 124 125 126 127 128 129
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. Internet Explorer and 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.

130
For Mahara 19.04, the supported browser versions are:
131
// TODO: Review list of browsers closer to the release date.
132 133 134 135
 * Firefox - 56.0
 * Chrome - 61.0
 * Safari - 11
 * Opera - 47.0
136
 * IE - 11 and Edge
137 138
 * Safari for iOS
 * Chrome for Android
139 140 141

# TRANSLATIONS

142
Mahara has been translated into many languages. You can get language packs from:
143

Aaron Wells's avatar
Aaron Wells committed
144
* https://wiki.mahara.org/wiki/Language_Packs
145

146 147 148 149
# MOODLE

Documentation on integrating Mahara with Moodle can be found in the
3.1MB PDF here:
150

151
 * https://wiki.mahara.org/images/d/d5/Mahoodle.pdf
152

153 154
------------------
# Copyright notice
155

156
Copyright (C) 2006-2017 Catalyst IT and others; see:
Aaron Wells's avatar
Aaron Wells committed
157
https://wiki.mahara.org/wiki/Contributors
158 159 160

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
161
the Free Software Foundation, version 3 or later of the License.
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180

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
along with this program.  If not, see <http://www.gnu.org/licenses/>.

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.