README.md in fluent-plugin-secure-forward-0.3.4 vs README.md in fluent-plugin-secure-forward-0.3.5pre1
- old
+ new
@@ -31,11 +31,11 @@
* `private_key_path`: set path of private key file
* `private_key_passphrase`: set passphrase of private key
```apache
<source>
- type secure_forward
+ @type secure_forward
# bind 0.0.0.0 # default
# port 24284 # default
self_hostname server.fqdn.example.com
shared_key secret_string
@@ -53,11 +53,11 @@
* `secure`: set `yes` or `true`
* `enable_strict_verification`: specify `yes` or `true` to verify FQDN of servers (input plugin)
```apache
<match secret.data.**>
- type secure_forward
+ @type secure_forward
self_hostname client.fqdn.local
shared_key secret_string
secure yes
@@ -85,11 +85,11 @@
This command generates `ca_cert.pem` and `ca_key.pem` on `/path/for/dir/of/certs`. For SSL communication with private CA, users must deploy both files for input plugins, and also must deploy `ca_cert.pem` for output plugins.
And then, configure Fluentd with these files and the passphrase. With this configuration, server certificates are automatically generated and issued by private CA.
```apache
<source>
- type secure_forward
+ @type secure_forward
# bind 0.0.0.0 # default
# port 24284 # default
self_hostname myserver.local
shared_key secret_string
@@ -107,11 +107,11 @@
* `secure`: set `yes` or `true`
* `enable_strict_verification`: specify `yes` or `true`
```apache
<match secret.data.**>
- type secure_forward
+ @type secure_forward
self_hostname myclient.local
shared_key secret_string
secure yes
@@ -135,11 +135,11 @@
For just testing or data center internal communications, this plugin has a feature to communicate without any verification of certificates. Turn `secure` option to `false` to use this feature.
```apache
<source>
- type secure_forward
+ @type secure_forward
self_hostname myserver.local
shared_key secret_string
secure no
@@ -148,11 +148,11 @@
Configure output plugin just same way:
```apache
<match data.**>
- type secure_forward
+ @type secure_forward
self_hostname myclient.local
shared_key secret_string
secure no
@@ -185,11 +185,11 @@
Minimal configurations like below:
```apache
<source>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname server.fqdn.local # This fqdn is used as CN (Common Name) of certificates
secure yes
# and configurations for certs
@@ -198,11 +198,11 @@
To check username/password from clients, like this:
```apache
<source>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname server.fqdn.local
secure yes
# and configurations for certs
@@ -221,11 +221,11 @@
To deny unknown source IP/hosts:
```apache
<source>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname server.fqdn.local
secure yes
# and configurations for certs
@@ -246,11 +246,11 @@
You can use both of username/password check and client check:
```apache
<source>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname server.fqdn.local
secure yes
# and configurations for certs
@@ -288,11 +288,11 @@
Minimal configurations like this:
```apache
<match secret.data.**>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname client.fqdn.local
secure yes
# and configurations for certs/verification
@@ -306,11 +306,11 @@
Without hostname ACL (and it's not implemented yet), `self_hostname` is not checked in any state. `${hostname}` placeholder is available for such cases.
```apache
<match secret.data.**>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname ${hostname}
secure yes
# and configurations for certs/verification
@@ -326,11 +326,11 @@
If server requires username/password, set `username` and `password` in `<server>` section:
```apache
<match secret.data.**>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname client.fqdn.local
secure yes
# and configurations for certs/verification
@@ -361,11 +361,11 @@
To specify keepalive timeouts, use `keepalive` configuration with seconds. SSL connection will be disconnected and re-connected for each 1 hour with configuration below. In Default (and with `keepalive 0`), connections will not be disconnected without any communication troubles. (This feature is for dns name updates, and SSL common key refreshing.)
```apache
<match secret.data.**>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname client.fqdn.local
secure yes
# and configurations for certs/verification
@@ -381,11 +381,11 @@
If you connect via Proxy,
set for `proxy_uri` in `<server>` section:
```apache
<match secret.data.**>
- type secure_forward
+ @type secure_forward
shared_key secret_string
self_hostname client.fqdn.local
secure yes
# and configurations for certs/verification
@@ -396,10 +396,10 @@
proxy_uri http://foo.bar.local:3128
</server>
</match>
```
-## Senario (developer document)
+## Scenario (developer document)
* server
* in\_secure\_forward
* client
* out\_secure\_forward