Skip to content

Commit 2b65e06

Browse files
authored
Merge pull request #447 from mcserep/ga-doc
Documentation for Google Analytics feature
2 parents 844c568 + 85b7c6a commit 2b65e06

1 file changed

Lines changed: 15 additions & 0 deletions

File tree

doc/usage.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,21 @@ The certificate of the CA that signed your certificate
253253
-----END CERTIFICATE-----
254254
~~~
255255

256+
### Enabling Google Analytics
257+
258+
To enable this feature, a `ga.txt` file should be created under
259+
the workspace directory (`--workspace` or `-w` flag given to the server).
260+
The `ga.txt` file shall consist of a single line, containing the
261+
Google Analytics *Tracking ID* (format `UA-XXXXXX-X`) or *Measurement ID*
262+
(format `G-XXXXXXX`).
263+
When configured correctly, upon starting a `CodeCompass_webserver`, the
264+
*"Google Analytics monitoring enabled."* informational status message will
265+
be displayed.
266+
267+
**Note:** without explicitly creating the `ga.txt` file in the workspace
268+
directory, the Google Analytics integration is disabled and no related code
269+
is executed in the browser. **This is the default behaviour.**
270+
256271
### Usage example
257272

258273
```bash

0 commit comments

Comments
 (0)