README
¶
docket
A declarative way to pre-package and ship applications on Dokku.
Installation
Install the latest release with the quick install script (Linux, macOS, or a POSIX shell on Windows):
curl -fsSL https://raw.githubusercontent.com/dokku/docket/main/install.sh | sh
Or via Homebrew:
brew install dokku/repo/docket
Or with the Go toolchain:
go install github.com/dokku/docket@latest
See the Getting started guide for all channels, including prebuilt binaries and Debian/Ubuntu packages.
Usage
Describe the desired state of your app in a tasks.yml recipe:
---
- tasks:
- dokku_app:
app: inflector
- dokku_git_sync:
app: inflector
remote: http://github.com/cakephp/inflector.cakephp.org
Preview what would change, then apply it:
docket plan # show what apply would do, without changing anything
docket apply # make the changes needed to match the recipe
Running docket apply again is a no-op when the server already matches the recipe.
Documentation
- Getting started -- why docket, installation, and your first recipe
- Command reference -- every command and flag
- Recipes -- the recipe file format, plays, and multi-app recipes
- HCL recipes -- writing a recipe in HCL, block by block
- Inputs -- parameterize a recipe with variables and
--vars-file - Task envelope -- tags, conditionals, loops, and error handling per task
- Remote execution -- drive a remote Dokku server over SSH
- JSON output -- the
--jsonevent schema forapplyandplan - Writing tasks -- contribute a new task type
- Tasks -- reference for every task type
License
Documentation
¶
There is no documentation for this package.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
sdk
command
Command sdk writes the public sdk package's generated files from the engine: sdk/sdk_gen.go, the functions, constants and variables an embedding caller uses, and sdk/types_gen.go, a type alias for every engine type that caller has to be able to name.
|
Command sdk writes the public sdk package's generated files from the engine: sdk/sdk_gen.go, the functions, constants and variables an embedding caller uses, and sdk/types_gen.go, a type alias for every engine type that caller has to be able to name. |
|
internal
|
|
|
commands/templates
Package templates ships the embedded scaffolds used by `docket init`.
|
Package templates ships the embedded scaffolds used by `docket init`. |
|
fakedokku
Package fakedokku is the stateful fake dokku server behind sdk/dokkutest.
|
Package fakedokku is the stateful fake dokku server behind sdk/dokkutest. |
|
subprocess
Package subprocess SSH transport.
|
Package subprocess SSH transport. |
|
Package sdk is the supported way to drive docket's engine from Go: build and run tasks, read a server back as a recipe or one resource at a time, and describe the registered task types.
|
Package sdk is the supported way to drive docket's engine from Go: build and run tasks, read a server back as a recipe or one resource at a time, and describe the registered task types. |
|
dokkutest
Package dokkutest is a stateful fake dokku server for tests that drive docket's tasks through the sdk package without a real server.
|
Package dokkutest is a stateful fake dokku server for tests that drive docket's tasks through the sdk package without a real server. |
Click to show internal directories.
Click to hide internal directories.