Skip to content
Trailer.devDocumentation

Search is only available in production builds. Try building and previewing the site to test it out locally.

Quick Start Guide

A running workspace in the Trailer.dev UI, with its image selector and resource limits visible.

This guide takes you from a fresh standalone instance to a running workspace.

If you have not installed it yet, follow the Installation Guide. The short version:

Terminal window
docker run -d \
--name trailer \
-p 8090:8090 \
-v /var/run/docker.sock:/var/run/docker.sock \
-v trailer_data:/trailer_data \
ghcr.io/trailer-dev/standalone:latest

Open http://localhost:8090.

A fresh instance redirects you to the setup page. Create the initial administrator account. See First User Setup for the fields involved. You are logged in automatically afterward.

In standalone mode the embedded agent registers itself as a host. Open the Hosts page and confirm the host shows as online before continuing.

Workspaces are launched from images. Create one on the Create Image page: pick a base image, add the environments, services, and files you need, then build it. Track build progress from the Images page. It’s also possible to just directly supply an OCI image name on the Create Workspace page.

If you choose to build a custom image, once the image build finishes, or if you’re going to choose an OCI image from a registry, open the Create Workspace page. Select your image, give the workspace a name, and configure resources, networks, volumes, and any exposed URLs. Submit to deploy it.

Watch the workspace move to a running state on the Workspaces page. From the workspace details you can:

  • Open any exposed URL.
  • Run a shell with Exec.
  • View logs.