Update README.md

This commit is contained in:
yaso-meth
2025-05-09 11:31:55 +02:00
committed by GitHub
parent 262c357746
commit de6f6c3a05

View File

@@ -10,7 +10,29 @@
<ol>
<li>Clone Git Repo.</li>
<li>Navigate to Mzansi-Innovation-Hub directory. <pre><code>cd Mzansi-Innovation-Hub</code></pre></li>
<li>Start MIH Server</li>
<li>Create .env file in the same location as docker-compose.yml<pre><code>
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*</code></pre></li>
<li>Configure MIH-AI.</li>
<ol>
<li>If your server hardware has an Nvidia GPU, follow the instructions below "How to enable MIH-AI GPU usage"</li>
<li>If your server hardware does not use an Nvidia GPU, continue with the next step.</li>
</ol>
<li>Start MIH Server.</li>
<ol>
<li>Non-Prod: <pre><code>sudo docker compose up -d --build</code></pre></li>
<li>Prod: <pre><code>sudo docker compose --profile prod up -d --build</code></pre></li>
@@ -18,8 +40,8 @@
</ol>
<li>Check the status of the new MIH server using Portainer. <code>https://localhost:9443/</code> (Change Local Host to IP if necessary).</li>
<ol>
<li>If all containers are running without errors, proceed to step 5 (<b>NOTE:</b> certbot container will stop after running successfully).</li>
<li>If MIH-Minio did not start correctly, run <code>sudo chown 1001 File_Storage/</code> in the project directory, stop MIH Server (see details below), then start from step 3 again. <pre><code>sudo chown 1001 File_Storage</code></pre></li>
<li>If all containers are running without errors, proceed to step 5<br>(<b>NOTE:</b> certbot container will stop after running successfully).</li>
<li>If MIH-Minio did not start correctly, run <code>sudo chown 1001 File_Storage/</code> in the project directory, stop MIH Server (see details below), then start MIH Server again. <pre><code>sudo chown 1001 File_Storage</code></pre></li>
</ol>
<li>Set Up MIH-Minio config</li>
<ol>
@@ -29,12 +51,26 @@
<li>Non-Prod: make the mih bucket public.</li>
<li>Prod: keep the mih bucket private.</li>
</ol>
<li>CONTINUE HERE</li>
</ol>
<h2>How to Stop MIH Server:-</h2>
<ol>
<li>Non-Prod: <pre><code>sudo docker compose down</code></pre></li>
<li>Non-Prod: disables Nginx & CertBot container creation.<pre><code>sudo docker compose down</code></pre></li>
<li>Prod: <pre><code>sudo docker compose --profile prod down</code></pre></li>
<li>Prod with Letsincrypt certificate Generation: <pre><code>sudo docker compose --profile prod --profile withCert down</code></pre></li>
</ol>
<h2>How to enable MIH-AI GPU:-</h2>
<ol>
<li> Uncomment the code block in MIH-AI docker-compose.yaml
<pre><code>
# deploy:<br>
# resources:<br>
# reservations:<br>
# devices:<br>
# - driver: nvidia<br>
# count: all # or specify a number of GPUs<br>
# capabilities: [gpu]
</code></pre></li>
</ol>