Rebrand from Wrapper API to SAAC API
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:
@@ -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:**
|
||||
- ✅ 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:**
|
||||
```bash
|
||||
export WRAPPER_API_KEY="cw_abc123xyz789..."
|
||||
export SAAC_API_KEY="cw_abc123xyz789..."
|
||||
|
||||
# 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:
|
||||
echo 'export WRAPPER_API_KEY="cw_abc123xyz789..."' >> ~/.zshrc
|
||||
echo 'export SAAC_API_KEY="cw_abc123xyz789..."' >> ~/.zshrc
|
||||
```
|
||||
|
||||
### Step 2: Customize Your Site
|
||||
@@ -107,21 +107,21 @@ The script will:
|
||||
### List Your Applications
|
||||
|
||||
```bash
|
||||
curl -H "X-API-Key: $WRAPPER_API_KEY" \
|
||||
curl -H "X-API-Key: $SAAC_API_KEY" \
|
||||
https://apps.startanaicompany.com/api/v1/applications
|
||||
```
|
||||
|
||||
### View Application Details
|
||||
|
||||
```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
|
||||
```
|
||||
|
||||
### View Deployment Logs
|
||||
|
||||
```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"
|
||||
```
|
||||
|
||||
@@ -129,7 +129,7 @@ curl -H "X-API-Key: $WRAPPER_API_KEY" \
|
||||
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
@@ -137,7 +137,7 @@ curl -X POST \
|
||||
|
||||
```bash
|
||||
curl -X PATCH \
|
||||
-H "X-API-Key: $WRAPPER_API_KEY" \
|
||||
-H "X-API-Key: $SAAC_API_KEY" \
|
||||
-H "Content-Type: application/json" \
|
||||
https://apps.startanaicompany.com/api/v1/applications/YOUR_APP_UUID/env \
|
||||
-d '{
|
||||
@@ -151,7 +151,7 @@ curl -X PATCH \
|
||||
After updating env vars, redeploy:
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
@@ -159,7 +159,7 @@ curl -X POST \
|
||||
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
@@ -168,9 +168,9 @@ curl -X DELETE \
|
||||
## Automatic Deployments
|
||||
|
||||
Once deployed, every push to your repository's `master` branch will automatically:
|
||||
1. Trigger webhook to Wrapper API
|
||||
2. Wrapper authenticates with your API key
|
||||
3. Wrapper tells Coolify to redeploy
|
||||
1. Trigger webhook to SAAC API
|
||||
2. SAAC authenticates with your API key
|
||||
3. SAAC deploys your updated code
|
||||
4. Your site updates in 2-3 minutes
|
||||
|
||||
**No manual intervention needed!**
|
||||
@@ -194,13 +194,13 @@ DNS propagation takes 2-5 minutes.
|
||||
|
||||
Make sure you've exported your API key:
|
||||
```bash
|
||||
echo $WRAPPER_API_KEY
|
||||
echo $SAAC_API_KEY
|
||||
# Should show: cw_abc123xyz...
|
||||
```
|
||||
|
||||
If empty, export it again:
|
||||
```bash
|
||||
export WRAPPER_API_KEY="your_api_key_here"
|
||||
export SAAC_API_KEY="your_api_key_here"
|
||||
```
|
||||
|
||||
### "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:
|
||||
```bash
|
||||
# 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
|
||||
|
||||
# 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
|
||||
```
|
||||
|
||||
@@ -227,7 +227,7 @@ You're making too many requests. Wait and try again:
|
||||
|
||||
Check logs for specific errors:
|
||||
```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"
|
||||
```
|
||||
|
||||
@@ -240,7 +240,7 @@ Common issues:
|
||||
|
||||
1. **Check deployment status**:
|
||||
```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
|
||||
```
|
||||
|
||||
@@ -259,7 +259,7 @@ Common issues:
|
||||
If you lost your API key, regenerate it:
|
||||
```bash
|
||||
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
|
||||
```
|
||||
|
||||
@@ -277,10 +277,10 @@ If you can't access the old key, contact support.
|
||||
2. **Use environment variables**
|
||||
```bash
|
||||
# Good
|
||||
export WRAPPER_API_KEY="cw_..."
|
||||
export SAAC_API_KEY="cw_..."
|
||||
|
||||
# Bad - don't hardcode in scripts
|
||||
WRAPPER_API_KEY="cw_..." ./deploy.sh
|
||||
SAAC_API_KEY="cw_..." ./deploy.sh
|
||||
```
|
||||
|
||||
3. **Rotate keys periodically**
|
||||
@@ -316,11 +316,11 @@ If you hit a rate limit, wait for the reset time before retrying.
|
||||
|
||||
**Documentation:**
|
||||
- Template README: [README.md](README.md)
|
||||
- Wrapper API docs: Coming soon
|
||||
- SAAC API docs: Coming soon
|
||||
|
||||
**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:**
|
||||
- Email: info@startanaicompany.com
|
||||
|
||||
Reference in New Issue
Block a user