Skip to main content

Deploy Your First Service

This walkthrough guides you through deploying your first service using the template catalog. We will deploy Uptime Kuma, a lightweight uptime monitoring tool, as it requires minimal configuration and starts quickly.

Step 1: Log In​

Open your panel at https://panel.example.com. You will be redirected to the Keycloak login page.

Enter the admin credentials created during installation and click Sign In.

Step 2: Navigate to Templates​

From the dashboard, click Deploy in the sidebar. You will see four deployment options:

  • Template Deploy
  • Git Deploy
  • AI Deploy
  • Compose Deploy

Select Template Deploy to open the template catalog.

Step 3: Browse the Catalog​

The catalog displays 45 templates organized by category. You can:

  • Browse by category (AI Services, Databases, DevTools, Web Apps)
  • Use the search bar to find templates by name
  • View featured templates at the top of the page

Find Uptime Kuma in the DevTools category, or search for it by name.

Step 4: Configure the Service​

Click on Uptime Kuma to open the template detail page. You will see:

  • A description of the service
  • Minimum resource requirements
  • Configurable variables

Fill in the required fields:

FieldExample ValueDescription
Service Nameuptime-monitorUnique name (becomes the subdomain)
Customer(select your customer)Which customer owns this service

Uptime Kuma has minimal configuration — most templates will have additional fields for passwords, database names, and other settings.

Step 5: Deploy​

Click Deploy. The panel will:

  1. Generate a Docker Compose configuration from the template
  2. Create the service record in the database
  3. Pull the container image
  4. Start the container with Traefik labels for routing
  5. Wait for the health check to pass

You can watch the deploy progress in real time via the WebSocket-powered progress indicator.

Step 6: Verify​

Once the deploy completes (typically 30-60 seconds), your service is live at:

https://uptime-monitor.panel.example.com

Click the URL shown in the service detail page, or navigate to it directly. You should see the Uptime Kuma setup wizard.

Step 7: Check the Dashboard​

Return to the panel dashboard. Your new service appears in the service list with:

  • Status: Running (green)
  • URL: The auto-assigned subdomain
  • Resource usage: CPU and memory consumption
  • Actions: Start, Stop, Restart, Logs, Delete

What Just Happened​

Behind the scenes, the panel:

  1. Read the Uptime Kuma template YAML spec
  2. Generated a Docker Compose file with Traefik routing labels
  3. Created a DNS record (if Cloudflare is configured)
  4. Pulled the container image from Docker Hub
  5. Started the container on the Docker network
  6. Registered a Traefik route for uptime-monitor.panel.example.com
  7. Issued an SSL certificate via Let's Encrypt
  8. Began monitoring the container health

Next Steps​