Difference between revisions of "Apache"

Jump to: navigation, search
m (Slasharguments)
(copied from 2.8 docs thanks to Paul Verrall)
Line 26: Line 26:
 
==SSL==
 
==SSL==
  
Moodle has an option to enable login pages to force the HTTPS protocol. This is recommended but requires that your web server is configured for SSL. It is possible to run the whole site over HTTPS (typically by configuring Apache to rewrite all http:// URLs to <nowiki>https://</nowiki>) but as this disables caching, there is a considerable performance hit. Only do this if you have a very good reason.
+
Moodle has an option to enable HTTPS for the whole site or for just the login pages, either option requires that your web server is configured for SSL.
  
'''WARNING: Before switching on login over HTTPS, make very sure that HTTPS is working (just change the http:// to https:// in any Moodle URL). If not, you may lock yourself out'''
+
* Whole site HTTPS is enabled by including the https:// schema in your config.php 'wwwroot' parameter.
 +
* Login only HTTPS is enabled by setting the 'loginhttps' parameter, where the wwwroot schema should remain as http://
  
You have two options for obtaining an SSL certificate:
+
Prior to Moodle 2.3 It was not advised to run the whole site over HTTPS due to legacy restrictions with client-side caching. This is no longer the case assuming client browsers support the 'Cache-Control: public' method, which all supported browsers for this version of Moodle do.
* generate a self-signed certificate. This is fine on (say) an Intranet but unsuitable for the public internet (except perhaps for testing). The user has no assurance that the certificate is legitimate.
 
* purchase a certificate from a vendor. There is a surprising range of prices and value-added services available. Some hosting companies even provide free certificates.  
 
  
Below are instructions for install of a self-signed certificate. If you purchase a certificate you will normally receive instructions for installing it
+
To use HTTPS you will need to obtain an SSL certificate, you have two options:
  
===Debian and Apache2===
+
* Generate a self-signed certificate. This is fine on (say) an Intranet but unsuitable for the public internet, but users will we warned the certificated is untrusted when used publicly.
 +
* Purchase a certificate from a vendor. There is a surprising range of prices and value-added services available. Some hosting companies even provide free certificates.
  
1. generate a certification:
+
Debian provides instructions for installing a self-signed certificate [https://wiki.debian.org/Self-Signed_Certificate on their wiki] and includes general information on configuring Apache for SSL.
<pre>
+
If you purchase a vendor certificate you will normally receive instructions for installing it.
apache2-ssl-certificate
 
</pre>
 
  
for debian etch, apache2-ssl-certificate is no longer available, use make-ssl-cert instead:
+
A basic Apache SSL configuration can be summarised as:
<pre>
+
 
make-ssl-cert /usr/share/ssl-cert/ssleay.cnf /etc/apache2/ssl/apache.pem
+
Listen 443
</pre>
+
NameVirtualHost *:443
2. edit /etc/apache2/ports.conf:
+
<VirtualHost *:443>
<pre>
+
    SSLEngine On
      Listen 80
+
    SSLCertificateFile /path/to/your/certificate.crt
      Listen 443
+
    SSLCertificateKeyFile /path/to/your/certificate.key
</pre>
+
    ...
3. copy /etc/apache)2/sites-available/default to /etc/apache2/sites-available/default-ssl, and change /etc/apache2/sites-available/default:
+
</VirtualHost>
<pre>
 
      NameVirtualHost *:80
 
      <VirtualHost *:80>
 
      ...
 
      </VirtualHost>
 
</pre>
 
and also /etc/apache2/sites-available/default-ssl:
 
<pre>
 
      NameVirtualHost *:443
 
      <VirtualHost *:443>
 
      ...
 
              SSLEngine on
 
              SSLCertificateFile /etc/apache2/ssl/apache.pem
 
      ...
 
      </VirtualHost>
 
</pre>
 
4. symbolic link the ssl file:
 
<pre>
 
a2ensite default-ssl
 
</pre>
 
5. don't forget to symbolic link the ssl module:
 
<pre>
 
a2enmod ssl
 
</pre>
 
6. restart apache and '''test the connection''' (e.g. https://localhost/):
 
<pre>
 
/etc/init.d/apache2 restart
 
</pre>
 
  
 
== See also ==
 
== See also ==

Revision as of 17:44, 13 May 2015

This article refers to the 'Apache HTTP server'

The Apache HTTP server is the software that (along with the PHP scripting language) 'runs' Moodle. Note that there are alternatives (e.g. IIS on Windows) but the Apache HTTP Server is very popular on all platforms.

Installing Apache

Installers are available for most platforms from http://httpd.apache.org/download.cgi. The official installation instructions are here: http://httpd.apache.org/docs/2.0/install.html. If you are running Linux then you are recommended to use the packaged version if you can. For example in Debian/Ubuntu it is simply:

sudo apt-get install apache2

See the documentation for your particular platform for the instructions. Apache is straightforward to build from source if you have to and the PHP documentation contains an article on building both Apache and PHP together - although you should rarely need to do that.

Performance

See Performance recommendations

Slasharguments

The function slash arguments is required for various features in Moodle to work correctly, as described in Using slash arguments.

To turn it on, add this line to your httpd.conf, or to a .htaccess file in your local directory:

AcceptPathInfo On

SSL

Moodle has an option to enable HTTPS for the whole site or for just the login pages, either option requires that your web server is configured for SSL.

  • Whole site HTTPS is enabled by including the https:// schema in your config.php 'wwwroot' parameter.
  • Login only HTTPS is enabled by setting the 'loginhttps' parameter, where the wwwroot schema should remain as http://

Prior to Moodle 2.3 It was not advised to run the whole site over HTTPS due to legacy restrictions with client-side caching. This is no longer the case assuming client browsers support the 'Cache-Control: public' method, which all supported browsers for this version of Moodle do.

To use HTTPS you will need to obtain an SSL certificate, you have two options:

  • Generate a self-signed certificate. This is fine on (say) an Intranet but unsuitable for the public internet, but users will we warned the certificated is untrusted when used publicly.
  • Purchase a certificate from a vendor. There is a surprising range of prices and value-added services available. Some hosting companies even provide free certificates.

Debian provides instructions for installing a self-signed certificate on their wiki and includes general information on configuring Apache for SSL. If you purchase a vendor certificate you will normally receive instructions for installing it.

A basic Apache SSL configuration can be summarised as:

Listen 443
NameVirtualHost *:443
<VirtualHost *:443>
    SSLEngine On
    SSLCertificateFile /path/to/your/certificate.crt
    SSLCertificateKeyFile /path/to/your/certificate.key
    ...
</VirtualHost>

See also