Skip to main content
Projects are the primary organizational unit in Suga. Each project represents a complete application with all its services, databases, and infrastructure.

Key Features of a Project

A project contains your application:
  • Logical Boundary - Groups related services and infrastructure
  • Multiple Environments - Each project has production, staging, dev, etc.
  • Canvas Workspace - Visual design space for your infrastructure
  • Deployment History - Complete record of infrastructure changes per project
  • Version Control - Every change tracked with commit messages and author
Think of a project as one complete application, like “Marketing Website”, “E-commerce API”, or “Internal Dashboard”.

Project Structure

Creating a Project

Click New project in the dashboard to open the New Project page, which offers three ways to start. Whichever you pick, the project is created with a default production environment and full deployment tracking, and the canvas opens.

Import from a GitHub repository

Click Connect GitHub to install the Suga GitHub App on your account or organization (once per account or org), then pick the repository you want to deploy. Suga takes you to an import page where you set the project name and the build and deploy settings:
  • Branch - the branch Suga watches and builds from
  • Build method - auto-detect, or point Suga at your Dockerfile
  • Root directory - for monorepos, the subdirectory holding the app
  • Build args - values passed to the build
Click Create project. The project opens on the canvas with a container already connected to the repository. See Build from GitHub for how rebuilds work after that.

Start from a template

Under Starting from scratch?, pick a template such as PostgreSQL, Redis, MySQL, or MongoDB. Suga creates the project with that service configured and ready on the canvas. Templates are single services, so add the rest of your infrastructure from the canvas afterwards.

Start with an empty project

Click Create empty project for a blank canvas. Use this when you’re importing a Compose file, adding a function, or bringing a pre-built image from a registry.

Project Settings

Access project settings from the project dropdown menu. Settings are minimal and focused on project identity:

General

  • Project Name - Change the display name shown in the dashboard
  • Description - Optional description for the project

Delete Project

Permanently delete the project and all its data. This action is in the danger zone section at the bottom of settings.
Deleting a project permanently deletes all environments, deployments, services, volumes, and data. This action cannot be undone.

The Canvas

Every project has a visual canvas where you design infrastructure: Canvas Features:
  • Add services, volumes, and templates to your infrastructure
  • Visual connections between services and volumes
  • Real-time configuration panel
  • Environment selector to switch between production/staging/dev
  • Deploy button to push changes live

Environments

Each project can have multiple environments (production, staging, development, preview, etc.) with isolated namespaces and independent configuration. See Environments for detailed information.

Common Questions

Yes, you can change the project name anytime in Project Settings.
Not currently. You’ll need to recreate the project in the target organization. Export your configuration from the canvas first.
There’s no hard limit on services per project. Resource availability depends on your plan.
All deployments are immediately stopped and all data is permanently deleted. Make sure to back up any important data before deleting a project.