Aller au contenu principal

Démarrage rapide

Ce guide vous mène de zéro à une instance en marche. Il vous faut Docker avec Compose v2.

1. Récupérer les fichiers de déploiement​

Les fichiers d'auto-hébergement se trouvent dans le dossier deploy/ de la branche next.

git clone --branch next https://github.com/notacamp/campbooks
cd campbooks/deploy

2. Créer votre fichier de réglages​

Copiez l'exemple. Tous les réglages se trouvent dans ce seul fichier .env.

cp .env.example .env

3. Définir les deux valeurs obligatoires​

Ouvrez .env et définissez au moins ces deux valeurs. POSTGRES_PASSWORD ne doit contenir que des caractères sûrs pour une URL, car il est intégré dans une URL de connexion. openssl rand -hex 24 en produit un bon. CAMPBOOKS_PUBLIC_URL est l'adresse que les gens utilisent pour joindre votre instance. Elle sert aussi à construire les liens d'invitation.

POSTGRES_PASSWORD=change-me
CAMPBOOKS_PUBLIC_URL=https://campbooks.example.com

Pour un essai sur votre propre machine, utilisez http://localhost:8080 comme URL publique et ajoutez CAMPBOOKS_ENV=development à .env. Le http:// simple n'est accepté qu'en développement. N'utilisez jamais CAMPBOOKS_ENV=development sur un serveur auquel d'autres personnes peuvent accéder : une vraie installation utilise https:// et laisse CAMPBOOKS_ENV non défini.

4. Le démarrer​

Cette commande démarre le serveur et Postgres (avec pgvector). La connexion est intégrée au serveur, donc aucun service distinct ne s'en occupe. Au premier démarrage, un service ponctuel génère aussi la clé secrète de l'instance. Gardez-en une copie (voir Mises à jour et sauvegardes).

docker compose up -d

5. Vérifier que tout va bien​

Le point de contrôle de santé confirme que le serveur atteint la base de données.

curl http://localhost:8080/api/v1/system/health

Vous devriez obtenir ceci :

{"status":"ok","database":"ok"}

6. Ouvrir l'application et se connecter​

Le serveur sert l'application web sur le port 8080. Si vous n'êtes pas connecté, il vous envoie vers l'écran de connexion, puis vous ramène. Les gens se connectent avec Google, Microsoft, Zoho ou une clé d'accès. Pour proposer un fournisseur, enregistrez d'abord son application OAuth (voir Connexion).

http://localhost:8080/

7. Créer le premier espace de travail​

La première personne qui se connecte crée le premier espace de travail. Invitez les autres depuis Réglages, puis Membres. Les invitations ne sont pas encore envoyées par e-mail : vous recevez le lien une seule fois, juste après l'invitation, et vous le transmettez vous-même. Voir Connexion pour savoir qui d'autre peut créer un espace de travail.

Étapes suivantes​