SSH settings¶
You can index files remotely using SSH.
Here is a list of SSH settings (under server.
prefix):
Name | Default value | Documentation |
---|---|---|
server.hostname |
null |
Hostname |
server.port |
22 |
Port |
server.username |
null |
Username / Password |
server.password |
null |
Username / Password |
server.protocol |
"local" |
Set it to ssh |
server.pem_path |
null |
Using Username / PEM file |
Username / Password¶
Let’s say you want to index from a remote server using SSH:
- FS URL:
/path/to/data/dir/on/server
- Server:
mynode.mydomain.com
- Username:
username
- Password:
password
- Protocol:
ssh
(default tolocal
) - Port:
22
(default to22
)
name: "test"
fs:
url: "/path/to/data/dir/on/server"
server:
hostname: "mynode.mydomain.com"
port: 22
username: "username"
password: "password"
protocol: "ssh"
Using Username / PEM file¶
Let’s say you want to index from a remote server using SSH:
- FS URL:
/path/to/data/dir/on/server
- Server:
mynode.mydomain.com
- Username:
username
- PEM File:
/path/to/private_key.pem
- Protocol:
ssh
(default tolocal
) - Port:
22
(default to22
)
name: "test"
fs:
url: "/path/to/data/dir/on/server"
server:
hostname: "mynode.mydomain.com"
port: 22
username: "username"
password: "password"
protocol: "ssh"
pem_path: "/path/to/private_key.pem"
Windows drives¶
When using Windows, you might want to index documents coming from another drive than C:
.
To specify the drive, you need to use the following format:
name: "test"
fs:
url: "/D:/path/to/data/dir/on/server"
server:
hostname: "mynode.mydomain.com"
port: 22
username: "username"
password: "password"
protocol: "ssh"