example.env

# To use this file, rename it to `.env`.

# Are advanced & experimental features enabled?
# ADVANCED=false

# Are search robots allowed to index this site?
# ALLOW_ROBOTS=false

# Public HTTP(S) URLs of LexImpact Socio-Fiscal API server
API_BASE_URLS="https://simulateur-socio-fiscal.leximpact.dev/api/"
# API_BASE_URLS="http://localhost:8000"

# Public HTTP(S) URL of LexImpact Socio-Fiscal UI server (aka this application)
# BASE_URL="https://simulateur-socio-fiscal.leximpact.dev/"
BASE_URL="http://localhost:5173"

# Private (for connected users) HTTP(S) URL of LexImpact Socio-Fiscal Budget server
# BUDGET_API_URL="https://SECRET.DOMAIN.NAME/state_simulation"

# URL of GitLab pipeline to run when a non-authentication user requests a budget simulation
# BUDGET_DEMAND_PIPELINE_URL="https://GITLAB.DOMAIN.NAME/api/v4/projects/PROJECT_ID/pipeline?ref=main"

# Token used for calling the budget simulation demand GitLab pipeline
#BUDGET_DEMAND_PIPELINE_TOKEN="SECRET"

# Secret key used to sign JSON web tokens sent to Budget API
# BUDGET_JWT_SECRET="SECRET"

# Key for children in a family
CHILDREN_KEY="enfants"

# Key for family entity
FAMILY_KEY="famille"

# GitHub access token used for parameters edition
# Caution, this token is private and must be kept secret.
GITHUB_PERSONAL_ACCESS_TOKEN=null

# Comma-separated list of entities ("familles", "foyers_fiscaux", "menages" for France)
# that should not be shown when editing test cases
HIDDEN_ENTITIES=menages

# Key for household entity
HOUSEHOLD_KEY="menage"

# Secret key used to sign & verify JSON web token used to store user informations in cookie
JWT_SECRET="SECRET"

# URL of web service that provides Legifrance data (law articles, etc)
LEGAL_URL="https://legal.tricoteuses.fr/"

# Matomo analytics configuration
# MATOMO_SITE_ID=123
# MATOMO_URL="https://MATOMO_SERVER/"
# Prepend the site domain to the page title when tracking (optional, default = false).
# MATOMO_PREPEND_DOMAIN=true
# Track visitors accross a domain (for example, example.com & its subdomains (optional).
# MATOMO_SUBDOMAINS="*.DOMAIN"

# OpenID Connect configuration
# OPENID_CONNECT_CLIENT_ID="OAUTH2_CLIENT_ID"
# OPENID_CONNECT_CLIENT_SECRET="OAUTH2_CLIENT_SECRET"
# OPENID_CONNECT_ISSUER_URL="https://IDENTITY_PROVIDER/PATH/TO/REALM"

# Description of OpenFisca country repository
OPENFISCA_BRANCH="master"
OPENFISCA_GROUP="openfisca"
OPENFISCA_PROJECT="openfisca-france"
OPENFISCA_REPOSITORY_RAW_URL_TEMPLATE="https://raw.githubusercontent.com/${group}/${project}/${branch}/${path}"
OPENFISCA_REPOSITORY_URL_TEMPLATE="https://github.com/${group}/${project}/blob/${branch}/${path}"

# URL of portal site (used when clicking on left logo in menu bar)
PORTAL_URL="https://leximpact.an.fr/"

# Set to true when application is behind a proxy
PROXY=false

# Optional name of default reform to use
# Reform name must belong to a name of an OpenFisca reform in metadata.json
# REFORM=reforme_test_1

# Optional name of revaluation reform to use
# Reform name must belong to a name of an OpenFisca reform in metadata.json
# REFORM_REVALUATION=contrefactuel_plf

# Show intro balloons.
SHOW_TUTORIAL=true

# Directory containing cache of budget simulations
SIMULATIONS_BUDGET_DIR="../simulations_budget"

# Directory containing cache of test cases simulations
SIMULATIONS_TEST_CASES_DIR="../simulations_cas_types"

# Key for taxable household (aka "foyer fiscal") entity
TAXABLE_HOUSEHOLD_KEY="foyer_fiscal"

# URL of autocompleter of French communes
TERRITOIRES_URL="https://territoires.leximpact.dev/"

TITLE="Simulateur socio-fiscal"