Skip to content

Commencer

Robin Lafontaine edited this page Feb 13, 2025 · 1 revision

Pour Commencer

Phish & Tips, désigné par la suite comme P&T, a été développé comme une solution tout-en-un "BYOS" (Bring Your Own Service - Apportez Votre Propre Service), ce qui signifie que vous pouvez utiliser le serveur SMTP intégré à la solution, le client mail et le bucket S3 ou, comme son nom l'indique, apporter/utiliser les vôtres !

Commençons par cloner le projet avec git clone https://github.com/maximezim/PhishAndTips.git
puis déplaçons-nous dans le répertoire du projet avec cd PhishAndTips.

Pour configurer votre environnement Phish & Tips, il y a deux étapes principales à suivre :

  • Définir vos Variables d'Environnement
  • Choisir vos profils Docker Compose

Variables d'Environnement

Chaque environnement est différent, c'est pourquoi les variables d'environnement existent (évidemment) et pourquoi Phish & Tips les utilise. Pour définir vos variables d'environnement, vous devez d'abord créer un fichier .env à la racine du répertoire du projet. Une fois créé, vous pouvez copier l'exemple de variables d'environnement depuis le wiki de Phish & Tips ici. Une fois vos variables d'environnement configurées selon vos préférences, vous pouvez passer à la section des profils 😁.

Profils

Le Docker Compose de Phish & Tips contient plusieurs profils différents selon ce que vous souhaitez utiliser. Voici une liste complète des profils actuels :

  • dev (Développement)
  • prod (Production)
  • smtp (SMTP & client mail de P&T)
  • s3 (S3 de P&T)

Pour utiliser un profil, vous devez simplement le déclarer dans la commande docker compose up avec --profile.

Exemple : docker compose --profile dev up [!NOTE] Vous pouvez combiner plusieurs profils à la fois.
Exemple : docker compose --profile prod --profile smtp --profile s3 up

Le profil prod doit toujours être utilisé (sauf si vous êtes en développement, utilisez alors dev) ; cependant, smtp et s3 sont complètement optionnels. Pour plus d'informations sur les Profils Docker, voir ici

Clone this wiki locally