UI Guide

Managing Deployments

Create, monitor, and manage your application deployments.

The Deployments page is your central hub for managing all your Docker applications. Here you can create new deployments, monitor their status, and control their lifecycle.

Deployments List

The deployments list shows all your applications with key information:

  • Name — Deployment identifier
  • Status — Running, stopped, error, etc.
  • Services — Number of containers in the deployment
  • Domain — Configured domain (if any)
  • Created — When the deployment was created
  • Actions — Quick action buttons

Filtering and Search

Use the search bar to filter deployments by name. You can also filter by status using the status dropdown.

View Modes

Toggle between:

  • Table View — Compact list with sortable columns
  • Grid View — Card-based layout with more details
Deployments List

Creating Deployments

Click "New Deployment" to open the deployment wizard. Two modes are available:

Easy Mode

Deploy from pre-configured templates:

  1. Select a template category (Applications, Frameworks, etc.)
  2. Click on a template to select it
  3. Enter a deployment name
  4. Configure optional settings:
    • Port — External port for the application
    • Domain — Custom domain (if proxy is enabled)
    • Mount Points — What data to persist
    • Database — Use shared database (if applicable)
  5. Click "Deploy" to create and start the deployment

Compose Mode

For advanced users who want full control:

  1. Enter a deployment name
  2. Write or paste your docker-compose.yml
  3. Optionally add environment variables
  4. Click "Deploy"
Create Deployment Wizard
Tip: The compose editor includes syntax highlighting and validation. Invalid YAML will show errors before you deploy.

Deployment Detail View

Click on a deployment to open its detail view. This provides comprehensive information and controls organized in tabs:

Deployment Details

Overview Tab

  • General Info — Name, status, creation date
  • Domain & SSL — Proxy configuration, SSL status
  • Quick Actions — Start, stop, restart, delete

Services Tab

Lists all containers in the deployment:

  • Container name and image
  • Status and health
  • Port mappings
  • Individual container actions (logs, restart, etc.)

Logs Tab

Real-time log viewer with features:

  • Service Filter — View logs for specific service
  • Auto-scroll — Automatically scroll to new logs
  • Tail Lines — Number of historical lines to show
  • Download — Export logs to file

Stats Tab

Real-time resource usage monitoring:

  • CPU — Usage percentage per container
  • Memory — Used/limit and percentage
  • Network — Bytes in/out
  • Block I/O — Disk read/write

Compose Tab

View and edit the docker-compose.yml:

  • Syntax-highlighted YAML editor
  • Save changes and restart to apply
  • View raw compose file
Edit Compose and Service Files

Files Tab

Browse and manage deployment files:

  • File tree navigation
  • View and edit text files
  • Upload new files
  • Download files
  • Create directories
  • Delete files (with confirmation)
File Manager

Deployment Actions

Start

Starts all containers in the deployment using docker-compose up -d.

Stop

Gracefully stops all containers using docker-compose down. Volumes and data are preserved.

Restart

Stops and starts all containers. Useful for applying configuration changes.

Delete

Removes the deployment:

  1. Stops all running containers
  2. Removes containers and networks
  3. Optionally deletes the deployment directory
Warning: Deleting a deployment removes its containers but preserves Docker volumes by default. To fully remove data, delete volumes separately.

Setting Up Proxy

To expose a deployment to the internet:

  1. Go to deployment detail → Overview tab
  2. Find the "Domain & SSL" section
  3. Click "Set Up Proxy"
  4. Enter your domain name
  5. Select the container port
  6. Enable SSL if desired
  7. Save

FlatRun will:

  • Generate Nginx virtual host configuration
  • Reload Nginx to apply changes
  • Request SSL certificate if enabled

Updating Deployments

To update a deployment:

  1. Go to the Compose tab
  2. Make your changes to the docker-compose.yml
  3. Click "Save"
  4. Restart the deployment to apply changes

Bulk Operations

Select multiple deployments using checkboxes to perform bulk actions:

  • Start All — Start all selected deployments
  • Stop All — Stop all selected deployments
  • Delete All — Delete all selected deployments (with confirmation)