Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
anh-bolt committed Aug 19, 2024
1 parent f66cb60 commit be2aae0
Showing 1 changed file with 31 additions and 29 deletions.
60 changes: 31 additions & 29 deletions sftp-connector-product/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,58 +55,60 @@ Before starting the demo, please make sure to have an SSH/SFTP server on your co

\* In order to test the connector with SSH key pair, put the public key file to folder `c:/sshkey`.

2. Open the `configuration/variables.yaml` in your Designer and update the following global variables:

2. Configure one or more SFTP connectors in global variables. A SFTP connector is identified by a name and a global variable section containing access information. The following example shows connection information for a SFTP connector that should be accessible under the name local-rebex.
Put this variable block into your project. At least `host`, `auth`, `username` and `password` must be defined.
```
Variables:
com.axonivy.connector.sftp.server:
# The host name to the SFTP server
host: 'localhost'
local-rebex:
# The host name to the SFTP server
host: 'localhost'
# Auth type to the SFPT server: password OR ssh
auth: 'password'
# Auth type to the SFPT server: password OR ssh
auth: 'password'
# The password to the SFTP server
password: pwd
# The password to the SFTP server
password: pwd
# The port number to the SFTP server
port: 22
# The port number to the SFTP server
port: 22
# The username to the SFTP server
username: 'usr'
# The username to the SFTP server
username: 'usr'
```

Or in order to enable the connector with SSH keypair, update following global variables:
Or in order to enable the connector with SSH keypair, `secret.sshkey` and `secret.sshpassphrase` must be defined:
```
Variables:
com.axonivy.connector.sftp.server:
# The host name to the SFTP server
host: 'localhost'
local-rebex:
# The host name to the SFTP server
host: 'localhost'
# Auth type to the SFPT server: password OR ssh
auth: 'ssh'
# Auth type to the SFPT server: password OR ssh
auth: 'ssh'
# The password to the SFTP server
password: ''
# The password to the SFTP server
password: ''
# The port number to the SFTP server
port: 22
# The port number to the SFTP server
port: 22
# The username to the SFTP server
username: 'usr'
# The username to the SFTP server
username: 'usr'
# The ssh key string to SFTP server
# [secret private key]
secret_sshkey: |
YOUR PRIVATE KEY CONTENT HERE
# The ssh key string to SFTP server
# [secret private key]
secret.sshkey: |
YOUR PRIVATE KEY CONTENT HERE
# The ssh key passphrase
secret_sshpassphrase: 'Your ssh key passphrase'
# The ssh key passphrase
secret.sshpassphrase: 'Your ssh key passphrase'
```
\* the private key is in pair of the public key put in step 1

Expand Down

0 comments on commit be2aae0

Please sign in to comment.