diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..5948edc --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +book/* diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 0000000..1290623 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,7 @@ +# Summary + +- [Introduction](./gokill.md) + - [Triggers](triggers/triggers.md) + - [Timeout](triggers/timeout.md) + - [EthernetDisconnect](triggers/ethernetdisconnect.md) + - [Actions](actions/actions.md) diff --git a/docs/actions/actions.md b/docs/actions/actions.md new file mode 100644 index 0000000..2ac68ee --- /dev/null +++ b/docs/actions/actions.md @@ -0,0 +1,34 @@ +# Available Actions: + +# Print +Description: When triggered prints the configured message to stdout +Values: +- **message** + - Type: string + - Descr: Message that should be printed + - Default: "" + +### Timeout +Description: When triggered waits given duration before continuing with next stage +Values: +- **duration** + - Type: int + - Descr: duration in seconds + - Default: 0 + +# Command +Description: When triggered executes given command +Values: +- **command** + - Type: string + - Descr: command to execute + - Default: +- **args** + - Type: string[] + - Descr: args + - Default: + +### Shutdown +Description: When triggered shuts down the machine +Values: + diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..46d2314 --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,10 @@ +[book] +authors = [] +language = "en" +multilingual = false +src = "." +title = "gokill docs" + +[output.html.fold] +enable = true +level = 0 diff --git a/docs/chapter_1.md b/docs/chapter_1.md new file mode 100644 index 0000000..bcace54 --- /dev/null +++ b/docs/chapter_1.md @@ -0,0 +1,71 @@ +# Available Triggers: + + +### Timeout +Description: Triggers after given duration. +Values: +- **duration** + - Type: int + - Descr: duration in seconds + - Default: 0 + +# EthernetDisconnect +Description: Triggers if Ethernetcable is disconnected. +Values: +- **waitTillConnected** + - Type: bool + - Descr: Only trigger when device was connected before + - Default: true +- **interfaceName** + - Type: string + - Descr: Name of ethernet adapter + - Default: "" + +### UsbDisconnect +Description: Triggers when given usb drive is disconnected +Values: +- **waitTillConnected** + - Type: bool + - Descr: Only trigger when device was connected before + - Default: true +- **deviceId** + - Type: string + - Descr: Name of device under /dev/disk/by-id/ + - Default: "" + + +# Available Actions: + + +# Print +Description: When triggered prints the configured message to stdout +Values: +- **message** + - Type: string + - Descr: Message that should be printed + - Default: "" + +### Timeout +Description: When triggered waits given duration before continuing with next stage +Values: +- **duration** + - Type: int + - Descr: duration in seconds + - Default: 0 + +# Command +Description: When triggered executes given command +Values: +- **command** + - Type: string + - Descr: command to execute + - Default: +- **args** + - Type: string[] + - Descr: args + - Default: + +### Shutdown +Description: When triggered shuts down the machine +Values: + diff --git a/docs/gokill.md b/docs/gokill.md new file mode 100644 index 0000000..e10b99d --- /dev/null +++ b/docs/gokill.md @@ -0,0 +1 @@ +# Introduction diff --git a/docs/triggers/ethernetdisconnect.md b/docs/triggers/ethernetdisconnect.md new file mode 100644 index 0000000..c8cfca1 --- /dev/null +++ b/docs/triggers/ethernetdisconnect.md @@ -0,0 +1,12 @@ +# EthernetDisconnect +Description: Triggers if Ethernetcable is disconnected. +Values: +- **waitTillConnected** + - Type: bool + - Descr: Only trigger when device was connected before + - Default: true +- **interfaceName** + - Type: string + - Descr: Name of ethernet adapter + - Default: "" + diff --git a/docs/triggers/timeout.md b/docs/triggers/timeout.md new file mode 100644 index 0000000..219e0f6 --- /dev/null +++ b/docs/triggers/timeout.md @@ -0,0 +1,9 @@ +# Timeout + +Description: Triggers after given duration. +Values: +- **duration** + - Type: int + - Descr: duration in seconds + - Default: 0 + diff --git a/docs/triggers/triggers.md b/docs/triggers/triggers.md new file mode 100644 index 0000000..32b357e --- /dev/null +++ b/docs/triggers/triggers.md @@ -0,0 +1,16 @@ +# Available Triggers: + + +### UsbDisconnect +Description: Triggers when given usb drive is disconnected +Values: +- **waitTillConnected** + - Type: bool + - Descr: Only trigger when device was connected before + - Default: true +- **deviceId** + - Type: string + - Descr: Name of device under /dev/disk/by-id/ + - Default: "" + +