API documentation and partial update to 0.3.7

Author: javuto

config.toml

@@ -13,7 +13,7 @@ unsafe= true
 home = [ "HTML", "RSS", "JSON"]
 
 [params]
-author = "Javier Marcos de Prado, JMPSec"
+author = "Javier Marcos, JMP Sec"
 description = "Documentation for osctrl: Fast and efficient osquery management"
 themeVariant = "osctrl"
 editURL = "https://github.com/jmpsec/osctrl-docs/edit/master/content/"

content/components/osctrl-api/_index.md

@@ -15,6 +15,4 @@ pre = ""
 
 The osctrl-api component of **osctrl** provides an API interface to interact with its enrolled nodes and with **osctrl** itself.
 
-The API is documented with Swagger:
-
-[https://app.swaggerhub.com/apis-docs/jmpsec/osctrl-api/](https://app.swaggerhub.com/apis-docs/jmpsec/osctrl-api/)
+You can find the updated [API documentation](/openapi/doc.html) for **osctrl**, generated using [stoplight.io](https://docs.stoplight.io/).

content/deployment/docker/_index.md

@@ -4,6 +4,6 @@ date = 2019-08-09T19:23:53+02:00
 weight = 2
 +++
 
-You can use docker to run **osctrl**. Each component has a separate `Dockerfile` to run independently. There is also a [docker-compose.yml](https://github.com/jmpsec/osctrl/blob/master/docker/docker-compose.yml) that ties all the components together to serve a functional deployment.
+You can use docker to run **osctrl** and all the components are defined in the `docker-compose-dev.yml` that ties all the components together, to serve a functional deployment.
 
-In the [Makefile](https://github.com/jmpsec/osctrl/blob/master/Makefile) there are docker specific commands to deploy **osctrl**, which are utilizing the [dockerize.sh](/usage/dockerize.sh/) command
+Ultimately you can just execute `make docker_dev` and it will automagically build and run **osctrl** locally in docker, for development purposes.

content/deployment/natively/_index.md

@@ -4,10 +4,14 @@ date = 2019-08-09T19:24:35+02:00
 weight = 3
 +++
 
-If you want to deploy **osctrl** in your own environment, you can use the [provision.sh](https://github.com/jmpsec/osctrl/blob/master/deploy/provision.sh) to install all necessary dependencies and to configure all components.
+If you want to deploy **osctrl** in your own environment, you can use the [provision.sh](https://github.com/jmpsec/osctrl/blob/master/deploy/provision.sh) script to install all necessary dependencies and to configure all components.
 
-It is a good idea to take a look at the [usage](/usage/provision.sh/) of the provisioning script to understand all the options and all the parameters. Check out also how the same script is used with [vagrant](/deployment/vagrant/) to deploy **osctrl** in a local virtual machine, with all components installed and configured.
+It is a good idea to take a look at the [usage](/usage/provision.sh/) of the provisioning script to understand all the options and all the parameters.
 
 ### Examples
 
-The most common use case for provisioning **osctrl** is very similar to how it gets provisioned for [vagrant](/deployment/vagrant/), which means in dev mode and using self-signed certificates.
+A very common use case for provisioning **osctrl** , would run in dev mode and using self-signed certificates. This is would be the preferred choice for development purposes:
+
+```properties
+./deploy/provision.sh -m dev -s /path/to/code --nginx --postgres --redis -p all --all-hostname "dev.osctrl.net" -E
+```

content/deployment/vagrant/_index.md

@@ -18,7 +18,7 @@ USAGE:
    osctrl-admin [global options] command [command options] [arguments...]
 
 VERSION:
-   0.3.4
+   0.3.7
 
 DESCRIPTION:
    Admin service for osctrl, a fast and efficient osquery management
@@ -65,9 +65,10 @@ GLOBAL OPTIONS:
    --jwt-file FILE                  Load JWT configuration from FILE (default: "config/jwt.json") [$JWT_CONFIG_FILE]
    --jwt-secret value               Password to be used for the backend [$JWT_SECRET]
    --jwt-expire value               Maximum amount of hours for the tokens to expire (default: 3) [$JWT_EXPIRE]
-   --osquery-version value          Set osquery version as default to be used (default: "5.10.2") [$OSQUERY_VERSION]
-   --osquery-tables FILE            Load osquery tables schema from FILE (default: "data/5.10.2.json") [$OSQUERY_TABLES]
+   --osquery-version value          Set osquery version as default to be used (default: "5.12.1") [$OSQUERY_VERSION]
+   --osquery-tables FILE            Load osquery tables schema from FILE (default: "data/5.12.1.json") [$OSQUERY_TABLES]
    --logger-file value, -F value    Logger configuration to handle status/results logs from nodes (default: "config/logger.json") [$LOGGER_FILE]
+   --logger-db-same                 Use the same DB configuration for the logger (default: false) [$LOGGER_DB_SAME]
    --static value, -s value         Directory with all the static files needed for the osctrl-admin UI (default: "./static") [$STATIC_FILES]
    --static-offline, -S             Use offline static files (js and css). Default is online files. (default: false) [$STATIC_ONLINE]
    --templates value                Directory with all the templates needed for the osctrl-admin UI (default: "./tmpl_admin") [$STATIC_FILES]

content/usage/dockerize.sh/_index.md

@@ -18,7 +18,7 @@ USAGE:
    osctrl-api [global options] command [command options] [arguments...]
 
 VERSION:
-   0.3.4
+   0.3.7
 
 DESCRIPTION:
    API service for osctrl, a fast and efficient osquery management

content/usage/osctrl-admin/_index.md

@@ -18,7 +18,7 @@ USAGE:
    osctrl-cli [global options] command [command options] [arguments...]
 
 VERSION:
-   0.3.4
+   0.3.7
 
 DESCRIPTION:
    CLI for osctrl, a fast and efficient osquery management

content/usage/osctrl-api/_index.md

@@ -18,7 +18,7 @@ USAGE:
    osctrl-tls [global options] command [command options] [arguments...]
 
 VERSION:
-   0.3.4
+   0.3.7
 
 DESCRIPTION:
    TLS service for osctrl, a fast and efficient osquery management
@@ -60,6 +60,7 @@ GLOBAL OPTIONS:
    --cert FILE, -T FILE             TLS termination certificate from FILE (default: "config/tls.crt") [$TLS_CERTIFICATE]
    --key FILE, -K FILE              TLS termination private key from FILE (default: "config/tls.key") [$TLS_KEY]
    --logger-file value, -F value    Logger configuration to handle status/results logs from nodes (default: "config/logger.json") [$LOGGER_FILE]
+   --logger-db-same                 Use the same DB configuration for the logger (default: false) [$LOGGER_DB_SAME]
    --always-log, -a, --always       Always log status and on-demand query logs from nodes in database (default: false) [$ALWAYS_LOG]
    --carver-type value              Carver to be used to receive files extracted from nodes (default: "db") [$CARVER_TYPE]
    --carver-file value              Carver configuration file to receive files extracted from nodes (default: "config/carver.json") [$CARVER_FILE]