README.md 5.19 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
10
// TODO: Update the link closer to the release date.

Aaron Wells's avatar
Aaron Wells committed
11
 * http://manual.mahara.org/en/15.04/intro/introduction.html#what-is-mahara
12
13

# SUPPORT
14

15
The best ways of obtaining support are:
16

17
18
 * http://manual.mahara.org - the Mahara online user manual
 * 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
24
# INSTALLATION

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 basic installation instructions are:
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 16.10 supports direct upgrades from previous Mahara versions 1.6.0 and later.
39
To upgrade an existing Mahara installation, follow the instructions here:
40

41
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
42

43
44
45
46
47
48
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

49
# SYSTEM REQUIREMENTS
50

Robert Lyon's avatar
Robert Lyon committed
51
Here are the system requirements needed to run Mahara 16.10.
52

Aaron Wells's avatar
Aaron Wells committed
53
### OS
54

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

59
60
### Web Server

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

Aaron Wells's avatar
Aaron Wells committed
64
65
### Database

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

71
72
### PHP

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

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

### Web Browser

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

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

# TRANSLATIONS

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

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

122
123
124
125
# MOODLE

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

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

129
130
------------------
# Copyright notice
131

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

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

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.