Skip to content

Commit 9f5ae06

Browse files
javutojavuto
committed
Update environments and provision
1 parent 2db3b8d commit 9f5ae06

Some content is hidden

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

77 files changed

+2150
-2033
lines changed

‎README.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,12 @@
1-
# osctrl
1+
# osctrl-docs
22

33
<p align="center">
44
<img alt="osctrl" src="logo.png" width="300" />
55
<p align="center">
66
Fast and efficient osquery management.
77
</p>
8-
<p align="center">
9-
<a href="https://github.com/jmpsec/osctrl/blob/master/LICENSE.md">
10-
<img alt="Software License" src="https://img.shields.io/badge/license-GPL3-brightgreen.svg?style=flat-square">
11-
</a>
12-
<a href="https://travis-ci.org/jmpsec/osctrl">
13-
<img alt="Travis" src="https://img.shields.io/travis/jmpsec/osctrl/master.svg?style=flat-square">
14-
</a>
15-
<a href="https://goreportcard.com/report/github.com/jmpsec/osctrl">
16-
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/jmpsec/osctrl?style=flat-square&fuckgithubcache=1">
17-
</a>
18-
</p>
198
</p>
209

21-
## osctrl-docs
22-
2310
Documentation for [osctrl](https://github.com/jmpsec/osctrl): https://osctrl.net
2411

2512
## Generating docs

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

Lines changed: 57 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ USAGE:
1818
osctrl-admin [global options] command [command options] [arguments...]
1919

2020
VERSION:
21-
0.3.0
21+
0.3.4
2222

2323
DESCRIPTION:
2424
Admin service for osctrl, a fast and efficient osquery management
@@ -27,57 +27,60 @@ COMMANDS:
2727
help
2828

2929
GLOBAL OPTIONS:
30-
--config, -c Provide service configuration via JSON file (default: false) [$SERVICE_CONFIG]
31-
--config-file FILE, -C FILE Load service configuration from FILE (default: "config/admin.json") [$SERVICE_CONFIG_FILE]
32-
--listener value, -l value Listener for the service (default: "0.0.0.0") [$SERVICE_LISTENER]
33-
--port value, -p value TCP port for the service (default: "9001") [$SERVICE_PORT]
34-
--auth value, -A value Authentication mechanism for the service (default: "db") [$SERVICE_AUTH]
35-
--host value, -H value Exposed hostname the service uses (default: "0.0.0.0") [$SERVICE_HOST]
36-
--session-key value Session key to generate cookies from it [$SESSION_KEY]
37-
--logging value, -L value Logging mechanism to handle logs from nodes (default: "db") [$SERVICE_LOGGER]
38-
--redis, -r Provide redis configuration via JSON file (default: false) [$REDIS_CONFIG]
39-
--redis-file FILE, -R FILE Load redis configuration from FILE (default: "config/redis.json") [$REDIS_CONFIG_FILE]
40-
--redis-host value Redis host to be connected to (default: "127.0.0.1") [$REDIS_HOST]
41-
--redis-port value Redis port to be connected to (default: "6379") [$REDIS_PORT]
42-
--redis-pass value Password to be used for redis [$REDIS_PASS]
43-
--redis-db value Redis database to be selected after connecting (default: 0) [$REDIS_DB]
44-
--redis-status-exp value Redis expiration in hours for status logs (default: 24) [$REDIS_STATUS_EXP]
45-
--redis-result-exp value Redis expiration in hours for result logs (default: 24) [$REDIS_RESULT_EXP]
46-
--redis-query-exp value Redis expiration in hours for query logs (default: 24) [$REDIS_QUERY_EXP]
47-
--db, -d Provide DB configuration via JSON file (default: false) [$DB_CONFIG]
48-
--db-file FILE, -D FILE Load DB configuration from FILE (default: "config/db.json") [$DB_CONFIG_FILE]
49-
--db-host value Backend host to be connected to (default: "127.0.0.1") [$DB_HOST]
50-
--db-port value Backend port to be connected to (default: "5432") [$DB_PORT]
51-
--db-name value Database name to be used in the backend (default: "osctrl") [$DB_NAME]
52-
--db-user value Username to be used for the backend (default: "postgres") [$DB_USER]
53-
--db-pass value Password to be used for the backend (default: "postgres") [$DB_PASS]
54-
--db-max-idle-conns value Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
55-
--db-max-open-conns value Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
56-
--db-conn-max-lifetime value Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
57-
--tls, -t Enable TLS termination. It requires certificate and key (default: false) [$TLS_SERVER]
58-
--cert FILE, -T FILE TLS termination certificate from FILE (default: "config/tls.crt") [$TLS_CERTIFICATE]
59-
--key FILE, -K FILE TLS termination private key from FILE (default: "config/tls.key") [$TLS_KEY]
60-
--saml-file FILE Load SAML configuration from FILE (default: "config/saml.json") [$SAML_CONFIG_FILE]
61-
--jwt, -j Provide JWT configuration via JSON file (default: false) [$JWT_CONFIG]
62-
--jwt-file FILE Load JWT configuration from FILE (default: "config/jwt.json") [$JWT_CONFIG_FILE]
63-
--jwt-secret value Password to be used for the backend [$JWT_SECRET]
64-
--jwt-expire value Maximum amount of hours for the tokens to expire (default: 3) [$JWT_EXPIRE]
65-
--osquery-version value Set osquery version as default to be used (default: "5.4.0") [$OSQUERY_VERSION]
66-
--osquery-tables FILE Load osquery tables schema from FILE (default: "data/5.4.0.json") [$OSQUERY_TABLES]
67-
--logger-file value, -F value Logger configuration to handle status/results logs from nodes (default: "config/logger.json") [$LOGGER_FILE]
68-
--static value, -s value Directory with all the static files needed for the osctrl-admin UI (default: "./static") [$STATIC_FILES]
69-
--static-offline, -S Use offline static files (js and css). Default is online files. (default: false) [$STATIC_ONLINE]
70-
--templates value Directory with all the templates needed for the osctrl-admin UI (default: "./tmpl_admin") [$STATIC_FILES]
71-
--carved value Directory for all the received carved files from osquery (default: "./carved_files/") [$CARVED_FILES]
72-
--carver-type value Carver to be used to receive files extracted from nodes (default: "db") [$CARVER_TYPE]
73-
--carver-file value Carver configuration file to receive files extracted from nodes (default: "config/carver.json") [$CARVER_FILE]
74-
--log-s3-bucket value S3 bucket to be used as configuration for logging [$LOG_S3_BUCKET]
75-
--log-s3-region value S3 region to be used as configuration for logging [$LOG_S3_REGION]
76-
--log-s3-key-id value S3 access key id to be used as configuration for logging [$LOG_S3_KEY_ID]
77-
--log-s3-secret value S3 access key secret to be used as configuration for logging [$LOG_S3_SECRET]
78-
--carver-s3-bucket value S3 bucket to be used as configuration for carves [$CARVER_S3_BUCKET]
79-
--carver-s3-region value S3 region to be used as configuration for carves [$CARVER_S3_REGION]
80-
--carve-s3-key-id value S3 access key id to be used as configuration for carves [$CARVER_S3_KEY_ID]
81-
--carve-s3-secret value S3 access key secret to be used as configuration for carves [$CARVER_S3_SECRET]
82-
--version, -v print the version (default: false)
30+
--config, -c Provide service configuration via JSON file (default: false) [$SERVICE_CONFIG]
31+
--config-file FILE, -C FILE Load service configuration from FILE (default: "config/admin.json") [$SERVICE_CONFIG_FILE]
32+
--listener value, -l value Listener for the service (default: "0.0.0.0") [$SERVICE_LISTENER]
33+
--port value, -p value TCP port for the service (default: "9001") [$SERVICE_PORT]
34+
--auth value, -A value Authentication mechanism for the service (default: "db") [$SERVICE_AUTH]
35+
--host value, -H value Exposed hostname the service uses (default: "0.0.0.0") [$SERVICE_HOST]
36+
--session-key value Session key to generate cookies from it [$SESSION_KEY]
37+
--logging value, -L value Logging mechanism to handle logs from nodes (default: "db") [$SERVICE_LOGGER]
38+
--redis, -r Provide redis configuration via JSON file (default: false) [$REDIS_CONFIG]
39+
--redis-file FILE, -R FILE Load redis configuration from FILE (default: "config/redis.json") [$REDIS_CONFIG_FILE]
40+
--redis-connection-string value Redis connection string, must include schema (<redis|rediss|unix>://<user>:<pass>@<host>:<port>/<db>?<options> [$REDIS_CONNECTION_STRING]
41+
--redis-host value Redis host to be connected to (default: "127.0.0.1") [$REDIS_HOST]
42+
--redis-port value Redis port to be connected to (default: "6379") [$REDIS_PORT]
43+
--redis-pass value Password to be used for redis [$REDIS_PASS]
44+
--redis-db value Redis database to be selected after connecting (default: 0) [$REDIS_DB]
45+
--redis-status-exp value Redis expiration in hours for status logs (default: 24) [$REDIS_STATUS_EXP]
46+
--redis-result-exp value Redis expiration in hours for result logs (default: 24) [$REDIS_RESULT_EXP]
47+
--redis-query-exp value Redis expiration in hours for query logs (default: 24) [$REDIS_QUERY_EXP]
48+
--redis-conn-retry value Time in seconds to retry the connection to the cache, if set to 0 the service will stop if the connection fails (default: 7) [$REDIS_CONN_RETRY]
49+
--db, -d Provide DB configuration via JSON file (default: false) [$DB_CONFIG]
50+
--db-file FILE, -D FILE Load DB configuration from FILE (default: "config/db.json") [$DB_CONFIG_FILE]
51+
--db-host value Backend host to be connected to (default: "127.0.0.1") [$DB_HOST]
52+
--db-port value Backend port to be connected to (default: "5432") [$DB_PORT]
53+
--db-name value Database name to be used in the backend (default: "osctrl") [$DB_NAME]
54+
--db-user value Username to be used for the backend (default: "postgres") [$DB_USER]
55+
--db-pass value Password to be used for the backend (default: "postgres") [$DB_PASS]
56+
--db-max-idle-conns value Maximum number of connections in the idle connection pool (default: 20) [$DB_MAX_IDLE_CONNS]
57+
--db-max-open-conns value Maximum number of open connections to the database (default: 100) [$DB_MAX_OPEN_CONNS]
58+
--db-conn-max-lifetime value Maximum amount of time a connection may be reused (default: 30) [$DB_CONN_MAX_LIFETIME]
59+
--db-conn-retry value Time in seconds to retry the connection to the database, if set to 0 the service will stop if the connection fails (default: 7) [$DB_CONN_RETRY]
60+
--tls, -t Enable TLS termination. It requires certificate and key (default: false) [$TLS_SERVER]
61+
--cert FILE, -T FILE TLS termination certificate from FILE (default: "config/tls.crt") [$TLS_CERTIFICATE]
62+
--key FILE, -K FILE TLS termination private key from FILE (default: "config/tls.key") [$TLS_KEY]
63+
--saml-file FILE Load SAML configuration from FILE (default: "config/saml.json") [$SAML_CONFIG_FILE]
64+
--jwt, -j Provide JWT configuration via JSON file (default: false) [$JWT_CONFIG]
65+
--jwt-file FILE Load JWT configuration from FILE (default: "config/jwt.json") [$JWT_CONFIG_FILE]
66+
--jwt-secret value Password to be used for the backend [$JWT_SECRET]
67+
--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.10.2") [$OSQUERY_VERSION]
69+
--osquery-tables FILE Load osquery tables schema from FILE (default: "data/5.10.2.json") [$OSQUERY_TABLES]
70+
--logger-file value, -F value Logger configuration to handle status/results logs from nodes (default: "config/logger.json") [$LOGGER_FILE]
71+
--static value, -s value Directory with all the static files needed for the osctrl-admin UI (default: "./static") [$STATIC_FILES]
72+
--static-offline, -S Use offline static files (js and css). Default is online files. (default: false) [$STATIC_ONLINE]
73+
--templates value Directory with all the templates needed for the osctrl-admin UI (default: "./tmpl_admin") [$STATIC_FILES]
74+
--carved value Directory for all the received carved files from osquery (default: "./carved_files/") [$CARVED_FILES]
75+
--carver-type value Carver to be used to receive files extracted from nodes (default: "db") [$CARVER_TYPE]
76+
--carver-file value Carver configuration file to receive files extracted from nodes (default: "config/carver.json") [$CARVER_FILE]
77+
--log-s3-bucket value S3 bucket to be used as configuration for logging [$LOG_S3_BUCKET]
78+
--log-s3-region value S3 region to be used as configuration for logging [$LOG_S3_REGION]
79+
--log-s3-key-id value S3 access key id to be used as configuration for logging [$LOG_S3_KEY_ID]
80+
--log-s3-secret value S3 access key secret to be used as configuration for logging [$LOG_S3_SECRET]
81+
--carver-s3-bucket value S3 bucket to be used as configuration for carves [$CARVER_S3_BUCKET]
82+
--carver-s3-region value S3 region to be used as configuration for carves [$CARVER_S3_REGION]
83+
--carve-s3-key-id value S3 access key id to be used as configuration for carves [$CARVER_S3_KEY_ID]
84+
--carve-s3-secret value S3 access key secret to be used as configuration for carves [$CARVER_S3_SECRET]
85+
--version, -v print the version
8386
```

0 commit comments

Comments
 (0)