mirror of
https://gitlab.easter-eggs.com/ee/ldapsaisie.git
synced 2024-11-18 08:19:05 +01:00
Improve/fix SSH LSaddon documentation
This commit is contained in:
parent
a0e6cea771
commit
d3f719a4e5
2 changed files with 37 additions and 17 deletions
|
@ -21,9 +21,9 @@
|
||||||
******************************************************************************/
|
******************************************************************************/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
************************************************
|
*********************************
|
||||||
* Données de configuration pour le support FTP *
|
* Configuration for SSH support *
|
||||||
************************************************
|
*********************************
|
||||||
*/
|
*/
|
||||||
|
|
||||||
// PhpSecLib autoload file path
|
// PhpSecLib autoload file path
|
||||||
|
|
|
@ -88,7 +88,27 @@ LSerror :: defineError('SSH_07',
|
||||||
*
|
*
|
||||||
* @author Benjamin Renard <brenard@easter-eggs.com>
|
* @author Benjamin Renard <brenard@easter-eggs.com>
|
||||||
*
|
*
|
||||||
* @param[in] $params array The SSH connexion parameters
|
* @param[in] $params array The SSH connexion parameters :
|
||||||
|
* array (
|
||||||
|
* 'host' => '[SSH server hostname/IP]', // required
|
||||||
|
* 'port' => [SSH port], // optional, default : 22
|
||||||
|
* 'timeout' => [SSH connection timeout], // optional, default : 10
|
||||||
|
*
|
||||||
|
* // Authentication
|
||||||
|
* 'user' => '[SSH remote user]', // required
|
||||||
|
*
|
||||||
|
* // Auth method :
|
||||||
|
* // One of the following method configuration is required.
|
||||||
|
*
|
||||||
|
* // Auth using simple password
|
||||||
|
* 'password' => '[secret password]'
|
||||||
|
*
|
||||||
|
* // Auth using a key
|
||||||
|
* 'auth_key' => array (
|
||||||
|
* 'file_path' => '[SSH private key file path]',
|
||||||
|
* 'password' => '[SSH private key file password]' // Only if need
|
||||||
|
* )
|
||||||
|
* )
|
||||||
* @param[in] $sftp boolean Enable SFTP mode (default : false)
|
* @param[in] $sftp boolean Enable SFTP mode (default : false)
|
||||||
*
|
*
|
||||||
* @retval mixed SSH2/SFTP object or false
|
* @retval mixed SSH2/SFTP object or false
|
||||||
|
|
Loading…
Reference in a new issue