From de6f6c3a050789b881171440cc8f79b125a1dfa9 Mon Sep 17 00:00:00 2001 From: yaso-meth <164614470+yaso-meth@users.noreply.github.com> Date: Fri, 9 May 2025 11:31:55 +0200 Subject: [PATCH] Update README.md --- README.md | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index fed50da8..41052eb9 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,29 @@
  1. Clone Git Repo.
  2. Navigate to Mzansi-Innovation-Hub directory.
    cd Mzansi-Innovation-Hub
  3. -
  4. Start MIH Server
  5. +
  6. Create .env file in the same location as docker-compose.yml
    
    +SQL_ROOT_PW=*PASSWORD*
    +SQL_USER=*USER*
    +SQL_USER_PW=*PASSWORD*
    +
    +SUPERTOKENS_DB=supertokens
    +SUPERTOKENS_API_KEY=*API KEY*
    +
    +MINIO_ROOT_USER=*USER*
    +MINIO_ROOT_PW=*PASSWORD*
    +
    +CERTBOT_EMAIL=*ADMIN_EMAIL*
    +CERTBOT_APP_DOMAIN=*APP_DOMAIN*
    +CERTBOT_API_DOMAIN=*API_DOMAIN*
    +CERTBOT_STORAGE_DOMAIN=*STORAGE_DOMAIN*
    +CERTBOT_MONITOR_DOMAIN=*MONITOR_DOMAIN*
    +CERTBOT_AI_DOMAIN=*AI_DOMAIN*
  7. +
  8. Configure MIH-AI.
  9. +
      +
    1. If your server hardware has an Nvidia GPU, follow the instructions below "How to enable MIH-AI GPU usage"
    2. +
    3. If your server hardware does not use an Nvidia GPU, continue with the next step.
    4. +
    +
  10. Start MIH Server.
    1. Non-Prod:
      sudo docker compose up -d --build
    2. Prod:
      sudo docker compose --profile prod up -d --build
    3. @@ -18,8 +40,8 @@
  11. Check the status of the new MIH server using Portainer. https://localhost:9443/ (Change Local Host to IP if necessary).
    1. -
    2. If all containers are running without errors, proceed to step 5 (NOTE: certbot container will stop after running successfully).
    3. -
    4. If MIH-Minio did not start correctly, run sudo chown 1001 File_Storage/ in the project directory, stop MIH Server (see details below), then start from step 3 again.
      sudo chown 1001 File_Storage
    5. +
    6. If all containers are running without errors, proceed to step 5
      (NOTE: certbot container will stop after running successfully).
    7. +
    8. If MIH-Minio did not start correctly, run sudo chown 1001 File_Storage/ in the project directory, stop MIH Server (see details below), then start MIH Server again.
      sudo chown 1001 File_Storage
  12. Set Up MIH-Minio config
    1. @@ -29,12 +51,26 @@
    2. Non-Prod: make the mih bucket public.
    3. Prod: keep the mih bucket private.
    -
  13. CONTINUE HERE
  14. +

How to Stop MIH Server:-

    -
  1. Non-Prod:
    sudo docker compose down
  2. +
  3. Non-Prod: disables Nginx & CertBot container creation.
    sudo docker compose down
  4. Prod:
    sudo docker compose --profile prod down
  5. Prod with Letsincrypt certificate Generation:
    sudo docker compose --profile prod --profile withCert down
+ +

How to enable MIH-AI GPU:-

+
    +
  1. Uncomment the code block in MIH-AI docker-compose.yaml +
    
    +# deploy:
    +# resources:
    +# reservations:
    +# devices:
    +# - driver: nvidia
    +# count: all # or specify a number of GPUs
    +# capabilities: [gpu] +
  2. +