From 582f2b4018933de53d5b9b05e6bab36762ebfec4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ma=C3=ABl=20Gangloff?= Date: Mon, 12 Aug 2024 17:08:39 +0200 Subject: [PATCH] docs: update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Maël Gangloff --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index cd5097c..0410bf2 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,19 @@ Although the RDAP and WHOIS protocols allow you to obtain precise information ab perform a reverse search to discover a list of domain names associated with an entity. Additionally, accessing a detailed history of events (ownership changes, renewals, etc.) is not feasible with these protocols. +## Install +For more details on the installation procedure, please refer to [INSTALL.md](/INSTALL.md). This project is compatible with Docker. +1. Clone the GitHub repository +2. Build the Docker image locally + ```shell + docker compose -f compose.yaml -f compose.prod.yaml build --pull --no-cache + ``` +3. Modify environment variables and add static files to customize your instance +4. Start the project in production environment + ```shell + docker compose -f compose.yaml -f compose.prod.yaml up + ``` + ## How it works? ### RDAP search