mirror of
https://github.com/bytedance/g3.git
synced 2026-04-29 12:11:04 +00:00
initial commit
This commit is contained in:
zhangjingqiang
commit
13716f4923
1425 changed files with 163227 additions and 0 deletions
250
g3proxy/doc/configuration/user_group/source.rst
Normal file
250
g3proxy/doc/configuration/user_group/source.rst
Normal file
|
|
@ -0,0 +1,250 @@
|
|||
.. _configuration_user_group_source:
|
||||
|
||||
******
|
||||
Source
|
||||
******
|
||||
|
||||
For the *map* format, the **type** key should always be set.
|
||||
|
||||
file
|
||||
====
|
||||
|
||||
Fetch dynamic users from a local file.
|
||||
|
||||
The content of the file should be the json encoded string of all dynamic users.
|
||||
|
||||
The keys used in *map* format are:
|
||||
|
||||
* path
|
||||
|
||||
**required**, **type**: :ref:`file path <conf_value_file_path>`
|
||||
|
||||
Set path for the file. The file should be existed before start the daemon.
|
||||
|
||||
* format
|
||||
|
||||
**optional**, **type**: :ref:`config file format <conf_value_config_file_format>`
|
||||
|
||||
Set the file format for the file specified in *path*.
|
||||
|
||||
**default**: If the file has extension, the extension will be used to detect the format.
|
||||
If not format can be detected through extension, *yaml* will be used.
|
||||
|
||||
For *url* str values, the *path* should be an absolute path with the following format:
|
||||
|
||||
file://<path>[?[format=<format>]]
|
||||
|
||||
http
|
||||
====
|
||||
|
||||
Fetch dynamic users through an http GET request.
|
||||
|
||||
The success response code should be 200, and the body should be the json encoded string of all dynamic users.
|
||||
|
||||
The keys used in *map* format are:
|
||||
|
||||
* url
|
||||
|
||||
**required**, **type**: :ref:`url str <conf_value_url_str>`
|
||||
|
||||
Set the url to GET.
|
||||
|
||||
* cache_file
|
||||
|
||||
**required**, **type**: :ref:`file path <conf_value_file_path>`
|
||||
|
||||
The local file to cache remote results, it will be used during initial load of the user group.
|
||||
|
||||
The file will be created if not existed.
|
||||
|
||||
* timeout
|
||||
|
||||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
|
||||
|
||||
Set the timeout value for the whole request.
|
||||
|
||||
It's not recommended to set the timeout value greater the :ref:`refresh_interval <conf_user_group_refresh_interval>`
|
||||
in group config.
|
||||
|
||||
**default**: 10s
|
||||
|
||||
* connect_timeout
|
||||
|
||||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
|
||||
|
||||
Set the connect timeout value.
|
||||
|
||||
It's not recommended to set the timeout value greater the :ref:`refresh_interval <conf_user_group_refresh_interval>`
|
||||
in group config.
|
||||
|
||||
**default**: 5s
|
||||
|
||||
.. versionadded:: 1.2.0
|
||||
|
||||
* interface
|
||||
|
||||
**optional**, **type**: str
|
||||
|
||||
Set the bind IP or bind interface.
|
||||
|
||||
**default**: not set
|
||||
|
||||
.. versionadded:: 1.2.0
|
||||
|
||||
* max_body_size
|
||||
|
||||
**optional**, **type**: :ref:`humanize size <conf_value_humanize_usize>`
|
||||
|
||||
Set the max body size.
|
||||
|
||||
**default**: 64MiB
|
||||
|
||||
lua
|
||||
===
|
||||
|
||||
.. versionadded:: 1.1.3
|
||||
|
||||
Fetch users through local lua script.
|
||||
|
||||
.. note::
|
||||
|
||||
Environment variable `LUA_PATH`_ and `LUA_CPATH`_ can be set to include more lua module files.
|
||||
Any ";;" in the value of the *LUA_PATH* environment variable will be replaced by the default path.
|
||||
|
||||
.. _LUA_PATH: https://www.lua.org/manual/5.1/manual.html#pdf-package.path
|
||||
.. _LUA_CPATH: https://www.lua.org/manual/5.1/manual.html#pdf-package.cpath
|
||||
|
||||
|
||||
The return value of the script should be the json encoded string of all dynamic users.
|
||||
|
||||
The keys used in *map* format are:
|
||||
|
||||
* cache_file
|
||||
|
||||
**required**, **type**: :ref:`file path <conf_value_file_path>`
|
||||
|
||||
The local file to cache results, it will be used during initial load of the user group.
|
||||
|
||||
The file will be created if not existed.
|
||||
|
||||
* fetch_script
|
||||
|
||||
**required**, **type**: :ref:`file path <conf_value_file_path>`
|
||||
|
||||
The path of the lua script to fetch dynamic users.
|
||||
|
||||
The content of this script file should be like:
|
||||
|
||||
.. code-block:: lua
|
||||
|
||||
-- TODO fetch users
|
||||
local result = "[]"
|
||||
-- return the json encoded string
|
||||
return result
|
||||
|
||||
**alias**: script
|
||||
|
||||
* fetch_timeout
|
||||
|
||||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
|
||||
|
||||
Set the timeout value for the execution of the fetch script.
|
||||
|
||||
It's not recommended to set the timeout value greater the :ref:`refresh_interval <conf_user_group_refresh_interval>`
|
||||
in group config.
|
||||
|
||||
**default**: 30s, **alias**: timeout
|
||||
|
||||
* report_script
|
||||
|
||||
**optional**, **type**: :ref:`file path <conf_value_file_path>`
|
||||
|
||||
The path of the lua script to report the parse result of the fetched dynamic users.
|
||||
|
||||
Two global functions should be defined in this script, like this:
|
||||
|
||||
.. code-block:: lua
|
||||
|
||||
function reportOk ()
|
||||
-- takes no argument
|
||||
end
|
||||
|
||||
function reportErr (errMsg)
|
||||
-- takes one argument, which the error message string
|
||||
end
|
||||
|
||||
.. versionadded:: 1.4.1
|
||||
|
||||
* report_timeout
|
||||
|
||||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
|
||||
|
||||
Set the timeout value for the execution of the report script.
|
||||
|
||||
It's not recommended to set the timeout value greater the :ref:`refresh_interval <conf_user_group_refresh_interval>`
|
||||
in group config.
|
||||
|
||||
**default**: 15s, **alias**: timeout
|
||||
|
||||
.. versionadded:: 1.4.1
|
||||
|
||||
python
|
||||
======
|
||||
|
||||
.. versionadded:: 1.5.0
|
||||
|
||||
Fetch users through local python script.
|
||||
|
||||
The keys used in *map* format are:
|
||||
|
||||
* cache_file
|
||||
|
||||
**required**, **type**: :ref:`file path <conf_value_file_path>`
|
||||
|
||||
The local file to cache results, it will be used during initial load of the user group.
|
||||
|
||||
The file will be created if not existed.
|
||||
|
||||
* script
|
||||
|
||||
**required**, **type**: :ref:`file path <conf_value_file_path>`
|
||||
|
||||
The path of the python script.
|
||||
|
||||
Three global functions should be defined in this script, like this:
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
def fetch_users():
|
||||
# required, takes no argument, returns the json string
|
||||
return "[]"
|
||||
|
||||
def report_ok():
|
||||
# optional, takes no argument
|
||||
pass
|
||||
|
||||
def report_err(errmsg):
|
||||
# optional, takes one positional argument, which is the error message string
|
||||
pass
|
||||
|
||||
* fetch_timeout
|
||||
|
||||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
|
||||
|
||||
Set the timeout value for the execution of the fetch function.
|
||||
|
||||
It's not recommended to set the timeout value greater the :ref:`refresh_interval <conf_user_group_refresh_interval>`
|
||||
in group config.
|
||||
|
||||
**default**: 30s, **alias**: timeout
|
||||
|
||||
* report_timeout
|
||||
|
||||
**optional**, **type**: :ref:`humanize duration <conf_value_humanize_duration>`
|
||||
|
||||
Set the timeout value for the execution of the report functions.
|
||||
|
||||
It's not recommended to set the timeout value greater the :ref:`refresh_interval <conf_user_group_refresh_interval>`
|
||||
in group config.
|
||||
|
||||
**default**: 15s, **alias**: timeout
|
||||
Loading…
Add table
Add a link
Reference in a new issue