sb693yd/ZKT26
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update SK1/README.md

Browse Source
This commit is contained in:
Sarukesh Boominathan 2026-05-12 13:33:52 +00:00
parent e581827e42
commit a572a44c77
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
SK1/README.md
View File

@ -94,7 +94,7 @@ sk1/
│ ├── remove-app.sh # Teardown script — stops containers + deletes all Azure resources │ ├── remove-app.sh # Teardown script — stops containers + deletes all Azure resources
│ └── backup.sh # pg_dump → Azure Blob Storage │ └── backup.sh # pg_dump → Azure Blob Storage
├── docker-compose.yml # Defines frontend, backend, redis services ├── docker-compose.yml # Defines frontend, backend, redis services
├── .env.example # Template for environment variables (safe to commit) ├── .env # Template for environment variables (safe to commit)
├── .gitignore # Excludes .env, node_modules, __pycache__, dist ├── .gitignore # Excludes .env, node_modules, __pycache__, dist
└── README.md # This file └── README.md # This file
``` ```
@ -112,7 +112,6 @@ All configuration is done via environment variables in the `.env` file. This fil
| `SECRET_KEY` | Used to salt password hashes | | `SECRET_KEY` | Used to salt password hashes |
| `DB_PASS` | PostgreSQL admin password (used by backup script) | | `DB_PASS` | PostgreSQL admin password (used by backup script) |
Copy `.env.example` to `.env` and fill in your values before running any scripts.
--- ---
@ -153,7 +152,7 @@ Stops all containers and deletes the entire Azure resource group (VM, database,
## Using the Application ## Using the Application
1. Open the app URL in a browser (`https://yourdomain.com`) 1. Open the app URL in a browser (`https://project.sarukesh.uk`)
2. Enter a title, paste your code or text into the editor 2. Enter a title, paste your code or text into the editor
3. Select the language for syntax highlighting 3. Select the language for syntax highlighting
4. Choose an expiry time (or never) 4. Choose an expiry time (or never)
@ -214,7 +213,7 @@ Cloudflare dashboard → your domain → **Analytics** tab shows:
### From Nginx (per-request logs) ### From Nginx (per-request logs)
```bash ```bash
ssh azureuser@YOUR_VM_IP ssh azureuser@40.118.12.245
docker logs pastevault-frontend docker logs pastevault-frontend
``` ```
@ -266,4 +265,4 @@ The biggest cost saving in this architecture is using Cloudflare as the HTTPS/CD
| highlight.js | Open source library | Client-side syntax highlighting for 15 languages | | highlight.js | Open source library | Client-side syntax highlighting for 15 languages |
| Azure CLI documentation | Official docs | VM, PostgreSQL, and storage provisioning commands | | Azure CLI documentation | Official docs | VM, PostgreSQL, and storage provisioning commands |
| Docker documentation | Official docs | Multi-stage Dockerfile, Compose configuration | | Docker documentation | Official docs | Multi-stage Dockerfile, Compose configuration |
| **Claude (Anthropic)** | Generative AI | Used to generate application code, Dockerfiles, deployment scripts, and this documentation. All output reviewed and tested manually. | | **Claude (Anthropic)** | Used to generate application code and all output reviewed and tested manually. |