authelia/docs/content/en/reference/guides/server-asset-overrides.md

80 lines
3.5 KiB
Markdown
Raw Normal View History

---
title: "Server Asset Overrides"
description: "A reference guide on overriding server assets"
lead: "This section contains reference documentation for Authelia's server asset override capabilities."
2022-06-28 05:27:14 +00:00
date: 2022-06-15T17:51:47+10:00
draft: false
images: []
menu:
reference:
parent: "guides"
weight: 220
toc: true
---
This guide effectively documents the usage of the
[asset_path](../../configuration/miscellaneous/server.md#asset_path) server configuration option.
## Structure
```console
/config/assets/
├── favicon.ico
├── logo.png
└── locales/<lang>[-[variant]]/<namespace>.json
```
## Assets
2022-12-07 09:43:02 +00:00
| Asset | File Name | Directory | Notes |
|:-------------------:|:-----------:|:---------:|:-----------------------:|
| Favicon | favicon.ico | No | N/A |
| Logo | logo.png | No | N/A |
| Translation Locales | locales | Yes | see [locales](#locales) |
## locales
*__Important Note__ Currently users can only override languages that already exist in this list either by overriding
the language itself, or adding a variant form of that language. If you'd like support for another language feel free
to make a PR. We also encourage people to make PR's for variants where the difference in the variants is significant.*
*__Important Note__ Users wishing to override the locales files should be aware that we do not provide any guarantee
that the file will not change in a breaking way between releases as per our [Versioning Policy]. Users who planning to
utilize these overrides should either check for changes to the files in the
[en](https://github.com/authelia/authelia/tree/master/internal/server/locales/en) translation prior to upgrading or
[Contribute](../../contributing/prologue/translations.md) their translation to ensure it is maintained.*
The locales directory holds folders of internationalization locales. This directory can be utilized to override these
locales. They are the names of locales that are returned by the `navigator.langauge` ECMAScript command. These are
generally those in the [RFC5646 / BCP47 Format](https://www.rfc-editor.org/rfc/rfc5646.html) specifically the language
codes from [Crowdin](https://support.crowdin.com/api/language-codes/).
Each directory has JSON files which you can explore the format of in the
[internal/server/locales](https://github.com/authelia/authelia/tree/master/internal/server/locales) directory on
GitHub. The important part is the key names you wish to override.
A full example for the `en-US` locale for the portal namespace is `locales/en-US/portal.json`.
Languages in browsers are supported in two forms. In their language only form such as `en` for English, and in their
variant form such as `en-AU` for English (Australian). If a user has the browser language `en-AU` we automatically load
the `en` and `en-AU` languages, where any keys in the `en-AU` language take precedence over the `en` language, and the
translations for the `en` language only applying when a translation from `en-AU` is not available.
### Namespaces
Each file in a locale directory represents a translation namespace. The list of current namespaces are below:
| Namespace | Purpose |
|:---------:|:-------------------:|
| portal | Portal Translations |
### Supported Languages
List of supported languages and variants:
{{% table-i18n-overrides %}}
More information may be available from the [Internationalization Reference Guide](./internationalization.md).
[Versioning Policy]: ../../policies/versioning.md