Skip to content

Commit

Permalink
fix(docs/config) escape config template for >= 0.6
Browse files Browse the repository at this point in the history
Fix #254
  • Loading branch information
thibaultcha committed Sep 29, 2016
1 parent 8c41637 commit b6cc371
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 34 deletions.
21 changes: 10 additions & 11 deletions app/docs/0.6.x/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -443,17 +443,17 @@ worker_processes auto;
error_log logs/error.log error;
daemon on;
worker_rlimit_nofile {{auto_worker_rlimit_nofile}};
worker_rlimit_nofile {{ "{{auto_worker_rlimit_nofile" }}}};
env KONG_CONF;
events {
worker_connections {{auto_worker_connections}};
worker_connections {{ "{{auto_worker_connections" }}}};
multi_accept on;
}
http {
resolver {{dns_resolver}} ipv6=off;
resolver {{ "{{dns_resolver" }}}} ipv6=off;
charset UTF-8;
access_log logs/access.log;
Expand Down Expand Up @@ -494,11 +494,11 @@ worker_processes auto;
lua_max_pending_timers 16384;
lua_shared_dict reports_locks 100k;
lua_shared_dict cluster_locks 100k;
lua_shared_dict cache {{memory_cache_size}}m;
lua_shared_dict cache {{ "{{memory_cache_size" }}}}m;
lua_shared_dict cassandra 1m;
lua_shared_dict cassandra_prepared 5m;
lua_socket_log_errors off;
{{lua_ssl_trusted_certificate}}
{{ "{{lua_ssl_trusted_certificate" }}}}
init_by_lua '
kong = require "kong"
Expand All @@ -513,13 +513,13 @@ worker_processes auto;
server {
server_name _;
listen {{proxy_listen}};
listen {{proxy_listen_ssl}} ssl;
listen {{ "{{proxy_listen" }}}};
listen {{ "{{proxy_listen_ssl" }}}} ssl;
ssl_certificate_by_lua 'kong.exec_plugins_certificate()';
ssl_certificate {{ssl_cert}};
ssl_certificate_key {{ssl_key}};
ssl_certificate {{ "{{ssl_cert" }}}};
ssl_certificate_key {{ "{{ssl_key" }}}};
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;# omit SSLv3 because of POODLE (CVE-2014-3566)
location / {
Expand All @@ -532,7 +532,6 @@ worker_processes auto;
# Authenticate the user and load the API info
access_by_lua 'kong.exec_plugins_access()';
# Proxy the request
# Proxy the request
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
Expand Down Expand Up @@ -566,7 +565,7 @@ worker_processes auto;
}
server {
listen {{admin_api_listen}};
listen {{ "{{admin_api_listen" }}}};
client_max_body_size 10m;
client_body_buffer_size 10m;
Expand Down
21 changes: 10 additions & 11 deletions app/docs/0.7.x/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -443,17 +443,17 @@ worker_processes auto;
error_log logs/error.log error;
daemon on;
worker_rlimit_nofile {{auto_worker_rlimit_nofile}};
worker_rlimit_nofile {{ "{{auto_worker_rlimit_nofile" }}}};
env KONG_CONF;
events {
worker_connections {{auto_worker_connections}};
worker_connections {{ "{{auto_worker_connections" }}}};
multi_accept on;
}
http {
resolver {{dns_resolver}} ipv6=off;
resolver {{ "{{dns_resolver" }}}} ipv6=off;
charset UTF-8;
access_log logs/access.log;
Expand Down Expand Up @@ -494,11 +494,11 @@ worker_processes auto;
lua_max_pending_timers 16384;
lua_shared_dict reports_locks 100k;
lua_shared_dict cluster_locks 100k;
lua_shared_dict cache {{memory_cache_size}}m;
lua_shared_dict cache {{ "{{memory_cache_size" }}}}m;
lua_shared_dict cassandra 1m;
lua_shared_dict cassandra_prepared 5m;
lua_socket_log_errors off;
{{lua_ssl_trusted_certificate}}
{{ "{{lua_ssl_trusted_certificate" }}}}
init_by_lua '
kong = require "kong"
Expand All @@ -513,13 +513,13 @@ worker_processes auto;
server {
server_name _;
listen {{proxy_listen}};
listen {{proxy_listen_ssl}} ssl;
listen {{ "{{proxy_listen" }}}};
listen {{ "{{proxy_listen_ssl" }}}} ssl;
ssl_certificate_by_lua 'kong.exec_plugins_certificate()';
ssl_certificate {{ssl_cert}};
ssl_certificate_key {{ssl_key}};
ssl_certificate {{ "{{ssl_cert" }}}};
ssl_certificate_key {{ "{{ssl_key" }}}};
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;# omit SSLv3 because of POODLE (CVE-2014-3566)
location / {
Expand All @@ -532,7 +532,6 @@ worker_processes auto;
# Authenticate the user and load the API info
access_by_lua 'kong.exec_plugins_access()';
# Proxy the request
# Proxy the request
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
Expand Down Expand Up @@ -566,7 +565,7 @@ worker_processes auto;
}
server {
listen {{admin_api_listen}};
listen {{ "{{admin_api_listen" }}}};
client_max_body_size 10m;
client_body_buffer_size 10m;
Expand Down
23 changes: 11 additions & 12 deletions app/docs/0.8.x/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -357,7 +357,7 @@ data_centers:

Consistency level to use. See [http://docs.datastax.com/en/cassandra/2.0/cassandra/dml/dml_config_consistency_c.html](http://docs.datastax.com/en/cassandra/2.0/cassandra/dml/dml_config_consistency_c.html)

**Default:**
**Default:**

```yaml
consistency: ONE
Expand Down Expand Up @@ -503,17 +503,17 @@ worker_processes auto;
error_log logs/error.log error;
daemon on;
worker_rlimit_nofile {{auto_worker_rlimit_nofile}};
worker_rlimit_nofile {{ "{{auto_worker_rlimit_nofile" }}}};
env KONG_CONF;
events {
worker_connections {{auto_worker_connections}};
worker_connections {{ "{{auto_worker_connections" }}}};
multi_accept on;
}
http {
resolver {{dns_resolver}} ipv6=off;
resolver {{ "{{dns_resolver" }}}} ipv6=off;
charset UTF-8;
access_log logs/access.log;
Expand Down Expand Up @@ -554,11 +554,11 @@ worker_processes auto;
lua_max_pending_timers 16384;
lua_shared_dict reports_locks 100k;
lua_shared_dict cluster_locks 100k;
lua_shared_dict cache {{memory_cache_size}}m;
lua_shared_dict cache {{ "{{memory_cache_size" }}}}m;
lua_shared_dict cassandra 1m;
lua_shared_dict cassandra_prepared 5m;
lua_socket_log_errors off;
{{lua_ssl_trusted_certificate}}
{{ "{{lua_ssl_trusted_certificate" }}}}
init_by_lua '
kong = require "kong"
Expand All @@ -573,13 +573,13 @@ worker_processes auto;
server {
server_name _;
listen {{proxy_listen}};
listen {{proxy_listen_ssl}} ssl;
listen {{ "{{proxy_listen" }}}};
listen {{ "{{proxy_listen_ssl" }}}} ssl;
ssl_certificate_by_lua 'kong.exec_plugins_certificate()';
ssl_certificate {{ssl_cert}};
ssl_certificate_key {{ssl_key}};
ssl_certificate {{ "{{ssl_cert" }}}};
ssl_certificate_key {{ "{{ssl_key" }}}};
ssl_protocols TLSv1 TLSv1.1 TLSv1.2;# omit SSLv3 because of POODLE (CVE-2014-3566)
location / {
Expand All @@ -592,7 +592,6 @@ worker_processes auto;
# Authenticate the user and load the API info
access_by_lua 'kong.exec_plugins_access()';
# Proxy the request
# Proxy the request
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
Expand Down Expand Up @@ -626,7 +625,7 @@ worker_processes auto;
}
server {
listen {{admin_api_listen}};
listen {{ "{{admin_api_listen" }}}};
client_max_body_size 10m;
client_body_buffer_size 10m;
Expand Down

0 comments on commit b6cc371

Please sign in to comment.