Skip to content

Commit 987e1c6

Browse files
committed
updated example vars documentation
1 parent ab71f7d commit 987e1c6

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,19 +77,39 @@ This is a sample playbook file for using the role to install NGINX App Protect o
7777
app_protect_configure: true
7878
7979
# For use with the app_protect_configure option to determine if the default security policy will be written to the target host
80+
# Used when `app_protect_configure: true`.
8081
app_protect_security_policy_template_enable: true
8182

82-
# For use with the app_protect_configure option to determine if the default log policy will be written to the target host
83+
# Default app protect enforcement mode. Values can be `blocking` or `transparent`.
84+
# Used when `app_protect_configure: true` and `app_protect_security_policy_template_enable: true`.
85+
security_policy_enforcement_mode: blocking
86+
87+
# For use with the app_protect_configure option to determine if the default log policy will be written to the target host.
88+
# Used when `app_protect_configure: true`.
8389
app_protect_log_policy_template_enable: true
8490

91+
# Which violation types to log. Possible values: TBD
92+
# Used when `app_protect_configure: true` and `app_protect_log_policy_template_enable: true`.
93+
log_policy_filter_request_type: all
94+
8595
# For use with the app_protect_configure option to determine if the sample nginx.conf will be written to the target host.
86-
# Since this can be dangerous, this value is default to false in the role defaults
96+
# Since this can be dangerous, this value is default to false in the role defaults.
97+
# Used when `app_protect_configure: true`.
8798
nginx_conf_template_enable: true
8899

89100
# For use with the app_protect_configure option to determine the syslog target to be injected
90-
# into the default log policy that will be written to the target host
101+
# into the default log policy that will be written to the target host.
102+
# Used when `nginx_conf_template_enable: true`.
91103
log_policy_syslog_target: 10.1.1.8:5144
92104

105+
# DEPRECATED: A proxy pass workload used in the sample nginx.conf for demo purposes.
106+
# Will be removed from this role in the future.
107+
# Used when `nginx_conf_template_enable: true`.
108+
nginx_demo_workload: http://10.1.10.105:8080
109+
110+
# Determines whether or not to clean up tmp files created during the installation and configuration steps.
111+
cleanup_when_done: true
112+
93113
roles:
94114
- role: ansible-role-nginx-app-protect
95115
```

0 commit comments

Comments
 (0)