Note: You are currently viewing documentation for Moodle 2.4. Up-to-date documentation for the latest stable version of Moodle may be available here: Apache.

Apache: Difference between revisions

From MoodleDocs
Main page ► Installation ► Apache
Installation
(Installing Moodle template)
 
(13 intermediate revisions by 5 users not shown)
Line 1: Line 1:
When most people refer to '''Apache''' they are talking about the "Apache HTTP Server Project". In fact Apache is really the "Apache Software Foundation" which hosts a long list of projects of which the HTTP server is just one, albeit the best known.
{{Installing Moodle}}
'''This article refers to the 'Apache HTTP server''''


The Apache HTTP Server enables web pages to be published on the internet (or an intranet or even on a single test machine). The [[PHP]] scripting language, in which Moodle is developed, is tightly integrated with the Apache HTTP Server. A web server is a required component of a Moodle installation. There are two distinct developments of the Apache HTTP Server, version 1 and version 2. Although version 2 should have replaced version 1, the architectures are so different that they both continue to be supported. Either are fully supported by PHP and Moodle.
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.  
 
The Apache HTTP Server Project describes itself thus:
 
"The Apache HTTP Server Project is an effort to develop and maintain an open-source HTTP server for modern operating systems including UNIX and Windows NT. The goal of this project is to provide a secure, efficient and extensible server that provides HTTP services in sync with the current HTTP standards.
 
Apache has been the most popular web server on the Internet since April 1996. The November 2005 Netcraft Web Server Survey found that more than 70% of the web sites on the Internet are using Apache, thus making it more widely used than all other web servers combined."


== Installing Apache ==
== Installing Apache ==
Usually Apache is installed alongside [[PHP]] and [[MySQL]] in a combination known as XAMPP or MAMP. See information about [[Complete install packages for Windows|XAMPP(Windows cross platforms)]] and for information about [[Complete Install Packages for Mac OS X|MAMP (Mac OS platforms)]].
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:
<pre>
sudo apt-get install apache2
</pre>


Example, Debian/Ubuntu:
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.
apt-get install apache2
 
See the documentation for your particular distro for the instructions. Apache is straightforward to build from source if required and the PHP documentation contains an article on building both Apache and PHP together.


==Performance==
==Performance==


'''Caching'''
See [[Performance recommendations]]
 
Apache can be tuned to make pages load faster by specifying how the browser should cache the various page elements. How to do this varies slightly between OSes but there are two basic steps
 
# Install and enable mod_expires - refer to documentation or man pages
# Add this code to the virtual server config file within the section for the root directory (or within the .htaccess file if AllowOverrides is On):
<IfModule mod_expires.c>
  ExpiresActive On
  ExpiresDefault "access plus 1 seconds"
  ExpiresByType text/html "access plus 1 seconds"
  ExpiresByType image/gif "access plus 120 minutes"
  ExpiresByType image/jpeg "access plus 120 minutes"
  ExpiresByType image/png "access plus 120 minutes"
  ExpiresByType text/css "access plus 60 minutes"
  ExpiresByType text/javascript "access plus 60 minutes"
  ExpiresByType application/x-javascript "access plus 60 minutes"
  ExpiresByType text/xml "access plus 1 seconds"
</IfModule>
 
The effect is to make everything stay in the cache except HTML and XML, which change dynamically. It's possible to gain a several hundred percent decrease in load times this way
 
More info: [http://www.metaskills.net/blog/heuristics/sysadmin/how-to-control-browser-caching-with-apache-2 www.metaskills.net]
 
'''Servers'''
 
Apache serves webpages by spawning new child processes (smaller sub-programs) to deal with each connection. The number of these that you allow to run and to be kept in reserve has a big impact on how fast your server will run. The risk (especially on a server with a small amount of memory, such as a VPS) is that the available RAM will run out and the system will end up using the far slower hard disk as swap memory instead. To prevent this, you need to tell Apache only to have a certain number. Here is a sample set of configuration directives for a VPS server with 128MB of RAM (with up to 384 burstable), which apparently works quite well (more info [http://www.agnivo.com/tech/vps-mysql-and-apache-optimization-guide-27.html here])
 
Make a back up of your httpd.conf first. It’s generally found at /etc/httpd/conf/httpd.conf, then open the file with your editor e.g.
 
nano /etc/httpd/conf/httpd.conf
 
Then look for these values, which may be spread about a little and change them:
 
Timeout 200
KeepAlive On
MaxKeepAliveRequests 200
KeepAliveTimeout 3
MinSpareServers 5
MaxSpareServers 15
StartServers 5
MaxClients 20
MaxRequestsPerChild 2000
HostnameLookups Off
 
If you find that you are running out of memory (type
 
top
 
if using Linux and look at the swap figure), just lower some of the numbers. Similary, if you have extra memory, you can afford to raise them a bit. Remember to combine tuning of Apache with tuning of your database app.
==Reverse Proxy==
 
The following is working on a Moodle 2.0 environment 3-2-2011
 
A Reverse proxy is useful when you want to run a moodle on a computer that is inside your network. This is assuming you have a server running Apache with a Real World IP called (say) foo.bar.org
 
You want everyone in the world to be able to log in to your moodle at (say) foo.bar.org/foomoo  The foomoo is anything you want to call your moodle. foo.bar.org is your real world domain name.
 
Before you start this, check that in your local network you can go to moo.bar.local/foomoo and access your moodle. (i.e your local moodle lives at moo.bar.local/foomoo)
 
Inside your network you have a server called moo.bar.local on a local ip (These kind of addressed are commonly like 192.168.x.x or 172.16.x.x or 10.x.x.x). Moodle is installed on that server as moo.bar.local/foomoo
 
Apache is configured in various ways but usually a conf file in /etc/http/conf/httpd.conf or maybe in /etc/apache2. Directives are sometimes separated into a conf.d directory.
 
You need these settings somewhere in your apache configuration. These are the settings that worked for me and there are a number of proxy modules for apache. (I am not an expert on the moodle proxy modules. I know that the following worked for me).
<nowiki>
# Proxy Server directives. Uncomment the following lines to
# enable the proxy server:
#
<IfModule mod_proxy.c>
<Proxy *>
    Order deny,allow
    Deny from all
    Allow from all
</Proxy>
 
</nowiki>
 
Also
 
ProxyPass /foomoo http://moo.bar.local/foomoo
ProxyPassReverse /foomoo http://moo.bar.local/foomoo
 
 
In your config.php on your moodle server make two setting
 
$CFG->reverseproxy      = 'true';
$CFG->wwwroot  = 'http://foo.bar.org/foomoo';


==SSL==


Restart apache on both servers.
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.


At this point, you will not be able to access your moodle inside your local network but it should work from outside.
'''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'''


Inside your local network you will have a DNS server somewhere (often a MS AD server). If you don't have a dns server I would be very surprised but for a small network it is possible. My advice is get one.  
You have two options for obtaining an SSL certificate:
 
* 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.  
On that dns server you will need to have an "A" Record installed that links foo.bar.org to moo.bar.local. A dns change sometimes takes a while to propagate.
* 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.  
 
This should make you Moodle work from inside the site as well as outside.
 
==SSL==


If you want your website not to be hackable, you need to enable SSL so that your moodle password cannot be easily read by others as it is transmitted (as normal internet communications normally can be). There are 2 options - generate a self-signed certificate, which stops casual network sniffing, but which can ultimately be compromised with enough effort, or purchase a certificate from a vendor (about $35 per year from the cheap ones). Below are instructions for install of a self-signed certificate.
Below are instructions for install of a self-signed certificate. If you purchase a certificate you will normally receive instructions for installing it


'''Debian and Apache2'''
===Debian and Apache2===


1. generate a certification:
1. generate a certification:
      apache2-ssl-certificate
<pre>
apache2-ssl-certificate
</pre>


for debian etch, apache2-ssl-certificate is no longer available, use make-ssl-cert instead:
for debian etch, apache2-ssl-certificate is no longer available, use make-ssl-cert instead:
          make-ssl-cert /usr/share/ssl-cert/ssleay.cnf /etc/apache2/ssl/apache.pem
<pre>
 
make-ssl-cert /usr/share/ssl-cert/ssleay.cnf /etc/apache2/ssl/apache.pem
</pre>
2. edit /etc/apache2/ports.conf:
2. edit /etc/apache2/ports.conf:
<pre>
       Listen 80
       Listen 80
       Listen 443
       Listen 443
3. copy /etc/apache2/sites-available/default to /etc/apache2/sites-available/default-ssl, and change /etc/apache2/sites-available/default:
</pre>
3. copy /etc/apache)2/sites-available/default to /etc/apache2/sites-available/default-ssl, and change /etc/apache2/sites-available/default:
<pre>
       NameVirtualHost *:80
       NameVirtualHost *:80
       <VirtualHost *:80>
       <VirtualHost *:80>
       ...
       ...
       </VirtualHost>
       </VirtualHost>
 
</pre>
and also /etc/apache2/sites-available/default-ssl:
and also /etc/apache2/sites-available/default-ssl:
<pre>
       NameVirtualHost *:443
       NameVirtualHost *:443
       <VirtualHost *:443>
       <VirtualHost *:443>
Line 147: Line 60:
       ...
       ...
       </VirtualHost>
       </VirtualHost>
</pre>
4. symbolic link the ssl file:
4. symbolic link the ssl file:
      a2ensite default-ssl
<pre>
a2ensite default-ssl
</pre>
5. don't forget to symbolic link the ssl module:
5. don't forget to symbolic link the ssl module:
      a2enmod ssl
<pre>
6. restart apache and test the connection (e.g. https://localhost/):
a2enmod ssl
      /etc/init.d/apache2 restart
</pre>
6. restart apache and '''test the connection''' (e.g. https://localhost/):
<pre>
/etc/init.d/apache2 restart
</pre>


== See also ==
== See also ==
Line 160: Line 80:
* [http://httpd.apache.org/docs/2.0/misc/perf-tuning.html Apache Performance Tuning article at the official homepage]
* [http://httpd.apache.org/docs/2.0/misc/perf-tuning.html Apache Performance Tuning article at the official homepage]
* [https://els.earlham.edu/cayaraa/weblog/1468.html Making Moodle work with SSL]
* [https://els.earlham.edu/cayaraa/weblog/1468.html Making Moodle work with SSL]
 
* [http://www.krufix.de/ Using the same Moodle twice in local network and Internet via SSL-Proxy] (in German)
 
 
[[Category:Administrator]]
[[Category:Developer]]


[[pl:Apache]]
[[pl:Apache]]
[[ja:Apache]]
[[ja:Apache]]
[[de:Apache]]
[[de:Apache]]

Latest revision as of 09:15, 8 December 2011

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

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 https://) but as this disables caching, there is a considerable performance hit. Only do this if you have a very good reason.

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

You have two options for obtaining an SSL certificate:

  • 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

Debian and Apache2

1. generate a certification: 

apache2-ssl-certificate

for debian etch, apache2-ssl-certificate is no longer available, use make-ssl-cert instead: 

make-ssl-cert /usr/share/ssl-cert/ssleay.cnf /etc/apache2/ssl/apache.pem

2. edit /etc/apache2/ports.conf: 

      Listen 80
      Listen 443

3. copy /etc/apache)2/sites-available/default to /etc/apache2/sites-available/default-ssl, and change /etc/apache2/sites-available/default: 

      NameVirtualHost *:80
      <VirtualHost *:80>
      ...
      </VirtualHost>

and also /etc/apache2/sites-available/default-ssl: 

      NameVirtualHost *:443
      <VirtualHost *:443>
      ...
              SSLEngine on
              SSLCertificateFile /etc/apache2/ssl/apache.pem
      ...
      </VirtualHost>

4. symbolic link the ssl file: 

a2ensite default-ssl

5. don't forget to symbolic link the ssl module: 

a2enmod ssl

6. restart apache and test the connection (e.g. https://localhost/): 

/etc/init.d/apache2 restart

See also

Retrieved from "https://docs.moodle.org/24/en/index.php?title=Apache&oldid=94377"
Powered by MediaWiki