feature: entities wip (#226)

config.yaml

@@ -8,26 +8,40 @@ listenAddressSingleHTTPFrontend: 0.0.0.0:1337
 # Choose from INFO (default), WARN and DEBUG
 logLevel: "INFO"
 
+entities:
+  - name: container
+    file: /etc/OliveTin/entities/containers.yaml
+    icon: container
+
+helpers:
+  - title: refresh container file
+    shell: "docker ps --format '{{ .state }}' > /etc/OliveTin/entities/containers.yaml"
+    execOnStartup: true
+    execOnCron:
+      - "*/1 * * * * *"
+
 # Actions (buttons) to show up on the WebUI:
 actions:
-- title: date
+  - title: date
     shell: date
     icon: clock
     popupOnStart: true
 
+  - title: start
+    shell: docker start {{ container.name }}
+    icon: start
+    entity: container
+
     # This will run a simple script that you create.
-- title: Run backup script
+  - title: Run backup script
     shell: /opt/backupScript.sh
     shellAfterCompleted: "apprise -t 'Notification: Backup script completed' -b 'The backup script completed with code {{ exitCode}}. The log is: \n {{ stdout }} '"
     maxConcurrent: 1
     icon: backup
-  execOnCron: # https://docs.olivetin.app/exec-cron.html
-    - "@monthly"     # Once per month
-    - "0 12 25 12 *" # And on Christmas day!
 
     # This will send 1 ping (-c 1)
     # Docs: https://docs.olivetin.app/action-ping.html
-- title: Ping host
+  - title: Ping host
     shell: ping {{ host }} -c {{ count }}
     icon: ping
     timeout: 100
@@ -46,7 +60,7 @@ actions:
 
     # Restart lightdm on host "server1"
     # Docs: https://docs.olivetin.app/action-ping.html
-- title: restart httpd
+  - title: restart httpd
     titleAlias: restart_httpd
     icon: restart
     shell: ssh root@server1 'service httpd restart'
@@ -57,7 +71,7 @@ actions:
     # you are running OliveTin, or in the container.
     #
     # You probably want a much longer timeout as well (so that ansible completes).
-- title: "Run Ansible Playbook"
+  - title: "Run Ansible Playbook"
     icon: "&#x1F1E6"
     shell: ansible-playbook -i /etc/hosts /root/myRepo/myPlaybook.yaml
     timeout: 120
@@ -68,7 +82,7 @@ actions:
     # see the docs below.
     #
     # Docs: https://docs.olivetin.app/action-container-control.html
-- title: Restart Docker Container
+  - title: Restart Docker Container
     icon: restart
     shell: docker restart {{ container }}
     arguments:
@@ -79,17 +93,17 @@ actions:
           - value: traefik
           - value: grafana
 
-- title: Slow Script
+  - title: Slow Script
     shell: sleep 3
     timeout: 5
     icon: "&#x1F971"
 
-- title: Broken Script (timeout)
+  - title: Broken Script (timeout)
     shell: sleep 5
     timeout: 5
     icon: "&#x1F62A"
 
-- title: Delete old backups
+  - title: Delete old backups
     icon: ashtonished
     shell: rm -rf /opt/oldBackups/
     arguments:

internal/config/config.go

@@ -12,6 +12,7 @@ type Action struct {
 	CSS                    map[string]string `mapstructure:"omitempty"`
 	Timeout                int
 	Acls                   []string
+	Entity                 []string
 	ExecOnStartup          bool
 	ExecOnCron             []string
 	ExecOnFileCreatedInDir []string
@@ -37,12 +38,22 @@ type ActionArgumentChoice struct {
 	Title string
 }
 
+// HelperAction is an action that is used normally to generate entities, it cannot be started manually.
+type HelperAction struct {
+	Title                  string
+	Shell                  string
+	ExecOnStartup          bool
+	ExecOnCron             []string
+	ExecOnFileCreatedInDir []string
+	ExecOnFileChangedInDir []string
+}
+
 // Entity represents a "thing" that can have multiple actions associated with it.
 // for example, a media player with a start and stop action.
-type Entity struct {
+type EntityFile struct {
-	Title   string
+	File    string
+	Name    string
 	Icon    string
-	Actions []Action `mapstructure:"actions"`
 	CSS     map[string]string
 }
 
@@ -72,8 +83,8 @@ type Config struct {
 	ExternalRestAddress             string
 	LogLevel                        string
 	Actions                         []Action        `mapstructure:"actions"`
+	Entities                        []EntityFile    `mapstructure:"entities"`
 	Dashboards                      []DashboardItem `mapstructure:"dashboards"`
-	Entities                        []Entity        `mapstructure:"entities"`
 	CheckForUpdates                 bool
 	PageTitle                       string
 	ShowFooter                      bool
@@ -89,6 +100,7 @@ type Config struct {
 	DefaultPermissions              PermissionsList
 	AccessControlLists              []AccessControlList
 	WebUIDir                        string
+	HelperActions                   []HelperAction `mapstructure:"helperActions"`
 	CronSupportForSeconds           bool
 	SectionNavigationStyle          string
 }

var/entities/containers.yaml

@@ -0,0 +1,6 @@
+sonarr:
+  state: started
+plex:
+  state: started
+sabnzbd:
+  state: stopped