Skip to content

Commit

Permalink
fix typo in .env file
Browse files Browse the repository at this point in the history
  • Loading branch information
@ddecrulle
ddecrulle committed Dec 16, 2024
1 parent 2813c3a commit f208ea4
Showing 1 changed file with 19 additions and 17 deletions.
36 changes: 19 additions & 17 deletions web/.env
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
# ====================================================================================== #
##########################################################################################

# Here are defined the environement variables to configure the docker image inseefrlab/onyxia-web.
# Thoses parameters are mostly related to the branding and theme configuration.
# 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:
#
Expand All @@ -31,7 +31,7 @@
# 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.
# Eample:
# Example:
# HEADER_LOGO: "%PUBLIC_URL%/custom-resources/logo.svg?v=2"

# =============================================================================
Expand All @@ -42,7 +42,7 @@
# 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 matricial (.webp, .png, .jpg, etc.)
# An ThemedAssetUrl is a link to an image that can either be vectorial (.svg) or matrix (.webp, .png, .jpg, etc.)
#
# Examples:
#
Expand All @@ -51,7 +51,7 @@
# with the CUSTOM_RESOURCES:
# HEADER_LOGO: "%PUBLIC_URL%/custom-resources/logo.webp
#
# You can provides different varian of an asset to be used depending on if the user is in dark mode or not:
# You can provides different variant of an asset to be used depending on if the user is in dark mode or not:
#
# HEADER_LOGO: |
# {
Expand All @@ -62,13 +62,13 @@
# 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"
# Wich correspond to the color theme.colors.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"
# Wich correspond to the color theme.colors.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
#
Expand Down Expand Up @@ -99,13 +99,13 @@ HEADER_HIDE_ONYXIA=false
#
HEADER_TEXT_BOLD=

# This parameter is for defning the text of the header that is rendered with the focus color of your palette
# 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 mork with the dark 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"
#
Expand Down Expand Up @@ -223,7 +223,7 @@ SPLASHSCREEN_LOGO=
#
# SPLASHSCREEN_LOGO_SCALE_FACTOR=1.2
#
# On the contrary if you thik it's too big you can make it 20% smaller with:
# On the contrary if you think it's too big you can make it 20% smaller with:
#
# SPLASHSCREEN_LOGO_SCALE_FACTOR=0.8
#
Expand Down Expand Up @@ -272,7 +272,7 @@ SOCIAL_MEDIA_DESCRIPTION=Shared platform for statistical data processing and dat
#
SOCIAL_MEDIA_IMAGE=%PUBLIC_URL%/preview-onyxia.png

# Parameter to customize the image that gets displayed in the background of the hompage
# 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
Expand Down Expand Up @@ -379,7 +379,7 @@ HOMEPAGE_LOGO=
#
HOMEPAGE_MAIN_ASSET=

# A parameter to enable you to ajust the position of the main image of the homepage.
# 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"
#
Expand Down Expand Up @@ -424,7 +424,7 @@ HOMEPAGE_MAIN_ASSET_SCALE_FACTOR=1
# "en": "Welcome to the Onyxia Datalab"
# }
#
# The text gets rendered as markdown, you can levrage this this to make some words bold or insert links.
# 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).
#
Expand Down Expand Up @@ -488,7 +488,7 @@ HOMEPAGE_BELOW_HERO_TEXT_AUTHENTICATED=
#
HOMEPAGE_CALL_TO_ACTION_BUTTON=

# This parameter enables you to display a diffent call to action button when the user is authenticated.
# 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=
Expand Down Expand Up @@ -582,6 +582,8 @@ 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.
Expand Down Expand Up @@ -809,7 +811,7 @@ S3_DOCUMENTATION_LINK=https://docs.sspcloud.fr/content/storage.html
#
VAULT_DOCUMENTATION_LINK=https://docs.sspcloud.fr/content/secrets.html

# For devloppement only, to use if you want to run onyxia-web locally and connect to a remote
# 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=/api
Expand All @@ -820,8 +822,8 @@ ONYXIA_API_URL=/api

# 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 wich the user is redirected when the version number is clicked.
# Thoses two parameters ares set automatically by the Helm chart.
# *_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=

Expand Down

0 comments on commit f208ea4

Please sign in to comment.