class RemoteConfig
- RemoteConfig
- Reference
- Object
Included Modules
- YAML::Serializable
Defined in:
runway/models/configs/remote_config.crConstructors
Instance Method Summary
-
#auth : String | Nil
@return [String, nil] The authentication method to use when connecting to the remote server.
-
#auth=(auth : String | Nil)
@return [String, nil] The authentication method to use when connecting to the remote server.
-
#host : String | Nil
@return [String] The type hostname / ip address of the remote server to SSH into.
-
#host=(host : String | Nil)
@return [String] The type hostname / ip address of the remote server to SSH into.
-
#passphrase : String | Nil
@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the passphrase from for the remote server when using a private key.
-
#passphrase=(passphrase : String | Nil)
@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the passphrase from for the remote server when using a private key.
-
#password : String | Nil
@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the password from for the remote server.
-
#password=(password : String | Nil)
@return [String, nil] The ENVIRONMENT VARIABLE, to fetch the password from for the remote server.
-
#port : Int32 | Nil
@return [Int32] The port to use when connecting to the remote server.
-
#port=(port : Int32 | Nil)
@return [Int32] The port to use when connecting to the remote server.
-
#private_key_path : String | Nil
@return [String, nil] The path to the private key to use when connecting to the remote server.
-
#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.
-
#public_key_path : String | Nil
@return [String, nil] The path to the public key to use when connecting to the remote server.
-
#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.
-
#success_string : String | Nil
@return [String, nil] A "string" to search for in the remote command output to determine if the command was successful.
-
#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.
-
#username : String | Nil
@return [String] The username to use when connecting to the remote server.
-
#username=(username : String | Nil)
@return [String] The username to use when connecting to the remote server.
Constructor Detail
Instance Method Detail
@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
@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
@return [String] The type hostname / ip address of the remote server to SSH into.
@return [String] The type hostname / ip address of the remote server to SSH into.
@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
@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
@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.
@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.
@return [Int32] The port to use when connecting to the remote server.
@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
@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
@return [String, nil] The path to the public key to use when connecting to the remote server.
@return [String, nil] The path to the public key to use when connecting to the remote server.
@return [String, nil] A "string" to search for in the remote command output to determine if the command was successful.
@return [String, nil] A "string" to search for in the remote command output to determine if the command was successful.
@return [String] The username to use when connecting to the remote server.
@return [String] The username to use when connecting to the remote server.