.env

##########################################################################################
# ====================================================================================== #
#            inseefrlab/onyxia-web Docker Image Environment Variable Declaration         #
#                            and Documentation File                                      #
# ====================================================================================== #
##########################################################################################

# Here are defined the environment variables to configure the docker image inseefrlab/onyxia-web.  
# Those parameters are mostly related to the branding and theme configuration.  
#
# Example of a value.yaml file:
#
# onyxia:
#   web:
#     # Parameters inseefrlab/onyxia-web, you are reading the file where they are defined.
#     env:
#       CUSTOM_RESOURCES: "https://example.com/onyxia-resources.zip"
#       # This assumes you have a logo.svg file in the root of your zip file.
#       HEADER_LOGO: "%PUBLIC_URL%/custom-resources/logo.svg"
#       HEADER_TEXT_BOLD: "Your organization"
#       TERMS_OF_SERVICES: |
#         // This is JSON5, a more relaxed version of JSON. See https://json5.org/
#         {
#           en: "%PUBLIC_URL%/custom-resources/tos/en.md",
#           fr: "%PUBLIC_URL%/custom-resources/tos/fr.md",
#         }
#
# Cache busting: 
#
# Onyxia is configured to make the the browser cache assets so they are not re-downloaded
# each time the user access the app.
# If you update some of your asset but keep the same URL, you can force the browser of your
# users to download the new version by adding a query parameter to the URL.
# Example: 
#   HEADER_LOGO: "%PUBLIC_URL%/custom-resources/logo.svg?v=2"

# =============================================================================
# Theme and branding - Customize the look of the app, make it your own!
# =============================================================================

# Define the logo that appears in the header
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/a9bbdc99-db29-4a7e-9e00-ca759c00e3fa
# 
# Type: ThemedAssetUrl
# An ThemedAssetUrl is a link to an image that can either be vectorial (.svg) or matrix (.webp, .png, .jpg, etc.)
# 
# Examples: 
#
# HEADER_LOGO: "%PUBLIC_URL%/custom-resources/logo.webp"
# Or, it can point to an asset that you would have provided
# with the CUSTOM_RESOURCES:  
# HEADER_LOGO: "%PUBLIC_URL%/custom-resources/logo.webp
#
# You can provides different variant of an asset to be used depending on if the user is in dark mode or not:  
#
# HEADER_LOGO: |
#   {
#     light: "%PUBLIC_URL%/custom-resources/logo-light.webp",
#     dark: "%PUBLIC_URL%/custom-resources/logo-dark.webp"
#   }
# 
# When you use an SVG file, which is recommended, you can reference colors of your palette with special classes.
# For example if you would like to fill with the focus color you would apply the classes:  
#   class="onyxia-fill-palette-focus-main"
#   Which correspond to the color theme.colors.palette.focus.main
#
# You can also reference the color of the use cases which is even better as they are dynamically
# switched depending on if the user is in dark mode or not contrary to the palette colors that are static.  
# Example: 
#  class="onyxia-fill-useCases-typography-textFocus"
#  Which correspond to the color theme.colors.useCases.typography.textFocus
#
# There is also the pending of fill for stroke: onyxia-stroke-useCases-typography-textFocus
#
# You can refer to this source file to see what properties are available in the palette and the useCases:  
# https://github.com/InseeFrLab/onyxia-ui/blob/main/src/lib/color.ts  
# There are also all the non standard colors properties you might have defined in the PALETTE_OVERRIDE parameter.
#
# You can apply theses classes on the root of your SVG on on any <g> element:  
# See the default Onyxia logo for example: https://github.com/InseeFrLab/onyxia/blob/main/web/public/logo.svg?short_path=bceaf10
# 
HEADER_LOGO=%PUBLIC_URL%/logo.svg?v=2

# The parameters defines if 'Onyxia -' in the header should be hidden
# See https://user-images.githubusercontent.com/6702424/152916796-f93de2e4-b3d8-4214-bb01-628704562421.png
# 
# Type: "true" or "false"
#
HEADER_HIDE_ONYXIA=false 

# This parameter enable to defines the text that is rendered in bold in the header
# See: https://user-images.githubusercontent.com/6702424/152652494-7c2e2515-23f2-4b06-bd9f-15c00173bb66.png
# 
# Type: string
#
# Example:
#
# HEADER_TEXT_BOLD: My Organization
#
HEADER_TEXT_BOLD=

# This parameter is for defining the text of the header that is rendered with the focus color of your palette 
# See: https://user-images.githubusercontent.com/6702424/152652533-b97512ca-f6f4-4aa8-a91f-96988181902c.png
#
HEADER_TEXT_FOCUS=Datalab

# This parameter enables you to disable the ability to switch between dark and light mode.  
# This is to use if you with to create a custom theme but can't make it quite mark with the dark mode.
#
# Type: "true" or "false" 
#
# Examples:
#   DARK_MODE: false # Your Onyxia instance will always be in light mode.
#   
#   DARK_MODE: true # Your Onyxia instance will always be in dark mode.
#
DARK_MODE=

# This parameter allows you to override some, or all, of the color palette.
#
# Should you desire to personalize the color palette without the assistance of a UI designer, 
# there is a simple way. You can copy and paste the default palette and request ChatGPT to 
# propose a variation. For instance, you might want to emphasize a specific color, like 
# "TypeScript's blue". ChatGPT can use that as a reference to generate a new color scheme 
# tailored to your preference.
#
# Type: DeepPartial<typeof defaultPalette>
# See: https://github.com/InseeFrLab/onyxia-ui/blob/0fa8667227aac328cb685cc140f3cd2186956304/src/lib/color.ts#L15-L53
# and: https://github.com/InseeFrLab/onyxia/blob/main/web/src/ui/theme/palette.ts
#
# Example:  
#
# PALETTE_OVERRIDE: |
#   { 
#     "focus": { 
#         "main": "#00824D", 
#         "light": "#00824D",
#         "light2": "#00FFC2"
#     } 
#   }
#
# Optionally, you can also have specific colors override for depending of the mode that is enabled (light/dark)
#
# PALETTE_OVERRIDE: |
#   { 
#     "joyfulPink": "#FF00FF",
#   }
# PALETTE_OVERRIDE_LIGHT: |
#   {
#         "focus": {
#             "main": "#FFD700", // EU gold/yellow
#             "light": "#FFDC4A",
#             "light2": "#FFE680",
#         },
#   PALETTE_OVERRIDE_DARK: {
#           "focus": {
#               "main": "#FFD700", // EU gold/yellow
#               "light": "#FFDC4A",
#               "light2": "#FFE680",
#           },
#   }
# 
#
PALETTE_OVERRIDE=
PALETTE_OVERRIDE_LIGHT=
PALETTE_OVERRIDE_DARK=


# For customizing the font used in the webapp
#
# You must provide at least the normal width 400 (normal), 
# 500, 600 and 700 (bold) variants of the font width will be used if you provide them.
# Optionally you can also provide italic variant for each width.  
#
# Type: 
# {
#    fontFamily: string;
#    dirUrl: string;
#    400: string;
#    ["400-italic"]?: string;
#    500?: string;
#    ["500-italic"]?: string;
#    600?: string;
#    ["600-italic"]?: string;
#    700?: string;
#    ["700-italic"]?: string;
# } 
#
# Example: 
# 
# FONT: |
#   { 
#     "fontFamily": "Geist", 
#     "dirUrl": "%PUBLIC_URL%/custom-resources/fonts/Geist", 
#     "400": "Geist-Regular.woff2",
#     "500": "Geist-Medium.woff2",
#     "600": "Geist-SemiBold.woff2",
#     "700": "Geist-Bold.woff2"
#   }
#
FONT={ fontFamily: "Work Sans", dirUrl: "%PUBLIC_URL%/fonts/WorkSans", "400": "worksans-regular-webfont.woff2", "500": "worksans-medium-webfont.woff2", "600": "worksans-semibold-webfont.woff2", "700": "worksans-bold-webfont.woff2" }

# This parameter let you customize the splash screen that is displayed when the app is loading.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/40369e77-acb5-4c21-b9c2-4681a1594268  
# By default the image that is used is the HEADER_LOGO.
#
# Type: ThemedAssetUrl
# See the HEADER_LOGO for documentation about the ThemedAssetUrl type.
#
# Example:
#
# SPLASHSCREEN_LOGO: "%PUBLIC_URL%/custom-resources/logo.svg"
#
# Configuring the animation: 
# If you use an image that is not an SVG, the the image will automatically be animated with a blinking effect.  
# If you use an SVG, by default the image will be still.  
# You can make it blink by applying the class "splashscreen-animation" to the root of your SVG.
# Alternatively you can apply "splashscreen-animation-group1" 2 and 3 to <g> elements of your SVG to make them blink in a different rythm.  
# See the default Onyxia logo for example: https://github.com/InseeFrLab/onyxia/blob/main/web/public/logo.svg?short_path=bceaf10
#
SPLASHSCREEN_LOGO=

# This parameter let you change the size of the splash screen logo.  
#
# Type: number
#
# Examples:
# If you think that, by default the logo is too small, you can use this to make it 20% biger:  
#
# SPLASHSCREEN_LOGO_SCALE_FACTOR=1.2
#
# On the contrary if you think it's too big you can make it 20% smaller with:  
#
# SPLASHSCREEN_LOGO_SCALE_FACTOR=0.8
#
SPLASHSCREEN_LOGO_SCALE_FACTOR=1

# Favicon of the webapp, it's the icon that is displayed in the browser tab.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/980987a6-be87-43de-9a1b-cf5cd3f8d435
# By default the HEADER_LOGO get used **BUT** the color will be the hard codded fill color when the page
# is being rendered, so if HEADER_LOGO is used and you haven't changed it, it will be the orange onyxia logo
# for a few frame and then your theme color will be applied. 
# This will lead to your app being indexed by google as the orange onyxia logo.
# So, you may want to provide your favicon explicitly.
#
# Can be a .svg, .ico or .png
#
# Type: ThemedAssetUrl - See HEADER_LOGO
#
# Examples: See HEADER_LOGO
#
FAVICON=

# For configuring the text that is displayed in the browser tab.
# see: https://github.com/InseeFrLab/onyxia/assets/6702424/180e9edb-cbd9-433c-a8a8-708394fda89f
#
# Type: string
#
TAB_TITLE=Onyxia

# Title of the social card.
# see: https://github.com/InseeFrLab/onyxia/assets/6702424/256b847a-ddae-400d-b585-a702b2e2253a
# The social media card gets displayed when you share the link of your Onyxia instance on social media.
#
# Type: string
#
SOCIAL_MEDIA_TITLE=Onyxia

# Description text of the social card.
# see: https://user-images.githubusercontent.com/6702424/152668805-d1e055e0-2d9d-4b6c-9bc7-fba0093855aa.png
#
# Type: string
#
SOCIAL_MEDIA_DESCRIPTION=Shared platform for statistical data processing and data science services

# Image of displayed in the social media card.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/806ffd48-f657-4ebf-9b0d-a95de2c53459
#
# NOTE: Having a fully qualified url is best. Some social media might not resolve the origin relative urls.
#
# Type: string
#
# Example:  
#
# SOCIAL_MEDIA_IMAGE: "https://onyxia.my-domain.net/custom-resources/preview.png"
#
SOCIAL_MEDIA_IMAGE=%PUBLIC_URL%/preview.png

# Parameter to customize the image that gets displayed in the background of the homepage
# and in the login pages if you are using the Onyxia Keycloak theme.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/ec5cd974-e5fa-43a4-a14e-cfe1bdb3f946
# and: https://github.com/InseeFrLab/onyxia/assets/6702424/b5abfa70-c928-437d-9528-452f41a8f590  
#
# Type: ThemedAssetUrl or false - See HEADER_LOGO for documentation and examples.  
# 
# You if you set it to false the background image will be disabled.
#
# Examples:  
#
# BACKGROUND_ASSET: "false"
# or
# BACKGROUND_ASSET: |
#   {
#     "light": "%PUBLIC_URL%/custom-resources/background-light.webp",
#     "dark": "%PUBLIC_URL%/custom-resources/background-dark.webp"
#   }
#
BACKGROUND_ASSET=

# This parameter enables you to add some custom links in the header:
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/2792da93-af21-405b-804d-be75b8f2f333
#
# Type: LinkFromConfig[]
# { label: LocalizedString; icon: string; url: LocalizedString; }[]
# An array of objects with the following properties:
#   - label: The text of the button, can be localized.
#     A localized string is a string or an object that maps iso2 language codes to strings.
#     Example: you can write `"label": "My label"` or `"label": { "en": "My label", "fr": "Mon label" }`
#     The label gets rendered as markdown, so you can use markdown syntax in it.
#     Example: `"label": "My **first** label"` for rendering "first" in bold.  
#   - icon: The icon displayed at the left of the text.
#     It can either be a Material Design icon name or the url of an SVG file.
#     The catalog of Material Design icon can be browsed with this tool: https://mui.com/material-ui/material-icons
#     For example, if you wish to use https://mui.com/material-ui/material-icons/?query=data&selected=DataSaverOn
#     you'd set icon to "DataSaverOn".  
#   - url: The url to which the user is redirected when he clicks on the button.
#     This url can be internationalized, just like the label.  
#     If you use an external url it will be opened in a new tab.
#     You can also create links to internal pages of your Onyxia instance:
#     Example: `"url": "/catalog/automation"`
#     Those links will redirect in the same tab (and without an app refresh).
#     Finally, if the link points to a Markdown file hosted in your Onyxia instance's custom resources, it will be rendered
#     directly in the app.  
#
# Example:
#
# HEADER_LINKS: |
#   [
#     {
#       "label": "My first link",
#       "icon": "DataSaverOn", 
#       "url": "/catalog/automation" 
#     },
#     { 
#       "label": { 
#         "en": "**Data science** training",
#         "fr": "Formation **Data science**"
#       }, 
#       "icon": "%PUBLIC_URL%/custom-resources/trainings.svg", 
#       "url": "https://www.sspcloud.fr/formation" 
#     },
#     {
#       "label": "Declaration of **accessibility**",
#       "icon": "Accessibility",
#       "url": {
#         "en": "%PUBLIC_URL%/custom-resources/accessibility_en.md",
#         "fr": "%PUBLIC_URL%/custom-resources/accessibility_fr.md"
#       }
#     }
#   ]
#
HEADER_LINKS=

# See HEADER_LINKS, it's the same but for the footer.
# Only thing different is that the icon is not mandatory.  
FOOTER_LINKS=

# This parameter enables you to add some custom links in the left bar:
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/fbadc4f0-dd4c-4eef-9087-29624e7cb632
#
# Type: Same as HEADER_LINKS
#
# Examples: See HEADER_LINKS
#
LEFTBAR_LINKS=

# This parameter enables to completely disable the homepage of the app.
# It's this page: https://github.com/InseeFrLab/onyxia/assets/6702424/750e1c56-dbd2-465a-8033-5d0d6f786811
# If set to true the home of your instance becomes the catalog page.
# 
# Type: "true" or "false"
#
DISABLE_HOMEPAGE=false

# This parameter enables to customize the logo that gets displayed in the homepage.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/d10726b1-eaab-42d5-afe7-01183a64a26c
# By default the HEADER_LOGO gets used.
#
# Type: ThemedAssetUrl | "false" - See HEADER_LOGO, false for disabling the logo
#
# Examples: 
# See HEADER_LOGO
# or, to disable the logo:
# HOMEPAGE_LOGO: "false"
#
HOMEPAGE_LOGO=

# Parameter to customize the main image of the homepage.  
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/86bf26ed-fa2d-44f3-815d-05e09a81b7c4
#
# Type: ThemedAssetUrl | "false" - See HEADER_LOGO, false for disabling the image
#
# Examples: 
# See HEADER_LOGO
# or, to disable:
# HOMEPAGE_MAIN_ASSET: "false"
#
HOMEPAGE_MAIN_ASSET=

# A parameter to enable you to adjust the position of the main image of the homepage.
#
# Type: string - Represent a CSS measurement like "10px", "1em" or "3%" can be negative like "-10px"
#
# Examples: 
# HOMEPAGE_MAIN_ASSET_X_OFFSET: "200px"
# This will give you this result: https://github.com/InseeFrLab/onyxia/assets/6702424/e786fab8-57f3-4d66-9b9a-e62c8541f1ae
# HOMEPAGE_MAIN_ASSET_X_OFFSET: "-200px"
# Yields this result: https://github.com/InseeFrLab/onyxia/assets/6702424/7970c6d3-b8ea-4f53-bc02-ceb6be12f09f
# 
HOMEPAGE_MAIN_ASSET_X_OFFSET=0

# Same as HOMEPAGE_MAIN_ASSET_X_OFFSET but for the Y axis.
HOMEPAGE_MAIN_ASSET_Y_OFFSET=0

# This parameter enables you to adjust the size of the main image of the homepage.
#
# Type: number
# 
# Examples:
# Make the image 50% bigger:
# HOMEPAGE_MAIN_ASSET_SCALE_FACTOR: "1.5"
# Yields this result: https://github.com/InseeFrLab/onyxia/assets/6702424/6d644051-98d7-4eb4-b94e-cbcb3bbd45a2
# Make the image 50% smaller:
# HOMEPAGE_MAIN_ASSET_SCALE_FACTOR: "0.5"
# Yields this result: https://github.com/InseeFrLab/onyxia/assets/6702424/6d644051-98d7-4eb4-b94e-cbcb3bbd45a2
HOMEPAGE_MAIN_ASSET_SCALE_FACTOR=1

# This parameter is used to customize the hero text of the homepage.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/aaa68da6-fa30-4308-9651-762acf3cc1c3  
#
# Type: LocalizedString - a string or an object that maps iso2 language codes to strings.
# The list of supported language codes can be found here: https://github.com/InseeFrLab/onyxia/blob/main/web/src/core/ports/OnyxiaApi/Language.ts
#
# Examples: 
# HOMEPAGE_HERO_TEXT: Welcome to the Onyxia Datalab
#
# Or, you can provide a localized string:
#
# HOMEPAGE_HERO_TEXT: |
#   {
#     "fr": "Bienvenue dans le Datalab Onyxia",
#     "en": "Welcome to the Onyxia Datalab"
#   }
#
# The text gets rendered as markdown, you can leverage this this to make some words bold or insert links.
#
# HOMEPAGE_HERO_TEXT: Welcome to the **Onyxia** Datalab. Click [here](https://example.com) to learn more. [Go to the catalog](/catalog).
#
HOMEPAGE_HERO_TEXT=

# This parameter enable you to display a diffent hero text when the user is authenticated.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/aaa68da6-fa30-4308-9651-762acf3cc1c3
# If you don't specify this parameter the same text will be used when the user is authenticated and when he is not.
# In this variant you can use %USER_FIRSTNAME%.
#
# Type: LocalizedString
#
# Example:
#
# HOMEPAGE_HERO_TEXT_AUTHENTICATED: "Welcome %USER_FIRSTNAME%"
#
HOMEPAGE_HERO_TEXT_AUTHENTICATED=

# Same as HOMEPAGE_HERO_TEXT but for the text just below.  
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/121dba8a-a210-4497-8419-9a410b16dedf
#
HOMEPAGE_BELOW_HERO_TEXT=

# Same as HOMEPAGE_HERO_TEXT_AUTHENTICATED but for the text just below.  
# You can also use %USER_FIRSTNAME% here.
#
HOMEPAGE_BELOW_HERO_TEXT_AUTHENTICATED=

# Parameter to customize the action button that get displayed bellow the hero section.  
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/26993b9b-dcb0-4ef5-9e04-73c0a089b81f
#
# Type: LinkFromConfig | "false"
# { label: LocalizedString; url: string; icon?: string; startIcon?: string; endIcon?: string; } | "false" 
# See HEADER_LINKS for more precise documentation.  
#
# Examples:  
#
# HOMEPAGE_CALL_TO_ACTION_BUTTON: |
#   {
#     "label": {
#       en: "Read our get started guide",
#       fr: "Lire notre guide de démarrage",
#     },
#     "startIcon": "School",
#     "url": {
#         en: "%PUBLIC_URL%/custom-resources/onboarding_en.md",
#         fr: "%PUBLIC_URL%/custom-resources/onboarding_fr.md"
#     }
#   }
#
# Or
#
# HOMEPAGE_CALL_TO_ACTION_BUTTON: |
#   {
#     "label": {
#       "fr": "Lire notre documentation",
#       "en": "Read our documentation",
#     },
#     "startIcon": "MenuBook",
#     "url": "https://your-documentation.com"
#   }
#
# Or, to disable the button:
#
# HOMEPAGE_CALL_TO_ACTION_BUTTON: "false"
#
HOMEPAGE_CALL_TO_ACTION_BUTTON=

# This parameter enables you to display a different call to action button when the user is authenticated.
# See: HOMEPAGE_CALL_TO_ACTION_BUTTON
#
HOMEPAGE_CALL_TO_ACTION_BUTTON_AUTHENTICATED=

# This parameter let you customize the cards that are displayed in the homepage.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/dc3b827d-0612-48df-89f4-75d8694398c7
#
# Type: { pictogram: ThemedAssetUrl; title: LocalizedString; description: LocalizedString; button: LinkFromConfig; }[]
# If you have used the other parameters you should be familiar with the different types used here.
#
# The call to action buttons can redirect to external urls, pages of your Onyxia instance or to a Markdown file 
# hosted in your custom resources that will be rendered in the app.
#
# Examples: 
#
# HOMEPAGE_CARDS: |
#   [
#     {
#         pictogram: "%PUBLIC_URL%/pictograms/service.svg",
#         title: {
#           fr: "Un environnement ergonomique et des services **à la demande**",
#           en: "An ergonomic environment and **on demand** services",
#         },
#         description: {
#           fr: "Analysez les données, faites du calcul distribué et profitez d'un\
#             large catalogue de services. Réservez la puissance de calcul dont vous avez besoin.",
#           en: "Analyze data, do distributed computing and enjoy a wide catalog\
#             of services. Book the computing power you need.",
#         },
#         button: {
#             label: {
#               fr: "Consulter le catalogue",
#               en: "Browse the catalog",
#             },
#             url: "/catalog",
#             startIcon: "%PUBLIC_URL%/icons/catalog.svg"
#         }
#     },
#     {
#         pictogram: {
#           light: "%PUBLIC_URL%/custom-resources/your-pictogram-light.webp",
#           dark: "%PUBLIC_URL%/custom-resources/your-pictogram-dark.webp"
#         },
#         title: "Your **non localized** title",
#         description: "Your *non localized* description",
#         button: {
#             label: "Button label",
#             url: {
#               fr: "%PUBLIC_URL%/custom-resources/your-doc_fr.md",
#               en: "%PUBLIC_URL%/custom-resources/your-doc_en.md"
#             },
#             endIcon: "RocketLaunch"
#         }
#     },
#     {
#         pictogram: "https://example.com/your-pictogram.svg",
#         title: "Your **third** card",
#         description: "Access [the catalog](/catalog) or [read the documentation](https://example.com)",
#         button: {
#             label: "Button without icon",
#             url: "https://example.com"
#         }
#     }
#   ]
#
# Or, for no card at all:
#
# HOMEPAGE_CARDS: "[]"
#
HOMEPAGE_CARDS=

# This parameter only applies if you have configured your keycloak instance so that
# only a list of defined email domain are allowed to register.  
# By default the list of email domain allowed is displayed in the registration form.  
# https://github.com/user-attachments/assets/23eb9702-d62c-4171-a0a5-e5e14902a100  
# You can set this option to false if you don't want the list to be displayed.
#
LIST_ALLOWED_EMAIL_DOMAINS="true"

# This parameter enables 
#
# Type: LocalizedString
#
# Example:  
#
# CONTACT_FOR_ADDING_EMAIL_DOMAIN: |
#   {
#     "en": "If your email domain is not yet allowed [contact us](https://3innovation.slack.com/signup#/domain-signup)",
#     "fr": "Si votre domaine de messagerie n'est pas encore autorisé [contactez-nous](https://3innovation.slack.com/signup#/domain-signup)"
#   }
#
# Default: No message
#
CONTACT_FOR_ADDING_EMAIL_DOMAIN=

# =============================================================================
# Non cosmetic parameters - Enables to configures some behaviors of the app
# =============================================================================



# In the footer there is a "Terms of services" link.
# See: https://github.com/InseeFrLab/onyxia/assets/6702424/cdaefd0c-5567-49fc-9e55-f90cc0893ad6
# This parameter enables you to configures the Markdown that'll get displayed when the user click on the link.  
# If you use the Onyxia Keycloak theme, you can configure your Keycloak instance so that the user will have to 
# explicitly accept the terms of services before being able to use the platform.
# See: https://docs.onyxia.sh/#enabling-user-authentication
#
# Type: LocalizedString
# 
# Examples:  
#
# TERMS_OF_SERVICES: "%PUBLIC_URL%/custom-resources/tos_en.md"
#
# or
#
# TERMS_OF_SERVICES: |
#   {
#     "en": "%PUBLIC_URL%/custom-resources/tos_en.md",
#     "fr": "%PUBLIC_URL%/custom-resources/tos_fr.md" 
#   }
# 
TERMS_OF_SERVICES=

# With this parameter you can define some custom HTML code that will be injected at the end of the <head> tag.  
# This can be useful for analytics or for injecting some custom CSS or JS.
# Note that this will **NOT** apply in the Onyxia Keycloak Theme
#
# Example: 
#
# CUSTOM_HTML_HEAD: |
#   <script>
#     console.log("Hello world!");
#   </script>
#   <link rel="stylesheet" href="%PUBLIC_URL%/custom-resources/patch.css" />
#   <style>
#     body {
#       border: 10px solid red;
#     }
#   </style>
#   <script async src="https://www.googletagmanager.com/gtag/js?id=GA_MEASUREMENT_ID"></script>
#   <script>
#     window.dataLayer = window.dataLayer || [];
#     function gtag(){dataLayer.push(arguments);}
#     gtag('js', new Date());
#        
#     gtag('config', 'GA_MEASUREMENT_ID');
#   </script>
#
CUSTOM_HTML_HEAD=

# Enable to share a communication message to all your users, it will be displayed in a banner on the top of the page.
# https://github.com/inseefrlab/onyxia/assets/6702424/5c3345a6-b3e1-4620-af21-d8a4dad72af9
#
# Examples:
#
# GLOBAL_ALERT: "See what's **new**! [Blog post](https://example.com)!"
#
# You can also provide a severity among info, success, warning, error
#
# GLOBAL_ALERT: |
#   {
#     severity: "success", 
#     message: "See what's **new**! \
#       Read our [Blog post](https://example.com)!"
#   }
#
# You can localize the message by providing a map language iso2 -> message
#
# GLOBAL_ALERT: |
#   {
#     en: "See what's **new**! \
#       Read our [Blog post](https://example.com)!",
#     fr: "Voyez ce qui est **nouveau**! \
#       Lisez notre [Article de blog](https://example.fr)!",
#   }
#
# It works the same when you have a severity
#
# GLOBAL_ALERT: |
#   {
#     severity: "success",
#     message: {
#       en: "See what's **new**! [Blog post](https://example.com)!",
#       fr: "Voyez ce qui est **nouveau**! [Article de blog](https://example.fr)!",
#     }
#   }
#
GLOBAL_ALERT=

# Onyxia comes by default with support for many languages.
# This parameter enables you to selectively enable a subset of language.  
# If you don't plan to provide any translation for customizable texts like GLOBAL_ALERT or HOMEPAGE_HERO_TEXT,
# It's a good idea to only enable your language or to provide a list where you main language comes first.    
# For example if you set ENABLED_LANGUAGES=fr,en then when you provide a non internationalized text onyxia will be able
# to label it as French for screen readers.  
#
# Type: Comma separated list of language iso2 codes. 
# See supported language list here: https://github.com/InseeFrLab/onyxia/blob/main/web/src/core/ports/OnyxiaApi/Language.ts
# (Make sure you check the version of the source code for the version you are using)
#
# Example: 
#
# ENABLED_LANGUAGES: fr,en
# 
ENABLED_LANGUAGES=

# To hide the command bar by default, 
# it can be enabled back in the account page by the user.  
# For reference this is the command bar: https://github.com/InseeFrLab/onyxia/assets/6702424/474da82c-a0e1-4107-acf7-84870aab9f78
# 
# Type: "true" or "false"
#
DISABLE_COMMAND_BAR=false

# When this variable is set to true, it disables the injection of personal information
# into the Onyxia values for group projects. Specifically, it prevents:
# - Git credentials from being injected
# - Vault credentials from being injected
# - S3 credentials from being injected
#
# To enable this security feature, set the value to 'true'.
#
# Type: "true" or "false"
#
DISABLE_PERSONAL_INFOS_INJECTION_IN_GROUP=false

# The parameter controls the automatic service 
# launching behavior of Onyxia based on URL query parameters. When set to true,
# the "autoLaunch" feature is disabled, enhancing the security of the platform
# by requiring users to manually launch services.
#
# Context:
# - AutoLaunch Feature: Onyxia allows sharing URLs that encode a particular
#   service configuration. These URLs support an autoLaunch=true query parameter
#   that triggers automatic service launch upon user authentication.
# - Use Case: Our training platform (https://www.sspcloud.fr/formation) makes 
#   heavy use of this feature for seamless integration between the course catalog
#   and Onyxia instances.
#
# Security Concerns:
# The autoLaunch feature may introduce security vulnerabilities as the URL can
# be configured to execute scripts within the user's Kubernetes namespace.
#
# Behavior:
# - When DISABLE_AUTO_LAUNCH=true:
#   - The "autoLaunch" feature is deactivated.
#   - Users clicking a URL with autoLaunch=true will see a message prompting them
#     to review service parameters. The message cautions: "Someone might be attempting 
#     to get access to your cluster information. Make sure everything looks good,
#     particularly check for any suspicious initialization scripts."
#   - Users must manually launch services, offering a chance to review parameters.
# - When DISABLE_AUTO_LAUNCH=false (Default):
#   - The "autoLaunch" feature is active.
#   - Services are automatically launched based on URL configuration post-authentication.
#   - Note: To enhance security, you can define an x-security pattern in your catalog 
#     options. This allows fine-tuning of what's considered a sensitive parameter.
#     If such a parameter is changed, auto-launch is prevented. Documentation for
#     the x-security feature is forthcoming.
#
# Type: "true" or "false"
#
DISABLE_AUTO_LAUNCH=false

# This parameter enables you to make it so that when users access your Onyxia instance
# and they are not authenticated they are redirected to the login page automatically,
# without being able to browse the homepage and the catalog of services anonymously.  
#
# Type: "true" or "false"
#
# Default: false (users can browse the homepage and the catalog without being authenticated)
#
AUTHENTICATION_GLOBALLY_REQUIRED=false


# In the Data Explorer helper text there's a link to a sample dataset.
# You can customize the URL of this dataset with this parameter.
#
# Type: string
#
# Example: 
#
# SAMPLE_DATASET_URL: "%PUBLIC_URL%/custom-resources/my-sample-dataset.parquet"
#
SAMPLE_DATASET_URL=https://static.data.gouv.fr/resources/recensement-de-la-population-fichiers-detail-individus-localises-au-canton-ou-ville-2020-1/20231023-122841/fd-indcvi-2020.parquet

# In the Data Collection helper text, there is a link to a sample catalogue.
# You can customize the URL of this DCAT catalogue using this parameter.
#
# Type: string
#
# Example:
# SAMPLE_DATA_COLLECTION_URL="%PUBLIC_URL%/custom-resources/my-catalogue.jsonld"
#
SAMPLE_DATA_COLLECTION_URL=https://www.data.gouv.fr/api/1/organizations/534fff81a3a7292c64a77e5c/catalog.jsonld?format=parquet

# This parameter is for customizing what gets always displayed here: 
# https://github.com/InseeFrLab/onyxia/assets/6702424/1084acf6-8455-4a22-9e14-9f40eb5a87c2  
#
# For example if you set the value to "50%" if the user is currently using 50% or more of it's RAM quota
# the metric will always be displayed on the "My Services" page and the color will change from green to orange.  
# If it's usage is below 50% it will only be displayed when the user clicks on the "Show more" button.
#
QUOTA_WARNING_THRESHOLD=75%

# This parameter is for customizing the threshold at which a resource for the namespace is almost fully used.
#
# For example if you set the value to "90%" if the user is currently using 90% or more of it's RAM quota
# the metric will be displayed on the "My Services" page and the color will change from orange to red as a critical resources zone.
#
QUOTA_CRITICAL_THRESHOLD=95%

# Services that have been running for too long are displayed on the "My Services" page 
# with a warning alerting the user that the service has been running for "too long".  
# This parameter allows you to define what "too long" means in your Onyxia instance.  
#
# Default: 168 hours (7 days)
#
RUNNING_TIME_THRESHOLD_HOURS=168

# This parameter enable to customize the "our documentation" link on the "My Secrets" page.
#
# https://github.com/InseeFrLab/onyxia/assets/6702424/add9ac52-2604-40b6-a827-478587f2a05d
#
VAULT_DOCUMENTATION_LINK=https://docs.sspcloud.fr/content/secrets.html

# This parameter disable the display of a synthetic "All" catalog
# that aggregates and shows all charts from all available catalogs.
#
# When enabled (set to "true"), users will not see the additional "All" entry in /catalog page
# in the catalog selector, allowing them to browse all charts in one place.
DISABLE_DISPLAY_ALL_CATALOG=false

# This parameter is used only when Onyxia runs with api.enable set to false,
# which enables S3-only mode.
# It expects a JSON string representing the object that would otherwise be set
# in api.regions[0].data.S3.
# See: https://docs.onyxia.sh/admin-doc/s3-configuration
S3=

# ==================================================================================
# Private parameters - Not expected to be positioned manually, handled by the helm Chat.
# ==================================================================================


# For devolvement only, to use if you want to run onyxia-web locally and connect to a remote
# onyxia-api instance.
# You would set for example ONYXIA_API_URL=https://datalab.sspcloud.fr/api
ONYXIA_API_URL=

# It defines the version number as seen in the footer
# https://github.com/InseeFrLab/onyxia/assets/6702424/e026697a-bc59-4f10-b968-e2b389f8e9c1
# *_URL defines the url toward which the user is redirected when the version number is clicked.  
# Those two parameters ares set automatically by the Helm chart.
ONYXIA_VERSION=
ONYXIA_VERSION_URL=

SCREEN_SCALER=true

OIDC_DEBUG_LOGS=false

# NOTE: Temporary workaround until the Go onboarding API supports it.
OIDC_DISABLE_DPOP=false

# Can be "auto", "iframe" or "full page redirect"
OIDC_SESSION_RESTORATION_METHOD=auto