README.md 5.45 KB
Newer Older
1
# Mahara Readme
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/18.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 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 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 18.04 supports direct upgrades from previous Mahara versions 15.04.0 and later.
37 38 39 40 41 42 43 44 45 46

If you are upgrading from an earlier version you will need to upgrade
in two steps:

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

then

 * Upgrade version 15.04.X -> 'Y'

47
To upgrade an existing Mahara installation, follow the instructions here:
48

49
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
50

51 52 53 54 55 56
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

57
# SYSTEM REQUIREMENTS
58

59
Here are the system requirements needed to run Mahara 18.04.
60

Aaron Wells committed
61
### OS
62

Aaron Wells committed
63 64 65
Mahara is only officially supported on Debian (5.0/"Lenny" or later) and
Ubuntu (10.04/"Lucid Lynx" or later), however it will probably run in any
OS with a suitable web server.
66

67 68
### Web Server

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

Aaron Wells committed
72 73
### Database

74
Mahara requires either Postgres or MySQL. It would require extensive
Aaron Wells committed
75
modification to support other databases.
76
 * Postgres 9.1 or later
Aaron Wells committed
77 78
 * MySQL 5.1 or later (or MariaDB equivalent)

79 80
### PHP

81
Mahara requires PHP version 5.5.9 or later. The "magic_quotes" and "register_globals"
Aaron Wells committed
82 83 84
settings should be turned *off* (which is the default on modern PHP installations).

The following PHP extensions are also required:
85 86 87 88 89 90 91 92 93 94 95 96 97 98
 * 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 committed
99
 * memcache (optional; for SAML auth plugin)
100 101 102 103 104 105
 * zlib (optional)
 * adodb (optional; improves performance)
 * enchant or pspell (optional; for TinyMCE spellcheck button)

### Web Browser

106 107 108 109 110 111 112 113 114
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.

115
For Mahara 18.04, the supported browser versions are:
116
// TODO: Review list of browsers closer to the release date.
117 118 119 120
 * Firefox - 56.0
 * Chrome - 61.0
 * Safari - 11
 * Opera - 47.0
121
 * IE - 11 and Edge
122 123
 * Safari for iOS
 * Chrome for Android
124 125 126

# TRANSLATIONS

127
Mahara has been translated into many languages. You can get language packs from:
128

Aaron Wells committed
129
* https://wiki.mahara.org/wiki/Language_Packs
130

131 132 133 134
# MOODLE

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

136
 * https://wiki.mahara.org/images/d/d5/Mahoodle.pdf
137

138 139
------------------
# Copyright notice
140

141
Copyright (C) 2006-2017 Catalyst IT and others; see:
Aaron Wells committed
142
https://wiki.mahara.org/wiki/Contributors
143 144 145

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
146
the Free Software Foundation, version 3 or later of the License.
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165

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.