config.json

config.json est le fichier de configuration propre au relais : son port, qui peut le joindre, le token d’accès, les minuteurs qui décident quand un turn compte comme bloqué, et les tunnels et la preview lane, facultatifs. oar setup le crée. Vous le modifiez à la main pour tout ce que setup ne demande pas.

La plupart de ce que vous réglez dans l’interface web n’est pas dans ce fichier. Voir Réglages de l’interface web et environnement.

Où se trouve le fichier #

OAR_STATE_ROOT déplace tout le dossier d’état d’une installation globale (config, données et journaux) ; voir Où OAR garde ses fichiers.

COPILOT_WEB_RELAY_CONFIG pointe le relais vers un fichier précis, où qu’il soit, mais seulement quand le relais est démarré sans le lanceur propre à oar : node server/server.js, ou oar copilot (quand le fichier existe). oar setup, oar start, oar restart et le service utilisent toujours le config.json propre à l’installation, quoi que dise la variable. Dans un checkout sans server/config.json, oar copilot crée son fichier dans ~/.config/copilot-remote à la place (%LOCALAPPDATA%\copilot-remote sous Windows). Voir Variables d’environnement.

Le relais garde le fichier lisible par son seul propriétaire (mode 0600 sous macOS et Linux), parce qu’il contient le token d’accès en clair. Traitez-en une copie comme un mot de passe.

Qui l’écrit #

• oar setup écrit le token, localhostOnly et port, et garde toutes les autres clés telles qu’il les trouve. Un fichier qu’il crée, ou auquel elles manquent, reçoit aussi pollIntervalMs, processingTimeoutMs (600000) et conversationSessionMode. Voir oar setup et premier lancement.
• Le relais écrit cliBinaries quand vous installez ou mettez à jour une CLI de fournisseur depuis Settings (Réglages). Il ne modifie que cette clé. S’il ne peut pas lire le fichier comme du JSON, il refuse d’écrire et garde l’association pour le processus en cours seulement.
• Le relais crée le fichier quand aucun n’existe au démarrage, avec un authToken vide, le port 3333, localhostOnly: true, pollIntervalMs et conversationSessionMode. Il retire aussi une clé features restée d’anciennes versions (voir Clés obsolètes, ignorées et internes).
• Vous, dans n’importe quel éditeur de texte.

Le modifier à la main #

Le fichier est un seul objet JSON. Les clés que vous omettez prennent leur valeur par défaut, et un bloc imbriqué comme previews est lu en entier. Modifiez-le, puis redémarrez le relais : le relais lit le fichier une seule fois, au démarrage. Rien de ce que tient un relais en cours ne change quand vous enregistrez le fichier. Redémarrez avec oar restart (installations globales), ou avec 🌄 Restart web relay (Redémarrer le relais web) dans le menu ⋯ d’une conversation.

• Une clé inconnue est ignorée et conservée. Setup et les écritures propres au relais la laissent en place.
• Un JSON non valide n’arrête pas le relais. Il journalise Failed to read config.json, using defaults. et tourne avec les valeurs par défaut : port 3333, cette machine uniquement, et un token aléatoire, nouveau à chaque démarrage et affiché dans le journal. Votre token enregistré ne fonctionne plus tant que vous n’avez pas corrigé le fichier. Un second lecteur, celui qui choisit le dossier de données, se rabat sur le dossier par défaut. Le relais ne touche pas au fichier cassé.
• Une valeur erronée est traitée clé par clé. Les valeurs par défaut ci-dessous sont ce qu’utilise le relais quand un minuteur ou une limite manque ou est inutilisable. Les tunnels et la preview lane restent désactivés et journalisent la raison ; le relais lui-même continue de tourner.
• La ligne de commande l’emporte sur le fichier le temps d’une exécution : --token <value> et --port <number> sur node server/server.js (oar copilot les transmet aussi ; oar start non) remplacent authToken et port et ne sont jamais enregistrés dans le fichier. Un --port qui n’est pas un nombre de 1 à 65535 est ignoré avec un avertissement.

Réseau et accès #

Pour la première connexion, le token et l’accès LAN, voir premier lancement.

Turns et minuteurs #

La durée maximale d’un turn, le délai des tâches de fond et les surveillances de blocage ne sont pas ici : voir Quand un turn est bloqué.

Redémarrages et arrêt #

Ces clés règlent le redémarrage planifié du relais (🌄 Restart web relay). Voir Redémarrages et reprise. Chaque minuteur prend des millisecondes ; une valeur inférieure ou égale à 0, ou qui n’est pas un nombre, utilise la valeur par défaut.

Mémoire Ajouté en 0.9.19 #

Workspace et données #

CLI des fournisseurs #

Ces clés comptent là où le relais parle lui-même à la CLI Copilot installée, par exemple pour importer des sessions Copilot existantes et pour lister les modèles. La recherche explore le cache des paquets de la CLI Copilot (COPILOT_PKG_DIR ajoute un dossier à explorer en premier). Voir GitHub Copilot.

Aperçus #

Le bloc previews active la preview lane : un second écouteur, sur son propre port et son propre nom d’hôte, qui publie des serveurs de dev et des dossiers locaux. La mise en place, les noms d’hôte et le proxy frontal sont décrits sur la page de l’outil preview.

Si l’une de ces règles échoue alors que les aperçus sont activés, le relais journalise PREVIEW LANE disabled avec la raison, laisse la lane désactivée et continue de tourner.

Ces variables d’environnement remplacent les clés correspondantes : COPILOT_PREVIEWS_ENABLED (1, true, 0, false), COPILOT_PREVIEWS_PORT, COPILOT_PREVIEWS_BIND_HOST, COPILOT_PREVIEWS_PUBLIC_BASE_URL et COPILOT_PREVIEWS_ALLOWED_TARGET_HOSTS (séparés par des virgules).

Tunnels #

Deux tunnels peuvent joindre le relais depuis l’extérieur de votre réseau. Ils sont indépendants et peuvent tourner en même temps. Les deux sont désactivés par défaut, et un tunnel géré auquel il manque une valeur obligatoire reste désactivé et journalise pourquoi.

sshTunnel #

Un tunnel SSH inverse vers un serveur à vous. Voir Tunnel SSH.

cloudflaredTunnel #

Lance cloudflared de Cloudflare, que vous installez vous-même ; OAR n’en fournit pas. Voir Cloudflare Tunnel.

Réglages de l’interface web et environnement #

Les réglages de l’interface web ne sont pas dans ce fichier. Les interrupteurs et les clés des fournisseurs, les listes de modèles, la durée maximale d’un turn, le délai des tâches de fond et les flags de fonctionnalité sont stockés dans la base de données du relais, dans le dossier de données. Le fichier contient ce dont le relais a besoin avant que la base de données s’ouvre (le dossier de données, le port, le token) et des faits sur la machine (chemins des CLI, tunnels). La seule chose que l’interface écrit dans le fichier est cliBinaries. Ajouté en 0.9.17 DeepSeek n’a pas de clé ici non plus : sa clé d’API, son URL de base et son budget sont enregistrés depuis Settings → Providers → DeepSeek (Réglages → Fournisseurs → DeepSeek) dans la base de données.

Variables d’environnement. La liste complète se trouve sur la page Variables d’environnement. Là où une variable existe pour une clé, la variable l’emporte sur le fichier : COPILOT_WEB_RELAY_DATA_DIR (dataDir), COPILOT_WORKSPACE_ROOT_ALLOW_LIST, COPILOT_CLOUDFLARED_* et COPILOT_PREVIEWS_* (listées dans leurs sections). COPILOT_TUNNEL_MARKER_HEADERS est l’exception : ses noms s’ajoutent à tunnelMarkerHeaders. Les options --token et --port l’emportent sur les deux le temps d’une exécution. COPILOT_WEB_RELAY_CONFIG elle-même est traitée sous Où se trouve le fichier.

Un exemple #

Toutes les valeurs sont inventées. Supprimez les blocs que vous n’utilisez pas.

{
  "authToken": "0f3c1a9e-example-token-do-not-copy",
  "port": 3333,
  "localhostOnly": false,
  "remotePath": "",
  "trustProxy": "loopback",
  "allowedOrigins": [],
  "publicHostnames": ["relay.example.com"],
  "tunnelMarkerHeaders": ["x-edge-request-id"],
  "processingTimeoutMs": 600000,
  "maxRequeueRetries": 5,
  "contextIndicatorMode": "bar",
  "workspaceRootAllowList": ["/home/dev/projects", "/srv/sites"],
  "dataDir": "data",
  "cliBinaries": {
    "claude": "/home/dev/.local/bin/claude",
    "grok": "/home/dev/.grok/bin/grok"
  },
  "restartShutdownTimeoutMs": 45000,
  "restartGracefulTimeoutMs": 8000,
  "restartSpawnTimeoutMs": 18000,
  "restartRebindTimeoutMs": 20000,
  "restartReadyCooldownMs": 1000,
  "restartMaxAttempts": 3,
  "restartRetryBackoffMs": [1000, 3000, 7000],
  "previews": {
    "enabled": true,
    "port": 3334,
    "bindHost": "127.0.0.1",
    "allowPublicBind": false,
    "publicBaseUrl": "https://preview.example.com",
    "allowedTargetHosts": [],
    "maxLive": 8
  },
  "sshTunnel": {
    "mode": "managed",
    "required": false,
    "user": "ubuntu",
    "host": "vps.example.com",
    "remotePort": 4444,
    "remoteBind": "loopback",
    "identityFile": "~/.ssh/id_ed25519"
  },
  "cloudflaredTunnel": {
    "mode": "disabled",
    "token": "",
    "binary": "cloudflared",
    "extraArgs": []
  }
}

Clés obsolètes, ignorées et internes #

Si vous trouvez l’une de ces clés dans un fichier, vous pouvez la laisser ou la supprimer :