Add docs for directory mode configuration (#71)

* Add docs for directory mode configuration

Signed-off-by: Edward Broeder <eddie.broeder@intel.com>

* Add periods at the end of comments

Signed-off-by: Edward Broeder <eddie.broeder@intel.com>

* Add some missing documentation for log rotation

Signed-off-by: Edward Broeder <eddie.broeder@intel.com>

---------

Signed-off-by: Edward Broeder <eddie.broeder@intel.com>
This commit is contained in:
embroede 2024-02-29 21:50:54 -08:00 committed by GitHub
parent b289c1dbcf
commit 038d93cde6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 48 additions and 0 deletions

View File

@ -21,6 +21,10 @@ gcInterval: 1m0s
# In macos(just for testing), default value is /Users/$USER/.dragonfly.
workHome: ''
# workHomeMode is used to set the file mode bits for the workHome directory.
# The default is 0755.
workHomeMode: 0755
# logDir is the log directory.
# In linux, default value is /var/log/dragonfly.
# In macos(just for testing), default value is /Users/$USER/.dragonfly/logs.
@ -31,6 +35,10 @@ logDir: ''
# In macos(just for testing), default value is /Users/$USER/.dragonfly/cache.
cacheDir: ''
# cacheDirMode is used to set the file mode bits for the cacheDir directory.
# The default is 0755.
cacheDirMode: 0755
# pluginDir is the plugin directory.
# In linux, default value is /usr/local/dragonfly/plugins.
# In macos(just for testing), default value is /Users/$USER/.dragonfly/plugins.
@ -41,6 +49,10 @@ pluginDir: ''
# In macos(just for testing), default value is /Users/$USER/.dragonfly/data.
dataDir: ''
# dataDirMode is used to set the file mode bits for the dataDir directory.
# The default is 0755.
dataDirMode: 0755
# When daemon exit, keep peer task data or not.
# it is usefully when upgrade daemon service, all local cache will be saved
# default is false.

View File

@ -20,6 +20,10 @@ gcInterval: 1m0s
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly。
workHome: ''
# workHomeMode is used to set the file mode bits for the workHome directory.
# The default is 0755.
workHomeMode: 0755
# 服务的日志目录。
# Linux 上默认目录 /var/log/dragonfly。
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/logs。
@ -30,6 +34,10 @@ logDir: ''
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/cache。
cacheDir: ''
# cacheDirMode is used to set the file mode bits for the cacheDir directory.
# The default is 0755.
cacheDirMode: 0755
# 服务的插件目录。
# Linux 上默认目录 /usr/local/dragonfly/plugins。
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/plugins。
@ -40,6 +48,10 @@ pluginDir: ''
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/data/。
dataDir: ''
# dataDirMode is used to set the file mode bits for the dataDir directory.
# The default is 0755.
dataDirMode: 0755
# 当 daemon 退出是, 是否保存缓存数据。
# 保留缓存数据在升级 daemon 的时候比较有用。
# 默认为 false。

View File

@ -20,6 +20,10 @@ gcInterval: 1m0s
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly。
workHome: ''
# workHomeMode is used to set the file mode bits for the workHome directory.
# The default is 0755.
workHomeMode: 0755
# 服务的日志目录。
# Linux 上默认目录 /var/log/dragonfly。
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/logs。
@ -30,6 +34,10 @@ logDir: ''
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/cache。
cacheDir: ''
# cacheDirMode is used to set the file mode bits for the cacheDir directory.
# The default is 0755.
cacheDirMode: 0755
# 服务的插件目录。
# Linux 上默认目录 /usr/local/dragonfly/plugins。
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/plugins。
@ -40,6 +48,10 @@ pluginDir: ''
# macOS(仅开发、测试), 默认目录是 /Users/$USER/.dragonfly/data/。
dataDir: ''
# dataDirMode is used to set the file mode bits for the dataDir directory.
# The default is 0755.
dataDirMode: 0755
# 当 daemon 退出是, 是否保存缓存数据。
# 保留缓存数据在升级 daemon 的时候比较有用。
# 默认为 false。

View File

@ -21,6 +21,10 @@ gcInterval: 1m0s
# In macos(just for testing), default value is /Users/$USER/.dragonfly.
workHome: ''
# workHomeMode is used to set the file mode bits for the workHome directory.
# The default is 0755.
workHomeMode: 0755
# logDir is the log directory.
# In linux, default value is /var/log/dragonfly.
# In macos(just for testing), default value is /Users/$USER/.dragonfly/logs.
@ -31,6 +35,10 @@ logDir: ''
# In macos(just for testing), default value is /Users/$USER/.dragonfly/cache.
cacheDir: ''
# cacheDirMode is used to set the file mode bits for the cacheDir directory.
# The default is 0755.
cacheDirMode: 0755
# pluginDir is the plugin directory.
# In linux, default value is /usr/local/dragonfly/plugins.
# In macos(just for testing), default value is /Users/$USER/.dragonfly/plugins.
@ -41,6 +49,10 @@ pluginDir: ''
# In macos(just for testing), default value is /Users/$USER/.dragonfly/data.
dataDir: ''
# dataDirMode is used to set the file mode bits for the dataDir directory.
# The default is 0755.
dataDirMode: 0755
# When daemon exit, keep peer task data or not.
# it is usefully when upgrade daemon service, all local cache will be saved
# default is false.