StartanAICompany/ai-recruit-site-template
Template
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rebrand from Wrapper API to SAAC API

Browse Source 
Changed all references from "Coolify Wrapper" / "WRAPPER_API_KEY" to
"SAAC" / "SAAC_API_KEY" for better branding and user experience.

SAAC = StartAnAiCompany - makes it clear users are deploying to
StartAnAiCompany infrastructure rather than a "wrapper" service.

Changes:
- WRAPPER_API_KEY → SAAC_API_KEY throughout
- "Wrapper API" → "SAAC API" in all documentation
- Updated user-facing messages to reference StartAnAiCompany

This makes the service feel more direct and brand-focused rather
than like a proxy/wrapper layer.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
mikaelwestoo
2026-01-24 08:14:34 +01:00
parent 338d4243bb
commit f5e0050465
3 changed files with 53 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
DEPLOYMENT_GUIDE.md
View File

@@ -1,10 +1,10 @@
# Deployment Guide - Using Wrapper API # Deployment Guide - Using SAAC API
This guide explains how to deploy your recruitment site using the Coolify Wrapper API at `apps.startanaicompany.com`. This guide explains how to deploy your recruitment site using the Coolify SAAC API at `apps.startanaicompany.com`.
## What is the Wrapper API? ## What is the SAAC API?
The Wrapper API is a secure gateway that allows you to deploy applications to our Coolify infrastructure without needing direct access to Coolify. Each user gets their own API key and can only manage their own applications. The SAAC API is a secure gateway that allows you to deploy applications to our Coolify infrastructure without needing direct access to Coolify. Each user gets their own API key and can only manage their own applications.
**Benefits:** **Benefits:**
- ✅ No need for master Coolify credentials - ✅ No need for master Coolify credentials
@@ -42,12 +42,12 @@ curl -X POST https://apps.startanaicompany.com/api/v1/register \
**Save it to your environment:** **Save it to your environment:**
```bash ```bash
export WRAPPER_API_KEY="cw_abc123xyz789..." export SAAC_API_KEY="cw_abc123xyz789..."
# Add to your shell profile for persistence # Add to your shell profile for persistence
echo 'export WRAPPER_API_KEY="cw_abc123xyz789..."' >> ~/.bashrc echo 'export SAAC_API_KEY="cw_abc123xyz789..."' >> ~/.bashrc
# or for zsh: # or for zsh:
echo 'export WRAPPER_API_KEY="cw_abc123xyz789..."' >> ~/.zshrc echo 'export SAAC_API_KEY="cw_abc123xyz789..."' >> ~/.zshrc
``` ```
### Step 2: Customize Your Site ### Step 2: Customize Your Site
@@ -107,21 +107,21 @@ The script will:
### List Your Applications ### List Your Applications
```bash ```bash
curl -H "X-API-Key: $WRAPPER_API_KEY" \ curl -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications https://apps.startanaicompany.com/api/v1/applications
``` ```
### View Application Details ### View Application Details
```bash ```bash
curl -H "X-API-Key: $WRAPPER_API_KEY" \ curl -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID
``` ```
### View Deployment Logs ### View Deployment Logs
```bash ```bash
curl -H "X-API-Key: $WRAPPER_API_KEY" \ curl -H "X-API-Key: $SAAC_API_KEY" \
"https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/logs?tail=100" "https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/logs?tail=100"
``` ```
@@ -129,7 +129,7 @@ curl -H "X-API-Key: $WRAPPER_API_KEY" \
```bash ```bash
curl -X POST \ curl -X POST \
-H "X-API-Key: $WRAPPER_API_KEY" \ -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/deploy https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/deploy
``` ```
@@ -137,7 +137,7 @@ curl -X POST \
```bash ```bash
curl -X PATCH \ curl -X PATCH \
-H "X-API-Key: $WRAPPER_API_KEY" \ -H "X-API-Key: $SAAC_API_KEY" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/env \ https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/env \
-d '{ -d '{
@@ -151,7 +151,7 @@ curl -X PATCH \
After updating env vars, redeploy: After updating env vars, redeploy:
```bash ```bash
curl -X POST \ curl -X POST \
-H "X-API-Key: $WRAPPER_API_KEY" \ -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/deploy https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/deploy
``` ```
@@ -159,7 +159,7 @@ curl -X POST \
```bash ```bash
curl -X DELETE \ curl -X DELETE \
-H "X-API-Key: $WRAPPER_API_KEY" \ -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID
``` ```
@@ -168,9 +168,9 @@ curl -X DELETE \
## Automatic Deployments ## Automatic Deployments
Once deployed, every push to your repository's `master` branch will automatically: Once deployed, every push to your repository's `master` branch will automatically:
1. Trigger webhook to Wrapper API 1. Trigger webhook to SAAC API
2. Wrapper authenticates with your API key 2. SAAC authenticates with your API key
3. Wrapper tells Coolify to redeploy 3. SAAC deploys your updated code
4. Your site updates in 2-3 minutes 4. Your site updates in 2-3 minutes
**No manual intervention needed!** **No manual intervention needed!**
@@ -194,13 +194,13 @@ DNS propagation takes 2-5 minutes.
Make sure you've exported your API key: Make sure you've exported your API key:
```bash ```bash
echo $WRAPPER_API_KEY echo $SAAC_API_KEY
# Should show: cw_abc123xyz... # Should show: cw_abc123xyz...
``` ```
If empty, export it again: If empty, export it again:
```bash ```bash
export WRAPPER_API_KEY="your_api_key_here" export SAAC_API_KEY="your_api_key_here"
``` ```
### "Application limit reached" Error ### "Application limit reached" Error
@@ -208,11 +208,11 @@ export WRAPPER_API_KEY="your_api_key_here"
You've hit your quota (default: 50 apps). Delete unused apps: You've hit your quota (default: 50 apps). Delete unused apps:
```bash ```bash
# List your apps # List your apps
curl -H "X-API-Key: $WRAPPER_API_KEY" \ curl -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications https://apps.startanaicompany.com/api/v1/applications
# Delete an app # Delete an app
curl -X DELETE -H "X-API-Key: $WRAPPER_API_KEY" \ curl -X DELETE -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications/APP_UUID https://apps.startanaicompany.com/api/v1/applications/APP_UUID
``` ```
@@ -227,7 +227,7 @@ You're making too many requests. Wait and try again:
Check logs for specific errors: Check logs for specific errors:
```bash ```bash
curl -H "X-API-Key: $WRAPPER_API_KEY" \ curl -H "X-API-Key: $SAAC_API_KEY" \
"https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/logs?tail=200" "https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/logs?tail=200"
``` ```
@@ -240,7 +240,7 @@ Common issues:
1. **Check deployment status**: 1. **Check deployment status**:
```bash ```bash
curl -H "X-API-Key: $WRAPPER_API_KEY" \ curl -H "X-API-Key: $SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID
``` ```
@@ -259,7 +259,7 @@ Common issues:
If you lost your API key, regenerate it: If you lost your API key, regenerate it:
```bash ```bash
curl -X POST \ curl -X POST \
-H "X-API-Key: $OLD_WRAPPER_API_KEY" \ -H "X-API-Key: $OLD_SAAC_API_KEY" \
https://apps.startanaicompany.com/api/v1/users/regenerate-key https://apps.startanaicompany.com/api/v1/users/regenerate-key
``` ```
@@ -277,10 +277,10 @@ If you can't access the old key, contact support.
2. **Use environment variables** 2. **Use environment variables**
```bash ```bash
# Good # Good
export WRAPPER_API_KEY="cw_..." export SAAC_API_KEY="cw_..."
# Bad - don't hardcode in scripts # Bad - don't hardcode in scripts
WRAPPER_API_KEY="cw_..." ./deploy.sh SAAC_API_KEY="cw_..." ./deploy.sh
``` ```
3. **Rotate keys periodically** 3. **Rotate keys periodically**
@@ -316,11 +316,11 @@ If you hit a rate limit, wait for the reset time before retrying.
**Documentation:** **Documentation:**
- Template README: [README.md](README.md) - Template README: [README.md](README.md)
- Wrapper API docs: Coming soon - SAAC API docs: Coming soon
**Issues:** **Issues:**
- Template issues: https://git.startanaicompany.com/StartanAICompany/ai-recruit-site-template/issues - Template issues: https://git.startanaicompany.com/StartanAICompany/ai-recruit-site-template/issues
- Wrapper issues: https://git.startanaicompany.com/mikael.westoo/coolifywrapper/issues - SAAC API issues: https://git.startanaicompany.com/mikael.westoo/coolifywrapper/issues
**Contact:** **Contact:**
- Email: info@startanaicompany.com - Email: info@startanaicompany.com

6
README.md
View File

@@ -40,7 +40,7 @@ This repository is marked as a template. You can create your own recruitment sit
### Prerequisites ### Prerequisites
- Gitea account at git.startanaicompany.com - Gitea account at git.startanaicompany.com
- Wrapper API key (get from apps.startanaicompany.com) - SAAC API key (get from apps.startanaicompany.com)
- Basic command line knowledge - Basic command line knowledge
**📖 Detailed Guide:** See [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) for complete instructions. **📖 Detailed Guide:** See [DEPLOYMENT_GUIDE.md](DEPLOYMENT_GUIDE.md) for complete instructions.
@@ -101,7 +101,7 @@ curl -X POST https://apps.startanaicompany.com/api/v1/register \
Save the returned API key: Save the returned API key:
```bash ```bash
export WRAPPER_API_KEY="cw_your_api_key_here" export SAAC_API_KEY="cw_your_api_key_here"
``` ```
### Step 4: Deploy ### Step 4: Deploy
@@ -114,7 +114,7 @@ chmod +x deploy-to-apps.sh
``` ```
The script will: The script will:
- Create a Coolify application via Wrapper API - Create application on StartAnAiCompany infrastructure
- Configure domain (yournamerecruit.startanaicompany.com) - Configure domain (yournamerecruit.startanaicompany.com)
- Set up webhooks for automatic deployments - Set up webhooks for automatic deployments
- Trigger initial deployment - Trigger initial deployment

44
deploy-to-apps.example.sh
View File

@@ -1,17 +1,17 @@
#!/bin/bash #!/bin/bash
# ======================================== # ========================================
# AI Recruitment Site - Wrapper API Deployment Script # AI Recruitment Site - SAAC Deployment Script
# ======================================== # ========================================
# This script deploys your recruitment site via the Coolify Wrapper API # This script deploys your recruitment site to StartAnAiCompany infrastructure
# at apps.startanaicompany.com # via apps.startanaicompany.com
# #
# IMPORTANT: Copy this file to deploy-to-apps.sh and customize it # IMPORTANT: Copy this file to deploy-to-apps.sh and customize it
# DO NOT commit deploy-to-apps.sh to git (it's in .gitignore) # DO NOT commit deploy-to-apps.sh to git (it's in .gitignore)
# #
# Prerequisites: # Prerequisites:
# 1. Register for API key at: https://apps.startanaicompany.com/api/v1/register # 1. Register for API key at: https://apps.startanaicompany.com/api/v1/register
# 2. Set WRAPPER_API_KEY environment variable # 2. Set SAAC_API_KEY environment variable
# 3. Set GITEA_API_TOKEN environment variable (optional, for webhooks) # 3. Set GITEA_API_TOKEN environment variable (optional, for webhooks)
# 4. Customize your .env file with company information # 4. Customize your .env file with company information
@@ -26,8 +26,8 @@ fi
source .env source .env
# Check required environment variables # Check required environment variables
if [ -z "$WRAPPER_API_KEY" ]; then if [ -z "$SAAC_API_KEY" ]; then
echo "❌ Error: WRAPPER_API_KEY environment variable not set" echo "❌ Error: SAAC_API_KEY environment variable not set"
echo "" echo ""
echo "To get your API key:" echo "To get your API key:"
echo "1. Register at: curl -X POST https://apps.startanaicompany.com/api/v1/register \\" echo "1. Register at: curl -X POST https://apps.startanaicompany.com/api/v1/register \\"
@@ -35,7 +35,7 @@ if [ -z "$WRAPPER_API_KEY" ]; then
echo " -d '{\"email\":\"your@email.com\",\"gitea_username\":\"${GITEA_USERNAME}\"}'" echo " -d '{\"email\":\"your@email.com\",\"gitea_username\":\"${GITEA_USERNAME}\"}'"
echo "" echo ""
echo "2. Save the returned API key" echo "2. Save the returned API key"
echo "3. Export it: export WRAPPER_API_KEY='your_api_key_here'" echo "3. Export it: export SAAC_API_KEY='your_api_key_here'"
echo "" echo ""
exit 1 exit 1
fi fi
@@ -61,8 +61,8 @@ if [ -z "$GITEA_REPO_NAME" ]; then
exit 1 exit 1
fi fi
# Wrapper API configuration # SAAC API configuration
WRAPPER_API="https://apps.startanaicompany.com/api/v1" SAAC_API="https://apps.startanaicompany.com/api/v1"
# Repository URL (HTTPS for Coolify to clone) # Repository URL (HTTPS for Coolify to clone)
REPO_URL="https://git.startanaicompany.com/${GITEA_USERNAME}/${GITEA_REPO_NAME}.git" REPO_URL="https://git.startanaicompany.com/${GITEA_USERNAME}/${GITEA_REPO_NAME}.git"
@@ -79,10 +79,10 @@ echo " Repository: $REPO_URL"
echo " Domain: https://$FULL_DOMAIN" echo " Domain: https://$FULL_DOMAIN"
echo "" echo ""
# Create Coolify application via wrapper API # Create application via SAAC API
echo "📝 Creating application via Wrapper API..." echo "📝 Creating application on StartAnAiCompany server..."
APP_RESPONSE=$(curl -s -X POST "${WRAPPER_API}/applications" \ APP_RESPONSE=$(curl -s -X POST "${SAAC_API}/applications" \
-H "X-API-Key: ${WRAPPER_API_KEY}" \ -H "X-API-Key: ${SAAC_API_KEY}" \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-d "{ -d "{
\"name\": \"${SUBDOMAIN}-recruit\", \"name\": \"${SUBDOMAIN}-recruit\",
@@ -148,7 +148,7 @@ else
\"http_method\": \"GET\" \"http_method\": \"GET\"
}, },
\"events\": [\"push\"], \"events\": [\"push\"],
\"authorization_header\": \"Bearer ${WRAPPER_API_KEY}\", \"authorization_header\": \"Bearer ${SAAC_API_KEY}\",
\"active\": true \"active\": true
}") }")
@@ -190,12 +190,12 @@ echo " ${DOMAIN}/admin/login"
echo "" echo ""
echo "🔍 Monitor deployment:" echo "🔍 Monitor deployment:"
echo " View logs:" echo " View logs:"
echo " curl -H \"X-API-Key: \$WRAPPER_API_KEY\" \\" echo " curl -H \"X-API-Key: \$SAAC_API_KEY\" \\"
echo " ${WRAPPER_API}/applications/${APP_UUID}/logs" echo " ${SAAC_API}/applications/${APP_UUID}/logs"
echo "" echo ""
echo " List your applications:" echo " List your applications:"
echo " curl -H \"X-API-Key: \$WRAPPER_API_KEY\" \\" echo " curl -H \"X-API-Key: \$SAAC_API_KEY\" \\"
echo " ${WRAPPER_API}/applications" echo " ${SAAC_API}/applications"
echo "" echo ""
# Save deployment info # Save deployment info
@@ -208,14 +208,14 @@ Domain: $DOMAIN
Application UUID: $APP_UUID Application UUID: $APP_UUID
Repository: $REPO_URL Repository: $REPO_URL
Wrapper API: ${WRAPPER_API} SAAC API: ${SAAC_API}
Your API Key: ${WRAPPER_API_KEY} Your API Key: ${SAAC_API_KEY}
Monitor deployment: Monitor deployment:
curl -H "X-API-Key: \$WRAPPER_API_KEY" ${WRAPPER_API}/applications/${APP_UUID}/logs curl -H "X-API-Key: \$SAAC_API_KEY" ${SAAC_API}/applications/${APP_UUID}/logs
Trigger manual deployment: Trigger manual deployment:
curl -X POST -H "X-API-Key: \$WRAPPER_API_KEY" ${WRAPPER_API}/applications/${APP_UUID}/deploy curl -X POST -H "X-API-Key: \$SAAC_API_KEY" ${SAAC_API}/applications/${APP_UUID}/deploy
DEPLOYMENT_INFO DEPLOYMENT_INFO
echo "💾 Deployment information saved to deployment-info.txt" echo "💾 Deployment information saved to deployment-info.txt"