Compare commits
1 Commits
master
...
e9969abf1c
| Author | SHA1 | Date | |
|---|---|---|---|
| e9969abf1c |
1
docs/.gitignore
vendored
Normal file
1
docs/.gitignore
vendored
Normal file
@@ -0,0 +1 @@
|
|||||||
|
book/*
|
||||||
7
docs/SUMMARY.md
Normal file
7
docs/SUMMARY.md
Normal file
@@ -0,0 +1,7 @@
|
|||||||
|
# Summary
|
||||||
|
|
||||||
|
- [Introduction](./gokill.md)
|
||||||
|
- [Triggers](triggers/triggers.md)
|
||||||
|
- [Timeout](triggers/timeout.md)
|
||||||
|
- [EthernetDisconnect](triggers/ethernetdisconnect.md)
|
||||||
|
- [Actions](actions/actions.md)
|
||||||
34
docs/actions/actions.md
Normal file
34
docs/actions/actions.md
Normal file
@@ -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:
|
||||||
|
|
||||||
10
docs/book.toml
Normal file
10
docs/book.toml
Normal file
@@ -0,0 +1,10 @@
|
|||||||
|
[book]
|
||||||
|
authors = []
|
||||||
|
language = "en"
|
||||||
|
multilingual = false
|
||||||
|
src = "."
|
||||||
|
title = "gokill docs"
|
||||||
|
|
||||||
|
[output.html.fold]
|
||||||
|
enable = true
|
||||||
|
level = 0
|
||||||
71
docs/chapter_1.md
Normal file
71
docs/chapter_1.md
Normal file
@@ -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:
|
||||||
|
|
||||||
1
docs/gokill.md
Normal file
1
docs/gokill.md
Normal file
@@ -0,0 +1 @@
|
|||||||
|
# Introduction
|
||||||
12
docs/triggers/ethernetdisconnect.md
Normal file
12
docs/triggers/ethernetdisconnect.md
Normal file
@@ -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: ""
|
||||||
|
|
||||||
9
docs/triggers/timeout.md
Normal file
9
docs/triggers/timeout.md
Normal file
@@ -0,0 +1,9 @@
|
|||||||
|
# Timeout
|
||||||
|
|
||||||
|
Description: Triggers after given duration.
|
||||||
|
Values:
|
||||||
|
- **duration**
|
||||||
|
- Type: int
|
||||||
|
- Descr: duration in seconds
|
||||||
|
- Default: 0
|
||||||
|
|
||||||
16
docs/triggers/triggers.md
Normal file
16
docs/triggers/triggers.md
Normal file
@@ -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: ""
|
||||||
|
|
||||||
|
|
||||||
Reference in New Issue
Block a user