Update README.md

valyu-network · Apr 21, 2024 · df613fa · df613fa
1 parent ce1cfe5
commit df613fa
Showing 1 changed file with 52 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -82,6 +82,58 @@ This collection includes detailed requests and responses for each endpoint, help
 - **Resolve DID (POST /resolveDID)**: Resolve a DID and retrieve the associated DID document.
   - Request Body: `did` (required).
   - Success Response: Returns the resolved DID document.
+
+Here's a restructured version of the Docker Deployment section that emphasizes pulling the image from DockerHub first, followed by instructions on how to build and run the application locally while specifying the `KMS_SECRET_KEY` as an environment variable:
+
+## Docker Deployment 🐳
+
+This section outlines how to deploy the ValyuDID application using Docker, either by pulling a pre-built image from DockerHub or by building and running a Docker container locally.
+
+### Pulling the Docker Image from DockerHub
+
+To get started quickly without building the image yourself, you can pull the pre-built Docker image from DockerHub:
+
+```bash
+docker pull yorkeccak/valyudid:0.1-beta
+```
+
+### Running the Docker Container
+
+After pulling the image from DockerHub, you can run the application as follows:
+
+```bash
+docker run -p 3000:3000 -e KMS_SECRET_KEY=Your_Secret_Key yorkeccak/valyudid:0.1-beta
+```
+
+This command starts a container from the `yorkeccak/valyudid:0.1-beta` image, maps port 3000 inside the container to port 3000 on your host, and sets the `KMS_SECRET_KEY` environment variable required for the application to function properly. Access the application via `http://localhost:3000`.
+
+### Building the Docker Image Locally
+
+If you prefer to build the Docker image yourself, especially for development or modifications, follow these steps:
+
+**Build the Docker Image:**
+
+```bash
+docker build -t valyudid .
+```
+
+This command builds a Docker image named `valyudid` based on the instructions in your Dockerfile.
+
+**Run the Docker Container:**
+
+```bash
+docker run -p 3000:3000 -e KMS_SECRET_KEY=Your_Secret_Key valyudid
+```
+
+This command runs your locally built image with the necessary `KMS_SECRET_KEY` set as an environment variable. This setup is crucial for managing cryptographic operations within Veramo used in the application.
+
+### DockerHub
+
+For ease of access and deployment, you can find the Docker image on DockerHub:
+
+[DockerHub: yorkeccak/valyudid](https://hub.docker.com/repository/docker/yorkeccak/valyudid/general)
+
+This configuration ensures that both quick deployments using DockerHub and customized local builds are possible, providing flexibility for different deployment scenarios.
 
 ## Contributing 🤝
 
@@ -99,23 +151,6 @@ We welcome contributions from the community! Please follow these steps:
 - Keep functions small and focused.
 - Document your code where necessary.
 
-### Docker Image 🐳
-
-For deploying using Docker, the Valyu-DID Docker image is available on DockerHub:
-
-[DockerHub: yorkeccak/valyu-did](https://hub.docker.com/repository/docker/yorkeccak/valyu-did/general)
-
-## Docker Deployment 🐳
-
-This project includes a Dockerfile for building and running the app in a containerized environment. To build and run the Docker container, use:
-
-```bash
-docker build -t valyudid .
-docker run -p 3000:3000 valyudid
-```
-
-This will expose the application on port 3000, accessible via `http://localhost:3000`.
-
 ## License 📄
 
 This project is currently unlicensed and proprietary. Please contact us for any inquiries regarding usage or licensing.