Installation et configuration

Configuration

Variables

Data Fair supports quite a large number of parameters that are documented below. We try as much as possible to define sensible default values, still some parameters will almost always need to be overridden, these parameters have IMPORTANT in their descriptions.

Parameters can be overridden by directly modifying the files, but the recommanded way is to use environment variables.

Key in config fileEnv variableDescriptionDefault value
portPORT8080
modeMODEUse this parameter to run both the Web server and the dataset processing loop or run them separately. Pissible values: "server_worker", "server", "worker".server_worker
publicUrlPUBLIC_URLIMPORTANT. The URL where the server will be exposed. For example https://koumoul.com/data-fairhttp://localhost:8080
oldPublicUrlOLD_PUBLIC_URL
wsPublicUrlWS_PUBLIC_URLIMPORTANT. The URL where the Web socket server will be exposed. For example wss://koumoul.com/data-fairws://localhost:8080
sessionDomainSESSION_DOMAINnull
directoryUrlDIRECTORY_URLIMPORTANT. The URL where the user management service will be exposed. For example https://koumoul.com/s/simple-directoryhttp://localhost:8080
privateDirectoryUrlPRIVATE_DIRECTORY_URLnull
openapiViewerUrlOPENAPI_VIEWER_URLhttps://koumoul.com/openapi-viewer/
captureUrlCAPTURE_URLhttp://capture:8080
privateCaptureUrlPRIVATE_CAPTURE_URLnull
notifyUrlNOTIFY_URLnull
privateNotifyUrlPRIVATE_NOTIFY_URLnull
notifyWSUrlNOTIFY_WS_URLnull
subscriptionUrlSUBSCRIPTION_URLnull
mongo.urlMONGO_URLmongodb://localhost:27017/data-fair-production
mongo.maxBulkOpsMONGO_MAX_BULK_OPS1000
mongo.optionsMONGO_OPTIONS{}
cache.publicMaxAgeCACHE_PUBLIC_MAX_AGE300
cache.timestampedPublicMaxAgeCACHE_TIMESTAMPED_PUBLIC_MAX_AGE604800
cache.mongoSizeCACHE_MONGO_SIZE2000
analyticsANALYTICSJSON configuration of analytics, matches the "modules" part of the configuration for this library vue-multianalytics{}
elasticsearch.hostES_HOSTlocalhost:9200
elasticsearch.nodesES_NODESnull
elasticsearch.authES_AUTHnull
elasticsearch.optionsES_OPTIONS{}
elasticsearch.caES_CAnull
elasticsearch.defaultAnalyzerES_DEFAULT_ANALYZERcustom_french
elasticsearch.maxBulkLinesES_MAX_BULK_LINESMaximum number of lines when sending indexing in bulk into ElasticSearch.2000
elasticsearch.maxBulkCharsES_MAX_BULK_CHARSMaximum number of chars when sending indexing in bulk into ElasticSearch.200000
elasticsearch.maxShardSizeES_MAX_SHARD_SIZE10000000000
elasticsearch.nbReplicasES_NB_REPLICAS1
secretKeys.identitiesSECRET_IDENTITIESnull
secretKeys.limitsSECRET_LIMITSnull
secretKeys.notificationsSECRET_NOTIFICATIONSnull
secretKeys.masterDataSECRET_MASTER_DATAundefined
globalWebhooks.consumptionWEBHOOKS_CONSUMPTION[]
brand.logoBRAND_LOGOA link to an image with your logo.null
brand.titleBRAND_TITLEThe name of your organization or another name for the service.Data Fair
brand.descriptionBRAND_DESCRIPTIONFind, Access, Interoperate, Reuse data on the Web
brand.urlBRAND_URLA link to use on the top left logo.null
brand.embedBRAND_EMBEDnull
theme.darkTHEME_DARKfalse
theme.colors.primaryTHEME_PRIMARY#1E88E5
theme.colors.secondaryTHEME_SECONDARY#42A5F5
theme.colors.accentTHEME_ACCENT#FF9800
theme.colors.errorTHEME_ERROR#FF5252
theme.colors.infoTHEME_INFO#2196F3
theme.colors.successTHEME_SUCCESS#4CAF50
theme.colors.warningTHEME_WARNING#E91E63
theme.darkColors.primaryTHEME_DARK_PRIMARY#2196F3
theme.darkColors.secondaryTHEME_DARK_SECONDARYundefined
theme.darkColors.accentTHEME_DARK_ACCENTundefined
theme.darkColors.errorTHEME_DARK_ERRORundefined
theme.darkColors.infoTHEME_DARK_INFOundefined
theme.darkColors.successTHEME_DARK_SUCCESS#00E676
theme.darkColors.warningTHEME_DARK_WARNINGundefined
theme.cssUrlTHEME_CSS_URLnull
theme.cssTextTHEME_CSS_TEXT
darkModeSwitchDARK_MODE_SWITCHtrue
defaultLimits.totalStorageDEFAULT_LIMITS_TOTAL_STORAGE-1
defaultLimits.totalIndexedDEFAULT_LIMITS_TOTAL_INDEXED-1
defaultLimits.datasetStorageDEFAULT_LIMITS_DATASET_STORAGE-1
defaultLimits.datasetIndexedDEFAULT_LIMITS_DATASET_INDEXED-1
defaultLimits.nbDatasetsDEFAULT_LIMITS_NB_DATASETS-1
defaultLimits.maxSpreadsheetSizeDEFAULT_LIMITS_MAX_SPREADSHEET_SIZE50000000
worker.intervalWORKER_INTERVAL4000
worker.concurrencyWORKER_CONCURRENCYNumber of tasks processes in parallel. Tasks are all asynchronous processings on datasets (file format analysis, indexing, extending, etc.)4
worker.spawnTaskWORKER_SPAWN_TASKtrue
worker.errorRetryDelayWORKER_ERROR_RETRY_DELAY600000
browserLogLevelBROWSER_LOG_LEVELerror
listenWhenReadyLISTEN_WHEN_READYfalse
applicationsAPPLICATIONS[{"url":"https://koumoul.com/apps/infos-parcelles/2.7/"},{"url":"https://koumoul.com/apps/infos-loc/0.10/"},{"url":"https://cdn.jsdelivr.net/npm/@data-fair/app-charts@0.10/dist/"},{"url":"https://koumoul.com/apps/word-cloud/0.3/"},{"url":"https://koumoul.com/apps/sankey/0.5/"},{"url":"https://koumoul.com/apps/sunburst/0.2/"},{"url":"https://koumoul.com/apps/data-fair-networks/0.1/"},{"url":"https://koumoul.com/apps/list-details/0.4/"},{"url":"https://koumoul.com/apps/carto-stats/0.6/"},{"url":"https://koumoul.com/apps/data-fair-series/0.2/"},{"url":"https://koumoul.com/apps/bar-chart-race/0.2/"},{"url":"https://koumoul.com/apps/data-fair-geo-shapes/0.1/"},{"url":"https://koumoul.com/apps/scdl-deliberations/0.1/"},{"url":"https://koumoul.com/apps/scdl-equipements/0.1/"},{"url":"https://koumoul.com/apps/data-fair-events/1.0/"},{"url":"https://koumoul.com/apps/atelier-carto/1.0/"},{"url":"https://koumoul.com/apps/admin-divs-levels/0.3/"},{"url":"https://koumoul.com/apps/data-fair-proportions/0.2/"},{"url":"https://cdn.jsdelivr.net/npm/@data-fair/app-carousel@0.2/dist/"},{"url":"https://koumoul.com/apps/data-fair-form/1.0/"},{"url":"https://koumoul.com/apps/data-fair-radar/0.1/"},{"url":"https://koumoul.com/apps/data-fair-locate-game/0.1/"},{"url":"https://koumoul.com/apps/data-fair-quizz/0.1/"},{"url":"https://koumoul.com/apps/data-fair-sort-game/0.1/"},{"url":"https://koumoul.com/apps/data-fair-relations/0.2/"},{"url":"https://koumoul.com/apps/app-table/0.1/"},{"url":"https://koumoul.com/apps/data-fair-table/0.1/"},{"url":"https://koumoul.com/apps/app-treemap/0.2/"},{"url":"https://koumoul.com/apps/admin-divs-catchment/0.1/"}]
applicationsPrivateMappingAPPLICATIONS_PRIVATE_MAPPING["",""]
applicationsDirectoriesAPPLICATIONS_DIRECTORIES["https://koumoul.com/apps/","https://staging-koumoul.com/apps/","https://koumoul-dev.github.io/","https://data-fair.github.io/","https://cdn.jsdelivr.net/npm/@koumoul/","https://cdn.jsdelivr.net/npm/@data-fair/","https://cdn.jsdelivr.net/npm/iframe-resizer"]
baseAppsCategoriesBASE_APPS_CATEGORIES["carte","graphique","textuelle","SCDL"]
remoteServicesREMOTE_SERVICES[{"title":"Données Entreprises","url":"https://koumoul.com/s/sirene/api-docs.json"},{"title":"Géocoder","url":"https://koumoul.com/s/geocoder/api/v1/api-docs.json"},{"title":"Cadastre","url":"https://koumoul.com/s/cadastre/api-docs.json"},{"title":"Service de données cartographiques","url":"https://koumoul.com/s/tileserver/api/v1/api-docs.json"}]
remoteServicesPrivateMappingREMOTE_SERVICES_PRIVATE_MAPPING["",""]
defaultRemoteKey.valueDEFAULT_REMOTE_KEYDefault API key to use when calling remote services.null
catalogsCATALOGS[{"title":"Data.gouv.fr","href":"https://www.data.gouv.fr","logo":"https://static.data.gouv.fr/_themes/gouvfr/img/logo-header.svg"}]
disableSharingDISABLE_SHARINGfalse
disableApplicationsDISABLE_APPLICATIONSfalse
disableRemoteServicesDISABLE_REMOTE_SERVICESfalse
disablePublicationSitesDISABLE_PUBLICATION_SITESfalse
info.termsOfServiceINFO_TOS
info.contactINFO_CONTACT{"name":"","url":""}
ogr2ogr.skipOGR2OGR_SKIPfalse
ogr2ogr.timeoutOGR2OGR_TIMEOUT360000
extraNavigationItemsEXTRA_NAV_ITEMS[]
extraAdminNavigationItemsEXTRA_ADMIN_NAV_ITEMS[]
dateFormatsDATE_FORMATS["D/M/YYYY","D/M/YY","YYYY/M/D"]
dateTimeFormatsDATE_TIME_FORMATS["D/M/YYYY H:m","D/M/YY H:m","D/M/YYYY, H:m","D/M/YY, H:m","D/M/YYYY H:m:s","D/M/YY H:m:s","D/M/YYYY, H:m:s","D/M/YY, H:m:s","YYYY-MM-DDTHH:mm:ss","YYYY-MM-DD HH:mm:ss"]
defaultTimeZoneDEFAULT_TIME_ZONEEurope/Paris
i18n.localesI18N_LOCALESList of locales split by commasfr,en
i18n.defaultLocaleI18N_DEFAULT_LOCALEfr
observe.activeOBSERVE_ACTIVEtrue
observe.portOBSERVE_PORT9090
agentkeepaliveOptionsAGENTKEEPALIVE_OPTIONS{"maxSockets":128,"maxFreeSockets":128,"timeout":60000,"freeSocketTimeout":30000}
exportRestDatasets.cronEXPORT_REST_DATASETS_CRON0 6 * * 0
clamav.activeCLAMAV_ACTIVEfalse
clamav.hostCLAMAV_HOSTlocalhost
clamav.portCLAMAV_PORT3310
clamav.dataDirCLAMAV_DATA_DIR/data/data-fair