From 40a6c5f2542c4d79c05e10fb9d9a37e6c6eda44d Mon Sep 17 00:00:00 2001 From: Colin Griffin Date: Tue, 13 Dec 2022 10:51:21 -0500 Subject: [PATCH] add additional pull instructions and clarify scarf.sh usage --- README.md | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 499b747..6c6d90b 100644 --- a/README.md +++ b/README.md @@ -72,11 +72,21 @@ If you are evaluating Cal.com or running with minimal to no modifications, this Most configurations can be left as-is, but for configuration options see [Important Run-time variables](#important-run-time-variables) below. Update the appropriate values in your .env file, then proceed. - -4. Start Cal.com via docker compose + +4. (optional) Pre-Pull the images by running the following command: + + ```bash + docker compose pull + ``` + + This will use the default image locations as specified by `image:` in the docker-compose.yaml file. + + Note: To aid with support, by default Scarf.sh is used as registry proxy for download metrics. + +5. Start Cal.com via docker compose (Most basic users, and for First Run) To run the complete stack, which includes a local Postgres database, Cal.com web app, and Prisma Studio: - + ```bash docker compose up -d ``` @@ -95,7 +105,7 @@ If you are evaluating Cal.com or running with minimal to no modifications, this **Note: to run in attached mode for debugging, remove `-d` from your desired run command.** -5. Open a browser to [http://localhost:3000](http://localhost:3000), or your defined NEXT_PUBLIC_WEBAPP_URL. The first time you run Cal.com, a setup wizard will initialize. Define your first user, and you're ready to go! +6. Open a browser to [http://localhost:3000](http://localhost:3000), or your defined NEXT_PUBLIC_WEBAPP_URL. The first time you run Cal.com, a setup wizard will initialize. Define your first user, and you're ready to go! ## Updating Cal.com