Projects

Projects group applications and environments for coordinated deployments. A project represents a complete system or product.

What is a Project?

A project is a collection of applications. Think of a project as a complete web application consisting of:

• A frontend application
• A backend API
• A database
• A message broker
• A cache server

Each project can have its own set of environments and its own configuration overrides.

Creating a Project

1. Go to Projects in the navigation menu
2. Click on Create Project
3. Fill in the following information:
   • Name - A unique name for the project (e.g., “E-commerce Platform”)
   • Code - A unique code for identification (auto-generated based on name)
   • Description - An optional description of the project
4. Optionally upload an image or icon
5. Click on Create

Project Overview

After creating, you see the project in the list. Each project card shows:

• Project Name - The name of the project
• Connected Applications - The number of applications connected to the project

Project Details

Click on a project to go to its detail page. Here you find multiple tabs:

Overview

The overview tab shows a deployment matrix with an overview of all applications, versions, and environments in your project.

What you see in the Matrix:

• Applications - All applications connected to the project
• Versions - Each version per application
• Environments - All environments for the project
• Deployment Status - Which version is deployed where

Executing Deployment from Matrix:

1. Click on an application to expand it
2. View all versions and their deployment status
3. Click on Deploy next to the desired version and environment
4. Confirm and monitor the deployment

Environments

Manage the environments that are specific to this project.

Environment Status:

See for each environment:

• URL (if set)
• Whether an agent is connected
• The last deployed version

Setting Environment URLs:

1. Go to the Environments tab
2. Edit the URL for each environment
3. Save the changes

URLs are used to access your applications in different environments.

Agents

Manage the agents that are responsible for deployments in this project.

Connecting an Agent:

1. Go to the Agents tab
2. Click on Connect Agent
3. Select an agent and connect it to one or more environments
4. Save the connection

Agent Status:

• Online - Agent is connected and ready for deployments
• Offline - Agent is not connected (deployments will be queued)

If an agent is offline during a deployment, the deployment will be queued and executed when the agent comes back online.

Configurations

Define project-specific configuration overrides for the applications in this project.

Project Configuration:

1. Go to the Configurations tab
2. Select an application
3. Per environment, you can define overrides
4. Save the configuration

During deployment, the application’s base configurations and project overrides will be automatically merged.

Example Use Case:

You have a “User Service” application with a base configuration:

{
  "database": {
    "host": "localhost",
    "port": 5432
  }
}

For the “E-commerce Platform” project, you define overrides:

• Development: host: dev-db.local
• Staging: host: staging-db.example.com
• Production: host: prod-db.example.com

During deployment to production, the configuration is merged:

{
  "database": {
    "host": "prod-db.example.com",
    "port": 5432
  }
}

Settings

Manage general project settings:

• Edit project name
• Change description
• Update image or icon
• Delete project

Deleting Project: Note: if you delete a project, all configuration overrides and project-specific data will be deleted. The connected applications will remain.

Connecting Applications to a Project

From the Project Page:

1. Go to the Settings tab of a project
2. Click on Connect Application
3. Select the application you want to add
4. The application now appears in your project

From an Application:

An application can be connected to multiple projects. See the overview on the application page to see which projects the application is used in.

Environment-Specific Deployments

Each project can use its own set of environments, defined in Settings > Environments. You can choose to:

• Use all available environments
• Use only specific environments
• Define environment-specific configurations

Deployment Workflow

Manual Deployments

1. Select Project - Navigate to your project page
2. Select Application - In the deployment matrix, click on an application
3. Select Version - Choose the version you want to deploy
4. Select Environment - Select the target environment
5. Deploy - Click on Deploy and confirm
6. Monitor - Watch deployment progress in real-time

Automated Deployments

You can also use Auto Deploy Rules to automate deployments:

Benefits of Auto Deploy:

• Automatically deploy versions when created
• Time saving - no manual clicks needed
• Consistency - every version is deployed the same way
• Fewer errors - avoid forgotten deployments

Creating Auto Deploy Rules:

1. Go to a project
2. Navigate to the Auto Deploy Rules section
3. Click on Create Rule
4. Configure:
   • Which application?
   • Which version pattern? (e.g., v1.*)
   • To which environment?
5. Save the rule

For more information on auto deploy rules, see the Auto Deploy documentation.

Best Practices

Project Structure

• A project should be a logical grouping of applications
• Avoid having too many applications in one project (10-15 recommended max)
• Create separate projects for different product lines

Environment Organization

• Use consistent environment names (Development, Staging, Production)
• Define clear deployment rules per environment
• Keep environment order logical (from test to production)

Configuration Management

• Define only differences in project config overrides
• Use base config for standard values
• Use environment variables for sensitive data

Deployment Planning

• Plan deployments well (e.g., Staging first, then Production)
• Use deployment matrix for overview
• Monitor deployments and logs carefully

Project vs Application

It’s important to understand the difference:

In summary: Applications are the building blocks, Projects are the buildings you construct with those blocks.