.htaccess: 7 Useful Ingredients (Plus Bonus)
Published on April 12, 2007 (↻ February 5, 2024), filed under Development (RSS feed for all categories).
This and many other posts are also available as a pretty, well-behaved ebook: On Web Development.
This article features useful directives for .htaccess configuration files, based on my experience with a number of lightweight projects. It’s a pretty simple collection and you may be aware of some of these things. However, the simplicity can come in handy when your provider is somewhat restrictive (as DreamHost, for example, dislikes CheckSpelling
).
-
AddDefaultCharset On|Off|charset
The
AddDefaultCharset
directive adds a default encoding parameter when the content type of a response istext/plain
ortext/html
. (As far as I know the name of the directive is misleading—it specifies an encoding, not a character set.) When set, the affected files use the specified encoding. This directive also takes precedence over other encoding definitions.Example that makes
utf-8
the default encoding:AddDefaultCharset utf-8
. -
CheckSpelling On|Off
CheckSpelling
is a nice way towards a better website experience. It can also unburden error logs since it auto-corrects file requests. When activated, the directive compares each document name in the respective directory against the requested document name without regard to case, and compensates for one misspelling (character insertion, omission, transposition, or otherwise wrong character).Example of
CheckSpelling
being enabled:CheckSpelling On
. -
ContentDigest On|Off
The
ContentDigest
directive enablesContent-MD5
headers as specified in RFC 1864 and RFC 2068, respectively, and thus helps you with caching.ContentDigest
can impact server performance, though; also, there are alternatives.Example use:
ContentDigest On
. -
DefaultLanguage MIME-lang
DefaultLanguage
“tells Apache that all files in the directive’s scope (e.g., all files covered by the current<Directory>
container) that don’t have an explicit language extension (such as.fr
or.de
as configured byAddLanguage
) should be considered to be in the specified MIME-lang language.”Example that sets German as the default language:
DefaultLanguage de
. -
ErrorDocument error-code document
The
ErrorDocument
directive is one of the most relevant directives to set due to the importance of error pages (as errors are bad for the user experience, those documents should be on point). The directive allows you to define documents for certain HTTP status codes.Example pointing to an “error404” document in case a “not found” error shows up:
ErrorDocument 404 /error404
. -
Redirect [status] URL-path URL RedirectMatch [status] regex URL
Redirect
andRedirectMatch
are other important and popular directives, allowing to redirect requests to alternative locations, be they temporary or permanent, as defined by the respective HTTP status code. WhileRedirect
is pretty simple and probably more popular thatRedirectMatch
, the latter means more options for more powerful redirects. However, due to both popularity and complexity (ofRedirectMatch
’s regex capabilities), I recommend taking a closer look at the Apache documentation, and doing some tests first.Examples permantly redirecting
/count
to a canonical Mint tracker as well as GIF images to PNG:Redirect 301 /count https://example.com/mint/?js RedirectMatch 301 /img/(.*)gif https://example.com/img/$1png
-
RewriteEngine on RewriteCond %{HTTP_HOST} ^www.example.com [NC] RewriteRule ^(.*)$ https://example.com/$1 [L,R=301]
This is not a short description of a single directive you could use in your .htaccess file, but rather a snippet that’s for immediate use when it comes to the “domain name with or without www” question. The above snippet rewrites URLs starting with “www.example.com” to “example.com”, and it’s easily changed so that it does so vice-versa. Although some claim that “www. is deprecated” (I second that) and search engines like Google already allow you to specify the preferred domain spelling, that’s still a matter of taste that can be enforced as shown.
Bonus
I like to put some useful .htaccess articles and tutorials on top. In alphabetical order:
- Apache HTTP Server Project: Apache HTTP Server Tutorial: .htaccess Files;
- AskApache: Ultimate Htaccess Tutorial for .htaccess Files;
- Bently: More .htaccess Tips and Tricks;
- Esteves: .htaccess Cheatsheet;
- JavaScript Kit: Comprehensive Guide to .htaccess.
About Me
I’m Jens (long: Jens Oliver Meiert), and I’m a frontend engineering leader and tech author/publisher. I’ve worked as a technical lead for companies like Google and as an engineering manager for companies like Miro, I’m a contributor to several web standards, and I write and review books for O’Reilly and Frontend Dogma.
I love trying things, not only in web development (and engineering management), but also in other areas like philosophy. Here on meiert.com I share some of my experiences and views. (Please be critical, interpret charitably, and give feedback.)
Comments (Closed)
-
On May 9, 2007, 17:10 CEST, Robert said:
Hi Jens,
I am not having any luck using:
AddDefaultCharset utf-8
on a Dreamhost server…
Am I missing a special step for the Dreamhost world.
Thanks
-
On May 9, 2007, 19:53 CEST, Jens Oliver Meiert said:
Robert, what do you mean by “not having any luck”?
I made sure I use
AddDefaultCharset
on WHWS (DreamHost-hosted). That works fine. -
On May 9, 2007, 22:19 CEST, Robert said:
Hi Jens,
On this page I have a meta tag for charset along with a one line .htaccess file:
AddDefaultCharset utf-8
When I check the response headers using the Firefox Web Developer Extension:
Date: Wed, 09 May 2007 21:11:15 GMT
Server: Apache/1.3.37 (Unix) mod_throttle/3.1.2 DAV/1.0.3 mod_fastcgi/2.4.2 mod_gzip/1.3.26.1a PHP/4.4.4 mod_ssl/2.8.22 OpenSSL/0.9.7e
X-Powered-By: PHP/5.2.1
MS-Author-Via: DAV
Keep-Alive: timeout=5, max=100
Connection: Keep-Alive
Transfer-Encoding: chunked
Content-Type: text/html200 OK
The content-type is text/html not text/html; charset=utf-8
:-) I enjoyed the WHWS!
Robert
-
On May 10, 2007, 9:54 CEST, Jens Oliver Meiert said:
I probably have to look up some things again, but as far as I see, the reply you’re referrring to is based on a HEAD request. A GET shows that the encoding is set to
UTF-8
, though viameta
element.AddDefaultCharset
’s definitely applied when there is no encoding information available (see example text file via HEAD request). While you could check what happens when you don’t set the encoding viameta
(not always advisable), I’ll take a look at the specs again. -
On December 12, 2008, 15:37 CET, MrBruks said:
thanks for links Meiert, I’ve just solved my problem with .htaccess
Read More
Maybe of interest to you, too:
- Next: Revitalizing SUS, the System Usability Scale
- Previous: The Problem With Link Blogs (Plus Five Link Blogs That Rock)
- More under Development
- More from 2007
- Most popular posts
Looking for a way to comment? Comments have been disabled, unfortunately.
Get a good look at web development? Try WebGlossary.info—and The Web Development Glossary 3K. With explanations and definitions for thousands of terms of web development, web design, and related fields, building on Wikipedia as well as MDN Web Docs. Available at Apple Books, Kobo, Google Play Books, and Leanpub.