-
Notifications
You must be signed in to change notification settings - Fork 4
/
config.schema.json
352 lines (352 loc) · 9.4 KB
/
config.schema.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
{
"type": "object",
"properties": {
"snapraid": {
"type": "object",
"properties": {
"binary": {
"type": "string",
"examples": [
"/usr/bin/snapraid"
],
"description": "The location of your snapraid executable."
},
"config": {
"type": "string",
"examples": [
"/etc/snapraid.conf"
],
"description": "Location of the snapraid config file. Necessary for sanity checks."
},
"nice": {
"type": "number",
"examples": [
10
],
"description": "Run snapraid at a given `nice`. By default processes run at `0`. Lower values mean higher priority. Ranges between -20 to +19.",
"minimum": -20,
"maximum": 19
},
"diff": {
"type": "object",
"properties": {
"thresholds": {
"type": "object",
"properties": {
"updated": {
"type": "number",
"examples": [
500
],
"description": "If more files than the threshold amount have been updated, don't execute jobs. Set to `0` to disable.",
"minimum": 0
},
"removed": {
"type": "number",
"examples": [
500
],
"description": "If more files than the threshold amount have been removed, don't execute jobs. Set to `0` to disable.",
"minimum": 0
}
},
"additionalProperties": false,
"required": [
"updated",
"removed"
]
}
},
"additionalProperties": false,
"required": [
"thresholds"
]
},
"sync": {
"type": "object",
"properties": {
"pre_hash": {
"type": "boolean",
"examples": [
true
],
"description": "Whether to pre-hash changed blocks before syncing."
},
"auto_sync": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"examples": [
false
],
"description": "Whether or not to re-run the sync command if snapraid recommends it."
},
"max_attempts": {
"type": "number",
"examples": [
3
],
"description": "The max amount of attempts to `sync` the array before bailing.",
"minimum": 0
}
},
"additionalProperties": false,
"required": [
"enabled",
"max_attempts"
]
}
},
"additionalProperties": false,
"required": [
"pre_hash",
"auto_sync"
]
},
"scrub": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"examples": [
true
],
"description": "Whether or not to scrub the array."
},
"check_percent": {
"type": "number",
"examples": [
3
],
"description": "How many percent of the array to scrub each time. Set to `0` to disable scrubbing.",
"minimum": 0,
"maximum": 100
},
"min_age": {
"type": "number",
"examples": [
30
],
"description": "How old the blocks have to be before considered for scrub, in days.",
"minimum": 1
},
"scrub_new": {
"type": "boolean",
"examples": [
true
],
"description": "Whether to scrub newly synced blocks or not."
},
"scrub_delayed_run": {
"type": "number",
"examples": [
0,
3
],
"description": "Number of script runs before running scrub. Use this if you don't want to scrub the array every time",
"minimum": 0
}
},
"additionalProperties": false,
"required": [
"enabled",
"check_percent",
"min_age",
"scrub_new"
]
}
},
"additionalProperties": false,
"required": [
"binary",
"config",
"nice",
"diff",
"sync",
"scrub"
]
},
"notifications": {
"type": "object",
"properties": {
"email": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"examples": [
true
],
"description": "Whether or not to send notifications and reports to the defined email."
},
"binary": {
"type": "string",
"examples": [
"/usr/bin/mailx"
],
"description": "The location of `mailx`."
},
"from_email": {
"type": "string",
"examples": [
],
"description": "The senders email."
},
"to_email": {
"type": "string",
"examples": [
],
"description": "The recipients email."
}
},
"additionalProperties": false,
"required": [
"enabled",
"binary",
"from_email",
"to_email"
]
},
"discord": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"examples": [
true
],
"description": "Whether or not to send notifications and reports to Discord."
},
"webhook_id": {
"type": "string",
"examples": [
"1234567890"
],
"description": "Discord webhook id."
},
"webhook_token": {
"type": "string",
"examples": [
"abc123"
],
"description": "Discord webhook token."
}
},
"additionalProperties": false,
"required": [
"enabled",
"webhook_id",
"webhook_token"
]
}
},
"additionalProperties": false,
"required": [
"email",
"discord"
]
},
"logs": {
"type": "object",
"properties": {
"dir": {
"type": "string",
"examples": [
"/var/log/snapper"
],
"description": "The directory in which to save logs. Will be created if it does not exist."
},
"max_count": {
"type": "number",
"examples": [
14
],
"description": "How many historic logs to keep. A new log is generated on each run, and the previous ones are rotated and gzipped.",
"minimum": 1
}
},
"additionalProperties": false,
"required": [
"dir",
"max_count"
]
},
"spindown": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"examples": [
true
],
"description": "Whether to spin down hard drives after script execution or not"
},
"binary": {
"type": "string",
"examples": [
"/usr/sbin/hdparm"
],
"description": "The location of the `hdparm` executable."
},
"drives": {
"type": "string",
"enum": [
"parity",
"all"
],
"examples": [
"parity"
],
"description": "Which drives to spin down after script execution is complete"
}
},
"additionalProperties": false,
"required": [
"enabled",
"binary",
"drives"
]
},
"scripts": {
"type": "object",
"properties": {
"pre_run": {
"type": [
"string",
"null"
],
"examples": [
"bash /foo/bar/baz.sh"
],
"description": "Script to run before starting snapraid sync"
},
"post_run": {
"type": [
"string",
"null"
],
"examples": [
"bash /foo/bar/baz.sh"
],
"description": "Script to run after starting snapraid sync/scrub complete. Also executes if any error is encountered."
}
},
"additionalProperties": false,
"required": [
"pre_run",
"post_run"
]
}
},
"additionalProperties": false,
"required": [
"snapraid",
"notifications",
"logs",
"spindown",
"scripts"
]
}