medlogic
/
olivetin
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

doc: Better short config.yaml in README

This commit is contained in:
James Read 2021-11-20 01:07:54 +00:00 committed by GitHub
parent 8d3a2ad223
commit 7d0b73c169
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@ -75,19 +75,30 @@ logLevel: "INFO"
actions: actions:
# Docs: https://docs.olivetin.app/action-container-control.html # Docs: https://docs.olivetin.app/action-container-control.html
- title: Restart Plex - title: Restart Plex
icon: smile icon: restart
shell: docker restart plex shell: docker restart plex
# This will send 1 ping # This will send 1 ping
# Docs: https://docs.olivetin.app/action-ping.html # Docs: https://docs.olivetin.app/action-ping.html
- title: Ping Google.com - title: Ping host
shell: ping google.com -c 1 shell: ping {{ host }} -c {{ count }}
icon: ping
arguments:
- name: host
title: host
type: ascii_identifier
default: example.com
# Restart lightdm on host "overseer" - name: count
title: Count
type: int
default: 1
# Restart http on host "webserver1"
# Docs: https://docs.olivetin.app/action-ssh.html # Docs: https://docs.olivetin.app/action-ssh.html
- title: restart lightdm - title: restart httpd
icon: poop icon: restart
shell: ssh root@overseer 'service lightdm restart' shell: ssh root@webserver1 'service httpd restart'
``` ```
A full example config can be found at in this repository - [config.yaml](https://github.com/OliveTin/OliveTin/blob/main/config.yaml). A full example config can be found at in this repository - [config.yaml](https://github.com/OliveTin/OliveTin/blob/main/config.yaml).