#Variables d'environnement

#Comment définir les variables d'environnement ?

#Méthode d'installation via le code source Git ou create-nocobase-app

Définissez les variables d'environnement dans le fichier .env situé à la racine de votre projet. Après avoir modifié ces variables, vous devrez arrêter le processus de l'application et le redémarrer.

#Méthode d'installation Docker

Modifiez la configuration de docker-compose.yml et définissez les variables d'environnement dans le paramètre environment. Exemple :

services:
  app:
    image: nocobase/nocobase:latest
    environment:
      - APP_ENV=production

Vous pouvez également utiliser env_file pour définir les variables d'environnement dans un fichier .env. Exemple :

services:
  app:
    image: nocobase/nocobase:latest
    env_file: .env

Après avoir modifié les variables d'environnement, vous devez reconstruire le conteneur de l'application :

docker compose up -d app

#Variables d'environnement globales

#TZ

Permet de définir le fuseau horaire de l'application. Par défaut, c'est celui du système d'exploitation.

https://en.wikipedia.org/wiki/List_of_tz_database_time_zones

#APP_ENV

Environnement de l'application. La valeur par défaut est development. Les options disponibles sont :

• production environnement de production
• development environnement de développement

APP_ENV=production

#APP_KEY

La clé secrète de l'application, utilisée notamment pour générer les jetons utilisateur. Modifiez-la pour utiliser votre propre clé d'application et assurez-vous qu'elle ne soit pas divulguée.

APP_KEY=app-key-test

#APP_PORT

Port de l'application. La valeur par défaut est 13000.

APP_PORT=13000

#API_BASE_PATH

Préfixe de l'adresse de l'API NocoBase. La valeur par défaut est /api/.

API_BASE_PATH=/api/

#API_BASE_URL

#CLUSTER_MODE

v1.6.0+

Le mode de démarrage multi-cœur (cluster) pour l'application. Si cette variable est configurée, elle sera transmise à la commande pm2 start comme paramètre -i <instances>. Les options sont cohérentes avec le paramètre -i de pm2 (référez-vous à PM2: Cluster Mode), et incluent :

• max : Utilise le nombre maximal de cœurs CPU.
• -1 : Utilise le nombre maximal de cœurs CPU moins un.
• <number> : Spécifie le nombre de cœurs.

La valeur par défaut est vide, ce qui signifie que le mode n'est pas activé.

Pour plus d'informations, consultez : Mode Cluster.

#PLUGIN_PACKAGE_PREFIX

Préfixe du nom de package des plugins. La valeur par défaut est : @nocobase/plugin-,@nocobase/preset-.

Par exemple, pour ajouter le plugin hello au projet my-nocobase-app, le nom complet du package du plugin serait @my-nocobase-app/plugin-hello.

PLUGIN_PACKAGE_PREFIX peut être configuré comme suit :

PLUGIN_PACKAGE_PREFIX=@nocobase/plugin-,@nocobase-preset-,@my-nocobase-app/plugin-

La correspondance entre le nom du plugin et le nom du package est la suivante :

• Le nom du package du plugin users est @nocobase/plugin-users.
• Le nom du package du plugin nocobase est @nocobase/preset-nocobase.
• Le nom du package du plugin hello est @my-nocobase-app/plugin-hello.

#DB_DIALECT

Type de base de données. Les options disponibles sont :

• mariadb
• mysql
• postgres

DB_DIALECT=mysql

#DB_HOST

Hôte de la base de données (requis lors de l'utilisation de bases de données MySQL ou PostgreSQL).

La valeur par défaut est localhost.

DB_HOST=localhost

#DB_PORT

Port de la base de données (requis lors de l'utilisation de bases de données MySQL ou PostgreSQL).

• Le port par défaut pour MySQL et MariaDB est 3306.
• Le port par défaut pour PostgreSQL est 5432.

DB_PORT=3306

#DB_DATABASE

Nom de la base de données (requis lors de l'utilisation de bases de données MySQL ou PostgreSQL).

DB_DATABASE=nocobase

#DB_USER

Utilisateur de la base de données (requis lors de l'utilisation de bases de données MySQL ou PostgreSQL).

DB_USER=nocobase

#DB_PASSWORD

Mot de passe de la base de données (requis lors de l'utilisation de bases de données MySQL ou PostgreSQL).

DB_PASSWORD=nocobase

#DB_TABLE_PREFIX

Préfixe des tables de données.

DB_TABLE_PREFIX=nocobase_

#DB_UNDERSCORED

Indique si les noms de tables et de champs de la base de données doivent être convertis au format snake_case. La valeur par défaut est false. Si vous utilisez une base de données MySQL (MariaDB) avec lower_case_table_names=1, alors DB_UNDERSCORED doit être défini sur true.

#DB_LOGGING

Commutateur de journalisation de la base de données. La valeur par défaut est off. Les options disponibles sont :

• on activé
• off désactivé

DB_LOGGING=on

#DB_POOL_MAX

Nombre maximal de connexions dans le pool de connexions de la base de données. La valeur par défaut est 5.

#DB_POOL_MIN

Nombre minimal de connexions dans le pool de connexions de la base de données. La valeur par défaut est 0.

#DB_POOL_IDLE

Durée maximale, en millisecondes, pendant laquelle une connexion peut rester inactive avant d'être libérée. La valeur par défaut est 10000 (10 secondes).

#DB_POOL_ACQUIRE

Durée maximale, en millisecondes, pendant laquelle le pool tentera d'obtenir une connexion avant de générer une erreur. La valeur par défaut est 60000 (60 secondes).

#DB_POOL_EVICT

Intervalle de temps, en millisecondes, après lequel le pool de connexions supprimera les connexions inactives. La valeur par défaut est 1000 (1 seconde).

#DB_POOL_MAX_USES

Nombre de fois qu'une connexion peut être utilisée avant d'être abandonnée et remplacée. La valeur par défaut est 0 (illimité).

#LOGGER_TRANSPORT

Méthode de sortie des logs. Plusieurs valeurs peuvent être séparées par des virgules. La valeur par défaut est console en environnement de développement, et console,dailyRotateFile en production. Options :

• console - console.log
• file - Sortie vers un fichier
• dailyRotateFile - Sortie vers des fichiers rotatifs quotidiens

LOGGER_TRANSPORT=console,dailyRotateFile

#LOGGER_BASE_PATH

Chemin de stockage des logs basés sur des fichiers. La valeur par défaut est storage/logs.

LOGGER_BASE_PATH=storage/logs

#LOGGER_LEVEL

Niveau de sortie des logs. La valeur par défaut est debug en environnement de développement et info en production. Options :

• error
• warn
• info
• debug
• trace

LOGGER_LEVEL=info

Le niveau de sortie des logs de la base de données est debug, contrôlé par DB_LOGGING, et n'est pas affecté par LOGGER_LEVEL.

#LOGGER_MAX_FILES

Nombre maximal de fichiers de log à conserver.

• Lorsque LOGGER_TRANSPORT est file : La valeur par défaut est 10.
• Lorsque LOGGER_TRANSPORT est dailyRotateFile : Utilisez [n]d pour représenter le nombre de jours. La valeur par défaut est 14d.

LOGGER_MAX_FILES=14d

#LOGGER_MAX_SIZE

Rotation des logs par taille.

• Lorsque LOGGER_TRANSPORT est file : L'unité est le byte. La valeur par défaut est 20971520 (20 * 1024 * 1024).
• Lorsque LOGGER_TRANSPORT est dailyRotateFile : Vous pouvez utiliser [n]k, [n]m, [n]g. Non configuré par défaut.

LOGGER_MAX_SIZE=20971520

#LOGGER_FORMAT

Format d'impression des logs. La valeur par défaut est console en environnement de développement et json en production. Options :

• console
• json
• logfmt
• delimiter

LOGGER_FORMAT=json

Référence : Format des logs

#CACHE_DEFAULT_STORE

Identifiant unique pour la méthode de mise en cache, spécifiant la méthode de cache par défaut du serveur. La valeur par défaut est memory. Les options intégrées incluent :

• memory
• redis

CACHE_DEFAULT_STORE=memory

#CACHE_MEMORY_MAX

Nombre maximal d'éléments dans le cache mémoire. La valeur par défaut est 2000.

CACHE_MEMORY_MAX=2000

#CACHE_REDIS_URL

URL de connexion Redis, facultative. Exemple : redis://localhost:6379

CACHE_REDIS_URL=redis://localhost:6379

#TELEMETRY_ENABLED

Active la collecte de données de télémétrie. La valeur par défaut est off.

TELEMETRY_ENABLED=on

#TELEMETRY_METRIC_READER

Collecteurs de métriques de surveillance activés. La valeur par défaut est console. Les autres valeurs doivent faire référence aux noms enregistrés par les plugins de collecteurs correspondants, tels que prometheus. Plusieurs valeurs sont séparées par des virgules.

TELEMETRY_METRIC_READER=console,prometheus

#TELEMETRY_TRACE_PROCESSOR

Processeurs de données de trace activés. La valeur par défaut est console. Les autres valeurs doivent faire référence aux noms enregistrés par les plugins de processeurs correspondants. Plusieurs valeurs sont séparées par des virgules.

TELEMETRY_TRACE_PROCESSOR=console

#Variables d'environnement expérimentales

#APPEND_PRESET_LOCAL_PLUGINS

Utilisée pour ajouter des plugins locaux prédéfinis et non activés. La valeur est le nom du package du plugin (le paramètre name dans package.json), avec plusieurs plugins séparés par des virgules.

:::info

1. Assurez-vous que le plugin est téléchargé localement et qu'il se trouve dans le répertoire node_modules. Pour plus de détails, consultez l'« Organisation des plugins ».
2. Après avoir ajouté la variable d'environnement, le plugin n'apparaîtra sur la page du gestionnaire de plugins qu'après une installation initiale (nocobase install) ou une mise à jour (nocobase upgrade). :::

APPEND_PRESET_LOCAL_PLUGINS=@my-project/plugin-foo,@my-project/plugin-bar

#APPEND_PRESET_BUILT_IN_PLUGINS

Utilisée pour ajouter des plugins intégrés et installés par défaut. La valeur est le nom du package du plugin (le paramètre name dans package.json), avec plusieurs plugins séparés par des virgules.

:::info

1. Assurez-vous que le plugin est téléchargé localement et qu'il se trouve dans le répertoire node_modules. Pour plus de détails, consultez l'« Organisation des plugins ».
2. Après avoir ajouté la variable d'environnement, le plugin sera automatiquement installé ou mis à jour lors de l'installation initiale (nocobase install) ou de la mise à jour (nocobase upgrade). :::

APPEND_PRESET_BUILT_IN_PLUGINS=@my-project/plugin-foo,@my-project/plugin-bar

#Variables d'environnement temporaires

Lors de l'installation de NocoBase, vous pouvez utiliser des variables d'environnement temporaires pour faciliter le processus, par exemple :

yarn cross-env \
  INIT_APP_LANG=zh-CN \
  INIT_ROOT_EMAIL=demo@nocobase.com \
  INIT_ROOT_PASSWORD=admin123 \
  INIT_ROOT_NICKNAME="Super Admin" \
  nocobase install

# Équivalent à
yarn nocobase install \
  --lang=zh-CN  \
  --root-email=demo@nocobase.com \
  --root-password=admin123 \
  --root-nickname="Super Admin"

# Équivalent à
yarn nocobase install -l zh-CN -e demo@nocobase.com -p admin123 -n "Super Admin"

#INIT_APP_LANG

Langue lors de l'installation. La valeur par défaut est en-US. Les options disponibles sont :

• en-US
• zh-CN

yarn cross-env \
  INIT_APP_LANG=zh-CN \
  nocobase install

#INIT_ROOT_EMAIL

E-mail de l'utilisateur Root.

yarn cross-env \
  INIT_APP_LANG=zh-CN \
  INIT_ROOT_EMAIL=demo@nocobase.com \
  nocobase install

#INIT_ROOT_PASSWORD

Mot de passe de l'utilisateur Root.

yarn cross-env \
  INIT_APP_LANG=zh-CN \
  INIT_ROOT_EMAIL=demo@nocobase.com \
  INIT_ROOT_PASSWORD=admin123 \
  nocobase install

#INIT_ROOT_NICKNAME

Surnom de l'utilisateur Root.

yarn cross-env \
  INIT_APP_LANG=zh-CN \
  INIT_ROOT_EMAIL=demo@nocobase.com \
  INIT_ROOT_PASSWORD=admin123 \
  INIT_ROOT_NICKNAME="Super Admin" \
  nocobase install