Add live URL to README

2026-05-19 04:04:25 +02:00 · 2026-05-19 04:04:25 +02:00 · 14d69c0fe6
commit 14d69c0fe6
parent 295209d4f0
1 changed files with 82 additions and 59 deletions
--- a/sk1/README.md
+++ b/sk1/README.md
@ -1,6 +1,17 @@
 # Task Manager — Cloud Deployment (SK1)

-A full-stack task management web application deployed to **Microsoft Azure** using Docker Compose.
+**🌐 Live Application:** [https://taskmanager-gs699he.swedencentral.cloudapp.azure.com](https://taskmanager-gs699he.swedencentral.cloudapp.azure.com)
+
+## 📖 Application Description
+The **Task Manager** is a full-stack web application designed for creating, tracking, updating, and deleting tasks. It is intended for individuals needing a responsive, simple interface for personal productivity. It features a modern Single-Page Application frontend, a Node.js REST API backend, and uses PostgreSQL for reliable data storage and Redis for high-speed caching.
+
+## ☁️ Cloud & Architecture Description
+The application is deployed to **Microsoft Azure** using the "Azure for Students" subscription.
+- **Public Cloud:** Microsoft Azure (deployed in the `swedencentral` region).
+- **Cloud Services:** Azure Virtual Machines (Standard_B2ts_v2), Azure Public IP Addresses, Azure Network Security Groups (allowing ports 80/443/22).
+- **Docker Objects:** Docker Compose orchestration, 5 distinct Docker containers.
+- **Persistent Volumes:** Two Docker named volumes (`pgdata` and `redisdata`) to ensure data is preserved across container restarts. `caddy_data` and `caddy_config` for TLS certificates.
+- **Databases:** **PostgreSQL 16** serves as the primary relational database, and **Redis 7** acts as an in-memory cache.

 ## 🏗️ Architecture

@ -14,89 +25,100 @@ A full-stack task management web application deployed to **Microsoft Azure** usi
 | **PostgreSQL** | postgres:16-alpine | 5432 | Persistent relational database |
 | **Redis** | redis:7-alpine | 6379 | In-memory cache |

-## 🚀 Quick Deploy
+## 🚀 Quick Deploy & Usage Instructions

+### Pre-conditions for scripts
+The `prepare-app.sh` and `remove-app.sh` scripts require the following conditions:
+1. You must be authenticated to Azure via the Azure CLI (`az login`).
+2. You must have an active "Azure for Students" (or Pay-As-You-Go) subscription.
+3. The `.env` file must exist and contain the required variables (specifically `POSTGRES_PASSWORD`).
+4. The system running the script must have `ssh` and `scp` installed.
+
+### Deployment Steps
 ```bash
-# 1. Login to Azure (requires Azure for Students subscription)
+# 1. Login to Azure
 az login

-# 2. Clone and configure
+# 2. Clone the repository
 git clone git@git.kemt.fei.tuke.sk:gs699he/zkt26.git
 cd zkt26/sk1
+
+# 3. Configure environment
 cp env.example .env
-nano .env    # Set POSTGRES_PASSWORD, optionally change DNS_LABEL
+nano .env    # Set POSTGRES_PASSWORD

-# 3. Deploy (creates VM, installs Docker, starts containers)
+# 4. Deploy (Fully automated, no web GUI interaction required)
 ./prepare-app.sh
-
-# 4. Visit: https://taskmanager-gs699he.westeurope.cloudapp.azure.com
 ```

+### How to View and Use the Application
+1. Open a web browser.
+2. Navigate to the HTTPS URL provided at the end of the deployment script (e.g., `https://taskmanager-gs699he.swedencentral.cloudapp.azure.com`).
+3. You will see the Task Manager interface where you can add new tasks, mark them as complete, and delete them. The HTTPS certificate is automatically negotiated and secured.
+
 ## 🗑️ Remove (after exam)

 ```bash
 ./remove-app.sh    # Deletes entire resource group (VM, IP, disk)
 ```

-## 💾 Backup & Logs
+## 💾 Backup & Access Logs

+### How to Perform a Data Backup
+You can backup the database from the cloud server to your local machine by running:
 ```bash
-./backup-db.sh              # Download database dump
-./view-logs.sh              # All container logs
-./view-logs.sh --api -f     # Follow API logs in real-time
+./backup-db.sh
 ```
+This script securely connects to the VM, executes `pg_dump`, and downloads a `.sql` backup file to your local `backups/` folder.

-## 📁 Project Structure
-
-```
-sk1/
-├── api/                        # Node.js REST API
-│   ├── Dockerfile
-│   ├── server.js               # Express + CRUD routes
-│   ├── db.js                   # PostgreSQL pool
-│   └── package.json
-├── frontend/                   # Web UI
-│   ├── Dockerfile
-│   ├── nginx.conf
-│   └── public/ (index.html, style.css, app.js)
-├── db/init.sql                 # Database schema
-├── caddy/Caddyfile             # HTTPS proxy config
-├── docs/
-│   ├── architecture.png        # Architecture diagram
-│   ├── documentation.tex       # LaTeX source
-│   └── documentation.pdf       # 9-page PDF report
-├── docker-compose.yaml         # 5-service orchestration
-├── cloud-init.yaml             # VM bootstrap (Docker install)
-├── prepare-app.sh              # Azure deployment script
-├── remove-app.sh               # Azure teardown script
-├── backup-db.sh                # Database backup
-├── view-logs.sh                # Access log viewer
-├── env.example                 # Environment template
-├── .gitignore
-└── README.md
+### How to View Access Records from the Internet
+To view the HTTP/HTTPS access logs of traffic coming from the internet, run the following script:
+```bash
+./view-logs.sh --caddy
 ```
+This securely fetches the proxy logs from the Caddy container, showing IP addresses, request paths, and HTTP statuses.

-## ⚙️ Configuration
+## 📁 Project Structure & Uploaded Files

-| Variable | Description | Default |
-|----------|-------------|---------|
-| `POSTGRES_PASSWORD` | Database password | *(required)* |
-| `AZURE_RESOURCE_GROUP` | Azure resource group | taskmanager-rg |
-| `AZURE_LOCATION` | Azure region | westeurope |
-| `AZURE_VM_SIZE` | VM size | Standard_B1s |
-| `AZURE_DNS_LABEL` | DNS label for URL | taskmanager-gs699he |
+- **`prepare-app.sh`**: Shell script for automatically provisioning the Azure VM, opening ports, installing Docker, uploading files, and starting all services.
+- **`remove-app.sh`**: Shell script to completely delete the Azure Resource Group, eliminating the application and all associated costs.
+- **`backup-db.sh`**: Script to connect to the running database container via SSH and download a `.sql` backup.
+- **`view-logs.sh`**: Script to securely read Docker container logs (including internet access logs) from the Azure VM.
+- **`docker-compose.yaml`**: The main configuration file defining the 5-container architecture, networking, and volumes.
+- **`cloud-init.yaml`**: Cloud-init configuration used by Azure during VM creation to automatically install Docker.
+- **`env.example`**: Template for environment configuration.
+- **`api/`**: Contains the Node.js backend source code (`server.js`, `db.js`), `package.json`, and the `Dockerfile` for the API container.
+- **`frontend/`**: Contains the static web files (`index.html`, `style.css`, `app.js`), Nginx reverse-proxy configuration (`nginx.conf`), and the `Dockerfile`.
+- **`caddy/Caddyfile`**: Configuration for the Caddy web server to handle reverse-proxying and automatic TLS/HTTPS.
+- **`db/init.sql`**: SQL script containing the initial database schema to create the tasks table.

-## 💰 Cost (Azure for Students)
+## ⚙️ Configuration Description

-| Resource | Monthly Cost |
+The application relies completely on file-based and environment-based configuration:
+- **Environment Variables (`.env`)**: Used to configure database passwords, hostnames, and Azure deployment parameters (Location, VM Size, DNS). Secrets are injected dynamically and excluded from Git.
+- **Docker Compose (`docker-compose.yaml`)**: Declares container dependencies, restart policies (`restart: always`), and volume mounts.
+- **Nginx & Caddy configs**: Define routing rules without requiring manual web interface interaction.
+
+| Variable | Description |
 |----------|-------------|
-| VM (Standard_B1s) | ~$7.59 |
-| Public IP | ~$3.00 |
-| Disk (30 GB) | ~$1.20 |
-| TLS (Let's Encrypt) | Free |
-| **Total** | **~$11.79/mo** |
+| `POSTGRES_PASSWORD` | Database password (Secret, not in git) |
+| `AZURE_RESOURCE_GROUP` | Azure resource group (taskmanager-rg6) |
+| `AZURE_LOCATION` | Azure region (swedencentral) |
+| `AZURE_VM_SIZE` | VM size (Standard_B2ts_v2) |
+| `AZURE_DNS_LABEL` | DNS label for public URL |

-> 💡 Azure for Students gives $100 free credit — enough for ~8 months.
+## 💰 1-Year Cost Analysis (1000 users/day & 50GB Database)
+
+If the application scales to 1,000 daily users and requires 50 GB of persistent storage, the infrastructure costs for **one year** of operation on Azure are calculated as follows:
+
+| Cloud Resource | Price / Billing Interval | Total Annual Cost |
+|----------------|--------------------------|-------------------|
+| **Azure VM (Standard_B2ts_v2)** | ~$14.16 / month | **$169.92** |
+| **Disk (64 GB Premium SSD P6)** | ~$9.60 / month | **$115.20** |
+| **Public IPv4 Address** | ~$3.00 / month | **$36.00** |
+| **Bandwidth (Data Transfer Out)** | First 100 GB/month is Free. 1000 users × 1MB = 1GB/day ≈ 30 GB/month. | **$0.00** |
+| **TLS/SSL Certificates (Let's Encrypt)** | Free | **$0.00** |
+| **Total Estimated Cost** | | **~$321.12 / year** |

 ## 🔒 Security

@ -106,10 +128,11 @@ sk1/
 - Security headers in Nginx
 - Auto-restart on failure

-## 🤖 AI Declaration
+## 🤖 External Resources & Generative AI Usage

- **Google Antigravity (Gemini)**: Scripts, Docker config, LaTeX docs, diagram
- All code reviewed and adapted by student
+- **Google Antigravity (Gemini 2.5 Pro)**: Used via the Deepmind MCP IDE integration as a pair-programming assistant.
+- **Method of Use**: The generative model was used to rapidly scaffold the `docker-compose.yaml`, generate the architecture diagram, scaffold shell scripts (`prepare-app.sh`, `backup-db.sh`), and write the LaTeX report structure.
+- **Verification**: All outputs were thoroughly reviewed, manually tested, and adjusted to guarantee security and strict compliance with assignment requirements. No sensitive API keys or credentials were sent to or generated by the AI in a public context.

 ---