Getting Started
Welcome to Caster! This guide will walk you through creating your account, deploying your first site, and going live.
Create an Account
- Go to console.caster.zip and click Register
- Enter your email address and password
- You'll be logged in automatically and taken to the console
Create a Site
- From the console, click New Site
- Your site is created instantly with a unique ID (e.g.,
a3f9c2e8) - You'll be taken to the site page where you can deploy
You can optionally set a custom subdomain name later from the site's Advanced settings.
Deploy by Pasting Code
The simplest way to deploy — paste your HTML directly:
- Go to your site's detail page
- Paste your HTML into the content area (the default filename is
index.html) - Click Deploy
Your site will be live at https://{your-id}.caster.zip within seconds. No Dockerfile needed — Caster automatically serves static files with nginx.
Deploy via the Paste API
Chatbots and scripts can deploy via the API:
curl -X POST https://console.caster.zip/api/v1/sites/a3f9c2e8/paste \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"files": [
{"name": "index.html", "content": "<h1>Hello World</h1>"},
{"name": "style.css", "content": "body { font-family: sans-serif; }"}
]
}'
Deploy by Uploading a File
Upload a zip or tar.gz of your project:
- Go to your site's detail page
- Choose your archive file and click Deploy
No Dockerfile required for static sites — Caster injects an nginx Dockerfile automatically. If your archive includes a Dockerfile, Caster will use it instead.
Upload via the API
# Zip your project
zip -r mysite.zip . -x '.git/*'
# Upload and deploy
curl -X POST https://console.caster.zip/api/v1/sites/a3f9c2e8/deploy \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "file=@mysite.zip"
Alternative: Deploy with git push
For a git-based workflow, add Caster as a remote and push to deploy. This requires an SSH key.
Add your SSH key
- Generate one if needed:
ssh-keygen -t ed25519 - Add it on the SSH Keys page in the console, or via the API:
curl -X POST https://console.caster.zip/api/v1/ssh-keys \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{"public_key": "ssh-ed25519 AAAA... you@laptop"}'
Push to deploy
cd your-project
git remote add caster git@git.caster.zip:a3f9c2e8.git
git push caster main
View Your Site
After a successful deploy, your site will be live at https://{your-id}.caster.zip. You can check deployment status and build logs from the site detail page.
What's Next
- Deploying Apps — build logs, rollback, and more
- Dockerfile Requirements — custom Dockerfiles for dynamic apps
- CLI & SSH — manage sites from your terminal
- API Reference — automate everything with the REST API