example.env

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

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

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

# 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"
BUDGET_DEMAND_PIPELINE_URL=

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

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

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

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

# 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"
OPENID_CONNECT_CLIENT_ID=
OPENID_CONNECT_CLIENT_SECRET=
OPENID_CONNECT_ISSUER_URL=

# Are advanced & experimental features enabled?
PUBLIC_ADVANCED=false

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

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

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

# Key for family entity
PUBLIC_FAMILY_KEY="famille"

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

# Key for household entity
PUBLIC_HOUSEHOLD_KEY="menage"

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

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

# Description of OpenFisca country repository
PUBLIC_OPENFISCA_BRANCH="master"
PUBLIC_OPENFISCA_GROUP="openfisca"
PUBLIC_OPENFISCA_PROJECT="openfisca-france"
PUBLIC_OPENFISCA_REPOSITORY_RAW_URL_TEMPLATE="https://raw.githubusercontent.com/$<group>/$<project>/$<branch>/$<path>"
PUBLIC_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)
PUBLIC_PORTAL_URL="https://leximpact.an.fr/"

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

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

# Show intro balloons.
PUBLIC_SHOW_TUTORIAL=true

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

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

PUBLIC_TITLE="Simulateur socio-fiscal"

# 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"