Configuration Files

Essh configuration is written in Lua. In the configuration files, you can use DSL syntax that is more human-readable.

Example

host "web01.localhost" {
    HostName = "192.168.0.11",
    Port = "22",
    User = "kohkimakimoto",
    description = "web01 development server",
    tags = {
        "web",
    },
}

host "web02.localhost" {
    HostName = "192.168.0.12",
    Port = "22",
    User = "kohkimakimoto",
    description = "web02 development server",
    tags = {
        "web",
    },
}

task "uptime" {
    backend = "remote",
    targets = "web",
    script = "uptime",
}

Another Syntax

The above example of configuration is written in Lua DSL style. You can also use plain Lua functions styles. The following examples are valid config code.

host("web01.localhost", {
    HostName = "192.168.0.11",
    Port = "22",
    User = "kohkimakimoto",
    description = "web01 development server",
    tags = {
        "web",
    },
})

or

local web01 = host "web01.localhost"
web01.HostName = "192.168.0.11"
web01.Port = "22"
web01.User = "kohkimakimoto"
web01.description = "web01 development server"
web01.tags = {
    "web",
}

Evaluating Orders

Essh loads configuration files from several different places. Configuration are applied in the following order:

1. Loads .esshconfig.lua that is in the current directory, if it exists.
2. If .esshconfig.lua in the current directory does not exist, Loads ~/.essh/config.lua.
3. Loads .esshconfig_override.lua that is in the current directory.
4. Loads ~/.essh/config_override.lua.

If you use --config command line option or ESSH_CONFIG environment variable, You can change loading file that is in the current directory.

Lua

Essh provides built-in Lua libraries that can be used in the configuration files.

Please see Lua VM.