README.md 4.15 KB
Newer Older
1
# Mahara Readme
Nigel McNie's avatar
Nigel McNie committed
2

3
Thanks for downloading Mahara!
4 5

# SUPPORT
6

7
The best ways of obtaining support are:
8 9

 * http://manual.mahara.org/ - the Mahara online manual
10 11
 * https://mahara.org/forums - the Mahara project forums
 * https://wiki.mahara.org - the Mahara wiki
12 13
 * #mahara on freenode (IRC) - live chat with other users and developers

14 15 16
# INSTALLATION

For detailed installation instructions, see the installation page on our wiki:
17

18
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Installing_Mahara
Nigel McNie's avatar
Nigel McNie committed
19

20
The basic installation instructions are:
Nigel McNie's avatar
Nigel McNie committed
21

22 23 24 25 26 27 28
 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
29

Robert Lyon's avatar
Robert Lyon committed
30
Mahara 15.10 supports direct upgrades from previous Mahara versions 1.1.0 and later.
31
To upgrade an existing Mahara installation, follow the instructions here:
32

33
 * https://wiki.mahara.org/wiki/System_Administrator%27s_Guide/Upgrading_Mahara
34

35
# SYSTEM REQUIREMENTS
36

Aaron Wells's avatar
Aaron Wells committed
37
Here are the system requirements needed to run Mahara 15.10.
38

Aaron Wells's avatar
Aaron Wells committed
39
### OS
40

Aaron Wells's avatar
Aaron Wells committed
41 42 43
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.
44

45 46 47 48 49
### Web Server

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

Aaron Wells's avatar
Aaron Wells committed
50 51 52 53 54 55 56
### Database

Mahara requires either Postgres or MYSQL. It would require extensive
modification to support other databases.
 * Postgres 8.3 or later
 * MySQL 5.1 or later (or MariaDB equivalent)

57 58
### PHP

Aaron Wells's avatar
Aaron Wells committed
59 60 61 62
Mahara requires PHP version 5.3 or later. The "magic_quotes" and "register_globals"
settings should be turned *off* (which is the default on modern PHP installations).

The following PHP extensions are also required:
63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
 * 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

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, Safari, and Opera; and the last three versions
of IE. For Mahara 15.10, these versions are:
 * Firefox - 24.0
 * Chrome - 34.0
 * Safari - 6.0
 * Opera - 17.0
 * IE - 9, 10, 11

# TRANSLATIONS

Aaron Wells's avatar
Aaron Wells committed
95
Mahara has been translated into many lanugages. You can get language packs from:
96

Aaron Wells's avatar
Aaron Wells committed
97 98
* https://wiki.mahara.org/wiki/Language_Packs
 
99 100 101 102
# MOODLE

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

104
 * https://wiki.mahara.org/images/d/d5/Mahoodle.pdf
105

106 107
------------------
# Copyright notice
108

109
Copyright (C) 2006-2015 Catalyst IT and others; see:
Aaron Wells's avatar
Aaron Wells committed
110
https://wiki.mahara.org/wiki/Contributors
111 112 113

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
114
the Free Software Foundation, version 3 or later of the License.
115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133

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.