.htaccess の使い方・設定方法

.htaccess ファイル（分散設定ファイル）は、サーバの挙動を決定する設定ファイルのひとつ。
ウェブサーバとして「Apache」が使用されていて、サーバ管理者が「.htaccess」ファイルの設置を許可していれば使用可能。

通常 Apache は、httpd.conf というテキストファイルにディレクティブ（命令、コマンドのこと）と呼ばれる専用の命令を記述することで設定するが、httpd.conf はサーバ管理者しか編集できない。それに対して、.htaccess ファイルは各ユーザが、各ディレクトリ単位で設定することができるため、一般的によく利用される。

※.htaccess、または、httpd.conf へ設定を追記することで実現する。
またhttpd.confが親の設定ファイルで、.htaccessはhttpd.confの設定を上書きする形で反映される。
httpd.confが使用できる場合はこちらを利用する場合もあり、設定方法は.htaccessとほぼ同じである。

.htaccess ファイルを設置すると、アクセス制限やユーザー認証、リダイレクト(自動転送)、404エラーページのカスタマイズなどを設定することができる。

.htaccess ファイルは単なるテキストファイルだが、以下の点に注意が必要。

• .htaccess ファイルは設置されたディレクトリとその配下にある全てのディレクトリに影響を与える。
  ルート（public_html）に.htaccess ファイルを設置した場合は、全てのフォルダに影響を与える。
• 必ず最後に改行（空白行）を入れる。（一行以上の空白も大丈夫）。
• テキスト形式(プレーンテキスト)で保存する。UTF-8 として保存する場合は、BOMは付加しない。
• コメントは、行頭に「#」をつける。行の途中よりコメントアウトする場合はダブルクォートで囲む。
• .htaccess ファイルに文法誤りがある場合、そのディレクトリ以下のファイルにアクセスしようとすると、500 Internal Server Error が発生する。
• サーバ管理者が許可していない命令（ディレクティブ）を使うと、文法誤りのときと同様に 500 Internal Server Error が発生する。

リダイレクトの設定

リダイレクトとは、ドメインやページの URL （ファイル名やディレクトリ名）が変更された場合に用いられる自動転送処理のこと。

HTTPステータスコード

リダイレクトの設定方法は複数ある。Google 検索における信頼性が高い順に次のようになる。信頼性が低いとリダイレクトとして処理されない場合がありえる。

.htaccess ファイルを使ってリダイレクト(自動転送)するには、Redirect ディレクティブを使う方法と RewriteRule ディレクティブを使う方法がある。

Redirect ディレクティブ

以下は、Redirect ディレクティブを使って自動転送する構文。

Redirect [status] URL-path URL

301リダイレクト

301リダイレクトとは、サイトやページを恒久的に移転先へ転送することで、ユーザーや検索エンジンが正しいページにたどり着くことができるようにする方法。301リダイレクトが使われるケースは以下のような場合。

• サイトを新しいドメインに移動し、できるだけスムーズに移行を行いたい場合。
• ユーザーが複数の異なる URL を介してサイトにアクセスする場合。
• 2 つのウェブサイトを結合し、無効になった URL へのリンクが正しいページにリダイレクトされるようにしたい場合

Redirect ディレクティブを使った転送の場合、status 引数に permanent を指定することで、301リダイレクトになる。

例えば、現在のウェブサイトへの全アクセスを、新しいサイト http://example.com/ へ自動転送させたい場合は以下のように記述する。この場合、転送元（URL-path）が「/」で転送先（URL）が「http://example.com/」である。

Redirect permanent / http://example.com/

RedirectMatchディレクティブ

RedirectMatch ディレクティブは、Redirect ディレクティブと機能はほぼ同じだが、正規表現を用いたマッチングを行う点が異なる。

RedirectMatch [status] regex URL

例えば、すべての GIF ファイルを別サーバの同様な名前の JPEG ファイルに後方参照 を利用してリダイレクトするには、以下のように記述する。

RedirectMatch (.*).gif$ http://www.anotherserver.com$1.jpg

.htaccess が使えない場合

使っている環境で .htaccess によるリダイレクトが使用できない場合には、以下のような方法もある。

meta refresh

meta 要素の http-equiv 属性に “refresh” を設定することにより、リダイレクト（転送）を指定することができる。content 属性で指定した秒数後に、指定した URL へリダイレクトする。

以下が書式。これをhead内に記述する。

<meta http-equiv="refresh" content="秒数; URL=http://移転先ドメイン/"> 

<!-- 以下の例では meta 要素の content 属性で指定する秒数を０秒に指定してある -->
<meta http-equiv="refresh" content="0; URL=http://example.com/">

PHP header() 関数

PHP を使って別のページへリダイレクトさせるには、header() 関数で Location ヘッダーを使用する。

注意点として、header() 関数以下のスクリプトが実行されないように、必ず exit() 関数を使ってスクリプトを終了するようにすること。

<?php
header('HTTP/1.1 301 Moved Permanently');
header('Location: http://example.com/');
exit();
?>

<?php
header('Location: http://example.com/', true, 301);
exit();
?>

mod_rewrite を使ったリダイレクト

サーバーの拡張機能 mod_rewrite の機能が使えれば、RewriteRule ディレクティブ を使ったリダイレクトを設定することができる。

httpd.confに記載する場合

/etc/httpd/conf/httpd.conf内の以下の行が存在し、コメントアウトされていないことを確認。

LoadModule rewrite_module modules/mod_rewrite.so

もし設定を修正した場合は以下のコマンドで、確認・反映

apachectl configtest
/etc/init.d/httpd graceful

gracefulはリクエスト処理を中断しないで反映する。httpd reloadでも反映可能。こちらは、リクエスト処理を中断して、反映する。

mod_rewrite を使ったリダイレクトの基本的な形は以下のようなものになる。

RewriteEngine On
RewriteBase /
RewriteRule 転送元ファイル正規表現 転送先URL [フラグ] 

• RewriteEngine：mod_rewrite の機能の On/Off を指定する。デフォルトの値は Off になっているので、URL の書き換え処理を行うには、On にする必要がある。

• RewriteBase：RewriteRule ディレクティブで指定するリダイレクト先の URL 書き換えの基準となるディレクトリを相対パスで指定する。RewriteRule の転送先を相対パスで記述した場合にのみ適用される。絶対パスで指定している場合は不要。
  省略した場合には実際の URL の階層（.htaccess が置かれたディレクトリからの相対パス）が適用される。
  「RewriteBase /」と記述した場合、どのディレクトリに設置を行った場合でも必ずドキュメントルートからのパスになる。

• RewriteRule：具体的な URL 書き換えのルールを記述する。１番目のパラメータである正規表現にマッチした場合、2番目のパラメータである URL に書き換えられる。（RewriteRule ディレクティブ ）

• フラグ：省略可能だが、301リダイレクトにするには R=301 を指定する必要がある。また、併せてよく指定される「L」は URL の書き換え処理を終了（last）を意味する。

以下は、特定のページから特定のページにリダイレクトさせる場合の例。

RewriteEngine On
RewriteRule ^fuga.html$ http://www.example.com/hoge.html [R=301,L]

以下は、ディレクトリ単位でリダイレクトさせる場合で、転送先にファイル名を引き継ぎ、後方参照を使って同じファイル名として別ディレクトリに転送したい場合の例。

RewriteEngine On
RewriteRule ^fuga/(.*)$ http://www.example.com/hoge/$1 [R=301,L]

以下は、ディレクトリ単位でリダイレクトさせる場合で、転送先にファイル名を引き継がず、同一の URL に転送したい場合の例。

RewriteEngine On
RewriteRule ^fuga/(.*)$ http://www.example.com [R=301,L]

RewriteCond ディレクティブ

RewriteCond ディレクティブは、RewriteRule （書き換えルール）を実行するための条件を定義する。RewriteCond に記述した条件を満たした場合のみ、直後の RewriteRule ディレクティブの書き換えが行われ、条件を満たさない場合は、直後の RewriteRule ディレクティブは実行されない。

RewriteCond ディレクティブは、RewriteRule ディレクティブの前に 1 つ以上設置することができ、複数設置する場合は、オプション（フラグ）によって OR 条件として処理するかを指定することができる。オプションを省略した場合は、AND 条件として処理される。

以下が基本的な書式。

RewriteEngine On
RewriteCond テスト文字列 条件パターン [フラグ]
RewriteRule 条件 置換文字列

オプション（フラグ）

RewriteCond で使用できるオプション（フラグ）は以下。

OR と NC をどちらも指定したい場合には [OR,NC] とカンマ区切りで指定する。

条件を複数指定する場合 (AND 条件)： 複数の条件が全て一致した場合に RewriteRule を実行

RewriteCond テスト文字列 条件パターン
RewriteCond テスト文字列 条件パターン
RewriteRule 条件 置換文字列

条件を複数指定する場合 (OR 条件）：複数の条件のいずれかが一致した場合に RewriteRule を実行

RewriteCond テスト文字列 条件パターン [OR]
RewriteCond テスト文字列 条件パターン
RewriteRule 条件 置換文字列

テスト文字列に利用できる環境変数

以下は、「www なし」でアクセスがあったら、「www あり」に 301 リダイレクトさせる例。テスト文字列に %{HTTP_HOST} とあるが、これは「サーバーのホスト名」を表す。mod_rewrite では「環境変数」という変数を利用でき、%{環境変数名} と指定することで利用することができる。

RewriteEngine On
RewriteCond %{HTTP_HOST} ^example¥.com$  [NC]
RewriteRule ^(.*)$ http://www.example.com/$1 [R=301,L]

以下は利用できる「環境変数」の一例。

条件パターンで使える演算子

RewriteCond では条件に一致するパターンを Perl 互換の正規表現で指定する。以下は条件パターンの例。

RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d

1行目は、%{REQUEST_FILENAME} （リクエストされたファイル名）が「!-f」という条件を満たしていれば true となる。「!-f」は「!」と「-f」に分割することができる。

「-f」はファイルが存在する場合（ファイルである場合）は true を返す。「!」は否定（結果を逆転させるもの）。よって、「!-f」はファイル以外の（ファイルが存在しない）場合は、true を、ファイルの場合は false を返す。

２行目は、「-d」がディレクトリかどうかの検証を行い、%{REQUEST_FILENAME} がディレクトリの場合（そのディレクトリが存在する場合）は true を、それ以外の場合は false を返すが、1行目と同様に「!」がついているので、ディレクトリ以外の（ディレクトリが存在しない）場合に、true を、ディレクトリの場合は false を返す。

これら２つの条件にはオプション[OR]を指定していないので、AND 条件として処理され、「リクエストされたファイルが存在せず」かつ「リクエストされたディレクトリが存在しない」という条件になる。

以下は利用できる演算子の一例。

RewriteRule ディレクティブ

RewriteRule ディレクティブは、URL の書き換えを行うディレクティブ。「条件パターン」に一致する URL を、その後の「置換文字列」で書き換える。

条件パターンは（Perl 互換の）正規表現で指定することができる。以下が書式。

RewriteRule 条件パターン 置換文字列 [フラグ]

ユーザーからリクエストのあった URL（サーバーから渡された URL）が、条件パターンにマッチした場合、置換文字列で書き換えられる。

以下は「/index.html」でアクセスがあった場合、「/」に 301 リダイレクトさせる例。

RewriteEngine On
RewriteRule ^index\.html$ http://example.com/ [R=301,L]

以下は、RewriteRule で利用可能なフラグの例。

index.html なしに統一

/index.html（インデックスファイル）にアクセスがあったら、/（ディレクトリ）に301リダイレクトさせる方法。

例えば、https://www.example.com/index.html にアクセスがあった場合、https://www.example.com/ にリダイレクト（URL を正規化）するには、以下のように記述する。

RewriteEngine On
RewriteCond %{THE_REQUEST} ^.*/index\.html
RewriteRule ^(.*)/index\.html$ https://%{HTTP_HOST}/$1 [R=301,L]

index.html だけではなく、index.php も対象とするには、以下のように記述する。

RewriteEngine On
RewriteCond %{THE_REQUEST} ^.*/index\.(html|php)
RewriteRule ^(.*)index\.(html|php)$ https://%{HTTP_HOST}/$1 [R=301,L]

www あり・なしの統一

www ありの URL を、www なしの URL にリダイレクト、または、その逆の処理を行う。

www なしに統一

www.exmaple.com でアクセスがあった場合に exmaple.com にリダイレクト（URL を正規化）する方法。ドメイン部分を自分の環境に書き換えて、以下を記述した .htaccess をルートディレクトリに設置する。

RewriteEngine On
RewriteCond %{HTTP_HOST} ^www\.example\.com [NC]
RewriteRule ^(.*)$ https://example.com/$1 [R=301,L]

http://www.example.com/～ でアクセスがあった場合、%{HTTP_HOST} は www.example.com になる。RewriteCond 条件パターン部分の ^www\.example\.com とマッチするので、処理は RewriteRule に移行してリダイレクトされる。 [NC] は大文字小文字を区別しないフラグ。

$1 はリクエストされたページの URL を後方参照  で、正規化済みの URL の末尾に加えている。また、R=301 を指定して 301リダイレクトにしている。L は書き換えの終了（Last）を意味する。

www ありに統一

前述とは逆に exmaple.com でアクセスがあった場合に www.exmaple.com にリダイレクト（URL を正規化）する方法。ドメイン部分を自分の環境に書き換えて、以下を記述した .htaccess をルートディレクトリに設置する。

RewriteEngine On
RewriteCond %{HTTP_HOST} ^example\.com [NC]
RewriteRule ^(.*)$ https://www.example.com/$1 [R=301,L]

https スキームに統一

http からはじまる URL へのアクセスを https へリダイレクトさせる例。

RewriteEngine On
RewriteCond %{HTTPS} off
RewriteRule ^(.*)$ https://%{HTTP_HOST}%{REQUEST_URI} [R=301,L]

%{HTTPS} は HTTPS であれば on、そうでなければ off を返す。off の場合、https で始まる URL にリダイレクトさせる。

%{HTTP_HOST} はホスト名、%{REQUEST_URI} はクエリ文字列を含む URI 情報。http://example.com/fuga/index.html にアクセスされた場合、%{HTTP_HOST} は example.com、%{REQUEST_URI} は/fuga/index.html になる。

拡張子なしでのアクセス

通常 URL にはファイルの拡張子が含まれますが、拡張子なしでもアクセスできるようにする方法。

http://exmaple.com/sample.html でも、
http://exmaple.com/sample でも同じファイルにアクセスできるようにする例。

RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-d
RewriteCond %{REQUEST_FILENAME}\.html -f
RewriteRule ^(.*)$ $1.html 

%{REQUEST_FILENAME} !-d は、リクエストされたファイル名のディレクトリが存在しない場合は、という条件。

%{REQUEST_FILENAME}\.html -f は、リクエストされたファイル名に .html が付いたファイルが存在する場合は、という条件。

これら２つの条件にはオプション[OR]を指定していないので、AND 条件として処理されて、書き換え処理が行われ、結果として拡張子なしでアクセスしても拡張子の付いたファイルが表示される。

メンテナンスページにリダイレクト

どの URL にアクセスしても「現在メインテナンス中です」というメインテナンスページを表示する方法。まず、

メインテナンスページ（例：maintenance.html 任意の名前）を用意して、.htaccess に以下のように記述する。以下の例では、メインテナンスページはドキュメントルートに配置。（/maintenance.html）

ErrorDocument 503 /maintenance.html
     
RewriteEngine On
RewriteCond %{REQUEST_URI} !=/maintenance.html
RewriteCond %{REMOTE_ADDR} !=xxx.xxx.xxx.xxx
RewriteCond %{REQUEST_FILENAME} !\.(css|jpe?g|gif|png|js)$
RewriteRule ^.*$ - [R=503,L]
 
Header set Retry-After "Sun, 06 Aug 2017 6:00:00 GMT"

ErrorDocument 503 /maintenance.html

ErrorDocument ディレクティブ  で、HTTP ステータスコード  503 (Service Unavailable：サービス利用不可)を返すようにして、メインテナンスページ（maintenance.html）へリダイレクト。

*単にメインテナンスページにリダイレクトするだけだと、HTTP ステータスコードが 200 となるため、コンテンツとしてキャッシュされてしまう。また、HTTP 404 (Not Found：未検出) を設定すると、クローラーにサイトが無くなったものと判断される可能性がある。

RewriteCond %{REQUEST_URI} !=/maintenance.html

RewriteCond  で、メインテナンスページを除外。

RewriteCond %{REMOTE_ADDR} !=xxx.xxx.xxx.xxx

作業者の IP アドレスを除外（メインテナンスページが表示されてしまうと作業ができないため）。
複数ある場合は、行を増やして追加。

RewriteCond %{REQUEST_FILENAME} !.(css|jpe?g|gif|png|js)$

CSS や JavaScritp、画像ファイルなどのリソースファイルを除外。（メインテナンスページから参照できるようにするため）

RewriteRule ^.*$ – [R=503,L]

除外した以外の全てのページにステータスコード 503 を設定。ハイフン（-）はフラグの操作だけを実行したい(置換しない)場合に使用。

Header set Retry-After “Sun, 06 Aug 2017 6:00:00 GMT”

メンテナンス終了予定時刻（GMT で指定）を設定。

メンテナンスを知らせるページを作っている時間がない（緊急にメンテナンスをおこなければならない）場合は、以下を .htaccess に追記すれば、ユーザーには「Sorry. We’re under maintenance.」というメッセージを表示し、検索エンジンには503を返すことができる。

ErrorDocument 503 "Sorry. We're under maintenance."
RedirectMatch 503 .*

Redirect 301 /main/ http://www.abc.com/index.html
Redirect permanent /main/ http://www.abc.com/index.html

エラーページの変更

ErrorDocument ディレクティブを使って、エラードキュメントの表示方法の設定をすることができる。（Apache コア機能 ErrorDocument ディレクティブ）

以下が書式。error-code にはステータスコード  を、document には、表示するテキストまたはファイルへのパスを指定する。

ErrorDocument error-code document

ErrorDocument ディレクティブを使って、問題やエラーが発生したときに、 以下の四つのうちのいずれかの動作を設定することができる。

1. Apache 標準の簡単なエラーメッセージを表示（デフォルトなので特に設定は不要）
2. 自分で指定したメッセージを表示
3. 問題やエラーの処理をする為に、自サーバ内の URL-path へリダイレクト
4. 問題やエラーの処理をする為に、外部の URL へリダイレクト

自分で指定したメッセージを表示

自分で指定したメッセージを表示を表示する場合は、エラーコードの後に、メッセージをダブルクォート（”）で囲んで記述する。

ErrorDocument 404 "Sorry, the file not found"

問題やエラーの処理をする為に、自サーバ内の URL-path へリダイレクト

自分のサーバーに表示するファイルを配置する場合は、/ で始まるドキュメントルートからの相対パスを指定する。以下は 404.html というファイルをルートディレクトリに配置した場合の例。

401（Unauthorized：認証失敗）や 404（Not Found：未検出）の際にファイルを指定する場合はこの方法を使用する。

ErrorDocument 404 /404.html

問題やエラーの処理をする為に、外部の URL へリダイレクト

http などで始まる完全な URL を指定する。この場合、クライアントはエラーステータスコードを受け取らずに、リダイレクトのステータスコードを受け取るので注意が必要。

ErrorDocument 500 http://foo.example.com/cgi-bin/tester

404 ページを作成する場合に考慮する点

「有益な 404 ページを作成する」には、以下のようなことも書かれている。

• ユーザーに対して、探しているページが見つからないことを明確に伝える。
• 404 ページを、サイトのその他の部分と同じデザイン（ナビゲーションを含む）にする。
• 最も人気のある記事や投稿へのリンクの他、ホームページへのリンクを追加する。
• 404 ページが Google や他の検索エンジンのインデックスに登録されないようにするため、存在しないページがリクエストされたときにウェブサーバーが実際の 404 HTTP ステータス コードを返すことを確認する。

ファイル内のパスは「ルートパス」または「絶対パス」を使用

「404 ページ」は様々な場所から参照・呼び出しされるので画像やファイル、リンクへのパスは「/」から始まるルートパス（トップディレクトリからのパス）または絶対パス（URL）で指定する必要がある。

以下のような画像や CSS ファイル等は「ルートパス」または「絶対パス（URL）」で指定する。

• 画像へのパス
• 表示するリンクのパス（ナビゲーションやトップページへのリンク等）
• CSS や JavaScript のパス
• 場合によっては CSS や JavaScript は head 内などに記述することも考えられる

noindexの設定

ルートディレクトリ直下の.htaccessファイルで X-Robots-Tag HTTPヘッダー を使用する。
もし特定のディレクトリ以下のPDFファイルのみnoindexを指定したい場合（例えば「https://example.com/document/」以下のみ）は、任意のディレクトリ直下で .htaccessファイルを作成する。

<FilesMatch "\.pdf$">
Header set X-Robots-Tag "noindex"
</FilesMatch>

ちなみに他のファイル（例えばpngファイル）にnoindexを指定したい場合は以下の通り。

<FilesMatch "\.png$">
Header set X-Robots-Tag "noindex"
</FilesMatch>

また、複数のファイルタイプ（例えばpdfとpng）にnoindexを指定したい場合は以下のようにする。

<FilesMatch "\.(pdf|png)$">
Header set X-Robots-Tag "noindex"
</FilesMatch>