Skip to content

jmpsec/osctrl-docs

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

osctrl

osctrl

Fast and efficient osquery management.

Software License Travis Go Report Card

osctrl-docs

Documentation for osctrl: https://osctrl.net

Generating docs

The documentation is generated using hugo and you will have to install it.

Once it is ready, you can use the Makefile to render your changes into the HTML documentation issuing the command make docs.

Serve docs

To see how the documentation will look like before submitting your changes, you can serve it locally. Using the Makefile issue the command make serve and the documentation will be generated and served locally.

Donate

If you like osctrl you can send BTC or ETH donations to the following wallets:

bitcoin:bc1qvjep6r6j7a00xyhcgp4g2ea2f4pupaprcvllj5 ethereum:0x99e211251fca06286596498823Fd0a48785B64eB
bitcoin:bc1qvjep6r6j7a00xyhcgp4g2ea2f4pupaprcvllj5 ethereum:0x99e211251fca06286596498823Fd0a48785B64eB