From efe828e3afde3a5d31b30778dc80b76724f7eb37 Mon Sep 17 00:00:00 2001 From: Islandora Foundation Community <92804539+islandora-community@users.noreply.github.com> Date: Fri, 19 May 2023 13:52:45 -0400 Subject: [PATCH] Update install-a-demo.md --- docs/installation/install-a-demo.md | 75 +++++++++++++++++++---------- 1 file changed, 49 insertions(+), 26 deletions(-) diff --git a/docs/installation/install-a-demo.md b/docs/installation/install-a-demo.md index 2066e3b06..87d411445 100644 --- a/docs/installation/install-a-demo.md +++ b/docs/installation/install-a-demo.md @@ -6,43 +6,27 @@ features of Islandora and provide a starting point for exploration. Download your demo and use the instructions below to install. It is recommended that you have a minimum of 4GB of hard drive space available on your machine before getting started. It will take some time to build the image, do not be surprised if it takes at least 25 minutes. Thanks, and happy building! -Installation video tutorial +Installation Video Tutorial ============================================================== - -Click here to view a video tutorial: [How to Install Docker Desktop and Set up Starter Site](https://www.youtube.com/watch?v=xhJft9K-YMU) +Click here to view a video tutorial: [How to Install Docker Desktop and Set up Starter Site](https://www.youtube.com/watch?v=xhJft9K-YMU). Requirements ============================================================== +Before you can set up your demonstration locally you must first install a few software packages. -Before you can set up your demonstration locally you must first install a few -software packages. Docker Desktop -------------------------------------------------------------- -[Docker Desktop](https://www.docker.com/products/docker-desktop) provides a -graphical user interface for all major platforms. +[Docker Desktop](https://www.docker.com/products/docker-desktop) provides a graphical user interface for all major platforms. -Follow the link above and select the appropriate system and follow the -installation instructions. - -For Windows 10, you may receive the "Docker Failed to Start" Error message. To resolve this: - -* Download WSL 2 from Step 4 in [these instructions](https://learn.microsoft.com/en-ca/windows/wsl/install-manual#step-4---download-the-linux-kernel-update-package), but do not do any other steps in these instructions -* Under Windows ‘Firewall & Network Protection’, ‘Allow an app through the firewall’, and ‘Change settings’ to select the ‘Private’ box for ‘Virtual Machine Monitoring’ -* Restart computer for all changes to take effect - - -**If you already have Docker Desktop installed,** make sure that the **Extensions** -feature is listed in the left sidebar. If it is not, you need to update to the newest -version of Docker Desktop. This is required to add the Portainer extension. +Follow the link above and select the appropriate system and follow the installation instructions. Portainer Extension -------------------------------------------------------------- - Once you have a working [Docker Desktop](#dockerdesktop) installation, you can add the [Portainer](https://portainer.io/) extension: @@ -58,7 +42,6 @@ For more information on Portainer refer to its Setup ============================================================== - Assuming you have all the [Requirements](#requirements) installed and running. You can now setup your demo. @@ -90,7 +73,6 @@ internet. Wait for Install -------------------------------------------------------------- - Demo still needs to install and configure `Drupal`, which may take upwards of _10-15 minutes_. You can check on the install process by doing the following. @@ -125,7 +107,6 @@ password: password Reinstall ============================================================== - If you want to re-install your demo and restore it to its original state, please perform the following steps: @@ -145,10 +126,8 @@ state, please perform the following steps: 14. Click on **Start this Stack**. 15. Wait for the installation to complete like in the [Wait for Install Section](#waitforinstall) - Uninstall ============================================================== - If you want to completely uninstall your demo, please perform the following steps: @@ -164,3 +143,47 @@ following steps: 10. Select all items. 11. Click on **Remove**. +Troubleshooting +============================================================== +These troubleshooting issues and solutions for Docker Desktop have arised from and been used with Windows 10. + +"Docker Failed to Start" Error Message +-------------------------------------------------------------- +For Windows 10, you may receive the "Docker Failed to Start" Error message. To resolve this: + +* Download WSL 2 from Step 4 in [these instructions](https://learn.microsoft.com/en-ca/windows/wsl/install-manual#step-4---download-the-linux-kernel-update-package)--do not do any other steps in these instructions. +* Under Windows ‘Firewall & Network Protection’, ‘Allow an app through the firewall’, and ‘Change settings’ to select the ‘Private’ box for ‘Virtual Machine Monitoring’. +* Restart computer for all changes to take effect. + + +No Content Showing on islandora.io +-------------------------------------------------------------- +If no content is showing up in your local installation when on islandora.io in a browser, you may need to wait longer for the deployment process to complete. +1. Go to ‘containers’, click the ‘logs’ for ‘sandbox-drupal-1’ to see the deployment process. When completed you will see: +``` +##################### +# Install Completed # +##################### +``` +* This can take anywhere from 5 minutes to over an hour. + + +Docker Desktop and Virtual Machine (Vmmem in Task Manager) Taking up too much CPU and RAM +-------------------------------------------------------------- +If Docker Desktop and Virtual Machine (Vmmem in Task Manager) are taking up too much CPU and RAM, you can create a .wslconfig file to limit how much of your computers resources are allocated to these processes: +1. Open Notepad++ and type the following: +``` +[wsl2] +memory=4GB +processors=2 +``` +2. Modify the numbers to reflect how much you want to allocate to Docker Desktop (i.e. if you only have 4GB of RAM then allocate 2GB). + * Save As and select ‘All File Types’ from the dropdown. + * Name the file x.wslconfig and save it. + * Go to the location of the saved file and rename it, removing the ‘x’. + * The file should look like this: +![wslconfigimage](https://github.com/Islandora/documentation/assets/122306010/6833bc2b-0151-4053-b902-b764c1e44cc4) +3. Put the .wslconfig file in the appropriate location. + * In your File Explorer address bar type ‘%UserProfile% and hit enter. + * Move the .wslconfig file to this folder. +4. Restart your computer and start up Docker Desktop. It will now be using only the specified memory and processors.