From bafef14649994e46fd9125eaa7e8566660b3b5f0 Mon Sep 17 00:00:00 2001
From: Daniele Valverde <34126648+danielevalverde@users.noreply.github.com>
Date: Fri, 11 Oct 2024 12:36:58 -0300
Subject: [PATCH] Update README.md (#2157)

Add missing steps to run media similarity tests locally
---
 README.md | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/README.md b/README.md
index ff9fd4183e..e02ae27961 100644
--- a/README.md
+++ b/README.md
@@ -83,6 +83,9 @@ Then publish it to npm. Name the module `@meedan/name-of-my-module` (in its
 * Copy `test/config.yml.example` to `test/config.yml` and set the configurations
 * Copy `config.js.example` to `test/config.js` and set the configurations
 * Copy `config.js.example` to `config.js` and set the configurations
+* Additional configuration steps to run media similarity tests
+  - Start Ngrok: `ngrok http 9000`
+  - Add the public URL generated by ngrok (e.g., https://c239-152-233-241-217.ngrok-free.app) to the `similarity_media_file_url_host` in the Check API config file: https://github.com/meedan/check-api/blob/develop/config/config.yml.example#L47
 * Start the test environment in the [check](https://github.com/meedan/check) repository: `docker-compose -f docker-compose.yml -f docker-test.yml up`
 * Start the nginx proxy for `web` and `chromedriver` containers
 * `docker-compose exec web service nginx start`