Documentation Revamp

Co-authored-by: jbdoumenjou <jb.doumenjou@gmail.com>
2019-02-26 05:50:07 -08:00 · 2019-02-26 05:50:07 -08:00 · ac6b11037d
commit ac6b11037d
parent 848e45c22c
174 changed files with 5858 additions and 4002 deletions
--- a/docs/content/contributing/data-collection.md
+++ b/docs/content/contributing/data-collection.md
@ -0,0 +1,112 @@
+# Data Collection
+
+Understanding How Traefik is Being Used
+{: .subtitle }
+
+## Configuration Example
+
+**By default, this feature is disabled;** but to allow us understand better how you use Traefik, please enable the data collection option.
+
+??? example "Enabling Data Collection with TOML"
+
+    ```toml
+    [Global]
+        # Send anonymous usage data
+        # Default: false
+        #
+        sendAnonymousUsage = true
+    ```
+
+??? example "Enabling Data Collection with the CLI"
+
+    ```bash
+    ./traefik --sendAnonymousUsage=true
+    ```
+    
+## Collected Data
+
+This feature comes from the public proposal [here](https://github.com/containous/traefik/issues/2369).
+
+In order to help us learn more about how Traefik is being used and improve it, we collect anonymous usage statistics from running instances.
+Those data help us prioritize our developments and focus on what's important for our users (for example, which provider is popular, and which is not).
+
+### What's collected / when ?
+
+Once a day (the first call begins 10 minutes after the start of Traefik), we collect:
+
+- the Traefik version number
+- a hash of the configuration
+- an **anonymized version** of the static configuration (token, user name, password, URL, IP, domain, email, etc, are removed).
+
+!!! note
+    We do not collect the dynamic configuration information (routers & services).
+    We do not collect these data to run advertising programs.
+    We do not sell these data to third-parties.
+
+### Example of Collected Data
+
+??? example "Original configuration"
+
+    ```toml
+    [entryPoints]
+        [entryPoints.http]
+           address = ":80"
+    
+    [api]
+    
+    [Docker]
+      endpoint = "tcp://10.10.10.10:2375"
+      domain = "foo.bir"
+      exposedByDefault = true
+      swarmMode = true
+    
+      [Docker.TLS]
+        ca = "dockerCA"
+        cert = "dockerCert"
+        key = "dockerKey"
+        insecureSkipVerify = true
+    
+    [ECS]
+      domain = "foo.bar"
+      exposedByDefault = true
+      clusters = ["foo-bar"]
+      region = "us-west-2"
+      accessKeyID = "AccessKeyID"
+      secretAccessKey = "SecretAccessKey"
+    ```
+
+??? example "Resulting Obfuscated Configuration"
+
+    ```toml
+    [entryPoints]
+        [entryPoints.http]
+           address = ":80"
+    
+    [api]
+    
+    [Docker]
+      endpoint = "xxxx"
+      domain = "xxxx"
+      exposedByDefault = true
+      swarmMode = true
+    
+      [Docker.TLS]
+        ca = "xxxx"
+        cert = "xxxx"
+        key = "xxxx"
+        insecureSkipVerify = false
+    
+    [ECS]
+      domain = "xxxx"
+      exposedByDefault = true
+      clusters = []
+      region = "us-west-2"
+      accessKeyID = "xxxx"
+      secretAccessKey = "xxxx"
+    ```
+
+## The Code for Data Collection
+
+If you want to dig into more details, here is the source code of the collecting system: [collector.go](https://github.com/containous/traefik/blob/master/collector/collector.go)
+
+By default we anonymize all configuration fields, except fields tagged with `export=true`.