Runners

A Runner is a standalone service that can be deployed anywhere. The user can deploy a Runner on a target system by executing a set of instructions and commands generated upon Runner registration.

Once deployed, the Runner starts up and connects to the Daytona Server, at which point its status is marked as Running.

The Runner sends all requests, while the Server only responds. The Runner sends requests such as Heartbeat (to share its status) and Job Requests (to ask Daytona Server for jobs assigned to it).

A single Runner can use multiple Providers, configured during deployment or later via jobs, enabling flexibility for various environments.

Create a Runner

Daytona provides an option to create a new Runner, enabling you to deploy it on a target system and connect it to the Daytona Server.

1. Run the following command to create a new Runner:

daytona server runner create

Upon running the command, Daytona will generate a code snippet containing the server API URL and API key required to deploy the Runner on the target system.

2. Paste the code snippet into the target system’s terminal and execute it to configure the Runner.

Start / Serve a Runner

Daytona provides options to serve a Runner in the foreground or start a Runner as a daemon/background process. Use the method that best suits your requirements.

daytona runner serve

daytona runner start

The Runner will connect to the Daytona Server and its status will be marked as Running.

Configure a Runner

Daytona provides an option to configure a Runner, enabling you to update its configuration settings.

1. Run the following command to configure a Runner:

daytona runner configure

Upon running the command, Daytona will display the current Runner configuration settings and prompt you to update them.

ID
Unique ID generated by the Daytona Server
>

Name
Unique name set on the Daytona Server
>

Runner API Port
Port used for exposing runner health-check endpoint
> 3983

Server API URL
>

Server API Key
>

Providers Directory
Directory will be created if it does not exist
> /Users/<user>/Library/Application Support/daytona-runner/providers

Telemetry Enabled
[Yes]     [No]

Log File Path
File will be created if it does not exist
> /Users/<user>/Library/Application Support/daytona-runner/log

Log File Max Size
In megabytes
> 100

Log File Backups
> 7

Log File Max Age
In days
> 15

Log File Local Time
Used for timestamping files. Default is UTC time.
[Yes]     [No]

Log File Compress

[Yes]     [No]

Upon configuring the Runner, Daytona update the Runner configuration and display the following message:

Runner configuration updated. To start running jobs, run 'daytona runner start'.

Purge a Runner

Daytona provides an option to purge a Runner, enabling you to remove it from the Daytona Server.

1. Run the following command to purge a Runner:

daytona runner purge

Upon running the command, Daytona will display a list of Runners and prompt you to select the Runner you want to purge.

Purging will remove the entire Daytona Runner configuration from the system, are you sure you want to continue?
This action is irreversible.

[Yes]     [No]

2. Confirm the action by selecting Yes.

The Daytona Runner has been purged from this device.

Restart a Runner

Daytona provides an option to restart a Runner, enabling you to restart it on the target system.

1. Run the following command to restart a Runner:

daytona runner restart

Upon running this command, Daytona will restart the Runner on the target system.

Stop a Runner

Daytona provides an option to stop a Runner, enabling you to stop it on the target system.

1. Run the following command to stop a Runner:

daytona runner stop

Upon running this command, Daytona will stop the Runner on the target system.

Runner Logs

Daytona provides an option to view the logs of a Runner, enabling you to monitor its activities.

1. Run the following command to view the logs of a Runner:

daytona runner logs

Upon running this command, Daytona will display the logs of the Runner.