From cac8b475a3143d2a4b9249c565aca00750cca262 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Martin=20Kol=C3=A1rik?= Date: Sat, 11 Jan 2025 17:06:34 +0100 Subject: [PATCH] docs: host mode --- CONTRIBUTING.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2035484e..3c0c147a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -17,9 +17,10 @@ The API uses 3000 port by default. This can be overridden by `PORT` environment You can run the project by following these steps: 1. Clone this repository. -2. `docker compose -f docker-compose.dev.yml up -d` - Run Redis and MariaDB -3. `npm install && npm run download:files` -4. Run `npm run start:dev` +2. [Enable host networking in Docker Desktop](https://docs.docker.com/engine/network/drivers/host/#docker-desktop) if you haven't already. +3. `docker compose -f docker-compose.dev.yml up -d` - Run Redis and MariaDB +4. `npm install && npm run download:files` +5. Run `npm run start:dev` Once the API is live, you can spin up a probe instance by running as described at https://github.com/jsdelivr/globalping-probe/blob/master/CONTRIBUTING.md.