From 6a47938aa9907740db37c79a43907b3a6481a402 Mon Sep 17 00:00:00 2001
From: jamesread <contact@jwread.com>
Date: Sun, 11 Jul 2021 11:55:15 +0100
Subject: [PATCH] Issue #12 - Pointers from actions to documentation

---
 README.md       |  7 ++++++-
 var/config.yaml | 12 +++++-------
 2 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 642438d..567a21e 100644
--- a/README.md
+++ b/README.md
@@ -49,7 +49,9 @@ Mobile screen size (responsive layout);
 
 All documentation can be found at http://docs.olivetin.app . This includes installation and usage guide, etc. 
 
-## 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.
 
@@ -57,15 +59,18 @@ Put this `config.yaml` in `/etc/OliveTin/` if you're running a standard service,
 listenAddressWebUI: 0.0.0.0:1337 # Listen on all addresses available, port 1337
 logLevel: "INFO"
 actions: 
+  # Docs: https://docs.olivetin.app/action-container-control.html 
 - title: Restart Plex
   icon: smile
   shell: docker restart plex
   
   # This will send 1 ping 
+  # Docs: https://docs.olivetin.app/action-ping.html
 - title: Ping Google.com
   shell: ping google.com -c 1
   
   # Restart lightdm on host "overseer"
+  # Docs: https://docs.olivetin.app/action-ssh.html
 - title: restart lightdm
   icon: poop
   shell: ssh root@overseer 'service lightdm restart'
diff --git a/var/config.yaml b/var/config.yaml
index 9e6c4dd..e6490f8 100644
--- a/var/config.yaml
+++ b/var/config.yaml
@@ -9,11 +9,13 @@ logLevel: "INFO"
 # Actions (buttons) to show up on the WebUI:
 actions:   
   # This will send 1 ping (-c 1)
+  # Docs: https://docs.olivetin.app/action-ping.html
 - title: Ping Google.com
   shell: ping google.com -c 1
   icon: ping
   
   # Restart lightdm on host "overseer"
+  # Docs: https://docs.olivetin.app/action-ping.html
 - title: restart lightdm
   icon: poop
   shell: ssh root@overseer 'service lightdm restart'
@@ -39,14 +41,10 @@ actions:
 
   # 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;
-  #
-  # 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 
+  # However, if you are running in a container you will need to do some setup,
+  # see the docs below.
   #
+  # Docs: https://docs.olivetin.app/action-container-control.html
 - title: Restart Plex
   icon: smile
   shell: docker restart plex