ONIR CMS
DocumentationSe connecter
Documentation

Documentation ONIR CMS

Installer ONIR CMS, puis créer et intégrer un template visuel : guide, API, actions et contrat hôte.

Cette documentation s'adresse aux développeurs du dashboard et de templates. Elle couvre l'installation locale avec Docker, puis trois stacks (React, Vue, HTML/CSS/JS) et deux environnements : le mock (harness local, hors-ligne) et la production (dashboard, API, LLM, médiathèque).

Lancer le dashboard en local

Vous souhaitez d'abord faire tourner le dashboard sur votre machine ? Le guide Docker couvre Windows, Linux et macOS, sans installation locale de Node ou PostgreSQL.

Préparer l'environnement

Docker Desktop ou Docker Engine, build local ou images GHCR, génération des secrets, premier démarrage, tests et dépannage.

Suivre le guide →

Démarrer en quatre commandes

npx @onirtech/create-onirtech-template mon-premier-template --stack react
cd mon-premier-template
npm install
npm run dev

Par où commencer ?

Votre premier template

Guide pas à pas : création, code, tests, build, import. Chaque commande est vérifiée.

Commencer →SDK JavaScript

API complète : defineTemplate, hooks React/Vue, helpers, build Vite.

Lire l'API →Actions

Identité, envoi de message, fin : ce que l'hôte exécute et ce que le template reçoit.

Comprendre le flux →Données & hôte

Photothèque, liens, connaissances, conversations : qui crée quoi, en mock et en production.

Voir l'intégration →Contrat des templates

Manifeste, capacités, paramètres, contexte : la référence normative du protocole.

Consulter le contrat →API fiches

Rechercher les fiches par organisation, modèle, date et texte, avec clés API server-to-server et pagination.

Lire la référence →Skill pour agents IA

Un fichier de compétences pour créer, tester et vérifier un template sans inventer d'API.

Voir le skill →

Ordre de lecture conseillé

  1. Installation — lancez le dashboard et PostgreSQL avec Docker.
  2. Guide — créez un template et voyez-le tourner en local.
  3. SDK — apprenez l'API au fur et à mesure de vos besoins.
  4. Actions — comprenez ce qui se passe quand un message est envoyé.
  5. Données & hôte — branchez la médiathèque, les connaissances et les vraies conversations.
  6. Contrat — pour les cas avancés (transport, capacités, validation).

Prérequis

  • Node.js 20.19+ (recommandé : 22 ou 24) et npm.
  • Un éditeur (VS Code) et un terminal.
  • Un accès au panneau pour importer un template et le rattacher à un lien.

Besoin d'aide ?