Skip to content

Commit

Permalink
add document for filesystemstorage
Browse files Browse the repository at this point in the history
  • Loading branch information
xiaokangwang committed Feb 5, 2025
1 parent 055bb33 commit fd227ba
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,7 @@ export default defineUserConfig({
'/v5/config/service/backgroundObservatory',
'/v5/config/service/tun',
'/v5/config/service/subscription',
'/v5/config/service/filesystemstorage',
],
}
],
Expand Down Expand Up @@ -416,6 +417,7 @@ export default defineUserConfig({
'/en_US/v5/config/service/backgroundObservatory',
'/en_US/v5/config/service/tun',
'/en_US/v5/config/service/subscription',
'/en_US/v5/config/service/filesystemstorage',
],
}
],
Expand Down
16 changes: 16 additions & 0 deletions docs/en_US/v5/config/service/filesystemstorage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# File System Storage
* Name: `filesystemstorage`
* Type: Service
* ID: `service.filesystemstorage`

File system storage is a persistent storage implementation that stores information using plain files. (v5.27.0+)

Please ensure that the provided file system supports long file names.

> `stateStorageRoot`: ["WorkDir"]
The location to store states. Currently, only `WorkDir` is supported. This is the directory from which v2ray is running.

> `instanceName`: string
The name of the current instance. This will become the directory name where the states are stored.
16 changes: 16 additions & 0 deletions docs/v5/config/service/filesystemstorage.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# 文件系统持久存储
* 名称: `filesystemstorage`
* 类型: Service
* ID: `service.filesystemstorage`

文件系统存储是一种使用普通文件存储数据的持久存储实现。(v5.27.0+)

请确保所使用的文件系统支持长文件名。

> `stateStorageRoot`: ["WorkDir"]
存储位置。目前,仅支持 `WorkDir`。这是 v2ray 运行的目录。

> `instanceName`: 字符串
当前实例的名称。这将成为存储状态的目录名。

0 comments on commit fd227ba

Please sign in to comment.