Skip to content
Documentation
Configuration

Configuration

The worky.Config struct is the only configuration surface. Pass it to worky.New().

type Config struct {
    Name     string    // Workshop display name
    HomeDir  string    // State directory under home (default: ".worky")
    Port     int       // Default HTTP port (default: 8080)
    SiteFS   fs.FS     // Embedded Hugo output (must contain a "site/" subdirectory)
    Chapters []Chapter
}

Fields

Name 

Name: "My Workshop"

Displayed as the CLI tool name in help output and printed by status. Required.

HomeDir 

HomeDir: ".my-workshop"

The subdirectory under $HOME where worky stores state files:

FilePurpose
progress.jsonChapter unlock/complete state
server.pidPID of the background server (when --detach is used)
server.logLog output of the background server

Defaults to .worky if empty.

Port 

Port: 8080

The default HTTP port for serve. Participants can override with --port N. Defaults to 8080 if zero.

SiteFS 

//go:embed all:site
var site embed.FS

worky.New(worky.Config{
    SiteFS: site,
    // ...
})

An fs.FS containing the pre-built Hugo output. The embedded FS must contain a site/ subdirectory — worky calls fs.Sub(siteFS, "site") internally to strip the prefix.

The standard pattern is to build Hugo with publishDir = "site" and embed with //go:embed all:site.

Chapters 

Chapters: []worky.Chapter{
    {ID: "00", Name: "Setup",     Slug: "00-setup",     Checks: [...]},
    {ID: "01", Name: "Chapter 1", Slug: "01-chapter1",  Checks: [...]},
}

Ordered list of chapters. The first chapter is always unlocked. See Chapters for the full Chapter struct reference.

Full example 

package main

import (
    "embed"
    "time"

    "github.com/davideimola/worky"
    "github.com/davideimola/worky/checks"
)

//go:embed all:site
var site embed.FS

func main() {
    worky.New(worky.Config{
        Name:    "Kubernetes Workshop",
        HomeDir: ".k8s-workshop",
        Port:    9090,
        SiteFS:  site,
        Chapters: []worky.Chapter{
            {
                ID:   "00",
                Name: "Prerequisites",
                Slug: "00-prerequisites",
                Checks: []worky.Check{
                    {
                        Description: "kubectl is installed",
                        Run:         checks.CommandSucceeds("kubectl", "version", "--client"),
                    },
                    {
                        Description: "Cluster is reachable",
                        Run:         checks.CommandSucceeds("kubectl", "cluster-info"),
                        Timeout:     10 * time.Second,
                        Retries:     3,
                        RetryDelay:  2 * time.Second,
                    },
                },
            },
        },
    }).Run()
}
Getting StartedChapters