Variables d'environnement
Tianji prend en charge diverses variables d'environnement pour personnaliser son comportement. Vous pouvez configurer ces variables dans le champ env
de votre fichier docker-compose ou via votre environnement de déploiement.
Configuration de base
Variable | Description | Défaut | Exemple |
---|---|---|---|
PORT | Port du serveur | 12345 | 3000 |
JWT_SECRET | Secret pour les tokens JWT | Texte aléatoire | your-secret-key |
ALLOW_REGISTER | Activer l'inscription des utilisateurs | false | true |
ALLOW_OPENAPI | Activer l'accès OpenAPI | true | false |
WEBSITE_ID | Identifiant du site web | - | your-website-id |
DISABLE_AUTO_CLEAR | Désactiver le nettoyage automatique des données | false | true |
DISABLE_ACCESS_LOGS | Désactiver les journaux d'accès | false | true |
DB_DEBUG | Activer le débogage de la base de données | false | true |
Authentification
Variable | Description | Défaut | Exemple |
---|---|---|---|
DISABLE_ACCOUNT | Désactiver l'authentification basée sur le compte | false | true |
AUTH_SECRET | Secret d'authentification | MD5 du secret JWT | your-auth-secret |
AUTH_RESTRICT_EMAIL | Restreindre l'inscription à des domaines email spécifiques | - | @example.com |
Authentification par email et invitation par email
Variable | Description | Défaut | Exemple |
---|---|---|---|
EMAIL_SERVER | Serveur SMTP pour l'email | - | smtp://user:pass@smtp.example.com:587 |
EMAIL_FROM | Adresse de l'expéditeur de l'email | - | noreply@example.com |
Authentification GitHub
Variable | Description | Défaut | Exemple |
---|---|---|---|
AUTH_GITHUB_ID | ID client OAuth GitHub | - | your-github-client-id |
AUTH_GITHUB_SECRET | Secret client OAuth GitHub | - | your-github-client-secret |
Authentification Google
Variable | Description | Défaut | Exemple |
---|---|---|---|
AUTH_GOOGLE_ID | ID client OAuth Google | - | your-google-client-id |
AUTH_GOOGLE_SECRET | Secret client OAuth Google | - | your-google-client-secret |
Authentification OAuth/OIDC personnalisée
Variable | Description | Défaut | Exemple |
---|---|---|---|
AUTH_CUSTOM_ID | ID client OAuth/OIDC personnalisé | - | your-custom-client-id |
AUTH_CUSTOM_SECRET | Secret client OAuth/OIDC personnalisé | - | your-custom-client-secret |
AUTH_CUSTOM_NAME | Nom du fournisseur personnalisé | Custom | Enterprise SSO |
AUTH_CUSTOM_TYPE | Type d'authentification | oidc | oauth |
AUTH_CUSTOM_ISSUER | URL de l'émetteur OIDC | - | https://auth.example.com |
Fonctionnalités IA
Variable | Description | Défaut | Exemple |
---|---|---|---|
SHARED_OPENAI_API_KEY | Clé API OpenAI | - | your-openai-api-key |
SHARED_OPENAI_BASE_URL | URL personnalisée de l'API OpenAI | - | https://api.openai.com/v1 |
SHARED_OPENAI_MODEL_NAME | Modèle OpenAI à utiliser | gpt-4o | gpt-3.5-turbo |
DEBUG_AI_FEATURE | Déboguer les fonctionnalités IA | false | true |
Configuration du Sandbox
Variable | Description | Défaut | Exemple |
---|---|---|---|
USE_VM2 | Utiliser VM2 pour l'exécution du sandbox | false | true |
SANDBOX_MEMORY_LIMIT | Limite de mémoire pour le sandbox (MB) | 16 | 32 |
PUPPETEER_EXECUTABLE_PATH | Chemin personnalisé vers l'exécutable Puppeteer | - | /usr/bin/chromium |
Intégration de cartes
Variable | Description | Défaut | Exemple |
---|---|---|---|
AMAP_TOKEN | Jeton API AMap (Gaode) | - | your-amap-token |
MAPBOX_TOKEN | Jeton API Mapbox | - | your-mapbox-token |
Télémétrie
Variable | Description | Défaut | Exemple |
---|---|---|---|
DISABLE_ANONYMOUS_TELEMETRY | Désactiver la télémétrie anonyme | false | true |
CUSTOM_TRACKER_SCRIPT_NAME | Nom du script de suivi personnalisé | - | custom-tracker.js |
Configuration des variables d'environnement
Vous pouvez configurer ces variables d'environnement de différentes manières :
-
Configurez-les directement dans votre environnement de déploiement (Docker, Kubernetes, etc.).
-
Pour les déploiements Docker, vous pouvez utiliser des variables d'environnement dans votre docker-compose.yml :
services:
tianji:
image: moonrailgun/tianji:latest
environment:
- PORT=3000
- ALLOW_REGISTER=true
Valeurs booléennes
Pour les variables d'environnement booléennes, vous pouvez utiliser soit "1"
soit "true"
pour activer la fonctionnalité, et soit omettre la variable soit la définir sur n'importe quelle autre valeur pour la désactiver.