README.md 6.81 KB
Newer Older
1
2
@TODO This is only a draft. Review before the final .0 release and update the information accordingly.

3
# Mahara Readme
Nigel McNie's avatar
Nigel McNie committed
4

5
Mahara is an open source ePortfolio system. An ePortfolio is a type of
6
7
8
9
web application that allows learners to record and share evidence of their
learning and reflect on their learning. Mahara can be used to create different
types of portfolios, including learning portfolio, development portfolio,
presentation / showcase portfolio, employability portfolio.
Aaron Wells's avatar
Aaron Wells committed
10

11
12
For more information about Mahara and ePortfolios, see the Mahara manual's
[introduction chapter](https://manual.mahara.org/en/22.10/intro/introduction.html#what-is-mahara).
Aaron Wells's avatar
Aaron Wells committed
13

14
## SUPPORT
15

16
The best ways for obtaining support are:
17

18
19
20
21
 * [Mahara online manual](https://manual.mahara.org)
 * [Mahara community forums](https://mahara.org/forums)
 * [Mahara wiki](https://wiki.mahara.org)
 * [Live chat](https://matrix.to/#/#mahara:matrix.org) with others, in particular developers
22

23
## INSTALLATION
24

25
For detailed installation instructions see the [installation page](https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Installing_Mahara) on our wiki.
26

27
28
The following is a check list of the high level installation and setup steps.
Please refer to the installation instructions for the details:
29

30
31
32
 1. Create a PostgreSQL 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.
33
34
35
36
 4. Copy htdocs/config-dist.php to config.php.
 5. Edit config.php with the correct details for your installation.

# UPGRADING
37

38
Mahara 22.10 supports direct upgrades from previous Mahara versions 20.04.0 and later.
39

40
41
If you are upgrading from an earlier version, you will need to upgrade
in steps:
42

43
44
45
46
47
* if site version begins with 1.X, first upgrade to 15.04
* then/else upgrade version to 17.04.10
* then/else upgrade version to 18.04.6
* then/else upgrade version to 20.04.5
* then upgrade to 22.04.X (latest stable release)
48

49
Note: Older versions of Mahara are not compatible with latest versions
50
51
of PHP. You will need to do intermediate upgrade steps before
updating your server's PHP.
52

53
To upgrade an existing Mahara installation, follow the [upgrade instructions](https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara).
54

55
56
57
If you upgrade from Mahara 15.10 or earlier, you will need to [add a 'urlsecret'
value to your config.php file](https://manual.mahara.org/en/22.10/administration/config_php.html#urlsecret-run-the-cron-or-upgrade-only-when-you-are-authorised) if you wish to use the web-based upgrade and/or
cron scripts. See:
58

59
# SYSTEM REQUIREMENTS
60

61
Here are the system requirements needed to run Mahara 22.10.
62

63
64
65
66
67
68
69
### Operating system for the server

Mahara is officially supported on Ubuntu (18.04/"Bionic Beaver" LTS or later)
and Debian (9.0/"Stretch" LTS or later). However, it will run on other Linux-
based operating systems or even Windows servers. You may run into issues though
that the Mahara core project team may not be able to fix. Patches are welcome
to.
70

71
Note: This version of Mahara has **not** been tested on Debian 12+ or Ubuntu 22.04+.
72

73
74
Any operating system that supports modern web browsers with JavaScript can be
used to interact with Mahara.
75

76
### Web server
77

78
79
Mahara is supported on Apache 2 or later and tested on Nginx,
although it will probably run on any web server with the proper PHP extensions.
80

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

83
Mahara requires either PostgreSQL or MySQL/MariaDB. It would require extensive
Aaron Wells's avatar
Aaron Wells committed
84
modification to support other databases.
85
 * PostgreSQL 9.4 or later
86
 * MySQL 5.7 or later
87
 * MariaDB 10.1 or later
88

89
90
Note: This version of Mahara has **not** been tested on PostgreSQL 13+ and
MariaDB 10.8+ versions.
Aaron Wells's avatar
Aaron Wells committed
91

92
93
### PHP

94
95
96
97
98
Mahara can be used with PHP version 7.2.X, 7.3.X, or 7.4.X. The 'magic_quotes'
and 'register_globals' settings should be turned *off* (which is the default on
modern PHP installations).

Note: Mahara has **not** been fully tested with PHP 8.X. Some aspects of Mahara may not function as expected. [Plans are in place](https://mahara.org/interaction/forum/topic.php?id=8989) to support PHP 8.1.
Aaron Wells's avatar
Aaron Wells committed
99
100

The following PHP extensions are also required:
101
102
103
104
105
106
107
108
109
110
 * curl
 * gd (including Freetype support)
 * json
 * ldap
 * libxml
 * mbstring
 * mime_magic; or fileinfo
 * pgsql; or mysqli; or mysql
 * session
 * SimpleXML
111
 * intl - for language internationalisation
112
113
114
 * bz2 (optional)
 * imagick (optional)
 * openssl and xmlrpc (optional; for networking support)
115
 * memcached (optional; for SAML auth plugin)
116
117
118
119
 * zlib (optional)
 * adodb (optional; improves performance)
 * enchant or pspell (optional; for TinyMCE spellcheck button)

120
### Web browser
121

122
123
124
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 and Chrome (also on Android). Testing on Safari (also for iOS) is done on occasion,
Microsoft browsers, i.e. Microsoft Edge, are supported to a maximum of the
125
126
127
128
129
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 22.10, the supported browser versions are:
131
132
133
134
 * Firefox 99.0
 * Chrome 88.0
 * Safari 13.1
 * MS Edge 100.0
Aaron Wells's avatar
Aaron Wells committed
135
136
 * Safari for iOS
 * Chrome for Android
137
138
139

# TRANSLATIONS

140
Mahara has been translated into many languages. You can download [language packs](https://langpacks.mahara.org/), [install and update them via CLI](https://manual.mahara.org/en/22.10/administration/cli.html#install-and-update-language-packs), or [install and update them via the administration area](https://manual.mahara.org/en/22.10/administration/development.html#languages) in Mahara.
141

142
------------------
143
# COPYRIGHT NOTICE
144

145
Copyright (C) 2006-2022 Catalyst IT and others
146
147
148

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
149
the Free Software Foundation, version 3 or later of the License.
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.

156
157
158
You should have received a copy of the GNU General Public License 3.0+
along with this program (see the file 'COPYING'). If not, [view the GNU GLP
v.3+ online](https://www.gnu.org/licenses/gpl-3.0.html).
159
160
161
162
163
164
165
166
167
168
169

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.