|
|
@@ -206,10 +206,14 @@ sudo apt remove -y docker.io docker-compose docker-compose-v2 docker-doc podman-
|
|
|
```bash
|
|
|
sudo apt update
|
|
|
sudo apt install -y ca-certificates curl
|
|
|
-sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
|
|
|
-echo "deb [arch=\$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu jammy stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
|
|
|
+sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg \
|
|
|
+ -o /etc/apt/keyrings/docker.asc
|
|
|
+echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] \
|
|
|
+https://download.docker.com/linux/ubuntu jammy stable" | \
|
|
|
+sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
|
|
|
sudo apt-get update
|
|
|
-sudo apt-get install -y docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
|
|
|
+sudo apt-get install -y docker-ce docker-ce-cli containerd.io \
|
|
|
+ docker-buildx-plugin docker-compose-plugin
|
|
|
```
|
|
|
|
|
|
### Step 2.3: Start and Enable Docker Daemon
|
|
|
@@ -226,9 +230,23 @@ sudo usermod -aG docker $USER
|
|
|
```
|
|
|
|
|
|
### Step 2.5: Reboot the WSL Instance
|
|
|
-Execute the command below inside WSL to gracefully reboot the instance:
|
|
|
+To reboot the WSL instance, you must shutdown and restart WSL. You can choose one of the following methods:
|
|
|
+
|
|
|
+**Option A: Restart from Windows Host (Recommended & Safest)**
|
|
|
+1. Close your Ubuntu terminal.
|
|
|
+2. Open Windows PowerShell or Command Prompt.
|
|
|
+3. Run the shutdown command:
|
|
|
+ ```powershell
|
|
|
+ wsl --shutdown
|
|
|
+ ```
|
|
|
+4. Re-open your Ubuntu terminal.
|
|
|
+
|
|
|
+**Option B: Restart from inside WSL Terminal**
|
|
|
+If you prefer to trigger the reboot directly from the WSL terminal:
|
|
|
```bash
|
|
|
-cd /mnt/c/ && cmd.exe /c start "rebooting WSL" cmd /c "timeout 5 && wsl -d $WSL_DISTRO_NAME" && wsl.exe --terminate $WSL_DISTRO_NAME
|
|
|
+cd /mnt/c/ && cmd.exe /c start "rebooting WSL" cmd /c \
|
|
|
+ "timeout 5 && wsl -d Ubuntu-22.04" && \
|
|
|
+ wsl.exe --terminate Ubuntu-22.04
|
|
|
```
|
|
|
|
|
|
Upon reconnecting, verify Docker is running by starting the hello-world container:
|
|
|
@@ -250,20 +268,20 @@ sudo update-alternatives --config iptables
|
|
|
### Step 3.2: Configure DNS Settings
|
|
|
To ensure reliable package downloads and LLM registry calls:
|
|
|
```bash
|
|
|
-echo "1,\$ s/^/#/
|
|
|
-\$ a
|
|
|
+echo '1,$ s/^/#/
|
|
|
+$ a
|
|
|
nameserver 1.1.1.1
|
|
|
.
|
|
|
w
|
|
|
-q" | sudo ed /etc/resolv.conf
|
|
|
+q' | sudo ed /etc/resolv.conf
|
|
|
|
|
|
-echo "\$ a
|
|
|
+echo '$ a
|
|
|
# Added these 2 lines:
|
|
|
[network]
|
|
|
generateResolvConf = false
|
|
|
.
|
|
|
-W
|
|
|
-q" | sudo ed /etc/wsl.conf
|
|
|
+w
|
|
|
+q' | sudo ed /etc/wsl.conf
|
|
|
```
|
|
|
|
|
|
---
|
|
|
@@ -271,8 +289,8 @@ q" | sudo ed /etc/wsl.conf
|
|
|
## 4. Repository Clones & Branch Governance
|
|
|
|
|
|
There are two repositories configured for this project:
|
|
|
-- Primary Git Repository: `https://git.btshub.lu/lanfr/LocalFoodAI_lanfr144.git`
|
|
|
-- Alternative Git Repository (Worldwide Access - Clone): `https://github.com/lanfr144/LocalFoodAI_lanfr144.git`
|
|
|
+- Primary Git Repository: https://git.btshub.lu/lanfr/LocalFoodAI_lanfr144.git
|
|
|
+- Alternative Git Repository (Worldwide Access - Clone): https://github.com/lanfr144/LocalFoodAI_lanfr144.git
|
|
|
|
|
|
Clone the primary repository inside your home directory:
|
|
|
```bash
|
|
|
@@ -307,12 +325,13 @@ git remote set-head origin main
|
|
|
|
|
|
Ensure the runbooks and sync scripts have executable permissions:
|
|
|
```bash
|
|
|
-chmod +x data_sync.sh backup_db.sh manage_services.sh scripts/manage_models.sh
|
|
|
+chmod +x data_sync.sh backup_db.sh manage_services.sh \
|
|
|
+ scripts/manage_models.sh
|
|
|
```
|
|
|
|
|
|
Follow the standard runbook to initialize credentials and launch services:
|
|
|
```bash
|
|
|
-# 1. Create a local [.env file](file:///C:/Users/lanfr144/Documents/DOPRO1/Antigravity/Food/.env) based on [step 3 guidelines](#3-network-configuration--performance-tuning)
|
|
|
+# 1. Create a local [.env file](file:///C:/Users/lanfr144/Documents/DOPRO1/Antigravity/Food/.env) based on step 3 guidelines
|
|
|
# 2. Run the service manager to spin up containers
|
|
|
./manage_services.sh start
|
|
|
```
|
|
|
@@ -587,7 +606,15 @@ To prove and guarantee that no clinical user details or dietary profiles leave t
|
|
|
|
|
|
|
|
|
# Documentation Home
|
|
|
-Welcome to the static documentation mirror. Please navigate the markdown files in this directory for architectural diagrams and guides.
|
|
|
+
|
|
|
+Welcome to the static documentation portal. Please navigate the guides below:
|
|
|
+
|
|
|
+- **[Detailed Installation and Deployment Guide](Installation_Guide.md)**
|
|
|
+- **[Clinician User Manual](User_Guide.md)**
|
|
|
+- **[Technical Capstone Document](Technical_Document.md)**
|
|
|
+- **[Agile Scrum Wiki Portal](Scrum_Wiki.md)**
|
|
|
+- **[System Uninstallation Guide](Uninstall_Guide.md)**
|
|
|
+- **[Recommendations for Future Projects](Recommendations.md)**
|
|
|
""",
|
|
|
"Scrum_Wiki.md": """The current version is #ident "@(#)$Format:LocalFoodAI_lanfr144:generate_docs.py:%an:%ae:%ad:%cn:%ce:%cd:%H:%D:%N$"
|
|
|
|
|
|
@@ -600,31 +627,34 @@ Welcome to the static Scrum documentation portal. This master wiki aggregates an
|
|
|
|
|
|
## Sprint Ceremonies & Logs
|
|
|
|
|
|
-### 1. [Sprint Plans (Scrum_Plan.md)](Scrum_Plan.pdf)
|
|
|
+### 1. [Sprint Plans](Scrum_Plan.md)
|
|
|
*Contains Sprint Plan formulations, active user stories selection, scope statements, and team capacity bounds for each milestone loop.*
|
|
|
|
|
|
-### 2. [Daily Scrums (Scrum_Daily.md)](Scrum_Daily.pdf)
|
|
|
+### 2. [Daily Scrums](Scrum_Daily.md)
|
|
|
*Continuous daily stand-up summaries tracking individual task completion, blocker mitigations, and immediate day-to-day coordination.*
|
|
|
|
|
|
-### 3. [Sprint Reviews (Scrum_Review.md)](Scrum_Review.pdf)
|
|
|
+### 3. [Sprint Reviews](Scrum_Review.md)
|
|
|
*Contains sprint review logs, clinician demonstration summaries, feature validation checklists, and stakeholder feedback logs.*
|
|
|
|
|
|
-### 4. [Sprint Retrospectives (Scrum_Retro.md)](Scrum_Retro.pdf)
|
|
|
+### 4. [Sprint Retrospectives](Scrum_Retro.md)
|
|
|
*Reviews process improvements, continuous integration learnings, and action items aimed at optimizing team operations and environment tuning.*
|
|
|
|
|
|
---
|
|
|
|
|
|
## Deliverables & Quality Assurance
|
|
|
|
|
|
-### 5. [Scrum Artifacts (Scrum_Artifacts.md)](Scrum_Artifacts.pdf)
|
|
|
+### 5. [Scrum Artifacts](Scrum_Artifacts.md)
|
|
|
*Indexes sprint velocity metrics, completed story points distributions, burndown coordinates, and final Taiga delivery milestones.*
|
|
|
|
|
|
-### 6. [Sprint 8 Test Cases (Test_Cases_Sprint8.md)](Test_Cases_Sprint8.pdf)
|
|
|
+### 6. [Sprint 8 Test Cases](Test_Cases_Sprint8.md)
|
|
|
*Legacy acceptance test logs covering core NLP chat, portion converters, and initial search validations.*
|
|
|
|
|
|
-### 7. [Uninstallation Guide (Uninstall_Guide.md)](Uninstall_Guide.pdf)
|
|
|
+### 7. [Uninstallation Guide](Uninstall_Guide.md)
|
|
|
*Provides structured procedures to completely remove and tear down all system components from Windows and Linux/WSL environments.*
|
|
|
|
|
|
+### 8. [Recommendations for Future Projects](Recommendations.md)
|
|
|
+*Reflections and guidelines derived from this project's challenges to optimize subsequent deployments, including font selection, git attributes management, and shell formatting.*
|
|
|
+
|
|
|
---
|
|
|
|
|
|
> [!NOTE]
|