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

Issue #12 - Pointers from actions to documentation

This commit is contained in:
jamesread 2021-07-11 11:55:15 +01:00
parent d3f219a9ff
commit 6a47938aa9
2 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@ -51,21 +51,26 @@ All documentation can be found at http://docs.olivetin.app . This includes insta
## Example `config.yaml` ## Example `config.yaml`
Lots of documentation for how to write your `config.yaml` can be found at [the documentation site.](https://docs.olivetin.app)
Put this `config.yaml` in `/etc/OliveTin/` if you're running a standard service, or mount it at `/config` if running in a container. Put this `config.yaml` in `/etc/OliveTin/` if you're running a standard service, or mount it at `/config` if running in a container.
```yaml ```yaml
listenAddressWebUI: 0.0.0.0:1337 # Listen on all addresses available, port 1337 listenAddressWebUI: 0.0.0.0:1337 # Listen on all addresses available, port 1337
logLevel: "INFO" logLevel: "INFO"
actions: actions:
# Docs: https://docs.olivetin.app/action-container-control.html
- title: Restart Plex - title: Restart Plex
icon: smile icon: smile
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
- title: Ping Google.com - title: Ping Google.com
shell: ping google.com -c 1 shell: ping google.com -c 1
# Restart lightdm on host "overseer" # Restart lightdm on host "overseer"
# Docs: https://docs.olivetin.app/action-ssh.html
- title: restart lightdm - title: restart lightdm
icon: poop icon: poop
shell: ssh root@overseer 'service lightdm restart' shell: ssh root@overseer 'service lightdm restart'

12
var/config.yaml
View File

@ -9,11 +9,13 @@ logLevel: "INFO"
# Actions (buttons) to show up on the WebUI: # Actions (buttons) to show up on the WebUI:
actions: actions:
# This will send 1 ping (-c 1) # This will send 1 ping (-c 1)
# Docs: https://docs.olivetin.app/action-ping.html
- title: Ping Google.com - title: Ping Google.com
shell: ping google.com -c 1 shell: ping google.com -c 1
icon: ping icon: ping
# Restart lightdm on host "overseer" # Restart lightdm on host "overseer"
# Docs: https://docs.olivetin.app/action-ping.html
- title: restart lightdm - title: restart lightdm
icon: poop icon: poop
shell: ssh root@overseer 'service lightdm restart' shell: ssh root@overseer 'service lightdm restart'
@ -39,14 +41,10 @@ actions:
# OliveTin can control containers - docker is just a command line app. # OliveTin can control containers - docker is just a command line app.
# #
# However, if you are running in a container you will need to do some setup; # However, if you are running in a container you will need to do some setup,
# # see the docs below.
# 1) When creating the container, bind mount the docker sock like this;
# docker create -v /var/run/docker.sock:/container/path/docker.sock ...additional args here...
#
# 2) Install the docker client like this (if using the Fedora base image)
# - docker exec -it olivetin dnf install -y docker
# #
# Docs: https://docs.olivetin.app/action-container-control.html
- title: Restart Plex - title: Restart Plex
icon: smile icon: smile
shell: docker restart plex shell: docker restart plex