Skip to content

Commit fd227ba

Browse files
committed
add document for filesystemstorage
1 parent 055bb33 commit fd227ba

File tree

3 files changed

+34
-0
lines changed

3 files changed

+34
-0
lines changed

docs/.vuepress/config.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,7 @@ export default defineUserConfig({
229229
'/v5/config/service/backgroundObservatory',
230230
'/v5/config/service/tun',
231231
'/v5/config/service/subscription',
232+
'/v5/config/service/filesystemstorage',
232233
],
233234
}
234235
],
@@ -416,6 +417,7 @@ export default defineUserConfig({
416417
'/en_US/v5/config/service/backgroundObservatory',
417418
'/en_US/v5/config/service/tun',
418419
'/en_US/v5/config/service/subscription',
420+
'/en_US/v5/config/service/filesystemstorage',
419421
],
420422
}
421423
],
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# File System Storage
2+
* Name: `filesystemstorage`
3+
* Type: Service
4+
* ID: `service.filesystemstorage`
5+
6+
File system storage is a persistent storage implementation that stores information using plain files. (v5.27.0+)
7+
8+
Please ensure that the provided file system supports long file names.
9+
10+
> `stateStorageRoot`: ["WorkDir"]
11+
12+
The location to store states. Currently, only `WorkDir` is supported. This is the directory from which v2ray is running.
13+
14+
> `instanceName`: string
15+
16+
The name of the current instance. This will become the directory name where the states are stored.
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# 文件系统持久存储
2+
* 名称: `filesystemstorage`
3+
* 类型: Service
4+
* ID: `service.filesystemstorage`
5+
6+
文件系统存储是一种使用普通文件存储数据的持久存储实现。(v5.27.0+)
7+
8+
请确保所使用的文件系统支持长文件名。
9+
10+
> `stateStorageRoot`: ["WorkDir"]
11+
12+
存储位置。目前,仅支持 `WorkDir`。这是 v2ray 运行的目录。
13+
14+
> `instanceName`: 字符串
15+
16+
当前实例的名称。这将成为存储状态的目录名。

0 commit comments

Comments
 (0)