Browse Source

[checkup][statuspage] Add example configurations

drymer 1 year ago
parent
commit
712a8c6e23
Signed by: drymer <drymer@autistici.org> GPG Key ID: A307D64D5DDFDAAD
2 changed files with 60 additions and 2 deletions
  1. 36
    1
      checkup/README.md
  2. 24
    1
      statuspage/README.md

+ 36
- 1
checkup/README.md View File

@@ -1,4 +1,39 @@
1 1
 # Checkup
2 2
 
3 3
 Pretty simple, just execute [checkup](https://github.com/sourcegraph/checkup).
4
-Mount any file on `/checkup`.
4
+Use with
5
+[statuspage](https://git.daemons.it/drymer/dockerfiles/src/branch/master/statuspage).
6
+
7
+Example configuration file:
8
+
9
+``` json
10
+{
11
+     "checkers": [
12
+	     {
13
+		     "type": "tls",
14
+       	     "endpoint_name": "WEB Bad Daemons",
15
+		     "endpoint_url": "daemons.it:443",
16
+		     "attempts": 5
17
+	     },
18
+	     {
19
+		     "type": "tcp",
20
+       	     "endpoint_name": "TCP WEB Bad Daemons",
21
+		     "endpoint_url": "daemons.it:443",
22
+             "tls": true,
23
+		     "attempts": 5
24
+	     }
25
+     ],
26
+     "storage":
27
+     {
28
+         "provider": "fs",
29
+	     "dir": "/checkup/check_files",
30
+         "url": "http://localhost:2015/check_files"
31
+     }
32
+}
33
+```
34
+
35
+Example oneliner:
36
+
37
+``` bash
38
+docker run -ti -v `pwd`/checkup.json:/checkup/checkup.json -v /etc/ssl/certs:/etc/ssl/certs/ -v `pwd`/check_files:/checkup/check_files registry.daemons.it/checkup
39
+```

+ 24
- 1
statuspage/README.md View File

@@ -2,5 +2,28 @@
2 2
 
3 3
 Pretty simple, just execute
4 4
 [statuscheck](https://github.com/sourcegraph/checkup/tree/master/statuspage).
5
-Mount any file on `/statuscheck`. Use with
5
+Use with
6 6
 [checkup](https://git.daemons.it/drymer/dockerfiles/src/branch/master/checkup).
7
+
8
+Example configuration file:
9
+
10
+``` json
11
+checkup.config = {
12
+	"timeframe": 1 * time.Day,
13
+	"refresh_interval": 60,
14
+	"storage": {
15
+	     "url": "http://localhost:2015/check_files"
16
+	},
17
+	"status_text": {
18
+		"healthy": "Situation Normal",
19
+		"degraded": "Degraded Service",
20
+		"down": "Service Disruption"
21
+	}
22
+};
23
+```
24
+
25
+Example oneliner:
26
+
27
+``` bash
28
+docker run -ti -v `pwd`/config.js:/statuspage/js/config.js -v `pwd`/check_files:/statuspage/check_files -p 2015:2015 registry.daemons.it/statuspage -host localhost
29
+```

Loading…
Cancel
Save