UniFam Documentation

Auto-hébergement (Suite)

Installer la Suite UniFam sur votre propre serveur.

Le mode Suite regroupe plusieurs modules autour d'un foyer partagé. Il nécessite une clé d'activation.

Architecture de déploiement

1. Récupérer la configuration

# TODO : à remplacer par l'URL réelle du dépôt de déploiement
git clone <url-du-depot-de-deploiement> unifam
cd unifam
cp .env.example .env

2. Configurer

Renseignez au minimum dans .env :

  • les secrets de l'application ;
  • l'accès à la base de données ;
  • l'URL publique de votre instance ;
  • votre clé d'activation de la Suite.

Toutes les options sont listées dans Configuration.

Ne conservez aucune valeur par défaut pour les secrets. Générez-les, par exemple avec openssl rand -hex 32.

3. Démarrer

docker compose up -d
docker compose ps

Vérifiez l'état du service :

curl https://unifam.example.com/api/v1/health

4. Créer le foyer

Au premier accès, créez votre compte : vous devenez propriétaire (owner) du foyer. Invitez ensuite les autres membres et activez les modules souhaités.

5. Exposer en HTTPS

Placez UniFam derrière un reverse proxy qui gère les certificats TLS. Une configuration d'exemple sera ajoutée ici (TODO).

Sauvegardes

Sauvegardez régulièrement :

  • la base de données ;
  • les volumes de fichiers ;
  • votre fichier .env, stocké séparément et chiffré.

Testez la restauration avant d'en avoir besoin.

On this page