Browse Source

Slight renaming

Brendan Abolivier 6 years ago
parent
commit
73b26177d4
Signed by: Brendan Abolivier <contact@brendanabolivier.com> GPG key ID: 8EF1500759F70623
2 changed files with 6 additions and 6 deletions
  1. 4
    4
      README.md
  2. 2
    2
      config.example.yaml

+ 4
- 4
README.md View File

1
-# Grafana Dashboard Manager
1
+# Grafana Dashboards Manager
2
 
2
 
3
-The Grafana Dashboard Manager is a tool to help you manage your Grafana dashboards using Git.
3
+The Grafana Dashboards Manager is a tool to help you manage your Grafana dashboards using Git.
4
 
4
 
5
 ## Manager
5
 ## Manager
6
 
6
 
47
 It can then be built by cloning this repository and running
47
 It can then be built by cloning this repository and running
48
 
48
 
49
 ```bash
49
 ```bash
50
-cd grafana-dashboard-manager
50
+cd grafana-dashboards-manager
51
 gb build
51
 gb build
52
 ```
52
 ```
53
 
53
 
72
 You can specify a configuration file via the command line flag `--config`, which works with both the puller and pusher. For example, here's how the full call should look like when passing a configuration file path to the puller:
72
 You can specify a configuration file via the command line flag `--config`, which works with both the puller and pusher. For example, here's how the full call should look like when passing a configuration file path to the puller:
73
 
73
 
74
 ```bash
74
 ```bash
75
-./puller --config /etc/grafana-dashboard-manager/config.yaml
75
+./puller --config /etc/grafana-dashboards-manager/config.yaml
76
 ```
76
 ```
77
 
77
 
78
 If the `--config` flag isn't present in the command line call, it will default to a `config.yaml` file located in the directory from where the call is made.
78
 If the `--config` flag isn't present in the command line call, it will default to a `config.yaml` file located in the directory from where the call is made.

+ 2
- 2
config.example.yaml View File

22
     user: git
22
     user: git
23
     # Path to the private key used to authenticate on Git. It is recommended to
23
     # Path to the private key used to authenticate on Git. It is recommended to
24
     # use a passphraseless key.
24
     # use a passphraseless key.
25
-    private_key: /etc/grafana-dashboard-manager/id_rsa_nopasswd
25
+    private_key: /etc/grafana-dashboards-manager/id_rsa_nopasswd
26
     # Path to the directory where the git repository lies on the disk. If the
26
     # Path to the directory where the git repository lies on the disk. If the
27
     # directory doesn't exist, it will be created and the repository will be
27
     # directory doesn't exist, it will be created and the repository will be
28
     # cloned into it.
28
     # cloned into it.
32
         # Author's name.
32
         # Author's name.
33
         name: Grafana Dashboard Manager
33
         name: Grafana Dashboard Manager
34
         # Author's email.
34
         # Author's email.
35
-        email: grafana-dashboard-manager@company.tld
35
+        email: grafana-dashboards-manager@company.tld
36
 
36
 
37
 # An alternative to Git synchronisation is the "simple sync" mode. This will
37
 # An alternative to Git synchronisation is the "simple sync" mode. This will
38
 # only back up your dashboards on the disk and won't do anything else.
38
 # only back up your dashboards on the disk and won't do anything else.