diff --git a/.github/workflows/docker_guide_installer_release.yml b/.github/workflows/docker_guide_installer_release.yml
index e37a196..e95dee4 100644
--- a/.github/workflows/docker_guide_installer_release.yml
+++ b/.github/workflows/docker_guide_installer_release.yml
@@ -54,6 +54,6 @@ jobs:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url }}
- asset_path: ./src/proj_docker_guide_installer.ps1
- asset_name: proj_docker_guide-${{ env.VERSION }}-installer.ps1
+ asset_path: ./src/sagemath_docker_guide_installer.ps1
+ asset_name: sagemath_docker_guide-${{ env.VERSION }}-installer.ps1
asset_content_type: application/octet-stream
diff --git a/sagemath_docker_guide.md b/sagemath_docker_guide.md
index 418c098..edc2b4f 100644
--- a/sagemath_docker_guide.md
+++ b/sagemath_docker_guide.md
@@ -10,7 +10,7 @@ On the other hand, there are cases where Docker can also be interesting for user
A few years ago, [SageMath](https://www.sagemath.org/) offered binaries for Windows built with Cygwin (see for example [this page](https://opendreamkit.org/2017/10/11/SageWindows/)). Currently, the only way to work with SageMath on Windows is using the [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/) (`WSL`), which also requires some affinity for development.
-*Projects Docker Guide* is designed to fill this gap. It helps a user install Docker Desktop and then walks him through using the Docker images offered by your project. The current implementation assumes that this project is SageMath, but project-specific settings are separated from the general code so they can be easily adapted to other cases.
+*Projects Docker Guide* is designed to fill this gap. It helps a user install [Docker for Powershell](https://github.com/soehms/docker_for_powershell) and then walks him through using the Docker images offered by your project. The current implementation assumes that this project is SageMath, but project-specific settings are separated from the general code so they can be easily adapted to other cases.
Please note that this is a pre-release version. Use at your own risk.
@@ -18,8 +18,9 @@ Please note that this is a pre-release version. Use at your own risk.
1. [Installation](#1.)
2. [Usage](#2.)
- 1. [Install Docker Desktop](#2.1)
- 2. [Start Docker engine](#2.2)
+ 1. [Install Docker for Powershell](#2.1)
+ 1. [Install the Windows Subsystem for Linux](#2.1.1)
+ 2. [Start Docker daemon](#2.2)
3. [Downloading SageMath](#2.3)
4. [Creating a session](#2.4)
5. [Connecting to a session](#2.5)
@@ -30,8 +31,9 @@ Please note that this is a pre-release version. Use at your own risk.
7. [Delete software versions](#2.7)
8. [Using optional SageMath packages](#2.8)
3. [Uninstallation](#3.)
- 1. [Continue using Docker Desktop](#3.1)
- 2. [Remove Docker Desktop](#3.2)
+ 1. [Continue using Docker for Powershell](#3.1)
+ 2. [Remove Docker for Powershell](#3.2)
+ 1. [Remove the Windows Subsystem for Linux](#3.2.1)
4. [Usage on Linux](#4.)
5. [Help](#5.)
@@ -41,73 +43,70 @@ Download [sagemath_docker_guide-installer](https://github.com/soehms/projects_do
-After that, you should see a SageMath icon (labeled *SageMath Docker Guide*) on your desktop.
+If you're asked if you want to agree to open the file, just do so! If that doesn't work, open a Powershell terminal (i.e. press the Windows key, type "powershell" in the search box, and launch the suggested app). Run the following code there:
-
-
-Simply click on the icon to launch the application.
+```
+Set-ExecutionPolicy Bypass -Scope Process -Force
+.\Downloads\sagemath_docker_guide-0.2-installer.ps1
+```
-## 2. Usage
+This assumes that you have downloaded the installer to your default `Downloads` folder. You will also need to replace the version number with the current one. If you get the following screen, answer "Yes":
-After you have clicked on the SageMath Docker Guide icon the following will happen:
+
-### 2.1 Install Docker Desktop
+If the installation was successful, you should see a SageMath icon (labeled *SageMath Docker Guide*) on your desktop. Simply click on the icon to launch the application.
-If you already have Docker Desktop on your computer, you can [skip this section](#2.2).
+
-If you don't have Docker Desktop installed yet, you'll see the following screen:
+## 2. Usage
-
+After you have clicked on the SageMath Docker Guide icon the following will happen:
-After you accept to start the installation, the following hint will appear:
+### 2.1 Install Docker for Powershell
-
+If you already have [Docker for Powershell](https://github.com/soehms/docker_for_powershell#docker-for-powershell) on your computer, you can [skip this section](#2.2). Alternatively (for advanced users), if you have a [WSL](https://learn.microsoft.com/en-us/windows/wsl/)-distribution (say Ubuntu or something similar) with a working [Docker](https://docs.docker.com/engine/install/ubuntu/) or if you have [Docker Desktop](https://www.docker.com/products/docker-desktop/) you may [skip this section](#2.2), too.
-The installer itself will also ask you for your consent:
+If you don't have any Docker installed yet, you'll see the following screen:
-
+
-The installation of Docker Desktop will take some time. At the end you will be asked to restart your computer:
+After you accept to start the installation, the following hint will appear:
-
+
-After your computer boots back up, Docker Desktop will ask you to accept a *Subscription Service Agreement*:
+#### 2.1.1 Install the Windows Subsystem for Linux
-
+*Docker for Powershell* needs the *Windows Subsystem for Linux* (`WSL`). If this is present on your system you may [skip this section](#2.2). If not the installer tries to set this up.
-
+
-The next agreement you will be asked for will appear on this screen:
+During the process you must grant the following permissions:
-
+ 
-Docker Desktop will then ask you some questions that you can skip:
+After the installation of `WSL` is finished you have to reboot your computer:
-
+
-Finally, it will try to start the *Docker Engine*, which is the only thing needed for the *Projects Docker Guide*. If it fails, you will see a screen like this:
+If your computer is up again, click on the *SageMath Docker Guide* icon once more to continue the installation of Docker for Powershell. In rare cases you will see a screen like this:
-
+
This most likely happens if your CPU virtualization technology is not enabled in your BIOS setup. In this case, try to find help on [this site](https://support.microsoft.com/en-us/windows/enable-virtualization-on-windows-c5578302-6e43-4b4b-a449-8ced115f58e1).
-If this does not solve the problem, you should follow the instructions in the [Docker documentation](https://docs.docker.com/desktop/install/windows-install/).
[Go back to the Table of Contents](#TOF)
-### 2.2 Start Docker engine
+### 2.2 Start Docker daemon
-If your computer starts Docker Desktop automatically when it boots, you can [skip this section](#2.3).
+If Docker starts automatically when you boot your computer, you can [skip this section](#2.3). If the Docker daemon is not already running, you will see the following screen:
-If the Docker engine is not already running, you will see the following screen:
+
-
-
-Just wait until the Docker Desktop app opens and shows that the engine is running (green icon in the bottom left corner of the window), then click *Retry* (in the screenshot *Wiederholen* in german). As soon as a window titled *SageMath Docker Guide ...* opens you may close the Docker Desktop app:
-
-
+Click *Retry* until the popup message disappears.
[Go back to the Table of Contents](#TOF)
+
### 2.3 Downloading SageMath
If you already have downloaded SageMath from Docker hub, you can [skip this section](#2.4).
@@ -120,11 +119,11 @@ The first line takes you to the stable software versions of SageMath, the second
-Again select the line of your choice and press OK. The download progress will be displayed in a separate window. The following screenshot is from the download of version 10.5.beta3 of the SageMath development version:
+Again select the line of your choice and press OK. The download progress will be displayed in a separate window.
-
+
-Depending on the quality of your internet connection, this may take some time. If you interrupt it, it will resume from where you interrupted it when you restart the SageMath Docker Guide:
+Depending on the quality of your internet connection, this may take some time. If you interrupt it, it will resume from where you interrupted it when you restart the SageMath Docker Guide as in this eaxmple:
@@ -167,7 +166,7 @@ The last part of the name is just a sequential number.
When you see the *List of sessions ...* window, you are ready to start working with SageMath. Simply select the session you want to connect and press OK.
-### 2.5.1 IPython terminal
+#### 2.5.1 IPython terminal
If the session name is prefixed with "S-", a new terminal will open at the Sage prompt. Follow the [SageMath documentation](https://doc.sagemath.org/) to use SageMath.
@@ -184,7 +183,7 @@ In SageMath you can use `ls` to view the files in your folder. In the case of th
[Go back to the Table of Contents](#TOF)
-### 2.5.2 Jupyter notebook
+#### 2.5.2 Jupyter notebook
If the session name is prefixed with `N-`, a new tab titled *Home* will open in your default browser, displaying the list of files in your folder. If this is the first time connecting to the session, this may take a few seconds.
@@ -214,7 +213,7 @@ For more information on using Jupyter notebooks, see their [documentation](https
[Go back to the Table of Contents](#TOF)
-### 2.5.3 Bash terminal
+#### 2.5.3 Bash terminal
Sessions prefixed with `B-` require some experience with Linux operating systems. This session type is automatically set for repositories other than `sagemath/sagemath`:
@@ -286,21 +285,38 @@ Note that you cannot install all kinds of optional packages in `S-` and `N-` ses
## 3. Uninstallation
-The *SageMath Docker Guide* itself hardly takes up any space on your hard drive. The *Docker Desktop* app takes up much more space. However, this is not the majority of the space that may be used. Most of it is due to the use of the software, namely downloading the SageMath software as described in section 2.3.
+The *SageMath Docker Guide* itself hardly takes up any space on your hard drive. The underlying *Docker for Powershell* takes up some more space (about 0.3 GB plus 1.7 GB for `WSL`). However, this is not the majority of the space that may be used. Most of it is due to the use of the software, namely downloading the SageMath software as described in section 2.3.
-The most important thing to free up occupied space is therefore to remove these software versions from your computer. The size they take up on your device is indicated in the *List of software that have been downloaded*. To delete them, follow section 2.7. After that, do the following:
+The most important thing to free up occupied space is therefore to remove these software versions from your computer. The size they take up on your device is indicated in the *List of software that have been downloaded*. To delete them, follow [section 2.7](#2.7). After that, do the following:
-### 3.1 Continue using Docker Desktop
+### 3.1 Continue using Docker for Powershell
-If you no longer want to use *SageMath Docker Guide* but want to keep *Docker Desktop*, delete all downloaded SageMath software as described above. You can also delete the SageMath Docker Guide desktop icon if you want. That's all you need to do to free up used space.
+If you no longer want to use *SageMath Docker Guide* but want to keep *Docker for Powershell*, delete all downloaded SageMath software as described above. You can also delete the SageMath Docker Guide desktop icon if you want. That's all you need to do to free up used space.
-### 3.2 Remove Docker Desktop
+### 3.2 Remove Docker for Powershell
-If you don't like to use *Docker Desktop* any more, in addition to the steps above, go to the Windows software uninstall page and search for *Docker Desktop*:
+If you don't like to use *Docker for Powershell* any more, open a Powershell terminal as described in [section 1](#1.). To see the explicit name of the `WSL` distribution including the version number type
-
+```
+wsl -l -q
+```
+
+You can remove it by:
+
+```
+wsl --unregister DockerForPowershell-0.2
+```
+
+Replace the version number `0.2` by the one displayed in your terminal above.
+
+#### 3.2.1 Remove `WSL`
+
+If *Docker for Powershell* was the only `WSL` distribution you had on your system you may want to remove `WSL`, too. To do this open a Powershell terminal as before and type:
+
+```
+wsl --uninstall
+```
-To get there hit the Windows key, type `uninstall` into the search field and launch the suggested app. To start the uninstallation, click on the three point and select `uninstall` and follow the instructions of the uninstaller.
[Go back to the Table of Contents](#TOF)
@@ -312,7 +328,7 @@ Next, start Powershell (for example, by typing `pwsh` in a bash terminal) and ca
You also need to install Docker. If you don't have it, follow the instructions on the appropriate [Docker installation page](https://docs.docker.com/desktop/install/linux/).
-Instead of following the installation instructions for Windows as described in [Section 1.](#1.), simply download the file [sagemath_docker_guide.ps1](https://raw.githubusercontent.com/sagemath/sage-windows/refs/heads/main/src/sagemath_docker_guide.ps1) to the folder where you want to work with SageMath. After starting Powershell there, you can start the guide by executing `.\sagemath_docker_guide.ps1`.
+Instead of following the installation instructions for Windows as described in [section 1](#1.), simply download the files [sagemath_docker_guide.ps1](https://raw.githubusercontent.com/soehms/projects_docker_guide/refs/heads/main/src/sagemath_docker_guide.ps1) and [proj_docker_guide.psm1](https://raw.githubusercontent.com/soehms/projects_docker_guide/refs/heads/main/src/proj_docker_guide.psm1) to the folder where you want to work with SageMath. After starting Powershell there, you can start the guide by executing `.\sagemath_docker_guide.ps1`.
The main difference from using it on Windows is the appearance of the selection windows. On Linux they look like the following example:
@@ -322,4 +338,4 @@ Here you have to select a line with the space key and then press Enter.
## 5. Help
-It would be great if this code made it easier for many Windows users to use SageMath. But of course there is still a lot of work to do to achieve this goal. In particular, this cannot be done by one person alone. Therefore, any help is very welcome. This can be suggestions or bug reports. Please use the [issues](https://github.com/sagemath/sage-windows/issues) of this repository. But [pull requests](https://github.com/sagemath/sage-windows/pulls) that fix bugs, improve wording or implementation, or add more features, or even provide better screenshots (in english) are also welcome.
+It would be great if this code made it easier for many Windows users to use SageMath. But of course there is still a lot of work to do to achieve this goal. In particular, this cannot be done by one person alone. Therefore, any help is very welcome. This can be suggestions or bug reports. Please use the [issues](https://github.com/soehms/projects_docker_guide/issues) of this repository. But [pull requests](https://github.com/soehms/projects_docker_guide/pulls) that fix bugs, improve wording or implementation, or add more features, or even provide better screenshots (in english) are also welcome.
diff --git a/screenshots/sagemath_docker_guide/Agreement.png b/screenshots/sagemath_docker_guide/Agreement.png
deleted file mode 100644
index 92e6282..0000000
Binary files a/screenshots/sagemath_docker_guide/Agreement.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/BIOSnotEnabled.png b/screenshots/sagemath_docker_guide/BIOSnotEnabled.png
new file mode 100644
index 0000000..a7bd16d
Binary files /dev/null and b/screenshots/sagemath_docker_guide/BIOSnotEnabled.png differ
diff --git a/screenshots/sagemath_docker_guide/DaemonNotRunningAfterInstall.png b/screenshots/sagemath_docker_guide/DaemonNotRunningAfterInstall.png
new file mode 100644
index 0000000..01738d5
Binary files /dev/null and b/screenshots/sagemath_docker_guide/DaemonNotRunningAfterInstall.png differ
diff --git a/screenshots/sagemath_docker_guide/DockerForPowershellInstallStart.png b/screenshots/sagemath_docker_guide/DockerForPowershellInstallStart.png
new file mode 100644
index 0000000..682877d
Binary files /dev/null and b/screenshots/sagemath_docker_guide/DockerForPowershellInstallStart.png differ
diff --git a/screenshots/sagemath_docker_guide/DockerForPowershellMissing.png b/screenshots/sagemath_docker_guide/DockerForPowershellMissing.png
new file mode 100644
index 0000000..36c865f
Binary files /dev/null and b/screenshots/sagemath_docker_guide/DockerForPowershellMissing.png differ
diff --git a/screenshots/sagemath_docker_guide/DownloadingSagemath10.4.png b/screenshots/sagemath_docker_guide/DownloadingSagemath10.4.png
new file mode 100644
index 0000000..88f03c7
Binary files /dev/null and b/screenshots/sagemath_docker_guide/DownloadingSagemath10.4.png differ
diff --git a/screenshots/sagemath_docker_guide/Finish.png b/screenshots/sagemath_docker_guide/Finish.png
deleted file mode 100644
index 8fb3ac1..0000000
Binary files a/screenshots/sagemath_docker_guide/Finish.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/IconInstalled.png b/screenshots/sagemath_docker_guide/IconInstalled.png
new file mode 100644
index 0000000..b1daa87
Binary files /dev/null and b/screenshots/sagemath_docker_guide/IconInstalled.png differ
diff --git a/screenshots/sagemath_docker_guide/IconSettings.png b/screenshots/sagemath_docker_guide/IconSettings.png
deleted file mode 100644
index efdd02b..0000000
Binary files a/screenshots/sagemath_docker_guide/IconSettings.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/InstallGuide.png b/screenshots/sagemath_docker_guide/InstallGuide.png
deleted file mode 100644
index b8135cf..0000000
Binary files a/screenshots/sagemath_docker_guide/InstallGuide.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/Installation1.png b/screenshots/sagemath_docker_guide/Installation1.png
deleted file mode 100644
index d3a03f6..0000000
Binary files a/screenshots/sagemath_docker_guide/Installation1.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/Installation2.png b/screenshots/sagemath_docker_guide/Installation2.png
deleted file mode 100644
index 939c3ea..0000000
Binary files a/screenshots/sagemath_docker_guide/Installation2.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/Installation3.png b/screenshots/sagemath_docker_guide/Installation3.png
deleted file mode 100644
index 7f4e5c2..0000000
Binary files a/screenshots/sagemath_docker_guide/Installation3.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/Installation4.png b/screenshots/sagemath_docker_guide/Installation4.png
deleted file mode 100644
index 3ea944d..0000000
Binary files a/screenshots/sagemath_docker_guide/Installation4.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/InstallationSuccess.png b/screenshots/sagemath_docker_guide/InstallationSuccess.png
deleted file mode 100644
index d413405..0000000
Binary files a/screenshots/sagemath_docker_guide/InstallationSuccess.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/ListOfDownloadVersions.png b/screenshots/sagemath_docker_guide/ListOfDownloadVersions.png
index 1937dfd..de6b2dd 100644
Binary files a/screenshots/sagemath_docker_guide/ListOfDownloadVersions.png and b/screenshots/sagemath_docker_guide/ListOfDownloadVersions.png differ
diff --git a/screenshots/sagemath_docker_guide/RepositoryList.png b/screenshots/sagemath_docker_guide/RepositoryList.png
index 278fbed..f64a9d5 100644
Binary files a/screenshots/sagemath_docker_guide/RepositoryList.png and b/screenshots/sagemath_docker_guide/RepositoryList.png differ
diff --git a/screenshots/sagemath_docker_guide/RunWithPowershell.png b/screenshots/sagemath_docker_guide/RunWithPowershell.png
new file mode 100644
index 0000000..3e7a722
Binary files /dev/null and b/screenshots/sagemath_docker_guide/RunWithPowershell.png differ
diff --git a/screenshots/sagemath_docker_guide/SetExecutionPolicy.png b/screenshots/sagemath_docker_guide/SetExecutionPolicy.png
new file mode 100644
index 0000000..7e5816b
Binary files /dev/null and b/screenshots/sagemath_docker_guide/SetExecutionPolicy.png differ
diff --git a/screenshots/sagemath_docker_guide/SignIn.png b/screenshots/sagemath_docker_guide/SignIn.png
deleted file mode 100644
index 00668a2..0000000
Binary files a/screenshots/sagemath_docker_guide/SignIn.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/UnexpectedWSLerror.png b/screenshots/sagemath_docker_guide/UnexpectedWSLerror.png
deleted file mode 100644
index a5c5805..0000000
Binary files a/screenshots/sagemath_docker_guide/UnexpectedWSLerror.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/UninstallDockerDesktop.png b/screenshots/sagemath_docker_guide/UninstallDockerDesktop.png
deleted file mode 100644
index aa781e5..0000000
Binary files a/screenshots/sagemath_docker_guide/UninstallDockerDesktop.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/WSL-InstallProgress.png b/screenshots/sagemath_docker_guide/WSL-InstallProgress.png
new file mode 100644
index 0000000..7615af2
Binary files /dev/null and b/screenshots/sagemath_docker_guide/WSL-InstallProgress.png differ
diff --git a/screenshots/sagemath_docker_guide/WSLinstallAgreement.png b/screenshots/sagemath_docker_guide/WSLinstallAgreement.png
new file mode 100644
index 0000000..943b64d
Binary files /dev/null and b/screenshots/sagemath_docker_guide/WSLinstallAgreement.png differ
diff --git a/screenshots/sagemath_docker_guide/WSLinstallAgreement2.png b/screenshots/sagemath_docker_guide/WSLinstallAgreement2.png
new file mode 100644
index 0000000..8220369
Binary files /dev/null and b/screenshots/sagemath_docker_guide/WSLinstallAgreement2.png differ
diff --git a/screenshots/sagemath_docker_guide/WSLreboot.png b/screenshots/sagemath_docker_guide/WSLreboot.png
new file mode 100644
index 0000000..2bb1c51
Binary files /dev/null and b/screenshots/sagemath_docker_guide/WSLreboot.png differ
diff --git a/screenshots/sagemath_docker_guide/WelcomeDocker.png b/screenshots/sagemath_docker_guide/WelcomeDocker.png
deleted file mode 100644
index 29a1efa..0000000
Binary files a/screenshots/sagemath_docker_guide/WelcomeDocker.png and /dev/null differ
diff --git a/screenshots/sagemath_docker_guide/WelcomeSurvey.png b/screenshots/sagemath_docker_guide/WelcomeSurvey.png
deleted file mode 100644
index 57fd9b9..0000000
Binary files a/screenshots/sagemath_docker_guide/WelcomeSurvey.png and /dev/null differ
diff --git a/screenshots/sagemath_wsl_guide/ImportSageMath10.4.png b/screenshots/sagemath_wsl_guide/ImportSageMath10.4.png
deleted file mode 100644
index 244ec74..0000000
Binary files a/screenshots/sagemath_wsl_guide/ImportSageMath10.4.png and /dev/null differ
diff --git a/screenshots/sagemath_wsl_guide/RunSage.png b/screenshots/sagemath_wsl_guide/RunSage.png
deleted file mode 100644
index a28ce23..0000000
Binary files a/screenshots/sagemath_wsl_guide/RunSage.png and /dev/null differ
diff --git a/src/sagemath_docker_guide.ps1 b/src/sagemath_docker_guide.ps1
index c7e4ebc..a5fcb5b 100644
--- a/src/sagemath_docker_guide.ps1
+++ b/src/sagemath_docker_guide.ps1
@@ -8,1107 +8,8 @@
# http://www.gnu.org/licenses/
##############################################################################
-# ToDo
-# 1. Implement the *More* functionality in the *tags* window
-# 2. Add possiblility to stop a container
-# 3. Add possiblility to rename a container
-# 4. Extract project specific data from devcontainer.json files
-# 5. Move $this._container to argument list of methods
-# 6. Open separate terminal for selection windows on Linux, too
-
-
-###############################################################################################
-# To show verbose messages set $VerbosePreference = 2 (Continue) in your Powershell session.
-# To revert this set $VerbosePreference = 0 (SilentlyContinue)
-###############################################################################################
-
-
-###############################################################################################
-# Static declarations
-###############################################################################################
-
-param(
- [string] $option = "no option"
-)
-
-enum TagFilterValues {
- all
- stable
- pre
-}
-
-
-###############################################################################################
-# Access to global PS variables in class methods needs the following functions
-###############################################################################################
-
-function os_is_linux {
- return $PSVersionTable.Platform -eq 'Unix'
-}
-
-function get_matches {
- # get result of previous regular expresssion match via -match option
- Write-Verbose "get_matches ${Matches}"
- return $Matches
-}
-
-function reset_matches {
- # reset result of previous regular expresssion match via -match option
- if ($Matches -eq $null) {return}
- Write-Verbose "reset_matches before ${Matches}"
- $Matches.Clear()
- Write-Verbose "reset_matches after ${Matches}"
-}
-
-
-###############################################################################################
-# Classes for configuration purpose
-###############################################################################################
-
-class DockerGuideMenue {
- [string] $text
- [int] $dialog
-
- DockerGuideMenue([string] $text, [int] $dialog) {
- $this.text = $text
- $this.dialog = $dialog
- }
-}
-
-class DockerGuideApp {
- [string] $Name
- [string] $Prefix
- [int] $port
- [string] $option
- [int] $rank
-
- DockerGuideApp([string] $name, [string] $prefix, [int] $port, [string] $option, [int] $rank) {
- $this.Name = $name
- $this.Prefix = $prefix
- $this.port = $port
- $this.option = $option
- $this.rank = $rank
- }
-}
-
-class DockerGuideRepo {
- [string] $user
- [string] $name
- [string] $description
- [TagFilterValues] $filter
- [System.Collections.ArrayList] $apps
-
- DockerGuideRepo([string] $user, [string] $name, [string] $description, [TagFilterValues] $filter, [System.Collections.ArrayList] $apps) {
- $this.user = $user
- $this.name = $name
- $this.description = $description
- $this.filter = $filter
- $this.apps = $apps
- }
-}
-
-###############################################################################################
-# Base class containing declarations of static constants and methods common to
-# ProjectsDockerGuide and DockerInstallAssistance
-###############################################################################################
-class DockerGuideBase {
- [string] $_proj_name
- [string] $_version
- [pscustomobject] $image_keys
- [pscustomobject] $container_keys
- [pscustomobject] $tag_keys
- [pscustomobject] $dialogs
- [pscustomobject] $return_values
- [pscustomobject] $select_mode
- [pscustomobject] $buttons
- [pscustomobject] $icons
- [pscustomobject] $button_pressed
-
- DockerGuideBase() {
- # dictionaries for keys used in https://registry.hub.docker.com/v2/repositories/
- $this.image_keys = [ordered]@{
- repo = 'Repository';
- tag = 'Tag';
- id = 'ID';
- created = 'CreatedAt';
- size = 'Size';
- }
- $this.container_keys = [ordered]@{
- name = 'Names';
- id = 'ID';
- image = 'Image';
- created = 'CreatedAt'
- status = 'Status';
- size = 'Size';
- }
- $this.tag_keys = [ordered]@{
- name = 'name';
- full_size = 'full_size';
- id = 'id';
- user = 'last_updater_username';
- updated = 'last_updated';
- last_pulled = 'tag_last_pulled';
- last_pushed = 'tag_last_pushed';
- }
- # dictionaries for dialog handling
- $this.dialogs = [ordered]@{
- repos = 1;
- tags = 2;
- images = 3;
- containers = 4;
- apps = 5;
- }
- $this.return_values = @{
- created = 1;
- pulled = 2;
- }
- $this.select_mode = @{
- single = 1;
- multiple = 2;
- }
- # dictionaries for popup-messages
- $this.buttons = @{
- ok = 0;
- ok_cancel = 1;
- abort_ignore_retry = 2;
- yes_no_cancel = 3;
- yes_no = 4;
- retry_cancel = 5;
- }
- $this.icons = @{
- critical = 16;
- question = 32;
- exclamtion = 48;
- information = 64;
- }
- $this.button_pressed = @{
- ok = 1;
- cancel = 2;
- abort = 3;
- retry = 4;
- ignore = 5;
- yes = 6;
- no = 7;
- timeout = -1;
- }
- }
-
- [pscustomobject] popup_message([string] $text, [int] $button, [int] $icon) {
- $wshell = New-Object -ComObject Wscript.Shell
- $answer = $wshell.Popup($text, 0, $this._proj_name + ' Docker Guide', $button + $icon)
- Write-Verbose "Popup ${answer} ${text}"
- return $answer
- }
-}
-
-###############################################################################################
-###############################################################################################
-# Main Class
-###############################################################################################
-###############################################################################################
-
-class ProjectsDockerGuide : DockerGuideBase {
- [DockerInstallAssistent] $_install_assist
- [boolean] $_linux
- [boolean] $_ready
- [string] $_path
- [string] $_path_prefix
- [pscustomobject] $_container
- [pscustomobject] $_tag_lists
- [pscustomobject] $_menues
- [System.Collections.Hashtable] $_port_maps
- [System.Collections.ArrayList] $_proj_repositories
- [System.Collections.ArrayList] $_images
- [System.Collections.ArrayList] $_containers
-
- ProjectsDockerGuide([string] $project_name, [System.Collections.ArrayList] $project_repositories) {
- # Instatiating the class
- $this._proj_name = $project_name
- $this._version = '0.1'
- $this._install_assist = [DockerInstallAssistent]::new($project_name)
- $this._linux = $false
- $this._port_maps = @{}
- $this._path = "$PWD"
- if (os_is_linux) {
- $this._linux = $true
- $this._path_prefix = $this._path
- if ($this._path_prefix.StartsWith('/')) {
- $this._path_prefix = $this._path_prefix.Substring(1)
- }
- $this._path_prefix = $this._path_prefix.Replace('/', '-')
- }
- else {
- $this._path_prefix = $this._path.Replace(':\', '_').Replace('\', '-')
- }
- Write-Verbose "_path_prefix: $($this._path_prefix)"
- $this._proj_name = $project_name
- $menues = @{
- backr = [DockerGuideMenue]::new("Back", $this.dialogs.repos);
- backt = [DockerGuideMenue]::new("Back", $this.dialogs.tags);
- more = [DockerGuideMenue]::new("More", $this.dialogs.tags);
- download = [DockerGuideMenue]::new("Download other software version", $this.dialogs.images);
- del_image = [DockerGuideMenue]::new("Delete a software version", $this.dialogs.images);
- create = [DockerGuideMenue]::new("Create new session", $this.dialogs.containers);
- del_container = [DockerGuideMenue]::new("Delete a session", $this.dialogs.containers);
- bash = [DockerGuideMenue]::new("Work in a bash terminal (advanced)", $this.dialogs.apps);
- lab = [DockerGuideMenue]::new("Work in a Jupyter lab", $this.dialogs.apps);
- notebook = [DockerGuideMenue]::new("Work in a Jupyter notebook", $this.dialogs.apps);
- ipython = [DockerGuideMenue]::new("Work in a IPython terminal (default)", $this.dialogs.apps);
- }
- $this._menues = $menues
- $this._proj_repositories = $project_repositories
- $this.banner()
- $this._ready = $this.start_docker()
- }
-
- ####################################################################
- # Generic helper methods
- ####################################################################
-
- [void] banner() {
- $projname = $this._proj_name
- $version = $this._version
- @(
- ""
- "-----------------------------------------------------"
- "| Welcome to the ${projname} Docker Guide version ${version}! |"
- "-----------------------------------------------------"
- ""
- ) | Write-Host -BackgroundColor White -ForegroundColor DarkBlue
- }
-
- [pscustomobject] show_dialog([System.Collections.ArrayList] $view, [string] $description, [int] $mode) {
- Write-Verbose "show_dialog view $($view | Out-String)"
- Write-Host "Please have a look at the window: ${description}"
- $ans = $null
- try {
- $ans = $view | Out-GridView -Title $description -OutputMode $mode
- }
- catch [System.Management.Automation.CommandNotFoundException] {
- $ans = $view | Out-ConsoleGridView -Title $description -OutputMode $mode
- }
- Write-Verbose "show_dialog_view answer $($ans | Out-String)"
- return $ans
- }
-
- [boolean] check_proj_image([string] $img) {
- $proj_reps = @(foreach ($r in $this._proj_repositories) {
- "$($r.user)/$($r.name)"
- })
- if ($img -in $proj_reps) {
- return $true
- }
- return $false
- }
-
- [System.Collections.ArrayList] dialog_menue([int] $dialog) {
- return @(foreach ($m in $this._menues.values) {if ($m.dialog -eq $dialog) {$m.text}})
- }
-
- [DockerGuideRepo] image_to_repo([pscustomobject] $image) {
-
- $repo = $image.($this.image_keys.repo)
- $rep = $repo.Split("/")
- $user = $rep[0]
- $name = $rep[1]
- foreach ($r in $this._proj_repositories) {
- if ($r.user -eq $user -and $r.name -eq $name) {
- return $r
- }
- }
- return $null
- }
-
- [System.Collections.ArrayList] image_to_apps([pscustomobject] $image) {
- $repo = $this.image_to_repo($image)
- $apps = $repo.apps
- if ($apps.Count -eq 0) {
- $apps = @([DockerGuideApp]::new("Default", "", 0, "", "", 0))
- }
- return $apps
- }
-
- [pscustomobject] container_to_image([pscustomobject] $container) {
- $img = $container.($this.container_keys.image)
- $imgs = $this.find_images()
- foreach ($i in $imgs) {
- $repo = $i.($this.image_keys.repo)
- $tag = $i.($this.image_keys.tag)
- if ($img -eq "${repo}:${tag}") {
- return $i
- }
- }
- return $null
- }
-
- [DockerGuideApp] container_to_app([pscustomobject] $container) {
- $img = $this.container_to_image($container)
- $apps = $this.image_to_apps($img)
- if ($apps.Count -gt 1) {
- $name = $container.($this.container_keys.name)
- foreach ($app in $apps) {
- if ($name.StartsWith($app.Prefix)) {
- return $app
- }
- }
- }
- return $apps[0]
- }
-
- [pscustomobject] select_from_list([System.Collections.ArrayList] $items,
- [System.Collections.ArrayList] $cols,
- [System.Collections.ArrayList] $menue,
- [string] $title
- ) {
- # Return one image from the list according to user choice
- $proj_name = $this._proj_name
- Write-Verbose "Entering: select_from_list $title"
- $description = "${proj_name} Docker Guide: $title Please select the line of your choice!"
- $view = @(echo $items | select $cols)
- $mkeys = @()
- foreach ($m in $menue) {
- $mline = echo @($items[0]) | select $cols # copy of first line
- foreach ($key in $cols) {
- if ($cols.IndexOf($key) -eq 0) {
- $mline.$key = $m
- $mkeys += $key
- }
- else {
- $mline.$key = ""
- }
- }
- $view += $mline
- }
- Write-Verbose "mkeys $($mkeys | Out-String)"
- $ans = $this.show_dialog($view, $description, $this.select_mode.single)
- if (-not $ans) {
- return $null
- }
- else {
- foreach ($m in $menue) {
- $ind = $menue.IndexOf($m)
- $col = $mkeys[$ind]
- if ($ans.$col -eq $m) {
- return $m
- }
- }
- }
- return $ans
- }
-
- [System.Collections.ArrayList] search_tags([pscustomobject] $repo) {
- # search tags for the given repository on Docker Hub
- $uri = "https://registry.hub.docker.com/v2/repositories/$($repo.user)/$($repo.name)/tags/?page_size=250"
- Write-Verbose "Invoke-WebRequest ${uri}"
- $result = Invoke-WebRequest -UseBasicParsing -Uri $uri
- $JsonObject = ConvertFrom-Json -InputObject $result.Content
- $res = $JsonObject.results
- # filter the result
- $new_res = @()
- foreach ($t in $res) {
- if ($t.name.Contains('latest') -or $t.name.Contains('develop')) {
- continue
- }
- if ($repo.filter -eq [TagFilterValues]::pre) {
- if ($t.name.Contains('beta') -or $t.name.Contains('rc')) {
- $new_res += $t
- }
- }
- elseif ($repo.filter -eq [TagFilterValues]::stable) {
- if (-not ($t.name.Contains('beta') -or $t.name.Contains('rc'))) {
- $new_res += $t
- }
- }
- else {
- $new_res += $t
- }
- }
- return $new_res
- }
-
- [DockerGuideApp] select_app($apps) {
- # Return one tag from the repository
- $title = "List of different applications to work with $($this._proj_name)."
- $app_names = $apps[0].psobject.Properties.Name
- $cols = @($app_names[0], $app_names[1])
- $view = @(echo $apps | select $cols)
- $description = "$($this._proj_name) Docker Guide: $title Please select the line of your choice!"
- $ans = $this.show_dialog($view, $description, $this.select_mode.single)
- foreach ($app in $apps) {
- if ($app.Name -eq $ans.Name) {
- Write-Verbose "Selected app: $($app | Out-String)"
- return $app
- }
- }
- Write-Verbose "No Selection $($ans | Out-String)"
- return $null
- }
-
- [pscustomobject] select_repo() {
- # Return one tag from the repository
- $repos = $this._proj_repositories
- $cols = $repos[0].psobject.properties.name
- $menue = $this.dialog_menue($this.dialogs.repos)
- $title = "List of software that can be downloaded."
- return $this.select_from_list($repos, $cols, $menue, $title)
- }
-
- [pscustomobject] select_tag([pscustomobject] $repo) {
- # Return one tag from the repository
- $tags = $this.search_tags($repo)
- $cols = $($this.tag_keys.Values)
- $menue = $this.dialog_menue($this.dialogs.tags)
- $title = "List of software versions that can be downloaded."
- return $this.select_from_list($tags, $cols, $menue, $title)
- }
-
- ####################################################################
- # Methods to choose an image
- ####################################################################
-
- [System.Collections.ArrayList] find_images() {
- # Find all images
- return $this.find_images($false)
- }
-
- [System.Collections.ArrayList] find_images([bool] $refresh) {
- # Find all images
- if ($this._images -and -not $refresh) {
- return $this._images
- }
- $cmd = "docker images --format json"
- $lines = Invoke-Expression $cmd
- Write-Verbose "docker images: $($lines | Out-String)"
- $this._images = [System.Collections.ArrayList]@(foreach ($line in $lines) {
- $json = $line | ConvertFrom-Json
- $json
- })
- Write-Verbose "Images found: $($this._images | Out-String)"
- return $this._images
- }
-
- [System.Collections.ArrayList] find_proj_images() {
- # Filter the list of containers for the project
- $proj_images = [System.Collections.ArrayList]@()
- if (-not $this._images) {
- $this.find_images()
- }
- foreach ($i in $this._images) {
- $irep = $i.($this.image_keys.repo)
- if ($this.check_proj_image($irep)) {
- $proj_images.Add($i) | Out-Null
- }
- }
- return $proj_images
- }
-
- [pscustomobject] choose_image() {
- # Return the Image for which a new container should be started
- Write-Verbose "Entering choose image"
- do {
- $images = $this.find_proj_images()
- $i = $images.Count
- if ($i -eq 0) {
- $ans = $this.pull_images()
- if ($ans -eq $this.return_values.pulled) {
- continue
- }
- elseif ($this._menues.backr.text -eq $ans) {
- continue
- }
- else {
- return $ans
- }
- }
- $ans = $this.select_image($images)
-
- if ($this._menues.download.text -eq $ans) {
- $ans = $this.pull_images()
- if ($ans -eq $this.return_values.pulled) {
- continue
- }
- elseif ($this._menues.backr.text -eq $ans) {
- continue
- }
- else {
- return $ans
- }
- }
- elseif ($this._menues.del_image.text -eq $ans) {
- $this.delete_images($images)
- continue
- }
- else {
- return $ans
- }
- } while ($true)
-
- return $null
- }
-
- [pscustomobject] select_image([System.Collections.ArrayList] $images) {
- # Return one image from the list according to user choice
- $cols = $($this.image_keys.Values)
- $menue = $this.dialog_menue($this.dialogs.images)
- $title = "List of software versions that have been downloaded."
- return $this.select_from_list($images, $cols, $menue, $title)
- }
-
- [pscustomobject] pull_images() {
- # Return the Image for which a new container should be started
- Write-Verbose "Entering: pull images"
- do {
- $repo = $this.select_repo()
- if ($repo -eq $null) {
- return $null
- }
- if ($this._menues.backr.text -eq $repo) {
- Write-Verbose "Repo cmd $($repo | Out-String)"
- return $repo
- }
- $tag = $this.select_tag($repo)
- if ($tag -eq $null) {
- return $null
- }
- if ($this._menues.backt.text -eq $tag) {
- Write-Verbose "Tag cmd $($tag | Out-String)"
- continue
- }
- $this.pull_image($repo, $tag)
- $this._images = $null
- return $this.return_values.pulled
- } while ($true)
- return $null
- }
-
- [void] delete_images([System.Collections.ArrayList] $images) {
- # Return a list of images that should be deleted
- $proj_name = $this._proj_name
- $description = "${proj_name} Docker Guide: List of software that have been used formerly. Please select the lines you want to remove!"
- $cols = $($this.image_keys.Values)
- $view = @(echo $images | select $cols)
- $list = $this.show_dialog($view, $description, $this.select_mode.multiple)
- if (-not $list) {
- return
- }
- foreach ($i in $list) {
- Write-Verbose "Delete $($i | Out-String)"
- $this.delete_image($i)
- }
- return
- }
-
- ####################################################################
- # Methods to choose a container
- ####################################################################
-
- [System.Collections.ArrayList] find_containers() {
- # Find all containers
- return $this.find_containers($false)
- }
-
- [System.Collections.ArrayList] find_containers([bool] $refresh) {
- # Find all containers
- if ($this._containers -and -not $refresh) {
- return $this._containers
- }
- $cmd = "docker ps -a --format json"
- $lines = Invoke-Expression $cmd
- Write-Verbose "docker ps: $($lines | Out-String)"
- $this._containers = [System.Collections.ArrayList]@(foreach ($line in $lines) {
- $json = $line | ConvertFrom-Json
- $json
- })
- Write-Verbose "Containers found: $($this._containers | Out-String)"
- return $this._containers
- }
-
- [System.Collections.ArrayList] find_proj_containers() {
- # Filter the list of containers for the project
- return $this.find_proj_containers($false)
- }
-
- [System.Collections.ArrayList] find_proj_containers([bool] $matching) {
- # Filter the list of containers for the project
- $proj_containers = [System.Collections.ArrayList]@()
- if (-not $this._containers) {
- $this.find_containers()
- }
- foreach ($c in $this._containers) {
- $this.get_container_port($c)
- $cim = $c.($this.container_keys.image)
- $ci = $cim -split ":" # cut off the tag
- $img = $ci[0]
- if ($this.check_proj_image($img)) {
- $cn = $c.($this.container_keys.name)
- if ($matching -and -not $cn.Contains($this._path_prefix)) {
- Write-Verbose "Container ${cim} does not match $($this._path_prefix)"
- continue
- }
- $proj_containers.Add($c) | Out-Null
- }
- }
- return $proj_containers
- }
-
- [int] get_container_port([pscustomobject] $c) {
- $ports = $c.Ports
- if ($ports -eq "") {
- return 0
- }
- Write-Verbose "Ports ${ports}"
- if ($ports -match ":([0-9]*)-" -eq $true) {
- $m = get_matches
- Write-Verbose "match $($m | Out-String), $($m.Count)"
- $p = [int] $m[1]
- $cn = $c.($this.container_keys.name)
- Write-Verbose "port for ${cn}: $($p)"
- $this._port_maps[$cn] = $p
- return $p
- }
- return 0
- }
-
- [int] find_free_port([string] $start_port) {
- $s = [int] $start_port
- $p = $s
- foreach ($c in $this._containers) {
- $app = $this.container_to_app($c)
- if ($app.port -eq $s) {
- $p += 1
- }
- }
- Write-Verbose "Free port ${p} found for $($start_port)"
- return $p
- }
-
- [pscustomobject] choose_container() {
- # Return the Container that should be started
- Write-Verbose "Entering: choose container"
- $matching_containers = $this.find_proj_containers($true)
- $l = $matching_containers.Count
- if ($l -eq 0) {
- $containers = $this.find_proj_containers()
- $k = $containers.Count
- if (-not $k) {
- $img = $this.choose_image()
- if ($img -eq $null) {
- return $null
- }
- $this.create_container($img)
- return $this.return_values.created
- }
- else {
- Write-Host "No session belongs to the current directory $($this._path)!"
- return $this.select_container($containers)
- }
- }
- else {
- return $this.select_container($matching_containers)
- }
- }
-
- [pscustomobject] select_container([System.Collections.ArrayList] $containers) {
- # Return one container from the list according to user choice
- $cols = $($this.container_keys.Values)
- $menue = $this.dialog_menue($this.dialogs.containers)
- $title = "List of sessions that have been used or created formerly."
- return $this.select_from_list($containers, $cols, $menue, $title)
- }
-
- [void] delete_containers([System.Collections.ArrayList] $containers, [string] $purpose) {
- # Return a list of containers that should be deleted
- $proj_name = $this._proj_name
- $description = "${proj_name} Docker Guide: ${purpose}Please select the lines you want to remove!"
- $cols = $($this.container_keys.Values)
- $view = @(echo $containers | select $cols)
- $list = $this.show_dialog($view, $description, $this.select_mode.multiple)
- if (-not $list) {
- return
- }
- foreach ($c in $list) {
- Write-Verbose "Delete $($c | Out-String)"
- $this.delete_container($c)
- }
- return
- }
-
- ####################################################################
- # Methods that directly access Docker
- ####################################################################
- [boolean] start_docker() {
- try {
- Invoke-Expression "docker"
- }
- catch [System.Management.Automation.CommandNotFoundException] {
- # ToDo try to install Docker
- $text = 'Docker is not available on your system, but needed for this software! Shall we try to install it?'
- $answer = $this.popup_message($text, $this.buttons.yes_no, $this.icons.information)
- if ($answer -eq $this.button_pressed.yes) {
- $this._install_assist.run()
- # The following uncommented code can be used to run the installation in a separate terminal with admin permission
- # This will be needed if the installation has to be extended in more preliminary steps.
- # $argu = "Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope Process -Force; proj_docker_guide --install"
- # Start-Process -Verb runas powershell -ArgumentList $argu
- }
- return $false
- }
- $test_docker_running = Invoke-Expression "docker ps 2>&1"
- if ($test_docker_running.getType().Name -eq "ErrorRecord") {
- $cmd = 'C:\Program Files\Docker\Docker\resources\dockerd.exe' # must be started with 'Start-Process -Verb runAs' and than only listens to admin
- $cmd = 'C:\Program Files\Docker\Docker\Docker Desktop.exe'
- Write-Host "The Docker deamon is not running! Try to start Docker Desktop!"
- Start-Process $cmd
- }
- while ($test_docker_running.getType().Name -eq "ErrorRecord") {
- $text = 'Please wait until the Docker engine is running! As soon as this message does not appear any more, you may close the Docker Desktop app.'
- $answer = $this.popup_message($text, $this.buttons.retry_cancel, $this.icons.information)
- if ($answer -ne $this.button_pressed.retry) {
- return $false
- }
- Write-Verbose "Start Docker $($answer | Out-String)"
- $test_docker_running = Invoke-Expression "docker ps 2>&1"
- }
- return $true
- }
-
- [void] pull_image([pscustomobject] $repo, [pscustomobject] $tag) {
- # pull image
- $ruser = $repo.user
- $rname = $repo.name
- $tname = $tag.($this.tag_keys.name)
- $name = "${ruser}/${rname}:${tname}"
- Write-Host "Download of ${name} starts!"
- $argu = "/c docker pull $($name)"
- Write-Verbose "docker pull: ${argu}"
- Start-Process -FilePath cmd -ArgumentList $argu -Wait
- }
-
- [void] delete_image([pscustomobject] $i) {
- # delete an image
- $rep = $i.($this.image_keys.repo)
- $tag = $i.($this.image_keys.tag)
- $name = "${rep}:${tag}"
- Write-Host "Try to delete ${name}"
- $cont_to_delete = @()
- foreach ($c in $this._containers) {
- if ($c.($this.container_keys.image) -eq $name) {
- $cont_to_delete += $c
- }
- }
- Write-Verbose "cont_to_delete $($cont_to_delete | Out-String)"
- if ($cont_to_delete.Count -eq 0) {
- $cmd = "docker rmi ${name}"
- Write-Verbose "docker rmi: ${cmd}"
- Invoke-Expression $cmd
- Write-Host "The software ${name} has been deleted!"
- # remove it from the list
- $this._images = @($this._images | Where-Object {$i.($this.image_keys.id) -ne $_.($this.image_keys.id)})
- Write-Verbose "Images Count $($this._images.Count)"
- }
- else {
- Write-Host "There are containers for ${name} which must be deleted first!"
- $this.delete_containers($cont_to_delete, "List of sessions that must be deleted, to delete ${name}. ")
- }
- }
-
- [string] find_new_container_name([DockerGuideApp] $app) {
- # Rename Container to path
- Write-Verbose "Entering: find new container name"
- $base = $($app.Prefix) + $this._path_prefix
- $occupied = @()
- foreach ($c in $this._containers) {
- $cname = $c.($this.container_keys.name)
- if ($cname.Contains($base)) {
- $occupied += $cname
- }
- }
- Write-Verbose "occupied $($occupied | Out-String)"
- $i = 0
- do {
- if ($i -eq 0) {
- $name = ${base}
- }
- else {
- $name = "${base}_${i}"
- }
- $i += 1
- } while ($name -in $occupied)
- Write-Verbose "occupied $($occupied | Out-String)"
- Write-Verbose "new name ${name}"
- return $name
- }
-
- [void] create_container([pscustomobject] $image) {
- # create a new container
- $repo = $image.Repository
- $tag = $image.Tag
- Write-Host "Create a new container for ${repo}:${tag}"
- $port = ""
- $option = ""
- $apps = $this.image_to_apps($image)
- $app = $apps[0]
- if ($apps.Count -gt 1) {
- $app = $this.select_app($apps)
- if ($app -eq $null) {
- return
- }
- }
- $p = $this.find_free_port($app.port)
- if ($p -eq 0) {
- $port = ""
- }
- else {
- $port = " -p $($p):8888"
- }
- $option = " $($app.option)"
- $name = $this.find_new_container_name($app)
- $spwd = "$PWD"
- $tpwd = "/home/" + $name
- $cmd = "docker create -it --mount `"type=bind,src=$($spwd),target=$($tpwd)`" --name $($name) -w $($tpwd)$($port) $($repo):$($tag)$($option)"
- Write-Verbose "docker create: ${cmd}"
- $this._port_maps[$name] = $p
- Invoke-Expression $cmd
- $this._containers = $null # to refresh the list
- }
-
- [void] delete_container([pscustomobject] $c) {
- # delete a container
- $id = $c.($this.container_keys.id)
- $name = $c.($this.container_keys.name)
- Write-Host "Delete container ${name} (id ${id})"
- $cmd = "docker stop ${id}"
- Write-Verbose "docker stop: ${cmd}"
- Invoke-Expression $cmd
- $cmd = "docker rm ${id}"
- Write-Verbose "docker rm: ${cmd}"
- Invoke-Expression $cmd
- # remove it from the list
- $this._containers = @($this._containers | Where-Object {$id -ne $_.($this.container_keys.id)})
- Write-Verbose "Containers Count $($this._containers.Count)"
- }
-
- [void] attach_container() {
- # attach to an existing container
- $c = $this._container
- $id = $c.($this.container_keys.id)
- $name = $c.($this.container_keys.name)
- $app = $this.container_to_app($c)
- $ports = $this._port_maps
- $port_a = $app.port
- $port_m = $ports[$name]
- Write-Host "Attach container ${name} (id ${id})"
- $cmd = "docker start $($id)"
- Invoke-Expression $cmd
- if ($port_a -gt 0) {
- Write-Verbose "Use port $($port_m | Out-String) from mapping list $($ports | Out-String)"
- $cmd = "docker logs $($id)"
- reset_matches
- $url = ""
- $port = ""
- $tok = ""
- $match_str = "http\://127\.0\.0\.1\:([8-9][0-9]{3})\/.*\?token=([a-z,0-9]*)"
- Write-Verbose "match_str ${match_str}"
- do {
- $log_lines = Invoke-Expression $cmd
- if ($log_lines.Count -eq 0) {
- continue
- }
- [array]::Reverse($log_lines) # Revert the log-lines to not use older token
- $logs = $log_lines | Out-String
- Write-Verbose "Logs ${logs}"
- if ($logs -match $match_str) {
- $m = get_matches
- Write-Verbose "match $($m | Out-String), $($m.Count)"
- $url = $m[0]
- $port = $m[1]
- $tok = $m[2]
- }
- } while ($tok -eq "")
- $url = $url.Replace(":$($port_a)", ":$($port_m)")
- Write-Host "Please have a look at your browser at a tab with URL: ${url}"
- Start-Process $url
- }
- else {
- if ($this._linux) {
- $argu = "-x docker attach $($id)"
- }
- else {
- $argu = "/c docker attach $($id)"
- }
- Write-Verbose "docker attach: ${argu}"
- Start-Process -FilePath cmd -ArgumentList $argu -Wait
- }
- }
-
- ####################################################################
- # Entrypoint to app
- ####################################################################
- [void] run() {
- if (-not $this._ready) {
- $text = 'Docker is not available on your system, yet! Try again later on.'
- $this.popup_message($text, $this.buttons.ok, $this.icons.information)
- return
- }
- do {
- $this._container = $this.choose_container()
- Write-Verbose "Container Choice: $($this._container | Out-String)"
- if ($this._container -eq $this.return_values.created) {
- Write-Verbose "Just created a conrainer, now search it."
- continue
- }
- elseif ($this._menues.create.text -eq $this._container) {
- $image = $this.choose_image()
- if ($image -ne $null) {
- $this.create_container($image)
- }
- Write-Verbose "Just created a container here, now search it."
- continue
- }
- elseif ($this._menues.del_container.text -eq $this._container) {
- $this.delete_containers($this._containers, "List of sessions that have been used formerly. ")
- Write-Verbose "After deletion of containsers, now search again."
- continue
- }
- elseif ($this._container -eq $null) {
- Write-Verbose "No container chosen, now finish."
- Write-Host "Good bye!"
- return
- }
- elseif (-not $($this._container.($this.container_keys.name)).Contains($this._path_prefix)) {
- $c = $this._container
- Write-Verbose "$($c.Names) does not contain $($this._path_prefix)"
- $text = "The choosen session does not belong to the current folder $($this._path)! Start in anyway?"
- $answer = $this.popup_message($text, $this.buttons.yes_no, $this.icons.information)
- if ($answer -ne $this.button_pressed.yes) {
- continue
- }
- }
- $this.attach_container()
- } while ($true)
- }
-}
-
-
-###############################################################################################
-# Helper class to assist the Installation of Docker Desktop
-###############################################################################################
-class DockerInstallAssistent : DockerGuideBase {
-
- DockerInstallAssistent([string] $project_name) {
- $this._proj_name = $project_name
- }
-
- [void] banner() {
- @(
- " "
- " Docker Desktop will now be installed! "
- " "
- " After that your computer must be rebooted. "
- " "
- " Afterwards, Docker Desptop will ask you to accept a "
- " Subscription Service Agreement. Choose the "
- " recommented setting on finishing it. "
- " "
- " Docker Desktop will automatically restart and ask "
- " some questions, all of which you can skip. "
- " "
- " Finally, it will try to start what is called the Docker "
- " engine. That is the only thing we need. This means "
- " that you may close the Docker Desktop app once the "
- " engine is running. "
- " "
- " If the engine does not start successfully, then you "
- " should check if your CPU's virtualization mode is "
- " enabled in your BIOS-setup. "
- " "
- " For more problems with installing Docker Desktop, see "
- " here: "
- " "
- " https://docs.docker.com/desktop/install/windows-install/ "
- " "
- ) | Write-Host -BackgroundColor White -ForegroundColor Red
- }
-
- [void] reboot() {
- Write-Verbose "Restart Computer"
- $app_name = $this._proj_name + " Docker Guide"
- $text = "Your Computer must be restarted to complete the current installation step. After this is finished start ${app_name} again to continue."
- $answer = $this.popup_message($text, $this.buttons.ok_cancel, $this.icons.information)
- if ($answer -ne $this.button_pressed.ok) {
- return
- }
- Restart-Computer
- }
-
- [boolean] winget_available() {
- Write-Host "Check if the Microsoft App Installer can be used."
- $cmd = "winget list --disable-interactivity"
- Write-Verbose "Test winget ${cmd}"
- $test_winget = $null
- try {
- $test_winget = Invoke-Expression $cmd | Out-String
- }
- catch [System.Management.Automation.CommandNotFoundException] {
- Write-Verbose "Winget not installed"
- }
- if ($test_winget) {
- Write-Verbose "Winget test 1 ${test_winget}"
- if ($test_winget.Length -lt 10) {
- Write-Verbose "Winget corrupt"
- $test_winget = $null
- }
- else {
- $cmd = "winget upgrade Paint --disable-interactivity"
- $test_winget = Invoke-Expression $cmd | Out-String
- Write-Verbose "Winget test 2 ${test_winget}"
- if ($test_winget.Contains('0x8a15000f')) {
- Write-Verbose "Winget corrupt"
- $test_winget = $null
- }
- }
- }
- return ($test_winget -ne $null)
- }
-
- [void] install_docker_winget() {
- $argu = "install --exact --id Docker.DockerDesktop --accept-source-agreements --accept-package-agreements"
- Write-Verbose "Install Docker ${argu}"
- Write-Host "Install Docker Desktop via winget"
- Start-Process -Verb runAs winget -ArgumentList $argu -Wait
- $this.reboot()
- }
-
- [void] install_docker_native() {
- $url = 'https://desktop.docker.com/win/main/amd64/Docker%20Desktop%20Installer.exe?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-win-amd64'
- $file = "docker-installer.exe"
- $web_client = New-Object System.Net.WebClient
- Write-Host "Download the Docker Desktop installer"
- $web_client.DownloadFile($url, $file)
- Write-Host "Install Docker Desktop"
- Start-Process -Verb runAs -Wait docker-installer.exe " install --quiet"
- del $file
- $this.reboot()
- }
-
- [void] run() {
- Write-Verbose "Docker not installed! Try to install it."
- $this.banner()
- $use_winget = $this.winget_available()
- $text = 'Docker Desktop installation starts now. After this your comuter must be rebooted. Continue?'
- $answer = $this.popup_message($text, $this.buttons.yes_no, $this.icons.information)
- if ($answer -ne $this.button_pressed.yes) {
- return
- }
- if ($use_winget) {
- $this.install_docker_winget()
- }
- else {
- $this.install_docker_native()
- }
- }
-}
+Using module .\proj_docker_guide.psm1
###############################################################################################
# Project spezific configuration
@@ -1122,7 +23,7 @@ $all_apps = @($ipython, $notebook, $lab, $bash)
$all_apps = @($ipython, $notebook) # lab and bash not functional, yet
$bash_app = @($bash)
-$sage_repositories = @(
+$sagemath_repositories = @(
[DockerGuideRepo]::new("sagemath", "sagemath", "Repository for users, ony stable releases (default)", [TagFilterValues]::stable, $all_apps)
[DockerGuideRepo]::new("sagemath", "sagemath", "Repository for users, only pre-releases (advanced)", [TagFilterValues]::pre, $all_apps),
[DockerGuideRepo]::new("sagemathinc", "cocalc-docker", "Repository for users, Cocalc version", [TagFilterValues]::all, $bash_app),
@@ -1131,11 +32,5 @@ $sage_repositories = @(
)
-if ($option -eq "--install") {
- $docker_installer = [DockerInstallAssistent]::new("SageMath")
- $docker_installer.run()
-}
-else {
- $sage_docker_guide = [ProjectsDockerGuide]::new("SageMath", $sage_repositories)
- $sage_docker_guide.run()
-}
+$sagemath_docker_guide = [ProjectsDockerGuide]::new("SageMath", $sagemath_repositories)
+$sagemath_docker_guide.run()
diff --git a/src/sagemath_docker_guide_installer.ps1 b/src/sagemath_docker_guide_installer.ps1
index d5e1fde..4abdbd4 100644
--- a/src/sagemath_docker_guide_installer.ps1
+++ b/src/sagemath_docker_guide_installer.ps1
@@ -13,15 +13,20 @@
$proj_name = "SageMath"
$path = "$HOME\AppData\Local\SageMathDockerGuide"
-$psfile = "sagemath_docker_guide.ps1"; $icofile = "sage.ico"
-$ps = "${path}\${psfile}"; $ico = "${path}\${icofile}"
+$psfile = "sagemath_docker_guide.ps1"
+$psmfile = "proj_docker_guide.psm1"
+$icofile = "sage.ico"
+$ps = "${path}\${psfile}"; $psm = "${path}\${psmfile}"; $ico = "${path}\${icofile}"
$url = "https://raw.githubusercontent.com/sagemath/sage-windows/main/src"
-$urlps = "${url}/${psfile}"; $urlico = "${url}/ico/${icofile}"
+$urlpsm = "https://raw.githubusercontent.com/soehms/projects_docker_guide/main/src"
+$urlps = "${url}/${psfile}"; $urlpsm = "${urlpsm}/${psmfile}"; $urlico = "${url}/ico/${icofile}"
New-Item -ItemType Directory -Force -Path $path
Start-BitsTransfer -Source $urlps -Destination $ps
+Start-BitsTransfer -Source $urlpsm -Destination $psm
Start-BitsTransfer -Source $urlico -Destination $ico
+(Get-Content -Raw $ps) -creplace '$psmfile', '$psm' | Set-Content -NoNewLine $ps # adjust module path
$ShortcutPath = [System.IO.Path]::Combine([System.Environment]::GetFolderPath("Desktop"), "${proj_name}DockerGuide.lnk")
$WScriptObj = New-Object -ComObject WScript.Shell
@@ -33,4 +38,3 @@ $Shortcut.Arguments = $SourceArguments
$Shortcut.WorkingDirectory = "%HOMEDRIVE%%HOMEPATH%"
$Shortcut.IconLocation = "$ico"
$Shortcut.Save()
-