updated docs

Stephen G. Pope · Stephen G. Pope · commit a7e14f70028c · 2025-04-20T14:36:58.000-07:00
diff --git a/README.md b/README.md
@@ -187,146 +187,22 @@ Each endpoint is supported by robust payload validation and detailed API documen
 
 ---
 
-# Installing on the Google Cloud Platform (GCP)
+## Installation Guides
 
-## 🎥 Video Instructions
+This API can be deployed to various cloud platforms:
 
-Watch **[Detailed Video Instructions](https://youtu.be/6bC93sek9v8)** to set up the No-Code Architects Toolkit API.
+- [Google Cloud Platform (GCP) Installation Guide](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/cloud-installation/gcp.md) - Deploy the API on Google Cloud Run
+- [Digital Ocean Installation Guide](https://github.com/stephengpope/no-code-architects-toolkit/blob/main/docs/cloud-installation/do.md) - Deploy the API on Digital Ocean App Platform
 
-- Use the **Docker Image** below:
+## Testing the API
 
-  ```
-  stephengpope/no-code-architects-toolkit:latest
-  ```
-
-### Video Resources
-
-- **[Postman Template](https://bit.ly/49Gkh61)**
-- **[NCA Toolkit API GPT](https://bit.ly/4feDDk4)** 
-
-Or use the guide below walks you through the steps to install the NCA Toolkit API on GCP.
-
----
-
-## **Prerequisites**
-- A Google Cloud account. [Sign up here](https://cloud.google.com/) if you don't already have one.
-  - New users receive $300 in free credits.
-- Basic knowledge of GCP services such as Cloud Run and Cloud Storage.
-- A terminal or code editor for managing files.
-
----
-
-## **Step 1: Create a Google Cloud Project**
-1. Log into the [GCP Console](https://console.cloud.google.com/).
-2. Click on the **Project Selector** in the top navigation bar and select **New Project**.
-3. Enter a project name, such as `NCA Toolkit Project`.
-4. Click **Create**.
-
----
-
-## **Step 2: Enable Required APIs**
-Enable the following APIs:
-- **Cloud Storage API**
-- **Cloud Storage JSON API**
-- **Cloud Run API**
-
-### **How to Enable APIs:**
-1. In the GCP Console, navigate to **APIs & Services** > **Enable APIs and Services**.
-2. Search for each API, click on it, and enable it.
-
----
-
-## **Step 3: Create a Service Account**
-1. Navigate to **IAM & Admin** > **Service Accounts** in the GCP Console.
-2. Click **+ Create Service Account**.
-   - Enter a name (e.g., `NCA Toolkit Service Account`).
-3. Assign the following roles to the service account:
-   - **Storage Admin**
-   - **Viewer**
-4. Click **Done** to create the service account.
-5. Open the service account details and navigate to the **Keys** tab.
-   - Click **Add Key** > **Create New Key**.
-   - Choose **JSON** format, download the file, and store it securely.
-
----
-
-## **Step 4: Create a Cloud Storage Bucket**
-1. Navigate to **Storage** > **Buckets** in the GCP Console.
-2. Click **+ Create Bucket**.
-   - Choose a unique bucket name (e.g., `nca-toolkit-bucket`).
-   - Leave default settings, but:
-     - Uncheck **Enforce public access prevention**.
-     - Set **Access Control** to **Uniform**.
-3. Click **Create** to finish.
-4. Go to the bucket permissions, and add **allUsers** as a principal with the role:
-   - **Storage Object Viewer**.
-5. Save changes.
-
----
-
-## **Step 5: Deploy on Google Cloud Run**
-
-### 1. Navigate to Cloud Run
-- Open the **Cloud Run** service in the **Google Cloud Console**.
-
-### 2. Create a New Service
-- Click **Create Service**.
-- Then **Deploy one revision from Docker Hub using the image below**:
-
-  ```
-  stephengpope/no-code-architects-toolkit:latest
-  ```
-
-### 3. Allow Unauthenticated Invocations
-- Check the box to **allow unauthenticated invocations**.
-
-### 4. Configure Resource Allocation
-- Set **Memory**: `16 GB`.
-- Set **CPU**: `4 CPUs`.
-- Set **CPU Allocation**: **Always Allocated**.
-
-### 5. Adjust Scaling Settings
-- **Minimum Instances**: `0` (to minimize cost during idle times).
-- **Maximum Instances**: `5` (adjustable based on expected load).
-
-### 6. Use Second-Generation Servers
-- Scroll to **Platform Version** and select **Second Generation**.
-- Second-generation servers offer better performance and feature support for advanced use cases.
-
-### 7. Add Environment Variables
-- Add the following environment variables:
-- `API_KEY`: Your API key (e.g., `Test123`).
-- `GCP_BUCKET_NAME`: The name of your Cloud Storage bucket.
-- `GCP_SA_CREDENTIALS`: The JSON key of your service account.
-  - Paste the **entire contents** of the downloaded JSON key file into this field.
-  - Ensure:
-    - Proper JSON formatting.
-    - No leading or trailing spaces.
-
-### 8. Configure Advanced Settings
-- Set the **Container Port**: Default to `8080`.
-- **Request Timeout**: `300 seconds` (to handle long-running requests).
-- Enable **Startup Boost** to improve performance for the first request after a cold start.
-
-### 9. Deploy the Service
-- Verify all settings and click **Create**.
-- The deployment process might take a few minutes. Once completed, a green checkmark should appear in the Cloud Run dashboard.
-
-By following these steps, the NCA Toolkit will be successfully deployed and accessible via Google Cloud Run with second-generation servers for optimal performance.
-
----
-
-## **Step 6: Test the Deployment**
-
-1. Install **[Postman Template](https://bit.ly/49Gkh61)** on your computer.
-2. Import the API example requests from the NCA Toolkit GitHub repository.
-3. Configure two environment variables in Postman:
-   - `base_url`: Your deployed Cloud Run service URL.
-   - `x-api-key`: The API key you configured in **Step 5**.
-4. Use the example requests to validate that the API is functioning correctly.
-5. Use the **[NCA Toolkit API GPT](https://bit.ly/4feDDk4)** to learn more.
-
-By following these steps, your NCA Toolkit API should be successfully deployed on Google Cloud Platform.
+1. Install the **[Postman Template](https://bit.ly/49Gkhl)** on your computer
+2. Import the API example requests from the template
+3. Configure your environment variables in Postman:
+   - `base_url`: Your deployed API URL
+   - `x-api-key`: Your API key configured during installation
+4. Use the example requests to validate that the API is functioning correctly
+5. Use the **[NCA Toolkit API GPT](https://bit.ly/4feDDk4)** to explore additional features
 
 ---
 
diff --git a/docs/cloud-installation/do.md b/docs/cloud-installation/do.md
@@ -0,0 +1,109 @@
+# Installing on Digital Ocean
+
+This guide walks you through deploying the No-Code Architects Toolkit API on Digital Ocean's App Platform.
+
+## Prerequisites
+
+- A Digital Ocean account ([Sign up here](https://www.digitalocean.com/))
+- Basic familiarity with Digital Ocean App Platform
+- A credit/debit card for billing (you'll only be charged for what you use)
+
+## Step 1: Create a New Project
+
+1. Sign in to your Digital Ocean account
+2. Create a new project or select an existing one
+3. This will organize your resources for the NCA Toolkit
+
+## Step 2: Create a Digital Ocean Space
+
+You'll need to create a Space (Digital Ocean's object storage) for the toolkit to store processed files:
+
+1. Navigate to **Spaces Object Storage** in the Digital Ocean dashboard
+2. Click **Create a Space**
+3. Select a region (e.g., New York)
+4. Give your bucket a name (e.g., `nca-toolkit-bucket`)
+5. Select your project
+6. Click **Create Space**
+
+## Step 3: Generate API Keys for Your Space
+
+1. From your new Space, go to **Settings**
+2. Click **Create Access Key**
+3. Select **Full Access**
+4. Give your key a name (e.g., `nca-toolkit-key`)
+5. Click **Create Access Key**
+6. **IMPORTANT**: Save both the Access Key and Secret Key shown - you will only see them once!
+7. Also copy the Space URL (endpoint) for use in the next step
+
+## Step 4: Deploy the App
+
+1. From your Digital Ocean dashboard, click **Create** and select **App**
+2. Choose **Container Image** as the deployment source
+3. Select **Docker Hub** for the repository
+4. Enter `stephengpope/no-code-architects-toolkit` as the image name
+5. Enter `latest` for the image tag
+6. Click **Next**
+7. If needed, edit the name to remove any extra dashes (Digital Ocean may show an error for long names)
+8. Choose **Web Service** as the service type
+
+## Step 5: Configure Resources
+
+1. Select a plan with adequate resources for your needs:
+   - For testing, a $50/month instance provides good performance
+   - For smaller workloads, you can select a smaller instance
+   - Note: You're only charged for the time the server is running
+2. Set Containers to 1
+3. Close the resource selection dialog
+
+## Step 6: Configure Environment Variables
+
+Add the following environment variables exactly as shown (be careful with underscores vs. dashes and avoid any leading/trailing spaces):
+
+1. `API_KEY`: Your API key (e.g., `test123` for testing - change for production)
+2. `S3_ENDPOINT_URL`: The URL of your Space (copied from Step 3)
+3. `S3_ACCESS_KEY`: The access key from Step 3
+4. `S3_SECRET_KEY`: The secret key from Step 3
+5. `S3_BUCKET_NAME`: The name of your Space bucket (e.g., `nca-toolkit-bucket`)
+6. `S3_REGION`: The region code of your Space (e.g., `NYC3` for New York)
+
+## Step 7: Finalize and Deploy
+
+1. For Deployment Region, select a region close to your location (e.g., San Francisco)
+2. You can use the default app name or choose a custom name
+3. Click **Create Resource**
+4. Wait for the deployment to complete (this may take a few minutes)
+   - You may need to refresh the page to see updates
+
+## Step 8: Test Your Deployment
+
+### Using Postman
+
+1. Sign up for or log in to [Postman](https://www.postman.com/)
+2. Import the [NCA Toolkit Postman Collection](https://bit.ly/49Gkh61)
+3. Fork the collection to your workspace
+4. Create a new environment:
+   - Name it "Digital Ocean" or similar
+   - Add a variable `x-api-key` with the value matching your API_KEY (e.g., `test123`)
+   - Add a variable `base_url` with the value of your app's URL (shown in the Digital Ocean dashboard)
+   - Save the environment
+5. In the collection, navigate to the `toolkit/authenticate` endpoint and click Send
+6. If you receive a success response, your deployment is working correctly
+7. Then test the `toolkit/test` endpoint to verify complete functionality
+
+## Monitoring and Management
+
+- **Overview**: View basic information about your app
+- **Insights**: Monitor CPU and memory usage
+- **Runtime Logs**: View logs of API calls and server activity
+- **Console**: Access the server's command line (rarely needed)
+- **Settings**: Modify your app's configuration
+
+## Next Steps
+
+Now that you have successfully deployed the NCA Toolkit API, you can:
+- Explore all the available endpoints in the Postman collection
+- Integrate the API with your applications
+- Consider securing your API key with a more complex value
+- Scale your resources up or down based on your usage requirements
+
+Remember, Digital Ocean charges based on usage, so you can always delete the app when you're not using it to save costs.
diff --git a/docs/cloud-installation/gcp.md b/docs/cloud-installation/gcp.md
