Apache Server Configs is a collection of configuration snippets that can help your server improve the website's performance and security, while also ensuring that resources are served with the correct content-type and are accessible, if needed, even cross-domain.
There are two options for getting the Apache server configs:
- If you have access to the main server configuration
httpd.conf), you should configure Apache this way. This is usually the recommended way, as using
.htaccessfiles slows down Apache!
- If you don't have access to it, which is quite common with hosting services,
Using the Apache server configs repo directly has a few required steps to be able to work.
See also the Apache Getting Started.
The first thing to check is that the
httpd.conf file contains appropriate values for
your specific install.
Most specific variables are:
TypesConfig(ensure that the path for the
mime.typesfile is valid)
Apache test and restart
To verify Apache config
To verify Apache config with a custom file
apache2 -t -f httpd.conf
To reload Apache and apply the new config
Enable Apache httpd modules
Some configurations won't have any effect if the appropriate modules aren't enabled. So, in order for everything to work as intended, you need to ensure you have the following Apache modules enabled:
For more detailed information on configuration files and how to use them, please check the appropriate Apache documentation:
These instructions should work on any distribution where
apt-get has been
used to install Apache.
Open up a terminal and type the following command. Enter your password when prompted.
sudo a2enmod setenvif headers deflate filter expires rewrite include
Restart apache by using the following command, so the new configuration takes effect.
sudo /etc/init.d/apache2 restart
MAMP PRO. On the main screen, click the
Apachetab and ensure that all the required modules are 'checked', indicating they are enabled.
WampServer. If you have installed WampServer just click on the icon in the task bar then Apache section then modules section. You will be presented with a list of modules. Simply click on a module name to enable it. WampServer will automatically restart the Apache service after you enable a module.
Others. Locate the
httpd.conffile, which is typically found in:
Open the file in a text editor and uncomment all the required modules. Once you have done so, reset MAMP/WAMP/XAMPP.
This repository has the following structure:
./ ├── vhosts/ │ ├── 000-default.conf │ └── templates/ ├── h5bp/ │ ├── basic.conf │ └── .../ └── httpd.conf
This directory should contain all the server definitions.
Except if they are dot prefixed or non
.confextension, all files in this folder are loaded automatically.
Files in this folder contain a
<VirtualHost/>template for secure and non-secure hosts. They are intended to be copied in the
vhostsfolder with all
example.comoccurrences changed to the target host.
This directory contains config snippets (mixins) to be included as desired.
There are two types of config files provided, individual config snippets and combined config files which provide convenient defaults.
This file loads a small subset of the rules provided by this repository to add expires headers, allow cross-domain fonts and protect system files from web access. The
basic.conffile includes the rules which are recommended to always be defined.
The main Apache config file.
The default location of the configuration files is
/usr/local/apache2/, but these files may be located any of a variety of places, depending on how exactly you installed the server.
Common locations for these files may be found in the httpd wiki.
As a reference
To use as reference requires no special installation steps, download/checkout the repository to a convenient location and adapt your existing httpd configuration incorporating the desired functionality from this repository.
Download the latest release archive.
To use directly, add httpd config files from this repository.
apache2ctl stop git clone https://github.com/h5bp/server-configs-apache.git /tmp/h5bp-apache cd /usr/local cp -r apache2 apache2-previous cp -r /tmp/h5bp-apache/* apache2 # install-specific edits apache2ctl start
Creating a new site
cp templates/example.com.conf .actual-hostname.conf sed -i 's/example.com/actual-hostname/g' .actual-hostname.conf
Enabling a site
mv .actual-hostname.conf actual-hostname.conf
Disabling a site
mv actual-hostname.conf .actual-hostname.conf
Just copy the
.htaccess file in the root of the website.
- Download the
h5bp.htaccesson the latest release and rename the file to
- Install them via npm:
npm install --save-dev apache-server-configsInside the
dist/folder, you'll find a ready-to-use
Security, mime-type, and caching best practices evolve, and so should do your
.htaccess file. In the past, with each new Apache Server Configs release
it was quite tedious to find out which
.htaccess trick was just new or only
had changes in certain nuances.
The build script with its re-usable and customizable
build configuration lets you easily
.htaccess file. Each new
.htaccess build will contain the
updated Apache Server Configs source files, enabled or commented-out according
to your settings in the
htaccess.conf of your project root.
It allows you to define which module to enable or
disable for your project. Just copy the default
from this repo into your project directory. Adjust to your needs, and/or
add custom code snippets you need for your project.
Its syntax is straight and pretty much self-explanatory:
# Example Module title "example module" enable "src/example-module/images.conf" enable "src/example-module/web_fonts.conf" disable "src/example-module/not-needed.conf" omit "src/example-module/not-needed-at-all.conf" #... more modules ...
For example, the “Cross-origin web fonts” snippet is always included in
.htaccess file and enabled. If your project does not deal
with web fonts, you can
omit this section:
This will comment out the section:
…and this will exclude the section, saving lines in output:
For example, the “Forcing
https://” snippet is disabled by default,
although being included in our pre-built
.htaccess. To enable this
snippet, change the
disable keyword to
Adding custom modules
Imagine you're passing all requests to non-existing files to your favorite web framework. The according mod_dir snippet would go like this:
Store this snippet in a file, e.g.
config/framework_rewrites.conf, and add
a reference in your
# PROJECT MODULES enable "config/framework_rewrites.conf"
Dive into your project root and call the build script from wherever you cloned the repo. Here are three examples:
- Create a default
Create a default
.htaccess in the current work directory. An existing
htaccess.conf in this directory will be used; if none is present, the
$ path/to/server-configs-apache/bin/build.sh # Output looks like: [✔] Build .htaccess [✔] Moved in place: './.htaccess'
- Custom output location
Just add an output path and filename as a parameter. By the way, if there's an
.htaccess file, the build script will create a backup.
$ path/to/server-configs-apache/bin/build.sh htdocs/.htaccess [✔] Build .htaccess [✔] Create backup: 'htdocs/.htaccess~' [✔] Moved in place: 'htdocs/.htaccess'
Why not maintain your personal
~/htaccess.conf? This example creates a
.htaccess in the current work directory, according to your favorite settings
you may have stored in your
path/to/server-configs-apache/bin/build.sh ./.htaccess ~/htaccess.conf
- Apache v2.4.17+
The code is available under the MIT license.