Merge branch 'dev' into main

Author: zhex900

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Jake He
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.MD

@@ -0,0 +1,86 @@
+# Mir Kiosk Chromium 
+
+Mir Kiosk Chromium enables to run web based kiosks on Ubuntu Core. This is forked from Gerry Boland's [chromium-mir-kiosk](https://code.launchpad.net/~gerboland/+git/chromium-snap) 
+
+## Build
+
+`git clone https://github.com/zhex900/mir-kiosk-chromium`
+
+`cd mir-kiosk-chromium`
+
+`docker run --rm -v $PWD:/project -w /project zhex900/snapcraft:core18 snapcraft`
+
+## Install 
+
+This is tested on Ubuntu Core 18 and 20
+
+First install `mir-kiosk`
+
+`sudo snap install mir-kiosk`
+
+Install this snap package
+
+`sudo snap install ./mir-kiosk-chromium_87.0.4280.66_amd64.snap --dangerous --devmode`
+
+## Configuration
+
+To customize the startup url for chromium use:
+
+`sudo snap set chromium-mir-kiosk url="https://yoururl.com"`
+
+Set browser refresh interval. Default is 1hr (60 mins) 
+
+`sudo snap set chromium-mir-kiosk resettime=60`
+
+Show nav bar
+
+`sudo snap set chromium-mir-kiosk shownav=true`
+
+Hide cursor (true/false)
+
+`sudo snap set chromium-mir-kiosk hidecursor=true`
+
+Disable kiosk mode (true/false)
+
+`sudo snap set chromium-mir-kiosk disablekiosk=true`
+
+## Screen orientation
+
+`sudo vim /var/snap/mir-kiosk/current/miral-kiosk.display`. 
+Append this to the end of the file.
+```
+  kiosk:
+    cards:
+    - card-id: 0
+      DisplayPort-1:
+        orientation: right # left or normal
+```
+Apply the new kiosk layout
+
+`sudo snap set mir-kiosk display-layout=kiosk`
+
+## Remove chrome profile lock on boot
+
+When the kiosk is ungracefully shutdown, like lost of power. Chromium will display
+a white page asking to unlock existing profile. To remove this on reboot. Existing
+Chrome profile needs to be removed.
+
+`sudo vim /etc/systemd/system/snap.mir-kiosk-chromium.mir-kiosk-chromium.service`
+
+Add this before `ExecStart`. This will remove the profile lock when chromium crashes or ungracefully reboots.
+
+```yaml
+ExecStartPre=/usr/bin/rm -rf /root/snap/mir-kiosk-chromium/current/.config/chromium/SingletonLock
+ExecStartPre=/usr/bin/rm -rf /root/snap/mir-kiosk-chromium/current/.config/chromium/SingletonCookie
+ExecStartPre=/usr/bin/rm -rf /root/snap/mir-kiosk-chromium/current/.config/chromium/SingletonSocket
+```
+
+Change `Restart` to `always`. `Restart=always`
+
+`sudo systemctl daemon-reload`
+
+`sudo snap restart mir-kiosk-chromium`
+
+##Reference:
+1. https://discourse.ubuntu.com/t/configuring-mir-kiosk-a-masterclass/8150
+1. https://discourse.ubuntu.com/t/install-mir-kiosk-and-chromium-mir-kiosk-under-ubuntu-18-04-server/13108/4

TODO

@@ -6,9 +6,10 @@ description: |
 adopt-info: ppa-build
 confinement: strict
 grade: stable
+base: core18
 
 apps:
-  chromium-mir-kiosk:
+  mir-kiosk-chromium:
     command: desktop-launch xwayland-kiosk-launch chromium-browser.launcher
     daemon: simple
     desktop: usr/share/applications/chromium.desktop
@@ -132,4 +133,4 @@ parts:
     organize:
       chromium-browser.launcher: bin/
       i3.config: etc/
-base: core18
+