SnapDeploy Documentation

Learn how to deploy and manage containers with SnapDeploy

Getting Started

Deploy your first container in under 60 seconds.

# 1. Create an account
curl https://snapdeploy.dev/register
# 2. Deploy a container
snapdeploy deploy --image nginx:latest

Quick Deploy

Deploy in 60 seconds

API First

RESTful API & CLI

Secure

Built on AWS

Deployment Guide

Deploy from Docker Image

POST /api/containers/deploy
{
"imageName": "nginx:latest",
"containerName": "my-app",
"cpu": "512",
"memory": "1024"
}

Deploy from GitHub

POST /api/deployments/github
{
"repoUrl": "https://github.com/user/repo",
"branch": "main"
}

API Reference

Full API documentation for integrating with SnapDeploy.

GET /api/containers

List all your containers

POST /api/containers/deploy

Deploy a new container

PUT /api/containers/{id}

Update container configuration

DELETE /api/containers/{id}

Stop and delete a container

View Full API Documentation

CLI Usage

Installation

# Install via npm
npm install -g @snapdeploy/cli
# Or via curl
curl -fsSL https://cli.snapdeploy.dev/install.sh | sh

Common Commands

snapdeploy login
snapdeploy deploy --image nginx
snapdeploy list
snapdeploy logs <container-id>
snapdeploy stop <container-id>

Docker Integration

SnapDeploy supports any Docker image from Docker Hub or private registries.

Supported Features

  • Public Docker Hub images
  • Private Docker registries
  • Environment variables
  • Custom ports and volumes
  • Health checks

Monitoring

Real-time metrics and logs for all your containers.

Metrics Available

  • • CPU Usage
  • • Memory Usage
  • • Network I/O
  • • Request Count
  • • Response Times

Log Management

  • • Real-time log streaming
  • • 7-day retention
  • • Full-text search
  • • Log export
  • • Alert configuration

Troubleshooting

Container won't start

Check your container logs: snapdeploy logs <container-id>

Common issues:

  • Invalid Docker image name
  • Insufficient memory allocation
  • Port conflicts
Deployment is slow

Large Docker images take longer to pull. Consider:

  • Using smaller base images (Alpine Linux)
  • Optimizing your Dockerfile layers
  • Using private registry closer to our servers
How to get support

We're here to help!

Ready to Deploy?

Start deploying containers in under 60 seconds

Get Started Free