Skip to Content
Last modified by Erik Bakker on 2026/01/23 13:45
From version 141.1
edited by Erik Bakker
on 2025/10/19 21:14
Change comment: There is no comment for this version
To version 144.1
edited by Erik Bakker
on 2026/01/23 12:51
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -17,6 +17,9 @@
17 17  
18 18  ===3.1 General requirements===
19 19  
20 +{{info}}It is advised to use Docker version 24.0.7 as this is the version being used in the latest eMagiz cloud template. We advise aligning the on-premise Docker version and updating it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]].
21 +{{/info}}
22 +
20 20  {{info}}
21 21  * Standard configuration to ensure that communication between your server and eMagiz to ensure communication.
22 22   ** registry.emagiz.com:443
... ... @@ -46,12 +46,13 @@
46 46   ** 18.184.211.189
47 47   ** 3.123.136.31{{/warning}}
48 48  
49 -===3.2 Installation Windows===
50 -Whenever Windows is selected as operating system, you need to have a Windows Server 2022 version. Older Windows servers are **not** supported.
51 51  
52 52  
54 +===3.2 Installation Windows===
55 +When Windows is selected as the operating system, you need Windows Server 2022. Older Windows servers are **not** supported.
56 +
53 53  ==== 3.2.1 Docker Installation ====
54 -To install or update docker on your machine, execute the following commands in powershell with administrative rights:
58 +To install Docker on your machine, execute the following commands in PowerShell with administrative rights:
55 55  
56 56  {{code language="cmd"}}
57 57  Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Install-update-docker/install-update-docker.ps1" -o install-update-docker-ce.ps1
... ... @@ -58,38 +58,35 @@
58 58  .\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
59 59  {{/code}}
60 60  
61 -{{info}}It is advised to use Docker version 24.0.7 as this is the version being used in the latest eMagiz cloud template. We advise to align the on-premise Docker version and update it according to the release notes of the [[Cloud templates>>doc:Main.Release Information.Cloud Templates.WebHome||target="blank"]].
62 -{{/info}}
63 -
64 64  ==== 3.2.2 Customization ====
65 65  
66 -After installing Docker you have the option to stick with the standard configuration of Docker or you can opt to alter some specific settings. Settings that can be of particular interest are the setting that defines the IP address range your Docker installation will use to run the containers and the setting that defines where to store data (i.e. containers and images). To check the full list of compatible configuration options for Windows you can check: [[Configure Docker in Windows>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]].
67 +After installing Docker, you can stick with the standard configuration or adjust specific settings. Settings that can be of particular interest include the one that defines the IP address range your Docker installation will use to run containers, and the one that defines where to store data (i.e., containers and images). To check the full list of compatible configuration options for Windows, you can check: [[Configure Docker in Windows>>https://learn.microsoft.com/en-us/virtualization/windowscontainers/manage-docker/configure-docker-daemon||target="blank"]].
67 67  
68 68  {{warning}}Be aware that the customization will only take effect once you have restarted the machine.{{/warning}}
69 69  
70 70  ===== 3.2.2.1 IP address range =====
71 71  
72 -Below you can find the code necessary to configure a different IP address range.
73 +Below is the code needed to configure a different IP address range.
73 73  
74 74  {{code language="cmd"}}
75 75  cd C:\ProgramData\Docker\config\daemon.json
76 -#Add following lines
77 +#Add the following lines
77 77  {"fixed-cidr": "<ip-address>"}
78 78  {{/code}}
79 79  
80 80  ===== 3.2.2.2 Data location =====
81 81  
82 -Below you can find an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store data related to Docker. Based on your internal configuration you can choose the best suitable variant if that is needed. To do so you can add the following attribute to the Docker daemon file:
83 +Below is an example of switching from the default C directory ({{code language="cmd"}}c:\programdata\docker{{/code}}) to the D directory to store Docker data. Based on your internal configuration, you can choose the best suitable variant if needed. To do so, you can add the following attribute to the Docker daemon file:
83 83  
84 84  {{code language="cmd"}}
85 85  cd C:\ProgramData\Docker\config\daemon.json
86 -#Add following lines
87 +#Add the following lines
87 87  {
88 88   "data-root": "d:\\docker"
89 89  }
90 90  {{/code}}
91 91  
92 -{{warning}}Note that when you want to create multiple customizations to your configuration the result in the daemon.json file should be a **valid** JSON structure{{/warning}}
93 +{{warning}}Note that when you want to create multiple customizations to your configuration, the result in the daemon.json file should be a **valid** JSON structure{{/warning}}
93 93  
94 94  ==== 3.2.3 Check installation ====
95 95  
... ... @@ -99,13 +99,13 @@
99 99  docker ps
100 100  {{/code}}
101 101  
102 -If the command returns that the command cannot be found, please run the following command again.
103 +If the command returns "command not found," please run the following command again.
103 103  
104 104  {{code language="cmd"}}
105 105  .\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
106 106  {{/code}}
107 107  
108 -==== 3.2.3 Verify docker functionality ====
109 +==== 3.2.3 Verify Docker functionality ====
109 109  
110 110  Execute the following command
111 111  
... ... @@ -119,12 +119,25 @@
119 119  
120 120  ==== 3.2.4 Install eMagiz Deploy Agent ====
121 121  
122 -Install the eMagiz Deploy agent as can be found in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
123 +Install the eMagiz Deploy agent as described in this [[microlearning>>doc:Main.eMagiz Academy.Microlearnings.Intermediate Level.eMagiz Runtime Management.intermediate-runtime-management-deploy-agent.WebHome||target="blank"]]
123 123  
124 -===3.3 Uninstall Docker===
125 -To uninstall docker from your machine, execute the following commands in powershell with administrative rights:
125 +=== 3.3 Update Docker ===
126 +When you are advised to update your Docker version, you can verify whether you are on the correct Docker version by executing the following command in PowerShell with administrative rights:
126 126  
127 127  {{code language="cmd"}}
129 +docker version
130 +{{/code}}
131 +
132 +When this returns a version **lower** than the advised version shown under the "General requirements" section, you can update Docker on your machine. To do so, execute the following command in PowerShell with administrative rights:
133 +
134 +{{code language="cmd"}}
135 +.\install-update-docker-ce.ps1 -DockerVersion DESIRED_VERSION
136 +{{/code}}
137 +
138 +===3.4 Uninstall Docker===
139 +To uninstall Docker from your machine, execute the following commands in PowerShell with administrative rights:
140 +
141 +{{code language="cmd"}}
128 128  Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/emagiz/windows-support/main/Uninstall-docker/uninstall-docker.ps1" -o uninstall-docker-ce.ps1
129 129  {{/code}}
130 130  
... ... @@ -136,9 +136,9 @@
136 136  
137 137  == 4. Key takeaways ==
138 138  
139 -* eMagiz uses runtime images to deploy emagiz runtime on dockerized environments. The runtime image holds all the information and components required to run the runtime
153 +* eMagiz uses runtime images to deploy the eMagiz runtime on Dockerized environments. The runtime image holds all the information and components required to run the runtime
140 140  * eMagiz has a specific agent that manages the download of that image to the on-premises server
141 -* The firewall of the on-premises environment should allow outgoing traffic without any restriction. In case that is not desirable, eMagiz can provide the addresses and ports needed to setup the right firewall rules.
155 +* The firewall of the on-premises environment should allow outgoing traffic without any restrictions. If that is not desirable, eMagiz can provide the addresses and ports needed to set up the appropriate firewall rules.
142 142  
143 143  == 5. Suggested Additional Readings ==
144 144