Skip to content

Commit 89384d3

Browse files
javutojavuto
committed
Update to documentation after 0.4.1 release
1 parent b29a1ca commit 89384d3

File tree

55 files changed

+11710
-1253
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+11710
-1253
lines changed

‎content/usage/osctrl-admin/_index.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ pre = ""
77

88
`osctrl-admin` is the Admin service for **osctrl**.
99

10-
Execute `./osctrl-admin -h` to show the main help of the program:
10+
Execute `./osctrl-admin help` to show the main help of the program:
1111

1212
```properties
13-
$ ./osctrl-admin -h
13+
$ ./osctrl-admin help
1414
NAME:
1515
osctrl-admin - Admin service for osctrl, a fast and efficient osquery management
1616

1717
USAGE:
1818
osctrl-admin [global options] command [command options] [arguments...]
1919

2020
VERSION:
21-
0.3.7
21+
0.4.1
2222

2323
DESCRIPTION:
2424
Admin service for osctrl, a fast and efficient osquery management
@@ -53,6 +53,7 @@ GLOBAL OPTIONS:
5353
--db-name value Database name to be used in the backend (default: "osctrl") [$DB_NAME]
5454
--db-user value Username to be used for the backend (default: "postgres") [$DB_USER]
5555
--db-pass value Password to be used for the backend (default: "postgres") [$DB_PASS]
56+
--db-sslmode value SSL native support to encrypt the connection to the backend (default: "disable") [$DB_SSLMODE]
5657
--db-max-idle-conns value Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
5758
--db-max-open-conns value Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
5859
--db-conn-max-lifetime value Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
@@ -65,8 +66,8 @@ GLOBAL OPTIONS:
6566
--jwt-file FILE Load JWT configuration from FILE (default: "config/jwt.json") [$JWT_CONFIG_FILE]
6667
--jwt-secret value Password to be used for the backend [$JWT_SECRET]
6768
--jwt-expire value Maximum amount of hours for the tokens to expire (default: 3) [$JWT_EXPIRE]
68-
--osquery-version value Set osquery version as default to be used (default: "5.12.1") [$OSQUERY_VERSION]
69-
--osquery-tables FILE Load osquery tables schema from FILE (default: "data/5.12.1.json") [$OSQUERY_TABLES]
69+
--osquery-version value Set osquery version as default to be used (default: "5.13.1") [$OSQUERY_VERSION]
70+
--osquery-tables FILE Load osquery tables schema from FILE (default: "data/5.13.1.json") [$OSQUERY_TABLES]
7071
--logger-file value, -F value Logger configuration to handle status/results logs from nodes (default: "config/logger.json") [$LOGGER_FILE]
7172
--logger-db-same Use the same DB configuration for the logger (default: false) [$LOGGER_DB_SAME]
7273
--static value, -s value Directory with all the static files needed for the osctrl-admin UI (default: "./static") [$STATIC_FILES]

‎content/usage/osctrl-api/_index.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ pre = ""
77

88
`osctrl-api` is the API service for **osctrl**.
99

10-
Execute `./osctrl-api -h` to show the main help of the program:
10+
Execute `./osctrl-api help` to show the main help of the program:
1111

1212
```properties
13-
$ ./osctrl-api -h
13+
$ ./osctrl-api help
1414
NAME:
1515
osctrl-api - API service for osctrl, a fast and efficient osquery management
1616

1717
USAGE:
1818
osctrl-api [global options] command [command options] [arguments...]
1919

2020
VERSION:
21-
0.3.7
21+
0.4.1
2222

2323
DESCRIPTION:
2424
API service for osctrl, a fast and efficient osquery management
@@ -49,6 +49,7 @@ GLOBAL OPTIONS:
4949
--db-name value Database name to be used in the backend (default: "osctrl") [$DB_NAME]
5050
--db-user value Username to be used for the backend (default: "postgres") [$DB_USER]
5151
--db-pass value Password to be used for the backend (default: "postgres") [$DB_PASS]
52+
--db-sslmode value SSL native support to encrypt the connection to the backend (default: "disable") [$DB_SSLMODE]
5253
--db-max-idle-conns value Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
5354
--db-max-open-conns value Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
5455
--db-conn-max-lifetime value Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]

‎content/usage/osctrl-cli/_index.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ pre = ""
77

88
`osctrl-cli` is the CLI for **osctrl**. Its purpose is to execute actions in **osctrl** without having to access directly the backend or use the admin interface. It can be very handy to automate actions in scripts or similar.
99

10-
Execute `./osctrl-cli -h` to show the main help of the program:
10+
Execute `./osctrl-cli help` to show the main help of the program:
1111

1212
```properties
13-
$ ./osctrl-cli -h
13+
$ ./osctrl-cli help
1414
NAME:
1515
osctrl-cli - CLI for osctrl
1616

1717
USAGE:
1818
osctrl-cli [global options] command [command options] [arguments...]
1919

2020
VERSION:
21-
0.3.7
21+
0.4.1
2222

2323
DESCRIPTION:
2424
CLI for osctrl, a fast and efficient osquery management

‎content/usage/osctrl-cli/carve/_index.md

+130
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,130 @@
1+
+++
2+
title = "carve"
3+
date = 2024-11-04T12:21:37+01:00
4+
weight = 8
5+
pre = ""
6+
+++
7+
8+
### Carve
9+
10+
```properties
11+
$ ./osctrl-cli carve -h
12+
NAME:
13+
osctrl-cli carve - Commands for file carves
14+
15+
USAGE:
16+
osctrl-cli carve command [command options] [arguments...]
17+
18+
COMMANDS:
19+
complete, c Mark an file carve query as completed
20+
delete, d Mark a file carve query as deleted
21+
expire, e Mark a file carve query as expired
22+
run, r Start a new carve for a file or a directory
23+
list, l List file carves
24+
list-queries, l List file carves queries
25+
help, h Shows a list of commands or help for one command
26+
27+
OPTIONS:
28+
--help, -h show help
29+
```
30+
31+
#### Complete carve
32+
33+
```properties
34+
$ ./osctrl-cli carve complete -h
35+
NAME:
36+
osctrl-cli carve complete - Mark an file carve query as completed
37+
38+
USAGE:
39+
osctrl-cli carve complete [command options] [arguments...]
40+
41+
OPTIONS:
42+
--name value, -n value Carve name to be completed
43+
--env value, -e value Environment to be used
44+
--help, -h show help
45+
```
46+
47+
#### Delete carve
48+
49+
```properties
50+
$ ./osctrl-cli carve delete -h
51+
NAME:
52+
osctrl-cli carve delete - Mark a file carve query as deleted
53+
54+
USAGE:
55+
osctrl-cli carve delete [command options] [arguments...]
56+
57+
OPTIONS:
58+
--name value, -n value Carve name to be deleted
59+
--env value, -e value Environment to be used
60+
--help, -h show help
61+
```
62+
63+
#### Expire carve
64+
65+
```properties
66+
$ ./osctrl-cli carve expire -h
67+
NAME:
68+
osctrl-cli carve expire - Mark a file carve query as expired
69+
70+
USAGE:
71+
osctrl-cli carve expire [command options] [arguments...]
72+
73+
OPTIONS:
74+
--name value, -n value Carve name to be expired
75+
--env value, -e value Environment to be used
76+
--help, -h show help
77+
```
78+
79+
#### Run carve
80+
81+
```properties
82+
$ ./osctrl-cli carve run -h
83+
NAME:
84+
osctrl-cli carve run - Start a new carve for a file or a directory
85+
86+
USAGE:
87+
osctrl-cli carve run [command options] [arguments...]
88+
89+
OPTIONS:
90+
--path value, -p value File or directory path to be carved
91+
--env value, -e value Environment to be used
92+
--uuid value, -u value Node UUID to be used
93+
--expiration value, -E value Expiration in hours (0 for no expiration) (default: 6)
94+
--help, -h show help
95+
```
96+
97+
#### List carves
98+
99+
```properties
100+
$ ./osctrl-cli carve list -h
101+
NAME:
102+
osctrl-cli carve list - List file carves
103+
104+
USAGE:
105+
osctrl-cli carve list [command options] [arguments...]
106+
107+
OPTIONS:
108+
--env value, -e value Environment to be used
109+
--help, -h show help
110+
```
111+
112+
#### List carve queries
113+
114+
```properties
115+
$ ./osctrl-cli carve list-queries -h
116+
NAME:
117+
osctrl-cli carve list-queries - List file carves queries
118+
119+
USAGE:
120+
osctrl-cli carve list-queries [command options] [arguments...]
121+
122+
OPTIONS:
123+
--all, -A Show all file carves queries (default: false)
124+
--active, -a Show active file carves queries (default: false)
125+
--completed, -c Show completed file carves queries (default: false)
126+
--expired, -E Show expired file carves queries (default: false)
127+
--deleted, -d Show deleted file carves queries (default: false)
128+
--env value, -e value Environment to be used
129+
--help, -h show help
130+
```

‎content/usage/osctrl-cli/check-api/_index.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
+++
2+
title = "check-api"
3+
date = 2024-11-04T12:21:37+01:00
4+
weight = 7
5+
pre = ""
6+
+++
7+
8+
### Check
9+
10+
```properties
11+
$ ./osctrl-cli check-api -h
12+
NAME:
13+
osctrl-cli check-api - Checks API token
14+
15+
USAGE:
16+
osctrl-cli check-api [command options] [arguments...]
17+
18+
OPTIONS:
19+
--help, -h show help
20+
```
21+
22+
Although this command may appear a bit confusing, it comes in really handy to verify when the `osctrl-api` component is ready to go and the validity of a token.

‎content/usage/osctrl-cli/check/_index.md renamed to ‎content/usage/osctrl-cli/check-db/_index.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
+++
2-
title = "check"
3-
date = 2019-08-17T15:24:52-07:00
2+
title = "check-db"
3+
date = 2024-11-04T12:21:37+01:00
44
weight = 6
55
pre = ""
66
+++
77

88
### Check
99

1010
```properties
11-
$ ./osctrl-cli check -h
11+
$ ./osctrl-cli check-db -h
1212
NAME:
13-
osctrl-cli check - Checks DB connection
13+
osctrl-cli check-db - Checks DB connection
1414

1515
USAGE:
16-
osctrl-cli check [command options] [arguments...]
16+
osctrl-cli check-db [command options] [arguments...]
1717

1818
OPTIONS:
19-
--help, -h show help (default: false)
19+
--help, -h show help
2020
```
2121

2222
Although this command may appear a bit confusing, it comes in really handy to verify when the backend component is ready to go.

0 commit comments

Comments
 (0)