Skip to content
This repository has been archived by the owner on Mar 9, 2022. It is now read-only.

Commit

Permalink
Amend README.md with configuration information
Browse files Browse the repository at this point in the history
  • Loading branch information
edno committed Jul 3, 2016
1 parent 9b8af94 commit 0f8fb1d
Showing 1 changed file with 27 additions and 4 deletions.
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,14 @@
[![Coverage Status](https://img.shields.io/coveralls/edno/codeception-secureshell.svg?style=flat-square)](https://coveralls.io/github/edno/codeception-secureshell?branch=master)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/edno/codeception-secureshell/master/LICENSE)

The [Codeception](http://codeception.com/) module for **SSH commands** and **SSH tunnels**
The [Codeception](http://codeception.com/) module for **SSH commands**, **SFTP access** and **SSH tunnels**

If you just need a **SFTP** connection, please consider the in-built Codeception [FTP module](http://codeception.com/docs/modules/FTP).

## Roadmap
- 0.1: Basic commands for testing remote file system and commands
- 0.2: Tunnel commands
- 0.3: Services and advanced commands
- [x] **0.1**: Basic commands for testing remote file system and commands
- [ ] 0.2: Tunnel commands
- [ ] 0.3: Services and advanced commands

## Minimum Requirements
- Codeception 2.2
Expand All @@ -38,3 +40,24 @@ module:
enabled:
- Codeception\Extension\SecureShell
```
### Parameters
By default the module always [accepts the host public key fingerprint](https://en.wikibooks.org/wiki/Guide_to_Unix/Explanations/Connecting_to_Remote_Unix#Accepting_the_Key_Fingerprint).
You can enable a strict mode where only known hosts will be accepted by setting the configuration parameter `StrictHostKeyChecking` to `true`.
Once enabled, the module will verify the host fingerprint against a `known_hosts` file located at the root directory of your Codeception project.
```yaml
modules:
config:
Codeception\Extension\SecureShell:
StrictHostKeyChecking: true
```
If you want to reuse an existing `known_hosts` file, you can use the parameter `KnownHostsFile` for specifying the location of the file.
```yaml
modules:
config:
Codeception\Extension\SecureShell:
StrictHostKeyChecking: true
KnownHostsFile: '/etc/ssh/known_hosts'
```
The file must respect the [OpenSSH **~/.ssh/known_hosts** format](https://en.wikibooks.org/wiki/OpenSSH/Client_Configuration_Files#.7E.2F.ssh.2Fknown_hosts).

0 comments on commit 0f8fb1d

Please sign in to comment.