Getting Started
Phish & Tips, later referred to as P&T, was developed as an all-in-one "BYOS" (Bring Your Own Service) solution, meaning that you can use the solution's built-in SMTP server, mail client and S3 bucket or, as the name suggests, bring/use your own!
Let's start by cloning the project with git clone https://github.com/maximezim/PhishAndTips.git
and moving into the project directory with cd PhishAndTips.
In order to set up your Phish & Tips environment, there are two main steps to follow:
- Defining your Environment Variables
- Choosing your Docker Compose profiles
Every environment is different, this is why environment variables exist (duh) and why Phish & Tips uses them.
In order to set your environment variables, you must first create a .env file at the root of the project directory. Once created, you can copy the environment variables example from the Phish & Tips wiki here.
Once your environment variables are set up to your liking, you may proceed to the profiles section 😁.
Phish & Tips' Docker Compose contains multiple different profiles depending on what you want to use.
Here's a complete list of the current profiles:
-
dev(Development) -
prod(Production) -
smtp(P&T's SMTP & Mail client) -
s3(P&T's S3)
In order to use a profile, you simply have to declare it in the docker compose up command with --profile.
Example:
docker compose --profile dev up[!NOTE] You can combine multiple profiles at once.
Example:docker compose --profile prod --profile smtp --profile s3 up
The prod profile should always be used (unless you are in development, then use dev); however, smtp and s3 are completely optional.
For more information on Docker Profiles, see here
