cfc_cl_http_whitelist/README.md

29 lines
1.7 KiB
Markdown
Raw Normal View History

2022-08-20 15:27:52 -04:00
# cfc_cl_http_whitelist
## Configuring
2022-08-21 14:05:37 -04:00
You can create a file in `lua/cfc_http_restrictions/configs` to add your own default domains to your server.
2022-09-01 19:47:08 -04:00
e.g. `lua/cfc_http_restrictions/config/myserver_config.lua`. See [CFC's Whitelist config addon](https://github.com/CFC-Servers/cfc_cl_http_whitelist_configs) for an exmaple
2022-08-20 16:15:19 -04:00
Configuration is loaded from lua files and a data file on in the clients data folder
2022-08-20 15:27:52 -04:00
Each config thats loaded will overwrite values in the previous config, unless permanent=true is set on that config option
Configuration load order on client
- lua/cfc_http_retrictions/default_config.lua
- lua/cfc_http_restrictions/configs/*.lua
- data/cfc_cl_http_whitelist_config.json
#### Configuration options
| name | type | description |
| ----- | ---- | --------------------------------------------------------------------------------------------------------------------------------- |
| noisy | bool | mark the domain as noisy, hiding it from logs, this can be used for internal domains that will be called frequently on the client |
| allowed|bool| Is the domain allowed, if false block the domain, if true allow the domain |
|permanent|bool|Is the domain permanent, if true the domain can not be removed by the users own config|
2022-08-20 16:27:38 -04:00
|_edited|bool|DO NOT SET, internal field used to track if a config option has been edited by the client|
#### Clientside Convars
| name | default | description |
| ---- | ------- | ----------- |
| cfc_http_restrictions_log_allows | 1 | Should log allowed HTTP requests? |
| cfc_http_restrictions_log_blocks | 1 | Should log blocked HTTP requests |
| cfc_http_restrictions_log_verbose | 0 | Should the logs include verbose messages? noisy domains and full urls. |