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. -
  3. Start MIH Server
    4. +
  4. 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*
    5. +
  5. Configure MIH-AI.
    6. +
      +
    1. If your server hardware has an Nvidia GPU, follow the instructions below "How to enable MIH-AI GPU usage"
      2. +
    2. If your server hardware does not use an Nvidia GPU, continue with the next step.
      3. +
    +
  6. 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 @@
  7. Check the status of the new MIH server using Portainer. https://localhost:9443/ (Change Local Host to IP if necessary).
      8. -
    1. If all containers are running without errors, proceed to step 5 (NOTE: certbot container will stop after running successfully).
      2. -
    2. 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
      3. +
    3. If all containers are running without errors, proceed to step 5
      (NOTE: certbot container will stop after running successfully).
      4. +
    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 MIH Server again. 
      sudo chown 1001 File_Storage
  8. Set Up MIH-Minio config
      9. @@ -29,12 +51,26 @@
    1. Non-Prod: make the mih bucket public.
    2. Prod: keep the mih bucket private.
    -
  9. CONTINUE HERE
    10. +

How to Stop MIH Server:-

    -
  1. Non-Prod: 
    sudo docker compose down
    2. +
  2. Non-Prod: disables Nginx & CertBot container creation.
    sudo docker compose down
  3. Prod: 
    sudo docker compose --profile prod down
  4. 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. +