Auto-hébergement manuel

Exécutez Circlus sur votre serveur.

Ce parcours s'adresse aux premiers utilisateurs : préparez un VPS, pointez un domaine vers celui-ci, déployez le serveur open source Circlus avec Docker ou manuellement, puis revenez dans l'application pour créer votre premier cercle privé.

Suivre le guideOuvrir GitHub

Avant d'ouvrir l'application

Circlus a besoin d'une vraie adresse HTTPS avant que l'application puisse envoyer une clé d'accès serveur. N'entrez pas cette clé sur une adresse HTTP simple.

Un VPS

Un petit VPS Linux suffit pour commencer. Choisissez un hébergeur fiable et gardez l'accès SSH privé.

Un domaine

Pointez un domaine ou sous-domaine vers le VPS. Une IP nue ne convient que si HTTPS fonctionne avec un certificat valide.

HTTPS

Utilisez un reverse proxy comme Caddy ou Nginx et un certificat TLS. Caddy peut émettre les certificats automatiquement.

Services gérés

Les notifications push en arrière-plan et le relais TURN fiable nécessitent une demande séparée.

Parcours de configuration

Commencez par le dépôt open source. Docker Compose est le chemin le plus court, mais vous pouvez aussi gérer PostgreSQL, le serveur et les services de support vous-même.

Préparer le VPS

Créez un VPS Linux, ajoutez vos clés SSH, installez le runtime indiqué dans le dépôt et gardez un pare-feu minimal.

Pointer un domaine

Créez un enregistrement A ou AAAA, par exemple cercle.example.com, vers l'IP publique du VPS.

Déployer Circlus

Clonez le dépôt, configurez les variables d'environnement, initialisez la base et démarrez le backend.

Mettre HTTPS devant

Configurez le serveur web ou reverse proxy pour transmettre les requêtes API vers le backend Circlus.

Générer une clé d'accès

Utilisez la commande serveur du dépôt pour créer une clé courte durée. Traitez-la comme un mot de passe.

Créer le premier cercle

Dans Circlus, choisissez le scénario serveur vide, entrez le domaine HTTPS et la clé, puis laissez l'application créer le cercle et l'identité propriétaire.

Pour le push géré et TURN, conservez les variables d'environnement générées côté serveur et attendez l'approbation. Ne partagez pas les secrets de service.

Accès aux services gérés

Votre serveur peut être installé et utilisé avant approbation. L'approbation active les notifications push et le relais TURN géré.

Demander des identifiants

Le formulaire génère les identifiants serveur-à-serveur pour push et ICE. Enregistrez immédiatement les variables d'environnement, puis attendez l'approbation.

À enregistrer dans l'environnement serveur

Les secrets partagés ne sont affichés qu'une fois. La demande reste en attente jusqu'à l'approbation de l'identifiant serveur.

Règles de sécurité à garder

HTTPS uniquement

La clé d'accès serveur ne doit passer que par HTTPS.

Clé courte durée

Générez une clé fraîche pour la configuration, utilisez-la une fois, puis révoquez-la ou laissez-la expirer.

Rôles séparés

La clé d'hôte prouve le contrôle d'un serveur vide. Ensuite, l'identité propriétaire reçoit l'administration serveur.

Sauvegardes

Sauvegardez la base et la configuration. Perdre le VPS ne doit pas faire perdre le contrôle des cercles.