Update About and ReadMe (#18)

* Update Project Settings

* Update About

* Update LICENSE

* Update README

Author: jo-tools

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 SQLabs
+Copyright (c) 2024 SQLabs and jo-tools
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,17 +1,64 @@
 # cubeSQL Web Admin
-A web based administration for [cubeSQL Server](https://sqlabs.com/cubesql) (© sqlabs)
+A web based administration for [cubeSQL Server](https://sqlabs.com/cubesql) (© [sqlabs](https://sqlabs.com/))
 
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
 
 ## Description
 
-*[cubeSQL](https://sqlabs.com/cubesql) is a fully featured and high performance relational database management system built on top of the sqlite database engine.*
+*[cubeSQL Server](https://sqlabs.com/cubesql) is a fully featured and high performance relational database management system built on top of the sqlite database engine.*
 
-cubeSQL Web Admin is a web based administration tool for cubeSQL.
+cubeSQL Web Admin is a web based administration tool for [cubeSQL Server](https://sqlabs.com/cubesql).
+
+![ScreenShot: Login](screenshots/login.png?raw=true)
+
+![ScreenShot: Databases](screenshots/databases.png?raw=true)
 
 ## Build from Source Code
 
 In order to build cubeSQL Web Admin application, [Xojo](https://xojo.com/) and the latest [cubeSQL Xojo Plugin](https://github.com/cubesql/cubeSQLAdmin) are required.
 
 - Xojo can be obtained from: https://xojo.com/
 - Latest [cubeSQL Xojo Plugin](https://github.com/cubesql/cubeSQLAdmin) can be found inside the Plugins folder
+
+## Ready to use executables and Docker Images
+
+1. Executables are provided with the [Releases](https://github.com/cubesql/webadmin/releases).
+   - A Shell Script is provided to choose a Port and launch the Web Application
+   - It is up to you to install the Web Application as a service.  
+     See [Xojo Documentation: Deployment Overview](https://documentation.xojo.com/topics/application_deployment/web/deployment_overview.html)
+
+2. Docker Images provided by jo-tools can be found here:  
+   [Docker Hub: jotools/cubesql-webadmin](https://hub.docker.com/r/jotools/cubesql-webadmin)
+
+3. Docker Compose setups provided by jo-tools can be found here:  
+   [GitHub: jo-tools/docker](https://github.com/jo-tools/docker)
+   - These setups contain both cubeSQL Server and cubeSQL Web Admin
+
+## Configuration
+
+cubeSQL Web Admin supports the following launch arguments and corresponding environment variables:
+
+#### Web Application
+- `--Port` | `CUBESQL_WEBADMIN_PORT`
+
+#### Prefill Login data:
+
+- `--CubeSQLHostname` | `CUBESQL_HOSTNAME`
+- `--CubeSQLPort` | `CUBESQL_PORT`
+- `--CubeSQLEncryption` | `CUBESQL_ENCRYPTION` with values: `NONE`, `AES128`, `AES128`, `SSL`  
+  For Encryption type `SSL`:
+  - `--CubeSQLSSLCertificate` | `CUBESQL_SSL_CERTIFICATE`  
+    with value: `/path/to/file`
+  - `--CubeSQLSSLCertificatePassword` | `CUBESQL_SSL_CERTIFICATEPASSWORD`  
+    with value: `/path/to/file.txt` | plain text
+  - `--CubeSQLSSLRootCertificate` | `CUBESQL_SSL_ROOTCERTIFICATE`  
+    with value: `/path/to/file`
+  - `--CubeSQLSSLCipherList` | `CUBESQL_SSL_CIPHERLIST`  
+    with value: `/path/to/file.txt` | plain text
+- `--CubeSQLUsername` | `CUBESQL_USERNAME`  
+  Only if Username is prefilled:
+  - `--CubeSQLPassword` | `CUBESQL_PASSWORD`
+
+
+## About
+cubeSQL Web Admin has been written by Jürg Otter, who is a long term user of Xojo and working for [CM Informatik AG](https://cmiag.ch/). Their Application [CMI LehrerOffice](https://cmi-bildung.ch/) is a Xojo Design Award Winner 2018. In his leisure time Jürg provides some [bits and pieces for Xojo Developers](https://www.jo-tools.ch/).

cubesql-webadmin.xojo_project

@@ -66,17 +66,16 @@ Folder=information;webapp/containers/information;&h000000005EFC7FFF;&h0000000058
 WebContainer=cntCommands;webapp/containers/information/cntCommands.xojo_code;&h000000002752C7FF;&h000000005EFC7FFF;false
 WebContainer=cntClients;webapp/containers/information/cntClients.xojo_code;&h000000002140EFFF;&h000000005EFC7FFF;false
 WebContainer=cntLog;webapp/containers/information/cntLog.xojo_code;&h000000002B1057FF;&h000000005EFC7FFF;false
-MultiImage=PayPal;resources/PayPal.xojo_image;&h0000000027497FFF;&h0000000035B107FF;false
 DefaultWindow=LoginPage
 MajorVersion=0
 MinorVersion=0
 SubVersion=12
 NonRelease=0
 Release=0
 InfoVersion=cubeSQL Web Admin
-LongVersion=jo-tools.ch
+LongVersion=SQLabs
 ShortVersion=0.0.12
-WinCompanyName=jo-tools.ch
+WinCompanyName=sqlabs.com
 WinInternalName=cubesqlwebadmin
 WinProductName=cubeSQL Web Admin
 WinFileDescription=cubeSQL Web Admin
@@ -93,8 +92,8 @@ MDI=0
 MDICaption=
 DefaultEncoding=&h0
 AppIcon=cubesql-webadmin.xojo_resources;&h0
-OSXBundleID=ch.jo-tools.cubesqlwebadmin
-DebuggerCommandLine=--CubeSQLHostname=localhost --CubeSQLPort=4440 --CubeSQLUsername=admin --CubeSQLPassword=admin
+OSXBundleID=com.sqlabs.cubesqlwebadmin
+DebuggerCommandLine=--CubeSQLHostname=localhost --CubeSQLPort=4430 --CubeSQLUsername=admin --CubeSQLPassword=admin
 UseGDIPlus=False
 UseBuildsFolder=True
 HiDPI=True

resources/PayPal.xojo_image

@@ -4,7 +4,7 @@ Begin dlgBase dlgAbout
    ControlCount    =   0
    ControlID       =   ""
    Enabled         =   True
-   Height          =   655
+   Height          =   600
    Index           =   -2147483648
    Indicator       =   0
    LayoutDirection =   0
@@ -30,7 +30,7 @@ Begin dlgBase dlgAbout
       ControlID       =   ""
       Enabled         =   True
       HasBackgroundColor=   False
-      Height          =   549
+      Height          =   494
       Index           =   -2147483648
       Indicator       =   0
       LayoutDirection =   0
@@ -511,7 +511,7 @@ Begin dlgBase dlgAbout
          Width           =   140
          _mPanelIndex    =   -1
       End
-      Begin WebLink labWrittenBy
+      Begin WebLink labWrittenByWebsite
          Appearance      =   0
          Bold            =   False
          ControlID       =   ""
@@ -534,57 +534,22 @@ Begin dlgBase dlgAbout
          PanelIndex      =   "0"
          Parent          =   "rctFormContent"
          Scope           =   2
-         TabIndex        =   13
+         TabIndex        =   14
          TabPanelIndex   =   0
          TabStop         =   True
          Target          =   1
          Text            =   "jo-tools.ch"
          TextAlignment   =   0
          TextColor       =   &c000000FF
          Tooltip         =   ""
-         Top             =   406
-         Underline       =   False
-         URL             =   "#constUrl_JOTools"
-         Visible         =   True
-         Width           =   266
-         _mPanelIndex    =   -1
-      End
-      Begin WebLabel labContactInfo
-         Bold            =   False
-         ControlID       =   ""
-         Enabled         =   True
-         FontName        =   ""
-         FontSize        =   12.0
-         Height          =   58
-         Index           =   -2147483648
-         Indicator       =   0
-         Italic          =   False
-         Left            =   214
-         LockBottom      =   False
-         LockedInPosition=   True
-         LockHorizontal  =   False
-         LockLeft        =   True
-         LockRight       =   True
-         LockTop         =   True
-         LockVertical    =   False
-         Multiline       =   True
-         PanelIndex      =   "0"
-         Parent          =   "rctFormContent"
-         Scope           =   2
-         TabIndex        =   14
-         TabPanelIndex   =   0
-         TabStop         =   True
-         Text            =   "If you want to say thanks I'd appreciate a message or a donation via PayPal."
-         TextAlignment   =   0
-         TextColor       =   colTextKey
-         Tooltip         =   ""
          Top             =   452
          Underline       =   False
+         URL             =   "#constUrl_JOTools"
          Visible         =   True
-         Width           =   266
+         Width           =   120
          _mPanelIndex    =   -1
       End
-      Begin WebLink labContact
+      Begin WebLink labWrittenByGitHub
          Appearance      =   0
          Bold            =   False
          ControlID       =   ""
@@ -595,12 +560,12 @@ Begin dlgBase dlgAbout
          Index           =   -2147483648
          Indicator       =   0
          Italic          =   False
-         Left            =   214
+         Left            =   342
          LockBottom      =   False
          LockedInPosition=   True
          LockHorizontal  =   False
          LockLeft        =   True
-         LockRight       =   False
+         LockRight       =   True
          LockTop         =   True
          LockVertical    =   False
          Multiline       =   False
@@ -610,19 +575,19 @@ Begin dlgBase dlgAbout
          TabIndex        =   15
          TabPanelIndex   =   0
          TabStop         =   True
-         Target          =   2
-         Text            =   "Contact"
+         Target          =   1
+         Text            =   "GitHub: jo-tools"
          TextAlignment   =   0
          TextColor       =   &c000000FF
          Tooltip         =   ""
-         Top             =   518
+         Top             =   452
          Underline       =   False
-         URL             =   "#constUrl_MailTo_Contact"
+         URL             =   "#constUrl_JOToolsGitHub"
          Visible         =   True
-         Width           =   100
+         Width           =   140
          _mPanelIndex    =   -1
       End
-      Begin WebLabel labDonation
+      Begin WebLabel labWrittenByAuthor
          Bold            =   False
          ControlID       =   ""
          Enabled         =   True
@@ -632,29 +597,29 @@ Begin dlgBase dlgAbout
          Index           =   -2147483648
          Indicator       =   0
          Italic          =   False
-         Left            =   360
+         Left            =   214
          LockBottom      =   False
          LockedInPosition=   True
          LockHorizontal  =   False
-         LockLeft        =   False
+         LockLeft        =   True
          LockRight       =   True
          LockTop         =   True
          LockVertical    =   False
          Multiline       =   False
-         PanelIndex      =   "0"
+         PanelIndex      =   0
          Parent          =   "rctFormContent"
          Scope           =   2
-         TabIndex        =   16
+         TabIndex        =   13
          TabPanelIndex   =   0
          TabStop         =   True
-         Text            =   "Donation"
-         TextAlignment   =   3
+         Text            =   "Jürg Otter"
+         TextAlignment   =   0
          TextColor       =   &c000000FF
          Tooltip         =   ""
-         Top             =   518
+         Top             =   406
          Underline       =   False
          Visible         =   True
-         Width           =   120
+         Width           =   266
          _mPanelIndex    =   -1
       End
    End
@@ -680,7 +645,7 @@ Begin dlgBase dlgAbout
       TabIndex        =   1
       TabStop         =   True
       Tooltip         =   ""
-      Top             =   597
+      Top             =   542
       Visible         =   True
       Width           =   100
       _mPanelIndex    =   -1
@@ -689,11 +654,6 @@ End
 #tag EndWebPage
 
 #tag WindowCode
-	#tag Property, Flags = &h21
-		Private wpPayPal As WebPicture
-	#tag EndProperty
-
-
 #tag EndWindowCode
 
 #tag Events labVersion
@@ -758,21 +718,6 @@ End
 		End Sub
 	#tag EndEvent
 #tag EndEvents
-#tag Events labDonation
-	#tag Event
-		Sub Opening()
-		  Self.wpPayPal = New WebPicture(PayPal, "public.png")
-		  
-		  Var divBgColor As String = ""
-		  If Session.IsDarkMode Then
-		    divBgColor = " background-color: #D0D0D0;"
-		  End If
-		  
-		  Me.Text = "<raw><div style=""padding: 10px 10px 10px 10px;" + divBgColor + """><a href=""https://paypal.me/jotools"" target=""_blank"" style=""cursor: pointer;""><img src=""" + Self.wpPayPal.URL + """ width=""100"" height=""26"" border=""0""></a></div></raw>"
-		  
-		End Sub
-	#tag EndEvent
-#tag EndEvents
 #tag Events btnOk
 	#tag Event
 		Sub Pressed()