PHP Interface Deployer\Builder\BuilderInterface

Exibir arquivo Open project: elfet/deployer Interface Usage Examples

Public Methods

Method Description
configFile ( string $file = '~/.ssh/config' ) : Deployer\Builder\BuilderInterface If you use an ssh config file you can user it.
forwardAgent ( ) : Deployer\Builder\BuilderInterface Using forward agent to authentication
identityFile ( string $publicKeyFile = '~/.ssh/id_rsa.pub', string $privateKeyFile = '~/.ssh/id_rsa', string $passPhrase = '' ) : Deployer\Builder\BuilderInterface Authenticate with public key
password ( string | null | Deployer\Server\Password\PasswordGetterInterface $password = null ) : Deployer\Builder\BuilderInterface Set password for connection
pemFile ( string $pemFile ) : Deployer\Builder\BuilderInterface
set ( string $name, array | integer | string $value ) : Deployer\Builder\BuilderInterface Set server configuration.
stage ( string | array $stages ) : Deployer\Builder\BuilderInterface
user ( string $name ) : Deployer\Builder\BuilderInterface Define user name for authentication.

Method Details

configFile() public method

If you use an ssh config file you can user it.
public configFile ( string $file = '~/.ssh/config' ) : Deployer\Builder\BuilderInterface
$file string Config file path
return Deployer\Builder\BuilderInterface

forwardAgent() public method

Using forward agent to authentication
public forwardAgent ( ) : Deployer\Builder\BuilderInterface
return Deployer\Builder\BuilderInterface

identityFile() public method

Authenticate with public key
public identityFile ( string $publicKeyFile = '~/.ssh/id_rsa.pub', string $privateKeyFile = '~/.ssh/id_rsa', string $passPhrase = '' ) : Deployer\Builder\BuilderInterface
$publicKeyFile string
$privateKeyFile string
$passPhrase string
return Deployer\Builder\BuilderInterface

password() public method

Set password for connection
public password ( string | null | Deployer\Server\Password\PasswordGetterInterface $password = null ) : Deployer\Builder\BuilderInterface
$password string | null | Deployer\Server\Password\PasswordGetterInterface If you did not define password it will be asked on connection.
return Deployer\Builder\BuilderInterface

pemFile() public method

public pemFile ( string $pemFile ) : Deployer\Builder\BuilderInterface
$pemFile string
return Deployer\Builder\BuilderInterface

set() public method

Set server configuration.
public set ( string $name, array | integer | string $value ) : Deployer\Builder\BuilderInterface
$name string
$value array | integer | string
return Deployer\Builder\BuilderInterface

stage() public method

public stage ( string | array $stages ) : Deployer\Builder\BuilderInterface
$stages string | array
return Deployer\Builder\BuilderInterface

user() public method

Define user name for authentication.
public user ( string $name ) : Deployer\Builder\BuilderInterface
$name string
return Deployer\Builder\BuilderInterface