diff --git a/README.md b/README.md index 35060dbc..fed50da8 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,40 @@ -to run from scratch:- -1) sudo docker compose up -d --build -2) if MIH-Minio is not starting correctly run "sudo chown 1001 File_Storage/" in prject folder then run step 1 -3) add access key to MIH-Minio -4) make dev bucket public +

How to create your flavour of the MIH Server

+

Prerequisite:-

+
    +
  1. Ubuntu Server OS installed (24.04 tested)
    2. +
  2. Docker is Installed.
    3. +
  3. Git is Installed.
    4. +
  4. Sudo permission granted.
    5. +
+

Get Started:-

+
    +
  1. Clone Git Repo.
    2. +
  2. Navigate to Mzansi-Innovation-Hub directory. 
    cd Mzansi-Innovation-Hub
    3. +
  3. Start MIH Server
    4. +
      +
    1. Non-Prod: 
      sudo docker compose up -d --build
      2. +
    2. Prod: 
      sudo docker compose --profile prod up -d --build
      3. +
    3. Prod with Letsincrypt certificate Generation: 
      sudo docker compose --profile prod --profile withCert up -d --build
      4. +
    +
  4. Check the status of the new MIH server using Portainer. https://localhost:9443/ (Change Local Host to IP if necessary).
    5. +
      +
    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. +
    +
  5. Set Up MIH-Minio config
    6. +
      +
    1. Access MIH-Minio using https://localhost:9001/login (Change Localhost to IP if necessary).
      2. +
    2. Add/ Generate access key to MIH-Minio.
      3. +
    3. Create a bucket called mih.
      4. +
    4. Non-Prod: make the mih bucket public.
      5. +
    5. Prod: keep the mih bucket private.
      6. +
    +
  6. CONTINUE HERE
    7. +
+ +

How to Stop MIH Server:-

+
    +
  1. Non-Prod: 
    sudo docker compose down
    2. +
  2. Prod: 
    sudo docker compose --profile prod down
    3. +
  3. Prod with Letsincrypt certificate Generation: 
    sudo docker compose --profile prod --profile withCert down
    4. +