Templates

Templates are displayed on the right side of your Daytona dashboard when you try to create a Workspace. You can use them to customize your Daytona dashboard in combination with devcontainer during deployment to create Workspaces faster based on your requirements.

We will walk through our default templates, the content of each template, how to customise your own templates and how to deploy them a custom template to your Daytona dashboard.

We assume you have a successful Daytona deployment and gained access to a Daytona dashboard URL.

Default Templates Index

The default template index is a JSON file that contains an array of 13 objects. Each object represents a template. The template is located in this repository.

If you accidentally removed all the default templates and want to add it back, you might want to take the default templates.

Construct of a Template

The simplest example of a template includes the listed properties. Each of the properties is case sensitive.

[
  {
    "name": "C# (.NET)",
    "description": "Develop C# and .NET based applications. Includes all needed SDKs, extensions, and dependencies.",
    "gitUrl": "https://github.com/daytonaio-templates/dotnet",
    "imageUrl": "https://raw.githubusercontent.com/daytonaio-templates/index/main/img/dotnet.png",
    "rawReadmeUrl": "https://raw.githubusercontent.com/daytonaio-templates/dotnet/main/README.md"
  }
]

• name

  Required.

  The name of the template being displayed on the Daytona dashboard.

• description

  Required.

  The description of the template. This property won’t be displayed it’d be helpful to take notes when you are creating them.

• gitUrl

  Required.

  The content of the template.

• imageUrl

  Required.

  An image display on the template when it is deployed to the dashboard. It supports JPG, JPEG, SVG and PNG formats. It can link to any public image.

• rawReadmeUrl

  Required.

  Textual content is displayed on the pop-up dialog after you click on the selected template button on the dashboard. It is used to help users understand the content of the template. It has to be the raw content of a markdown file.

Customizing Templates

If you wish to customize your own template, you can create a copy of our default template and edit it to suit your needs.

To create a custom template, start by making a copy of the default template and modify it according to your requirements.

Requirement of a Custom Template

• The template must be hosted publicly, on a Git Provider or another platform.
• An array of objects accessible as raw content.
• Each object needs to include the required properties.
• gitUrl field needs to be a public repository. This repository will serve as the core content of your template and will be used to build your Workspace.

Obtain Raw Content from a Public Repository

You can obtain raw content easily if the images and content of templates are available publicly with your Git provider.

We will be using README.me file as an example. You can do the same for other content.

1. Obtain raw content link from GitHub

• Open a public repository on GitHub in browser. In your repository’s list of files, select the README.md file.

• In the upper right corner of the file view, click Raw to see the raw content.

• Copy the URL in the browser. This link is a raw content link suitable for the value of rawReadmeUrl field.

2. Obtain raw content link from Gitlab

• Open a public repository on GitLab in the browser. In your repository’s list of files, select the README.md file.

• In the upper right corner of the file view, click on Open Raw to see the raw content (hover to see Open Raw, the button is in between the Download button and Copy file content button).

• Copy the URL in the browser. This link is a raw content link suitable for the value of rawReadmeUrl field.

3. Obtain raw content link from BitBucket

• Open a public repository on BitBucket in the browser. In your repository’s list of files, select the README.md file.

• In the upper right corner of the file view, click on the 𓈓 button next to Edit and select Open raw.

• Copy the URL in the browser. This link is a raw content link suitable for the value of the rawReadmeUrl field.

Deploy Custom Templates

You can build your own template within your organization to suit your development needs. While the Daytona installer script lives in your virtual machine, you can edit the file content to customize your template.

cd installer
nano setup.sh

./setup.sh

nano update-template.sh

#!/bin/bash
# https://blog.mdminhazulhaque.io/extract-patch-file-configmap

URL="https://raw.githubusercontent.com/daytonaio/samples-index/main/index.json"

# parse the arguments for --url
while [[ $# -gt 0 ]]; do
  key="$1"
  case $key in
    -u|--url)
      URL="$2"
      shift
      shift
      ;;
    *)
      shift
      ;;
  esac
done

# error if no url is provided
if [[ -z "$URL" ]]; then
  echo "ERROR: no url provided"
  exit 1
fi

kubectl -n watkins get configmap watkins-dashboard -o go-template='{{index .data "configuration.json"}}' | \
    jq --arg url "$URL" '.workspaceTemplatesIndexUrl = $url' > configuration.json

# trap the exit signal to delete configuration.json when the script exits
trap 'rm -f configuration.json' EXIT

echo "Replacing: $(kubectl -n watkins get configmap watkins-dashboard -o go-template='{{index .data "configuration.json"}}' | jq -r .workspaceTemplatesIndexUrl)"
echo "With: $URL"

kubectl -n watkins create configmap watkins-dashboard --from-file=configuration.json=configuration.json --dry-run=client -o yaml | \
    kubectl -n watkins patch configmaps watkins-dashboard --type merge --patch-file /dev/stdin

# restart the watkins-dashboard pod
kubectl -n watkins rollout restart deployment watkins-dashboard
kubectl -n watkins rollout status deployment watkins-dashboard --watch

./update-template.sh -u <your raw content link>