Skip to content
Open
Show file tree
Hide file tree
Changes from 6 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
735 changes: 470 additions & 265 deletions CHANGELOG.md
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't change the file structure.

Large diffs are not rendered by default.

389 changes: 113 additions & 276 deletions README.md
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are some nice updates.
Can you jus try to not change the file structure and not change the github links please ?

Beside that, I like :

  • the "table of content".
  • the "Features" sections (Current + Added).
  • the "Contribution" section.
  • the "License" section.
  • the footer with "License, Version, Issues, Forks and Stars".

The roadmap could be a great addition but for now We can put it to the side and rethink about it later.

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@thebestbradley What about adding you as an official contributor on this repo ? This way we could put our efforts together 🙂 Of course you can keep your fork and continue to work on it if you want and/or prefer.

Large diffs are not rendered by default.

53 changes: 33 additions & 20 deletions docs/sftp_configuration.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,35 @@
# SFTP configuration

## agent
*string*: Path to ssh-agent's UNXI socket for ssh-agent-based user authentication.

_string_: Path to ssh-agent's UNXI socket for ssh-agent-based user authentication.
Windows users must set to 'pageant' for authenticating with Pagenat or (actual) path to a Cygwin "UNIX socket".
Id get more stability because some client/server have some sort of configured/hard coded limit.

## privateKeyPath
*string*: Absolute path to user's private key.

_string_: Absolute path to user's private key.

## passphrase
*mixed*: For an encrypted private key, this is the passphrase string used to decrypt it.

_mixed_: For an encrypted private key, this is the passphrase string used to decrypt it.
Set to true for enabling passphrase dialog. This will prevent from using cleartext passphrase in this config.

## interactiveAuth
*boolean*|*string[]*: Enable keyboard interaction authentication mechanism. Set to true to enable `verifyCode` dialog.

_boolean_|_string[]_: Enable keyboard interaction authentication mechanism. Set to true to enable `verifyCode` dialog.
For example using Google Authentication (multi-factor). Or pass array of predefined phrases to automatically enter them without user prompting.

Note: *Requires the server to have keyboard-interactive authentication enabled.*
Note: _Requires the server to have keyboard-interactive authentication enabled._

**default**: false

## algorithms

Explicit overrides for the default transport layer algorithms used for the connection.

**default**:

```json
{
"algorithms": {
Expand All @@ -35,15 +41,15 @@ Explicit overrides for the default transport layer algorithms used for the conne
],
"cipher": [
"aes128-gcm",
"[email protected]",
"aes256-gcm",
"[email protected]",
"aes128-cbc",
"aes192-cbc",
"aes256-cbc",
"aes128-ctr",
"aes192-ctr",
"aes256-ctr"
"[email protected]",
"aes256-gcm",
"[email protected]",
"aes128-cbc",
"aes192-cbc",
"aes256-cbc",
"aes128-ctr",
"aes192-ctr",
"aes256-ctr"
],
"serverHostKey": [
"ssh-rsa",
Expand All @@ -52,21 +58,28 @@ Explicit overrides for the default transport layer algorithms used for the conne
"ecdsa-sha2-nistp256",
"ecdsa-sha2-nistp384",
"ecdsa-sha2-nistp521",
"rsa-sha2-512",
"rsa-sha2-256"
"rsa-sha2-512",
"rsa-sha2-256"
],
"hmac": [
"hmac-sha2-256",
"hmac-sha2-512"
]
"hmac": ["hmac-sha2-256", "hmac-sha2-512"]
}
}
```

## sshConfigPath

Absolute path to your SSH configuration file.

**default**: `~/.ssh/config`

## sshCustomParams

Extra parameters appended to the SSH command used by "Open SSH in Terminal".

## Proxy Configuration

- proxyHost: Proxy server hostname
- proxyPort: Proxy server port
- proxyType: 'http' or 'socks5'
- proxyUsername: Username for proxy authentication (optional)
- proxyPassword: Password for proxy authentication (optional)
153 changes: 147 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading