User Guide

Getting Started

Login via GitHub

1. Navigate to the Vishwakarma dashboard URL
2. Click Sign in with GitHub
3. Authorize the application — your GitHub identity grants you admin access to the console
4. You'll land on the Dashboard showing active environments and security status

Register OCI Credentials

Before provisioning, register your cloud provider credentials:

1. Click Provision New Client on the Dashboard
2. Under OCI Configuration, enter your Tenancy OCID, User OCID, and Fingerprint
3. Paste your OCI Private Key (PEM) in the security section
4. Select the deployment Region (e.g., ap-hyderabad-1)
5. Click Finish & Provision Core to start infrastructure setup

Key Features

One-Click Deploy

• Provision a full cloud stack (VM, DNS, storage) with a single form submission
• Terraform-powered — consistent, repeatable infrastructure
• Pipeline status visible in real-time during provisioning

Auto SSL & Security

• Let's Encrypt SSL certificates auto-provisioned for all services
• Security health monitoring with active/expiring/rotation-due indicators
• Pi-hole DNS-level ad blocking included in every deployment

Monitoring & Management

• Dashboard: Real-time view of all client environments with status badges
• SSH Setup: Generate connection scripts for secure VM access
• Test Connection: Verify VM connectivity before deployment
• Activity Logs: Per-environment deployment history with timestamps

Common Tasks

Provision a New Client Environment

1. Click Provision New Client button on the Dashboard
2. Fill in Client Identity: Company name, email, and OCI region
3. Fill in OCI Configuration: Tenancy OCID, User OCID, Fingerprint
4. Paste the OCI Private Key PEM content
5. Click Finish & Provision Core
6. Monitor the pipeline status — from API → Git → Terraform → OCI → Apps
7. Once status shows Active, generate a secure portal link for the client

Connect via SSH

1. Navigate to SSH Setup in the sidebar
2. Enter an alias for the connection (e.g., "oravm")
3. Enter the VM's public IP address
4. Set the SSH user (default: ubuntu)
5. Upload your SSH private key file
6. Click Generate SSH Script
7. Run the downloaded script on your machine
8. Connect anytime with: ssh <alias>

Test a VM Connection

1. Go to Test Connection in the sidebar
2. Enter the VM's IP address and SSH user
3. Click Run Test — the system verifies reachability and access
4. Review the connectivity report

Generate a Secure Client Portal Link

1. Open a client's detail drawer by clicking their row in the table
2. Click Generate under the Secure Delivery section
3. Copy the generated link — the client uses this to view their credentials
4. Share the link securely with the client

Destroy Infrastructure

1. Open the client detail drawer
2. Click Destroy Infrastructure at the bottom
3. Confirm the action — all cloud resources for that client will be torn down
4. Optionally click Remove Record to delete the database entry separately

Troubleshooting

Issue	Solution
Provisioning stuck on "OCI" step	Check your OCI credentials (Tenancy OCID, User OCID, Fingerprint, Private Key). Verify the key has not expired.
SSH connection refused	Ensure the VM is running and the security list allows ingress on port 22. Use Test Connection to verify.
Portal link shows no data	Re-generate the link from the client drawer. The previous link expires after use.
Dashboard shows no clients	Ensure the worker API is healthy. Check browser console for network errors.
Deployment logs empty	Logs populate during provisioning. Active clients may not have logs until the next event.

Support

• Email: sdachary@gmail.com
• Response time: Within 24 hours on business days
• Emergency: Reply to your provisioning confirmation email with "URGENT" in the subject line