README.md 5.93 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:

Cecilia Vela Gurovic's avatar
Cecilia Vela Gurovic committed
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'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 18.04 supports direct upgrades from previous Mahara versions 17.04.0 and later.
37
38

If you are upgrading from an earlier version you will need to upgrade
39
in two or more steps:
40
41
42
43
44

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

then

45
46
47
48
49
50
51
52
53
 * Upgrade version 15.04.X -> 17.04.X (latest 17.04 version)

then

 * Upgrade version 17.04.X -> 'Y'

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
54

55
To upgrade an existing Mahara installation, follow the instructions here:
56

57
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
58

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

65
# SYSTEM REQUIREMENTS
66

Cecilia Vela Gurovic's avatar
Cecilia Vela Gurovic committed
67
Here are the system requirements needed to run Mahara 18.04.
68

Aaron Wells's avatar
Aaron Wells committed
69
### OS
70

71
72
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
73
OS with a suitable web server.
74

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

77
78
### Web Server

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

Aaron Wells's avatar
Aaron Wells committed
82
83
### Database

84
Mahara requires either Postgres or MySQL. It would require extensive
Aaron Wells's avatar
Aaron Wells committed
85
modification to support other databases.
86
87
88
89
90
91
 * 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
92

93
94
### PHP

95
Mahara requires PHP version 5.5.9 or later. The "magic_quotes" and "register_globals"
Aaron Wells's avatar
Aaron Wells committed
96
97
98
settings should be turned *off* (which is the default on modern PHP installations).

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

118
119
Note: This version of Mahara has not been tested on php versions 7.2+.

120
121
### Web Browser

122
123
124
125
126
127
128
129
130
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.

Cecilia Vela Gurovic's avatar
Cecilia Vela Gurovic committed
131
For Mahara 18.04, the supported browser versions are:
132
// TODO: Review list of browsers closer to the release date.
133
134
135
136
 * Firefox - 56.0
 * Chrome - 61.0
 * Safari - 11
 * Opera - 47.0
137
 * IE - 11 and Edge
Aaron Wells's avatar
Aaron Wells committed
138
139
 * Safari for iOS
 * Chrome for Android
140
141
142

# TRANSLATIONS

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

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

147
148
149
150
# MOODLE

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

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

154
155
------------------
# Copyright notice
156

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

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

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.