Repository files navigation

Run yourTaskfile.yml from the browser.

Start the Docker image withtask docker:run.

Task UI is meant for Docker environments. A generic Dockerfile exists, whichbundles typical dependencies liketask,ttyrec,docker,docker compose.

To use, start by navigating to thedockersubfolder. It contains a Taskfile, with the typical commands to build andrun task-ui from a Docker image. For examples with Taskfiles you couldrun, look into the folderexamples.

The layout is somewhat responsive, supporting mobile.

To set up your project to run with Task UI, it's recommended you use theexample Docker Compose setup here:

services:runner:image:titpetric/task-uirestart:alwaysbuild:.command:      ---history-enableports:    -3000:3000volumes:    -$PWD/app:/app    -/var/run/docker.sock:/var/run/docker.sock:ro

In particular, you should mount your/app folder which contains yourTaskfile.yml,docker-compose.yml and other files. Task UI will runwith what you provide it with.

• If you don't want history, remove thecommand flags.
• If you don't want to use Docker, remove the volume fordocker.sock.

The image provides anid_ecdsa key to use for SSH hops. The recommendedway to deploy is to provide your owndocker/root/.ssh folder withthe SSH keys. You can regenerate the SSH key withtask docker:gen.

task: Available tasks for this project:

• default: Run everything
• fix: Fix code
• install: Install task-ui
• run: Run task-ui
• test: Test task-ui
• docker:build: Build task-ui docker image
• docker:gen: Generate ssh key for docker image
• docker:run: Run task-ui in docker env

Run everything

commands:

• Task: fix
• Task: install
• Task: test

Test task-ui

commands:

• CGO_ENABLED=1 go test -race -count=1 -cover ./...
• CGO_ENABLED=0 go test -count=1 -cover ./...

Run task-ui

commands:

• task-ui --history-enable

Install task-ui

commands:

• CGO_ENABLED=0 go install .

Fix code

dependencies:

• deps:goimports

commands:

• goimports -w .
• go fmt ./...
• go vet .
• go mod tidy
• ./README.md.sh > README.md