Skip to content

Commit 0344b27

Browse files
committed
docs: rename the "provider" term in VFS config to "service"
See sxyazi/yazi#3403
1 parent 61aa495 commit 0344b27

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

docs/configuration/vfs.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,19 +11,23 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1111
If you want to fine-tune the default settings, the first step is to [create your own configuration file](/docs/configuration/overview).
1212
:::
1313

14-
You can register any supported virtual file service in your `vfs.toml`, for example:
14+
You can register any supported VFS provider in your `vfs.toml` as a service, for example:
1515

1616
```toml
17-
[providers.my-server]
17+
[services.my-server]
1818
type = "sftp"
1919
host = "1.2.3.4"
2020
user = "root"
2121
port = 22
2222
```
2323

24-
The provider here is `my-server`, you can use any other name you like in [kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case), up to 20 characters.
24+
The service here is `my-server`, you can use any other name you like in [kebab-case](https://developer.mozilla.org/en-US/docs/Glossary/Kebab_case), up to 20 characters.
2525

26-
Once registered, you can access them by the combination of provider type and name, for example, to start Yazi with the SFTP provider `my-server` as the working directory:
26+
Different names are considered as different virtual filesystems, even if they are configured with the same provider and exactly the same parameters.
27+
28+
## Usage
29+
30+
Once registered, you can access them by the combination of provider type and name, for example, to start Yazi with the SFTP service `my-server` as the working directory:
2731

2832
```sh
2933
yazi sftp://my-server
@@ -47,14 +51,14 @@ run = "reveal sftp://my-server//root/dog.jpg"
4751
desc = "Reveal dog.jpg on my-server"
4852
```
4953

50-
## SFTP
54+
## SFTP Provider
5155

5256
Yazi has an SFTP VFS provider built-in, which means you can manage files on remote servers over SSH.
5357

5458
To register an SFTP VFS named `my-server`, add the following to your `vfs.toml`:
5559

5660
```toml
57-
[providers.my-server]
61+
[services.my-server]
5862
type = "sftp"
5963
host = "1.2.3.4"
6064
user = "root"
@@ -68,7 +72,7 @@ On Unix-like systems the SSH agent is provided by `ssh-agent`. You can list the
6872
If you don't want to use an agent and prefer to specify a private key file, add the `key_file` and `key_passphrase` options, for example:
6973

7074
```toml
71-
[providers.my-server]
75+
[services.my-server]
7276
type = "sftp"
7377
host = "1.2.3.4"
7478
user = "root"
@@ -81,7 +85,7 @@ key_file = "~/.ssh/id_rsa"
8185
You can also authenticate with a password using the `password` option:
8286

8387
```toml
84-
[providers.my-server]
88+
[services.my-server]
8589
type = "sftp"
8690
host = "1.2.3.4"
8791
user = "root"
@@ -92,7 +96,7 @@ password = "my_password"
9296
If you want to use an agent socket other than `$SSH_AUTH_SOCK`, for example, if you [manage SSH keys with 1Password](https://developer.1password.com/docs/ssh/manage-keys/), specify it with `identity_agent`:
9397

9498
```toml
95-
[providers.my-server]
99+
[services.my-server]
96100
type = "sftp"
97101
host = "1.2.3.4"
98102
user = "root"

0 commit comments

Comments
 (0)