Skip to content

installers.base #

Installer - Base Module

This module provides heroscript actions to install and configure base system dependencies.

Actions

base.install

Installs base packages for the detected operating system (OSX, Ubuntu, Alpine, Arch).

Parameters:

  • reset (bool): If true, reinstalls packages even if they are already present. Default: false.
  • develop (bool): If true, installs development packages. Default: false.

Example:

!!base.install
develop: true

base.develop

Installs development packages for the detected operating system.

Parameters:

  • reset (bool): If true, reinstalls packages. Default: false.

Example:

!!base.develop
reset: true

base.redis_install

Installs and configures Redis server.

Parameters:

  • port (int): Port for Redis to listen on. Default: 6379.
  • ipaddr (string): IP address to bind to. Default: localhost.
  • reset (bool): If true, reinstalls and reconfigures Redis. Default: false.
  • start (bool): If true, starts the Redis server after installation. Default: true.

Example:

!!base.redis_install
port: 6380

fn check #

fn check(args RedisInstallArgs) bool

fn develop #

fn develop(args InstallArgs) !

fn install #

fn install(args_ InstallArgs) !

install base will return true if it was already installed

fn play #

fn play(mut plbook playbook.PlayBook) !

fn redis_install #

fn redis_install(args_ RedisInstallArgs) !
struct InstallArgs {
    port    int    = 6379
    datadir string = '${os.home_dir()}/hero/var/redis'
    ipaddr  string = "localhost" //can be more than 1, space separated
    reset   bool
    start   bool
    restart bool = true
}

fn sshkeysinstall #

fn sshkeysinstall(args InstallArgs) !

fn start #

fn start(args RedisInstallArgs) !

fn stop #

fn stop() !

struct InstallArgs #

@[params]
struct InstallArgs {
pub mut:
	reset   bool
	develop bool
}

struct RedisInstallArgs #

@[params]
struct RedisInstallArgs {
pub mut:
	port    int    = 6379
	datadir string ='${os.home_dir()}/hero/var/redis'
	ipaddr  string = 'localhost' // can be more than 1, space separated
	reset   bool
	start   bool
	restart bool // do not put on true
}