Installation

Vous pouvez installer Sovrium sur votre propre machine ou l'exécuter chez un hébergeur cloud. Choisissez la voie qui correspond à l'endroit où votre application s'exécutera.

Prérequis

Aucun. Sovrium est distribué sous forme de binaire autonome : ni environnement d'exécution, ni gestionnaire de paquets, rien à installer au préalable.

Les tables et l'authentification fonctionnent d'emblée sur une base de données SQLite embarquée. PostgreSQL 15+ est optionnel et débloque des fonctionnalités avancées (SQL brut, recherche vectorielle).

Installation locale

Choisissez la méthode qui correspond à votre système d'exploitation.

# Script d'installation (macOS, Linux)
curl -fsSL https://sovrium.com/install | sh

# Homebrew (macOS, Linux)
brew install sovrium/tap/sovrium

# Scoop (Windows)
scoop bucket add sovrium https://github.com/sovrium/scoop-bucket
scoop install sovrium

# Docker
docker pull ghcr.io/sovrium/sovrium:latest

Après l'installation, la commande sovrium est disponible depuis n'importe où.

Installation cloud

Exécutez Sovrium sur un hébergeur géré sans provisionner vous-même de serveur. N'importe quelle plateforme capable d'exécuter un conteneur durable convient : pointez-la vers l'image publiée ghcr.io/sovrium/sovrium. Render, Railway, Heroku, Platform.sh et Fly.io exécutent tous Sovrium ainsi. Scalingo également, ou vous pouvez y déployer depuis les sources avec le buildpack Sovrium, qui télécharge le binaire publié et vérifié par somme de contrôle — voir Déployer sur Scalingo.

Quel que soit l'hébergeur retenu, définissez BASE_URL (requise) et SOVRIUM_ENCRYPTION_KEY. Sovrium génère sa propre clé de chiffrement quand aucune n'est fournie, mais un hébergeur géré reconstruit le système de fichiers du conteneur à chaque déploiement : une clé auto-générée n'y survivrait pas, sauf à être écrite sur un volume persistant — sur un hébergeur géré, définissez-la explicitement. Il n'y a qu'un seul secret à gérer : le secret de signature des sessions est dérivé de la clé de chiffrement, vous ne définissez donc jamais AUTH_SECRET à côté. Générez-en une avec sovrium secret generate, ou avec openssl rand -hex 32 si vous n'avez pas encore le binaire sous la main. DATABASE_URL est optionnelle — Sovrium utilise par défaut SQLite embarqué — tout comme les variables SMTP_* pour l'envoi d'e-mails.

Vercel n'est pas pris en charge, car cette plateforme est serverless : elle n'offre ni serveur ni conteneur durable, et Sovrium a besoin d'un processus de longue durée pour servir votre application et stocker ses données.

Docker sur votre propre serveur

Pour exécuter Sovrium sur un VPS ou tout hôte que vous contrôlez, démarrez le conteneur directement et placez-le derrière un proxy inverse :

docker run -p 3000:3000 \
  -v "$PWD/app.yaml:/app/app.yaml:ro" \
  -v sovrium-data:/data \
  -e SOVRIUM_DATA_DIR=/data \
  -e NODE_ENV=production \
  -e SOVRIUM_ENCRYPTION_KEY="$(openssl rand -hex 32)" \
  -e BASE_URL="https://app.example.com" \
  ghcr.io/sovrium/sovrium:latest start /app/app.yaml

Deux montages, et les deux comptent. Le premier donne sa configuration au conteneur ; le second est l'endroit où il conserve son état. SOVRIUM_DATA_DIR doit pointer vers ce second montage — Sovrium écrit dans ./.sovrium par défaut, ce qui donne /app/.sovrium à l'intérieur du conteneur : un volume de données dépourvu de cette variable ne persiste donc rien. Cela vaut aussi pour la clé de chiffrement, d'où sa présence ci-dessus : le volume une fois branché, vous pourriez la retirer et laisser Sovrium conserver la sienne sur ce volume.

Sovrium accepte l'un ou l'autre point d'entrée, app.yaml ou app.ts : un guide qui montre l'un fonctionne tout aussi bien avec l'autre. Voir Déployer avec Docker pour la procédure de production complète.

Vérifier l'installation

Exécutez la commande d'aide pour vérifier que Sovrium est correctement installé :

sovrium --help

Créer un fichier de configuration

Sovrium lit un fichier de configuration YAML ou JSON. Créez un fichier app.yaml avec la configuration valide la plus simple :

name: my-app

Configuration de la base de données

Sovrium utilise par défaut une base de données SQLite embarquée — les tables et l'authentification fonctionnent sans aucune configuration. Définissez DATABASE_URL uniquement pour choisir l'emplacement du fichier SQLite ou pour passer à PostgreSQL :

# Par défaut : SQLite embarqué — aucun DATABASE_URL nécessaire

# Optionnel — choisir l'emplacement du fichier SQLite :
export DATABASE_URL="file:./data/app.db"

# Optionnel — utiliser PostgreSQL pour les fonctionnalités avancées :
export DATABASE_URL="postgresql://user:password@localhost:5432/myapp"

Étapes suivantes

• Démarrage rapide — créez et exécutez votre première application.
• Concepts fondamentaux — l'anatomie d'une application Sovrium.
• Fichiers de configuration — YAML, JSON, TypeScript et $ref.