README.md 5.18 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
Aaron Wells's avatar
Aaron Wells committed
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
Aaron Wells's avatar
Aaron Wells committed
7
8
introduction chapter:

9
 * http://manual.mahara.org/en/17.10/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
22
# INSTALLATION

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 basic installation instructions are:
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 17.10 supports direct upgrades from previous Mahara versions 1.9.0 and later.
37
To upgrade an existing Mahara installation, follow the instructions here:
38

39
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
40

41
42
43
44
45
46
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

47
# SYSTEM REQUIREMENTS
48

49
Here are the system requirements needed to run Mahara 17.10.
50

Aaron Wells's avatar
Aaron Wells committed
51
### OS
52

Aaron Wells's avatar
Aaron Wells committed
53
54
55
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.
56

57
58
### Web Server

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

Aaron Wells's avatar
Aaron Wells committed
62
63
### Database

64
Mahara requires either Postgres or MySQL. It would require extensive
Aaron Wells's avatar
Aaron Wells committed
65
66
67
68
modification to support other databases.
 * Postgres 8.3 or later
 * MySQL 5.1 or later (or MariaDB equivalent)

69
70
### PHP

Aaron Wells's avatar
Aaron Wells committed
71
Mahara requires PHP version 5.4 or later. The "magic_quotes" and "register_globals"
Aaron Wells's avatar
Aaron Wells committed
72
73
74
settings should be turned *off* (which is the default on modern PHP installations).

The following PHP extensions are also required:
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 * 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
89
 * memcache (optional; for SAML auth plugin)
90
91
92
93
94
95
 * zlib (optional)
 * adodb (optional; improves performance)
 * enchant or pspell (optional; for TinyMCE spellcheck button)

### Web Browser

96
97
98
99
100
101
102
103
104
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.

105
For Mahara 17.10, the supported browser versions are:
106
// TODO: Review list of browsers closer to the release date.
Robert Lyon's avatar
Robert Lyon committed
107
108
109
110
 * Firefox - 48.0
 * Chrome - 51.0
 * Safari - 9.1
 * Opera - 39.0
111
 * IE - 11 and Edge
Aaron Wells's avatar
Aaron Wells committed
112
113
 * Safari for iOS
 * Chrome for Android
114
115
116

# TRANSLATIONS

117
Mahara has been translated into many languages. You can get language packs from:
118

Aaron Wells's avatar
Aaron Wells committed
119
* https://wiki.mahara.org/wiki/Language_Packs
120

121
122
123
124
# MOODLE

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

126
 * https://wiki.mahara.org/images/d/d5/Mahoodle.pdf
127

128
129
------------------
# Copyright notice
130

131
Copyright (C) 2006-2017 Catalyst IT and others; see:
Aaron Wells's avatar
Aaron Wells committed
132
https://wiki.mahara.org/wiki/Contributors
133
134
135

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
136
the Free Software Foundation, version 3 or later of the License.
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155

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.