Browse Source

docs: link example.config.toml as the config reference

The TOML configuration file is documented in example.config.toml -
every option is listed with its default value and an inline comment.
But the README never links to it directly: it just says "please
checkout an example configuration file" / "please check configuration
file example", which is easy to skim past when looking for a config
reference.

This patch:
- makes example.config.toml an explicit link in the "Prepare a
  configuration file" section and calls it out as the configuration
  documentation;
- adds the same link to the Doppelganger and Metrics sections, which
  also point readers at the example file.

No content/option changes - README only.
pull/481/head
Alexey Dolotov 1 week ago
parent
commit
fc0ab916bc
1 changed files with 13 additions and 9 deletions
  1. 13
    9
      README.md

+ 13
- 9
README.md View File

384
 
384
 
385
 ### Prepare a configuration file
385
 ### Prepare a configuration file
386
 
386
 
387
-Please checkout an example configuration file. All options except of
388
-`secret` and `bind-to` are optional. You can safely have this minimal
389
-configuration file:
387
+mtg is configured via a [TOML](https://toml.io/en/) file. The full
388
+reference is [`example.config.toml`](./example.config.toml) in this
389
+repository — every option is listed there with its default value and
390
+an inline comment explaining what it does. Treat that file as the
391
+configuration documentation.
392
+
393
+All options except `secret` and `bind-to` are optional, so the minimal
394
+working configuration is:
390
 
395
 
391
 ```toml
396
 ```toml
392
 secret = "ee473ce5d4958eb5f968c87680a23854a0676f6f676c652e636f6d"
397
 secret = "ee473ce5d4958eb5f968c87680a23854a0676f6f676c652e636f6d"
396
 This is enough to run the whole application. All other
401
 This is enough to run the whole application. All other
397
 options already have sensible defaults for the app at almost any scale.
402
 options already have sensible defaults for the app at almost any scale.
398
 
403
 
399
-Oh, the configuration is done in [TOML format](https://toml.io/en/).
400
-
401
 ### Run a proxy
404
 ### Run a proxy
402
 
405
 
403
 Put a binary and a config into your webserver. Just for example,
406
 Put a binary and a config into your webserver. Just for example,
467
 
470
 
468
 ## Doppelganger
471
 ## Doppelganger
469
 
472
 
470
-mtg can mimic real websites, please take a look at relevant section in example
471
-config file.
473
+mtg can mimic real websites — see the `[defense.doppelganger]` section
474
+in [`example.config.toml`](./example.config.toml).
472
 
475
 
473
 mtg comes with some very good precollected statistics coming from
476
 mtg comes with some very good precollected statistics coming from
474
 [ok.ru](https://ok.ru/). It does not mean that you have to cover yourself
477
 [ok.ru](https://ok.ru/). It does not mean that you have to cover yourself
562
 
565
 
563
 Out of the box, mtg works with
566
 Out of the box, mtg works with
564
 [statsd](https://github.com/statsd/statsd) and
567
 [statsd](https://github.com/statsd/statsd) and
565
-[Prometheus](https://prometheus.io/). Please check configuration file
566
-example to get how to set this integration up.
568
+[Prometheus](https://prometheus.io/). See the `[stats.statsd]` and
569
+`[stats.prometheus]` sections in
570
+[`example.config.toml`](./example.config.toml) for setup.
567
 
571
 
568
 Here goes a list of metrics with their types but without a prefix.
572
 Here goes a list of metrics with their types but without a prefix.
569
 
573
 

Loading…
Cancel
Save