Use internationalization rewrites ("i18n rewrites") to serve different content depending on a user's country or preferred language. Here are some example configurations that you could set up:
Serve the same French content to all users who prefer French (regardless of country).
Example: a homepage with French textServe Standard French content to users who prefer French, but for Canadian users who prefer French, serve Canadian French content instead.
Example: a homepage with Standard French phrasing versus a homepage with Canadian French phrasingServe the same content to all Canadian users (regardless of their language preference).
Example: a homepage with your site's "default" language but with a Canada-specific feature (like a holiday theme)Serve Canadian French content to Canadian users who prefer French.
Example: a homepage with Canadian French phrasing and a Canada-specific feature (like a holiday theme)
Firebase Hosting determines a user's country from their IP address and a
user's language preferences from the Accept-Language
request header (usually
set automatically by their web browser).
Set up i18n rewrites
To set up i18n rewrites for your Hosting site, you need to create an "i18n
content" directory for all your localized content, then add the i18n
attribute
to your firebase.json
file to point to your new "i18n content" directory.
Here are the detailed steps:
Within your local app directory's
public
folder, make a separate directory for your "i18n content", then create subfolders for each language and country combination supported by your site.In each subfolder, add the content specific for that combination, like holiday-themed homepages or language-specific 404 pages.
Here's an example "i18n content" directory called
localized-files
:public/ index.html // your site's default homepage 404.html // your site's custom 404 page localized-files/ ALL_ca/ index.html es_ALL/ index.html 404.html fr/ index.html 404.html fr_ca/ index.html
public/ // matches requests that aren't specified by your "i18n content" subfolders // example: display your homepage in the "default" language for your site with no country-specific features index.html // your site's default homepage 404.html // your site's custom 404 page localized-files/ // matches requests from Canada with any language preference // example: display your homepage in the "default" language for your site with a Canada-specific feature ALL_ca/ index.html // matches requests from any country with a language preference of `es` or `es-foo` // example: display your homepage in Spanish with no country-specific features es_ALL/ index.html 404.html // your site's custom 404 page in Spanish // matches requests from any country with a language preference of `fr` or `fr-foo` // example: display your homepage in Standard French with no country-specific features fr/ index.html 404.html // your site's custom 404 page in French // matches requests from Canada with a language preference of `fr` or `fr-foo` // example: display your homepage in Canadian French and/or with a Canada-specific feature fr_ca/ index.html
The
localized-files/
directory contains separate subfolders for each language and country combination supported by your site. The naming pattern for each subfolder must follow either of these formats:languageCode_countryCode
: Contains content specific for users who have that language preference and that country codelanguageCode
: Contains content specific for users who have that language preference, but the content isn't country-specific; basically equivalent tolanguageCode_ALL
Refer to the subsection Country and language codes below for more details about these codes. You can use the value of
ALL
(case-sensitive) to indicate any country (likees_ALL/
) or any language (likeALL_ca/
).The files in a subfolder don't need to have analogous files in the
public
directory or other subfolders. You can create content that is entirely specific to a language and/or country.Add the
i18n
attribute to yourfirebase.json
file and specify the directory that contains your "i18n content". Continuing our example:// firebase.json "hosting": { "public": "public", "ignore": [ "firebase.json", "**/.*", "**/node_modules/**" ], "i18n": { "root": "/localized-files" // directory that contains your "i18n content" } ... }
The directory specified for
root
must be the name of the directory that contains all your "i18n content" subfolders. If you placed all your "i18n content" subfolders at the root of yourpublic
directory, use/
for the value ofroot
. Leading and trailing slashes in theroot
value are optional.Deploy your "i18n content" and config to your Hosting site.
You can test your setup using cookie overrides.
Country and language codes
When naming "i18n content" subfolders, you must use lowercase for both country
and language codes. You can use the value of ALL
(case-sensitive) to indicate
any country (like es_ALL/
) or any language (like ALL_ca/
).
Hosting obtains the country code from the user's IP address. Country codes are two-letter ISO 3166-1 alpha-2 codes.
The language codes are obtained from the user's Accept-Language
request header
(usually
set automatically by their web browser).
They are ISO 639-1 codes.
Keep the following in mind when using language codes:
When Hosting searches for which "i18n content" to serve, it orders the languages based on the quality values in the
Accept-Language
header.Hosting drops any regional and country subtags in the
Accept-Language
header, so the language code in a "i18n content" subfolder name cannot contain these subtags. For example, you can't usees-419
ores-US
as a language code in a subfolder name, but you can usees
.If you want to serve specific regional or country content, you can create subfolders that contain the specific language-country content you want to support.
In this example, a request from Spain with the language preference of
es
,es-es
, or evenes-419
would receive content from thees_es/
subfolder because Hosting treats all those language codes ases
.A request from the United States, Mexico, or any other country with the language preference of
es-419
would receive content from thees_ALL/
subfolder because Hosting treatses-419
ases
.public/ // matches requests that aren't specified by your "i18n content" subfolders index.html // the site's default homepage localized-files/ // matches requests from Spain with a language preference of `es` or `es-foo` es_es/ index.html // matches requests from any other country with a language preference of `es` or `es-foo` es_ALL/ index.html
In this example, a request from Mexico with the language preference of
es-419
would receive content from thees_mx/
subfolder because Hosting treats the language codees-419
ases
.However, a request from the United States with the language preference of
es-419
would receive content from thees_ALL/
subfolder because Hosting treatses-419
ases
and there's noes_us/
subfolder.public/ // matches requests that aren't specified by your "i18n content" subfolders index.html // the site's default homepage localized-files/ // matches requests from Argentina with a language preference of `es` or `es-foo` (mimics behavior of `es-ar` header tag) es_ar/ index.html // matches requests from Spain with a language preference of `es` or `es-foo` (mimics behavior of `es-es` header tag) es_es/ index.html // matches requests from Mexico with a language preference of `es` or `es-foo` (mimics behavior of `es-mx` header tag) es_mx/ index.html // matches requests from any other country with a language preference of `es` or `es-foo` (mimics behavior of `es-419` header tag) es_ALL/ index.html
Priority order for "i18n content"
If you set up i18n rewrites, Hosting serves content based on the following priority order:
Reserved namespaces that begin with a
/__/*
path segmentConfigured redirects
Exact-match static content
Language code + Country code (for example, content from
fr_ca/
)
The order follows the quality values for each language in the request'sAccept-Language
header.Country code only (for example, content from
ALL_ca/
)Language code only (for example, content from
fr/
ores_ALL/
)
The order follows the quality values for each language in the request'sAccept-Language
header."Default" exact-match static content
This is content that's outside the "i18n content" directory, like at the root of thepublic
directory.
Configured rewrites
404 handling
i18n 404 pages
This follows the same priority order listed above for exact-match static content.Custom 404 page
Default 404 page (provided by Firebase)
Example for priority order
Let's continue our example from above. We'll use the same example directory and an example request.
Example local project directory with an "i18n content" directory (called
localized-files
)public/ index.html // your site's default homepage 404.html // your site's custom 404 page localized-files/ ALL_ca/ index.html es_ALL/ index.html 404.html fr/ index.html 404.html fr_ca/ index.html
Example request information
Language codes:
fr
,en
(French, then English)
The language codes are ordered based on quality values in theAccept-Language
header.Country code:
ca
(Canada)
According to the exact-match priority order and the quality values for the language preferences, Hosting will search the directories for a requested page in the following order.
public/localized-files/fr_ca/
public/localized-files/en_ca/
public/localized-files/ALL_ca/
public/localized-files/fr_ALL/
public/localized-files/fr/
public/localized-files/en_ALL/
public/localized-files/en/
public/
404 handling
Which page will be served to the user?
Requested page:
index.html
index.html
from thefr_ca/
subfolderSince Hosting searches the
fr_ca/
subfolder first, it will find the exact-match forindex.html
in that subfolder.Requested page:
awesome-page.html
404.html
from thefr/
subfolderHosting first searches the entire directory (including all the "i18n content" subfolders and root directory) in priority order for an exact-match, but there's not an exact-match for
awesome-page.html
.So, Hosting will start its 404 handling, which follows the same i18n priority order as exact-match searches. The
fr/
subfolder is the first subfolder searched that contains a 404 page.
Note the following about this search-and-serve of the "i18n content" directory:
The
localized-files/
directory doesn't actually containen_ca/
,en_ALL/
, oren/
subfolders, so Hosting will just skip down the priority list until it finds a matching subfolder for the request's language-country combination.Even though the
localized-files/
directory contains anes_ALL/
subfolder, the example request above doesn't include anes
ores-foo
language code, so Hosting will not search for "i18n content" that matcheses
.Subfolders called
fr/
andfr_ALL/
are equivalent from the perspective of a user's country and language preferences. However, if both subfolders exist, Hosting will servefr_ALL/
content beforefr/
content.
Override language and country codes with cookies
You can change what content is served by using cookies to override the country and language headers.
Here are some ways you can use cookie overrides:
Test a feature with different language/country combinations to check which content is served.
Enable your users to change the content that they see. For example, you can implement a language picker, then set the user's
firebase-language-override
cookie accordingly.
To configure cookie overrides, set cookies with both or either of these names:
firebase-country-override
and firebase-language-override
. For example,
the following JavaScript code snippet overrides the country code to be ca
and
the Accept-Language
header to be fr,en
:
document.cookie = "firebase-country-override=ca";
document.cookie = "firebase-language-override=fr,en";
Language cookie overrides must be a comma-separated list of language codes in order of preference, without subtags or quality values.
Cookie overrides are not reflected in logs.