Skip to content

Commit c377041

Browse files
javutojavuto
committed
Update usage for generation and validation
1 parent f2f9588 commit c377041

File tree

38 files changed

+899
-910
lines changed

38 files changed

+899
-910
lines changed

‎content/configuration/_index.md‎

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -30,34 +30,27 @@ Each osctrl binary includes built-in commands to help you create and validate co
3030
To generate a valid YAML configuration file with default values:
3131

3232
```bash
33-
./osctrl-tls config-generate
34-
./osctrl-admin config-generate
35-
./osctrl-api config-generate
33+
./osctrl-tls config-generate -f tls.yaml
34+
./osctrl-admin config-generate -f admin.yaml
35+
./osctrl-api config-generate -f api.yaml
3636
```
3737

38-
This will output a complete configuration template to stdout with all available options and their default values. You can redirect this output to create your configuration file:
39-
40-
```bash
41-
./osctrl-tls config-generate > tls.yaml
42-
./osctrl-admin config-generate > admin.yaml
43-
./osctrl-api config-generate > api.yaml
44-
```
38+
This will create configuration files (`tls.yaml`, `admin.yaml`, `api.yaml`) populated with all required fields and default settings. If not using `-f`, the file will be created in `config/<service>.yml` by default.
4539

4640
The generated configuration includes:
4741

4842
* All required configuration sections
4943
* Default values for each setting
50-
* Comments explaining each field
5144
* Service-specific options relevant to each binary
5245

5346
#### Verify Configuration
5447

5548
To validate an existing configuration file before starting the service:
5649

5750
```bash
58-
./osctrl-tls config-verify --config-file tls.yaml
59-
./osctrl-admin config-verify --config-file admin.yaml
60-
./osctrl-api config-verify --config-file api.yaml
51+
./osctrl-tls config-verify --file tls.yaml
52+
./osctrl-admin config-verify --file admin.yaml
53+
./osctrl-api config-verify --file api.yaml
6154
```
6255

6356
The verification process checks:

‎docs/404.html‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,15 +9,15 @@
99
<title>404 Page not found</title>
1010

1111

12-
<link href="/css/nucleus.css?1766846599" rel="stylesheet">
13-
<link href="/css/fontawesome-all.min.css?1766846599" rel="stylesheet">
14-
<link href="/css/hybrid.css?1766846599" rel="stylesheet">
15-
<link href="/css/featherlight.min.css?1766846599" rel="stylesheet">
16-
<link href="/css/perfect-scrollbar.min.css?1766846599" rel="stylesheet">
17-
<link href="/css/theme.css?1766846599" rel="stylesheet">
18-
<link href="/css/hugo-theme.css?1766846599" rel="stylesheet">
12+
<link href="/css/nucleus.css?1766850329" rel="stylesheet">
13+
<link href="/css/fontawesome-all.min.css?1766850329" rel="stylesheet">
14+
<link href="/css/hybrid.css?1766850329" rel="stylesheet">
15+
<link href="/css/featherlight.min.css?1766850329" rel="stylesheet">
16+
<link href="/css/perfect-scrollbar.min.css?1766850329" rel="stylesheet">
17+
<link href="/css/theme.css?1766850329" rel="stylesheet">
18+
<link href="/css/hugo-theme.css?1766850329" rel="stylesheet">
1919

20-
<link href="/css/theme-osctrl.css?1766846599" rel="stylesheet">
20+
<link href="/css/theme-osctrl.css?1766850329" rel="stylesheet">
2121

2222
<style>
2323
:root #header + #content > #left > #rlblock_left {

‎docs/categories/index.html‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
<title>Categories :: osctrl: Fast and efficient osquery management</title>
1313

1414

15-
<link href="/css/nucleus.css?1766846599" rel="stylesheet">
16-
<link href="/css/fontawesome-all.min.css?1766846599" rel="stylesheet">
17-
<link href="/css/hybrid.css?1766846599" rel="stylesheet">
18-
<link href="/css/featherlight.min.css?1766846599" rel="stylesheet">
19-
<link href="/css/perfect-scrollbar.min.css?1766846599" rel="stylesheet">
20-
<link href="/css/auto-complete.css?1766846599" rel="stylesheet">
21-
<link href="/css/atom-one-dark-reasonable.css?1766846599" rel="stylesheet">
22-
<link href="/css/theme.css?1766846599" rel="stylesheet">
23-
<link href="/css/hugo-theme.css?1766846599" rel="stylesheet">
15+
<link href="/css/nucleus.css?1766850329" rel="stylesheet">
16+
<link href="/css/fontawesome-all.min.css?1766850329" rel="stylesheet">
17+
<link href="/css/hybrid.css?1766850329" rel="stylesheet">
18+
<link href="/css/featherlight.min.css?1766850329" rel="stylesheet">
19+
<link href="/css/perfect-scrollbar.min.css?1766850329" rel="stylesheet">
20+
<link href="/css/auto-complete.css?1766850329" rel="stylesheet">
21+
<link href="/css/atom-one-dark-reasonable.css?1766850329" rel="stylesheet">
22+
<link href="/css/theme.css?1766850329" rel="stylesheet">
23+
<link href="/css/hugo-theme.css?1766850329" rel="stylesheet">
2424

25-
<link href="/css/theme-osctrl.css?1766846599" rel="stylesheet">
25+
<link href="/css/theme-osctrl.css?1766850329" rel="stylesheet">
2626

2727

2828

29-
<script src="/js/jquery-3.3.1.min.js?1766846599"></script>
29+
<script src="/js/jquery-3.3.1.min.js?1766850329"></script>
3030

3131
<style>
3232
:root #header + #content > #left > #rlblock_left{
@@ -95,14 +95,14 @@ <h1 style="margin:0; padding:0">
9595
<span data-search-clear=""><i class="fas fa-times"></i></span>
9696
</div>
9797

98-
<script type="text/javascript" src="/js/lunr.min.js?1766846599"></script>
99-
<script type="text/javascript" src="/js/auto-complete.js?1766846599"></script>
98+
<script type="text/javascript" src="/js/lunr.min.js?1766850329"></script>
99+
<script type="text/javascript" src="/js/auto-complete.js?1766850329"></script>
100100
<script type="text/javascript">
101101

102102
var baseurl = "https:\/\/osctrl.net\/";
103103

104104
</script>
105-
<script type="text/javascript" src="/js/search.js?1766846599"></script>
105+
<script type="text/javascript" src="/js/search.js?1766850329"></script>
106106

107107
</div>
108108

@@ -1409,19 +1409,19 @@ <h1>
14091409
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
14101410
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
14111411
</div>
1412-
<script src="/js/clipboard.min.js?1766846599"></script>
1413-
<script src="/js/perfect-scrollbar.min.js?1766846599"></script>
1414-
<script src="/js/perfect-scrollbar.jquery.min.js?1766846599"></script>
1415-
<script src="/js/jquery.sticky.js?1766846599"></script>
1416-
<script src="/js/featherlight.min.js?1766846599"></script>
1417-
<script src="/js/highlight.pack.js?1766846599"></script>
1412+
<script src="/js/clipboard.min.js?1766850329"></script>
1413+
<script src="/js/perfect-scrollbar.min.js?1766850329"></script>
1414+
<script src="/js/perfect-scrollbar.jquery.min.js?1766850329"></script>
1415+
<script src="/js/jquery.sticky.js?1766850329"></script>
1416+
<script src="/js/featherlight.min.js?1766850329"></script>
1417+
<script src="/js/highlight.pack.js?1766850329"></script>
14181418
<script>hljs.initHighlightingOnLoad();</script>
1419-
<script src="/js/modernizr.custom-3.6.0.js?1766846599"></script>
1420-
<script src="/js/learn.js?1766846599"></script>
1421-
<script src="/js/hugo-learn.js?1766846599"></script>
1419+
<script src="/js/modernizr.custom-3.6.0.js?1766850329"></script>
1420+
<script src="/js/learn.js?1766850329"></script>
1421+
<script src="/js/hugo-learn.js?1766850329"></script>
14221422

1423-
<link href="/mermaid/mermaid.css?1766846599" rel="stylesheet" />
1424-
<script src="/mermaid/mermaid.js?1766846599"></script>
1423+
<link href="/mermaid/mermaid.css?1766850329" rel="stylesheet" />
1424+
<script src="/mermaid/mermaid.js?1766850329"></script>
14251425
<script>
14261426
mermaid.initialize({ startOnLoad: true });
14271427
</script>

‎docs/components/backend/index.html‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
<title>Backend :: osctrl: Fast and efficient osquery management</title>
1313

1414

15-
<link href="/css/nucleus.css?1766846599" rel="stylesheet">
16-
<link href="/css/fontawesome-all.min.css?1766846599" rel="stylesheet">
17-
<link href="/css/hybrid.css?1766846599" rel="stylesheet">
18-
<link href="/css/featherlight.min.css?1766846599" rel="stylesheet">
19-
<link href="/css/perfect-scrollbar.min.css?1766846599" rel="stylesheet">
20-
<link href="/css/auto-complete.css?1766846599" rel="stylesheet">
21-
<link href="/css/atom-one-dark-reasonable.css?1766846599" rel="stylesheet">
22-
<link href="/css/theme.css?1766846599" rel="stylesheet">
23-
<link href="/css/hugo-theme.css?1766846599" rel="stylesheet">
15+
<link href="/css/nucleus.css?1766850329" rel="stylesheet">
16+
<link href="/css/fontawesome-all.min.css?1766850329" rel="stylesheet">
17+
<link href="/css/hybrid.css?1766850329" rel="stylesheet">
18+
<link href="/css/featherlight.min.css?1766850329" rel="stylesheet">
19+
<link href="/css/perfect-scrollbar.min.css?1766850329" rel="stylesheet">
20+
<link href="/css/auto-complete.css?1766850329" rel="stylesheet">
21+
<link href="/css/atom-one-dark-reasonable.css?1766850329" rel="stylesheet">
22+
<link href="/css/theme.css?1766850329" rel="stylesheet">
23+
<link href="/css/hugo-theme.css?1766850329" rel="stylesheet">
2424

25-
<link href="/css/theme-osctrl.css?1766846599" rel="stylesheet">
25+
<link href="/css/theme-osctrl.css?1766850329" rel="stylesheet">
2626

2727

2828

29-
<script src="/js/jquery-3.3.1.min.js?1766846599"></script>
29+
<script src="/js/jquery-3.3.1.min.js?1766850329"></script>
3030

3131
<style>
3232
:root #header + #content > #left > #rlblock_left{
@@ -95,14 +95,14 @@ <h1 style="margin:0; padding:0">
9595
<span data-search-clear=""><i class="fas fa-times"></i></span>
9696
</div>
9797

98-
<script type="text/javascript" src="/js/lunr.min.js?1766846599"></script>
99-
<script type="text/javascript" src="/js/auto-complete.js?1766846599"></script>
98+
<script type="text/javascript" src="/js/lunr.min.js?1766850329"></script>
99+
<script type="text/javascript" src="/js/auto-complete.js?1766850329"></script>
100100
<script type="text/javascript">
101101

102102
var baseurl = "https:\/\/osctrl.net\/";
103103

104104
</script>
105-
<script type="text/javascript" src="/js/search.js?1766846599"></script>
105+
<script type="text/javascript" src="/js/search.js?1766850329"></script>
106106

107107
</div>
108108

@@ -1435,19 +1435,19 @@ <h1>
14351435
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
14361436
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
14371437
</div>
1438-
<script src="/js/clipboard.min.js?1766846599"></script>
1439-
<script src="/js/perfect-scrollbar.min.js?1766846599"></script>
1440-
<script src="/js/perfect-scrollbar.jquery.min.js?1766846599"></script>
1441-
<script src="/js/jquery.sticky.js?1766846599"></script>
1442-
<script src="/js/featherlight.min.js?1766846599"></script>
1443-
<script src="/js/highlight.pack.js?1766846599"></script>
1438+
<script src="/js/clipboard.min.js?1766850329"></script>
1439+
<script src="/js/perfect-scrollbar.min.js?1766850329"></script>
1440+
<script src="/js/perfect-scrollbar.jquery.min.js?1766850329"></script>
1441+
<script src="/js/jquery.sticky.js?1766850329"></script>
1442+
<script src="/js/featherlight.min.js?1766850329"></script>
1443+
<script src="/js/highlight.pack.js?1766850329"></script>
14441444
<script>hljs.initHighlightingOnLoad();</script>
1445-
<script src="/js/modernizr.custom-3.6.0.js?1766846599"></script>
1446-
<script src="/js/learn.js?1766846599"></script>
1447-
<script src="/js/hugo-learn.js?1766846599"></script>
1445+
<script src="/js/modernizr.custom-3.6.0.js?1766850329"></script>
1446+
<script src="/js/learn.js?1766850329"></script>
1447+
<script src="/js/hugo-learn.js?1766850329"></script>
14481448

1449-
<link href="/mermaid/mermaid.css?1766846599" rel="stylesheet" />
1450-
<script src="/mermaid/mermaid.js?1766846599"></script>
1449+
<link href="/mermaid/mermaid.css?1766850329" rel="stylesheet" />
1450+
<script src="/mermaid/mermaid.js?1766850329"></script>
14511451
<script>
14521452
mermaid.initialize({ startOnLoad: true });
14531453
</script>

‎docs/components/index.html‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
<title>Components :: osctrl: Fast and efficient osquery management</title>
1313

1414

15-
<link href="/css/nucleus.css?1766846599" rel="stylesheet">
16-
<link href="/css/fontawesome-all.min.css?1766846599" rel="stylesheet">
17-
<link href="/css/hybrid.css?1766846599" rel="stylesheet">
18-
<link href="/css/featherlight.min.css?1766846599" rel="stylesheet">
19-
<link href="/css/perfect-scrollbar.min.css?1766846599" rel="stylesheet">
20-
<link href="/css/auto-complete.css?1766846599" rel="stylesheet">
21-
<link href="/css/atom-one-dark-reasonable.css?1766846599" rel="stylesheet">
22-
<link href="/css/theme.css?1766846599" rel="stylesheet">
23-
<link href="/css/hugo-theme.css?1766846599" rel="stylesheet">
15+
<link href="/css/nucleus.css?1766850329" rel="stylesheet">
16+
<link href="/css/fontawesome-all.min.css?1766850329" rel="stylesheet">
17+
<link href="/css/hybrid.css?1766850329" rel="stylesheet">
18+
<link href="/css/featherlight.min.css?1766850329" rel="stylesheet">
19+
<link href="/css/perfect-scrollbar.min.css?1766850329" rel="stylesheet">
20+
<link href="/css/auto-complete.css?1766850329" rel="stylesheet">
21+
<link href="/css/atom-one-dark-reasonable.css?1766850329" rel="stylesheet">
22+
<link href="/css/theme.css?1766850329" rel="stylesheet">
23+
<link href="/css/hugo-theme.css?1766850329" rel="stylesheet">
2424

25-
<link href="/css/theme-osctrl.css?1766846599" rel="stylesheet">
25+
<link href="/css/theme-osctrl.css?1766850329" rel="stylesheet">
2626

2727

2828

29-
<script src="/js/jquery-3.3.1.min.js?1766846599"></script>
29+
<script src="/js/jquery-3.3.1.min.js?1766850329"></script>
3030

3131
<style>
3232
:root #header + #content > #left > #rlblock_left{
@@ -95,14 +95,14 @@ <h1 style="margin:0; padding:0">
9595
<span data-search-clear=""><i class="fas fa-times"></i></span>
9696
</div>
9797

98-
<script type="text/javascript" src="/js/lunr.min.js?1766846599"></script>
99-
<script type="text/javascript" src="/js/auto-complete.js?1766846599"></script>
98+
<script type="text/javascript" src="/js/lunr.min.js?1766850329"></script>
99+
<script type="text/javascript" src="/js/auto-complete.js?1766850329"></script>
100100
<script type="text/javascript">
101101

102102
var baseurl = "https:\/\/osctrl.net\/";
103103

104104
</script>
105-
<script type="text/javascript" src="/js/search.js?1766846599"></script>
105+
<script type="text/javascript" src="/js/search.js?1766850329"></script>
106106

107107
</div>
108108

@@ -1414,19 +1414,19 @@ <h1 id="components">Components</h1>
14141414
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
14151415
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
14161416
</div>
1417-
<script src="/js/clipboard.min.js?1766846599"></script>
1418-
<script src="/js/perfect-scrollbar.min.js?1766846599"></script>
1419-
<script src="/js/perfect-scrollbar.jquery.min.js?1766846599"></script>
1420-
<script src="/js/jquery.sticky.js?1766846599"></script>
1421-
<script src="/js/featherlight.min.js?1766846599"></script>
1422-
<script src="/js/highlight.pack.js?1766846599"></script>
1417+
<script src="/js/clipboard.min.js?1766850329"></script>
1418+
<script src="/js/perfect-scrollbar.min.js?1766850329"></script>
1419+
<script src="/js/perfect-scrollbar.jquery.min.js?1766850329"></script>
1420+
<script src="/js/jquery.sticky.js?1766850329"></script>
1421+
<script src="/js/featherlight.min.js?1766850329"></script>
1422+
<script src="/js/highlight.pack.js?1766850329"></script>
14231423
<script>hljs.initHighlightingOnLoad();</script>
1424-
<script src="/js/modernizr.custom-3.6.0.js?1766846599"></script>
1425-
<script src="/js/learn.js?1766846599"></script>
1426-
<script src="/js/hugo-learn.js?1766846599"></script>
1424+
<script src="/js/modernizr.custom-3.6.0.js?1766850329"></script>
1425+
<script src="/js/learn.js?1766850329"></script>
1426+
<script src="/js/hugo-learn.js?1766850329"></script>
14271427

1428-
<link href="/mermaid/mermaid.css?1766846599" rel="stylesheet" />
1429-
<script src="/mermaid/mermaid.js?1766846599"></script>
1428+
<link href="/mermaid/mermaid.css?1766850329" rel="stylesheet" />
1429+
<script src="/mermaid/mermaid.js?1766850329"></script>
14301430
<script>
14311431
mermaid.initialize({ startOnLoad: true });
14321432
</script>

‎docs/components/metrics/index.html‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,21 @@
1212
<title>Metrics :: osctrl: Fast and efficient osquery management</title>
1313

1414

15-
<link href="/css/nucleus.css?1766846599" rel="stylesheet">
16-
<link href="/css/fontawesome-all.min.css?1766846599" rel="stylesheet">
17-
<link href="/css/hybrid.css?1766846599" rel="stylesheet">
18-
<link href="/css/featherlight.min.css?1766846599" rel="stylesheet">
19-
<link href="/css/perfect-scrollbar.min.css?1766846599" rel="stylesheet">
20-
<link href="/css/auto-complete.css?1766846599" rel="stylesheet">
21-
<link href="/css/atom-one-dark-reasonable.css?1766846599" rel="stylesheet">
22-
<link href="/css/theme.css?1766846599" rel="stylesheet">
23-
<link href="/css/hugo-theme.css?1766846599" rel="stylesheet">
15+
<link href="/css/nucleus.css?1766850329" rel="stylesheet">
16+
<link href="/css/fontawesome-all.min.css?1766850329" rel="stylesheet">
17+
<link href="/css/hybrid.css?1766850329" rel="stylesheet">
18+
<link href="/css/featherlight.min.css?1766850329" rel="stylesheet">
19+
<link href="/css/perfect-scrollbar.min.css?1766850329" rel="stylesheet">
20+
<link href="/css/auto-complete.css?1766850329" rel="stylesheet">
21+
<link href="/css/atom-one-dark-reasonable.css?1766850329" rel="stylesheet">
22+
<link href="/css/theme.css?1766850329" rel="stylesheet">
23+
<link href="/css/hugo-theme.css?1766850329" rel="stylesheet">
2424

25-
<link href="/css/theme-osctrl.css?1766846599" rel="stylesheet">
25+
<link href="/css/theme-osctrl.css?1766850329" rel="stylesheet">
2626

2727

2828

29-
<script src="/js/jquery-3.3.1.min.js?1766846599"></script>
29+
<script src="/js/jquery-3.3.1.min.js?1766850329"></script>
3030

3131
<style>
3232
:root #header + #content > #left > #rlblock_left{
@@ -95,14 +95,14 @@ <h1 style="margin:0; padding:0">
9595
<span data-search-clear=""><i class="fas fa-times"></i></span>
9696
</div>
9797

98-
<script type="text/javascript" src="/js/lunr.min.js?1766846599"></script>
99-
<script type="text/javascript" src="/js/auto-complete.js?1766846599"></script>
98+
<script type="text/javascript" src="/js/lunr.min.js?1766850329"></script>
99+
<script type="text/javascript" src="/js/auto-complete.js?1766850329"></script>
100100
<script type="text/javascript">
101101

102102
var baseurl = "https:\/\/osctrl.net\/";
103103

104104
</script>
105-
<script type="text/javascript" src="/js/search.js?1766846599"></script>
105+
<script type="text/javascript" src="/js/search.js?1766850329"></script>
106106

107107
</div>
108108

@@ -1441,19 +1441,19 @@ <h1>
14411441
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
14421442
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
14431443
</div>
1444-
<script src="/js/clipboard.min.js?1766846599"></script>
1445-
<script src="/js/perfect-scrollbar.min.js?1766846599"></script>
1446-
<script src="/js/perfect-scrollbar.jquery.min.js?1766846599"></script>
1447-
<script src="/js/jquery.sticky.js?1766846599"></script>
1448-
<script src="/js/featherlight.min.js?1766846599"></script>
1449-
<script src="/js/highlight.pack.js?1766846599"></script>
1444+
<script src="/js/clipboard.min.js?1766850329"></script>
1445+
<script src="/js/perfect-scrollbar.min.js?1766850329"></script>
1446+
<script src="/js/perfect-scrollbar.jquery.min.js?1766850329"></script>
1447+
<script src="/js/jquery.sticky.js?1766850329"></script>
1448+
<script src="/js/featherlight.min.js?1766850329"></script>
1449+
<script src="/js/highlight.pack.js?1766850329"></script>
14501450
<script>hljs.initHighlightingOnLoad();</script>
1451-
<script src="/js/modernizr.custom-3.6.0.js?1766846599"></script>
1452-
<script src="/js/learn.js?1766846599"></script>
1453-
<script src="/js/hugo-learn.js?1766846599"></script>
1451+
<script src="/js/modernizr.custom-3.6.0.js?1766850329"></script>
1452+
<script src="/js/learn.js?1766850329"></script>
1453+
<script src="/js/hugo-learn.js?1766850329"></script>
14541454

1455-
<link href="/mermaid/mermaid.css?1766846599" rel="stylesheet" />
1456-
<script src="/mermaid/mermaid.js?1766846599"></script>
1455+
<link href="/mermaid/mermaid.css?1766850329" rel="stylesheet" />
1456+
<script src="/mermaid/mermaid.js?1766850329"></script>
14571457
<script>
14581458
mermaid.initialize({ startOnLoad: true });
14591459
</script>

0 commit comments

Comments
 (0)