Diff for "ServerSideIncludes"


Differences between revisions 1 and 11 (spanning 10 versions)
Revision 1 as of 2006-07-26 02:41:01
Size: 2110
Editor: S0106001150603f7d
Comment: move from wiki.u.c
Revision 11 as of 2012-03-18 18:18:39
Size: 2635
Editor: dsmythies
Comment: Update. Apache link was to 2.0 instead of 2.2. mime now cotains the AddType and AddOutputFilter
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
How to set up [http://httpd.apache.org/docs/2.0/howto/ssi.html Server Side Includes] on [:ApacheMySQLPHP:Apache], assuming you already have Apache installed. <<Include(Tag/StyleCleanup)>>

How to set up [[http://httpd.apache.org/docs/2.2/howto/ssi.html|Server Side Includes]] on [[ApacheMySQLPHP|Apache]], assuming you already have Apache installed.

Server Side Includes are a very simple way of performing a limited Server Side Programming. For instance, you can have the server assemble one single document by merging smaller ones (with the #include directive), you can display data on the file itself (with the date_local directive, and many more), and if security is none of your concern, you can even execute local programs.
Line 7: Line 11:
cd /etc/apache2/mods-enabled
sudo ln -s /etc/apache2/mods-available/include.load
sudo a2enmod include
Line 11: Line 14:
This creates a SymbolicLink in mods-enabled of the config file in mods-available. See also RootSudo. This creates a SymbolicLink in mods-enabled of the config file in mods-available.
Line 27: Line 30:
 # This directive allows us to have apache2's default start page
 # in /apache2-default/, but still have / go to the right place
 # Commented out for Ubuntu
 #RedirectMatch ^/$ /apache2-default/
Line 37: Line 36:
 Options Indexes FollowSymLinks MultiViews +Includes  Options Indexes FollowSymLinks MultiViews Includes
Line 41: Line 40:
 # This directive allows us to have apache2's default start page
 # in /apache2-default/, but still have / go to the right place
 # Commented out for Ubuntu
 #RedirectMatch ^/$ /apache2-default/
 AddType text/html .shtml
 AddOutputFilter INCLUDES .shtml
 DirectoryIndex index.shtml
Line 50: Line 44:
You need to add `+Includes` to the end of the end of the `Options`, and two new lines after the commented-out lines. You need to add `Includes` to the end of the end of the `Options`.
You can leave out the final
added line if you don't want includes in index pages.
Line 52: Line 47:
== Restart Apache2 == Note that on some older versions of Ubuntu, the /etc/apache2/mods-available/mime.conf might not contain the required AddType and AddOutputFilter directives for .shtml. and so another two lines will be required in /etc/apache2/sites-available/default:
{{{
<Directory /var/www/>
 Options Indexes FollowSymLinks MultiViews Includes
 AllowOverride None
 Order allow,deny
 allow from all
 AddType text/html .shtml
 AddOutputFilter INCLUDES .shtml
 DirectoryIndex index.shtml
</Directory>
}}}



== Restart Apache ==

For the changes to effect you will need to restart Apache with
Line 72: Line 84:
If your browser displays the local date (eg Saturday, 06-Aug-2005 23:05:21 CEST), SSI is working! If your browser displays the local date (eg Sunday, 18-Mar-2012 11:12:56 PDT), SSI is working!

Tested on Ubuntu 9.04, 12.04
Line 75: Line 89:
Based on [http://www.unet.univie.ac.at/%7Ea9826090/en/projects/linux/ubuntu-apache2-ssi.html Rafael Gattringer's Ubuntu Apache2 SSI Installation guide], with permission. Based on [[http://www.unet.univie.ac.at/%7Ea9826090/en/projects/linux/ubuntu-apache2-ssi.html|Rafael Gattringer's Ubuntu Apache2 SSI Installation guide]], with permission.
Line 77: Line 91:
CategoryCleanup

Tag/tag.png

Style Cleanup Required
This article does not follow the style standards in the Wiki Guide. More info...

How to set up Server Side Includes on Apache, assuming you already have Apache installed.

Server Side Includes are a very simple way of performing a limited Server Side Programming. For instance, you can have the server assemble one single document by merging smaller ones (with the #include directive), you can display data on the file itself (with the date_local directive, and many more), and if security is none of your concern, you can even execute local programs.

Enable the Includes module

sudo a2enmod include

This creates a SymbolicLink in mods-enabled of the config file in mods-available.

Editing config

Open the /sites-available/default file...

gksudo gedit /etc/apache2/sites-available/default

find this section...

<Directory /var/www/>
        Options Indexes FollowSymLinks MultiViews
        AllowOverride None
        Order allow,deny
        allow from all
</Directory>

and edit it to look like this:

<Directory /var/www/>
        Options Indexes FollowSymLinks MultiViews Includes
        AllowOverride None
        Order allow,deny
        allow from all
        DirectoryIndex index.shtml
</Directory>

You need to add Includes to the end of the end of the Options. You can leave out the final added line if you don't want includes in index pages.

Note that on some older versions of Ubuntu, the /etc/apache2/mods-available/mime.conf might not contain the required AddType and AddOutputFilter directives for .shtml. and so another two lines will be required in /etc/apache2/sites-available/default:

<Directory /var/www/>
        Options Indexes FollowSymLinks MultiViews Includes
        AllowOverride None
        Order allow,deny
        allow from all
        AddType text/html .shtml
        AddOutputFilter INCLUDES .shtml
        DirectoryIndex index.shtml
</Directory>

Restart Apache

For the changes to effect you will need to restart Apache with

sudo apache2ctl restart

Test it works

Create a SSI test file and save it under /var/www/ssi-test.shtml.

<html>
<head>
<title>SSI Test Page</title>
</head>
<body>
<!--#echo var="DATE_LOCAL" -->
</body>
</html>

In your WebBrowser, go to http://127.0.0.1/ssi-test.shtml.

If your browser displays the local date (eg Sunday, 18-Mar-2012 11:12:56 PDT), SSI is working!

Tested on Ubuntu 9.04, 12.04


Based on Rafael Gattringer's Ubuntu Apache2 SSI Installation guide, with permission.


ServerSideIncludes (last edited 2014-06-06 13:03:12 by ya-bo-ng)