class RemoteConfig

Included Modules

Defined in:

runway/models/configs/remote_config.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(ctx : YAML::ParseContext, node : YAML::Nodes::Node) #

[View source]

Instance Method Detail

def auth : String | Nil #

@return [String, nil] The authentication method to use when connecting to the remote server. Options include: login, publickey, or agent see: https://github.com/spider-gazelle/ssh2.cr/blob/1e3fc7da3cc5d7689dea6b57e50e1713050f84fd/src/session.cr#L149-L177


[View source]
def auth=(auth : String | Nil) #

@return [String, nil] The authentication method to use when connecting to the remote server. Options include: login, publickey, or agent see: https://github.com/spider-gazelle/ssh2.cr/blob/1e3fc7da3cc5d7689dea6b57e50e1713050f84fd/src/session.cr#L149-L177


[View source]
def host : String | Nil #

@return [String] The type hostname / ip address of the remote server to SSH into.


[View source]
def host=(host : String | Nil) #

@return [String] The type hostname / ip address of the remote server to SSH into.


[View source]
def passphrase : String | Nil #

@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the passphrase from for the remote server when using a private key. this value is not required if the private key is not encrypted with a passphrase


[View source]
def passphrase=(passphrase : String | Nil) #

@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the passphrase from for the remote server when using a private key. this value is not required if the private key is not encrypted with a passphrase


[View source]
def password : String | Nil #

@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the password from for the remote server. User's should absolutely not store passwords in the configuration file.


[View source]
def password=(password : String | Nil) #

@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the password from for the remote server. User's should absolutely not store passwords in the configuration file.


[View source]
def port : Int32 | Nil #

@return [Int32] The port to use when connecting to the remote server.


[View source]
def port=(port : Int32 | Nil) #

@return [Int32] The port to use when connecting to the remote server.


[View source]
def private_key_path : String | Nil #

@return [String, nil] The path to the private key to use when connecting to the remote server. this value is required if the auth is set to publickey by the underlying library see: https://github.com/spider-gazelle/ssh2.cr/blob/1e3fc7da3cc5d7689dea6b57e50e1713050f84fd/src/session.cr#L159-L163


[View source]
def private_key_path=(private_key_path : String | Nil) #

@return [String, nil] The path to the private key to use when connecting to the remote server. this value is required if the auth is set to publickey by the underlying library see: https://github.com/spider-gazelle/ssh2.cr/blob/1e3fc7da3cc5d7689dea6b57e50e1713050f84fd/src/session.cr#L159-L163


[View source]
def public_key_path : String | Nil #

@return [String, nil] The path to the public key to use when connecting to the remote server.


[View source]
def public_key_path=(public_key_path : String | Nil) #

@return [String, nil] The path to the public key to use when connecting to the remote server.


[View source]
def success_string : String | Nil #

@return [String, nil] A "string" to search for in the remote command output to determine if the command was successful.


[View source]
def success_string=(success_string : String | Nil) #

@return [String, nil] A "string" to search for in the remote command output to determine if the command was successful.


[View source]
def username : String | Nil #

@return [String] The username to use when connecting to the remote server.


[View source]
def username=(username : String | Nil) #

@return [String] The username to use when connecting to the remote server.


[View source]