Differences

This shows you the differences between two versions of the page.

--- startwindowsmixasservice [2022/03/24 16:22]
wikiadmin
+++ startwindowsmixasservice [2025/03/24 11:05] (current)
amyw [Setting up MIX as a Service on Windows]
@@ Line 1: / Line 1: @@
 =====Setting up MIX as a Service on Windows=====
-This article provides instructions on how to set up MIX as a service on Windows. As a service you can use the Windows Service manager panel to stop and start MIX, and to set it to run automatically when Windows starts. It is distributed with a permissive MIT license.
+This article provides instructions on how to set up MIX as a service on Windows. As a service you can use the Windows Service manager panel to stop and start MIX, and to set it to run automatically when Windows starts. The wrapper software is distributed with a permissive MIT license.
 These instructions use the service wrapper (WinSW) from https://github.com/winsw. This is an active open-source project and is very easy to set up and use. There are more features available for this wrapper than the basic setup described in this article, but the basic setup should be useful for most MIX installations.
@@ Line 13: / Line 13: @@
 ====Get the Service Wrapper Files====
-The first step to setting up the wrapper for MIX is to download the main executable and a configuration from https://github.com/winsw/winsw/releases.
+The first step to setting up the wrapper for MIX is to download the main executable and a configuration from https://github.com/winsw/winsw/releases .
 WinSW can be set up on x86 (32-bit) or x64 (64-bit) and the executable you select to download will depend on the MIX deployment Windows version and architecture. The most straightforward setup is for Windows 10+ which has .net 4.61+ installed (it will be by default on Windows 10+ systems). Download the current release (not the beta release). As of the date of this article the current release is 2.11, and version 3 is in alpha phase and probably should not be used except for experimentation. The links below are for version 2.11 and you should check if there is a later version.
-The executable to download for Windows 10 (and systems using .net 4.61 or newer) is https://github.com/winsw/winsw/releases/download/v2.11.0/WinSW.NET461.exe. If you are running an X86 version of Windows or an older version, please read the documentation page (link in the first section above) to understand which exe you will need.
+The executable to download for Windows 10 (and systems using .net 4.61 or newer) is https://github.com/winsw/winsw/releases/download/v2.11.0/WinSW.NET461.exe . If you are running an X86 version of Windows or an older version, please read the documentation page (link in the first section above) to understand which exe you will need.
-Also download the simple configuration example (sample-minimal.xml) from https://github.com/winsw/winsw/releases/download/v2.11.0/sample-minimal.xml. You can also download the more extensive (examples of every configurable property) configuration (sample-allOptions.xml) from https://github.com/winsw/winsw/releases/download/v2.11.0/sample-allOptions.xml.
+Also download the simple configuration example (sample-minimal.xml) from https://github.com/winsw/winsw/releases/download/v2.11.0/sample-minimal.xml . You can also download the more extensive (examples of every configurable property) configuration (sample-allOptions.xml) from https://github.com/winsw/winsw/releases/download/v2.11.0/sample-allOptions.xml .
 ==== Copy the Wrapper for MIX====
@@ Line 139: / Line 139: @@
 </code>
-====Final Setup: Copy the batch file to start MIX====
+====Final Setup: Copy and edit the batch file to start MIX====
-In the MIX directory is a subdirectory called "scripts". Go to this subdirectory and copy the run_mix.bat, then paste this to the main MIX directory. There is one line to edit in this file, so open run_mix.bat in Notepad++ or your text editor.
+In the MIX directory is a subdirectory called "scripts". Go to this subdirectory and copy the run_mix.bat, then paste this to the main MIX directory. One line needs to be changed so that the logging is as expected (file logging). Open run_mix.bat in Notepad++ or your text editor, you will see:
 <code batch>
+set path=..\jre\bin;.\lib\;%path%
+java -version
+set classpath=./*;./lib/*;./lib/jdbc/*;
+rem ./lib/OPCUAServer.jar;./lib/TransSECSRuntime.jar;./lib/opcua/*;./lib/jdbc/*;
+rem java -Djava.io.tmpdir=C:\plcshare -Dvib.sharedplcsimulation=true -DOmronFins.simulate=true -Xdebug -Xnoagent -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n -Dlog4j.configuration=log4j.console.xml  -DLoggerClass=Log4JLogger com.ergotech.mix.server.HeadlessController
+java -Dlog4j.configuration=log4j.console.xml -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n -DLoggerClass=Log4JLogger com.ergotech.mix.server.HeadlessController
 </code>
+change the line that says:
+<code>java -Dlog4j.configuration=log4j.console.xml -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n -DLoggerClass=Log4JLogger com.ergotech.mix.server.HeadlessController</code>
+to
+<code>
+java -Dlog4j.configuration=log4j.xml -Xrunjdwp:transport=dt_socket,server=y,address=8000,suspend=n -DLoggerClass=Log4JLogger com.ergotech.mix.server.HeadlessController </code>
+so that the log4j.xml file is changed from log4j.console.xml to log4j.xml.
+====Install the Service====
+Open a command shell in the mixruntime directory where you have been editing the files.
+type this into the console window:
+<code> mixruntime install </code>
+you should see some feedback in the console, similar to:
+C:\Users\Public\mixruntime>mixruntime install
+-03-24 15:44:21,848 INFO  - Installing service 'MIX Runtime Service (powered by WinSW) (MIXRuntime)'...
+-03-24 15:44:21,864 INFO  - Service 'MIX Runtime Service (powered by WinSW) (MIXRuntime)' was installed successfully.
+====Monitoring the Service====
+To see what you have accomplished, run the Windows Service panel. You can find this in the Windows start menu under Windows Administrative Tools, then scroll down to Services (it is actually running this: C:\WINDOWS\system32\services.msc).
+When you run the Services panel you can find the "MIXRuntime" service that you just installed:
+{{:pasted:20220324-165530.png}}
+You can see that the service is set up to run automatically when Windows starts (more precisely, when the LocalSystem account starts).
+if you ever need to uninstall the service, use mixruntime uninstall.
+====Starting the Service====
+You can start MIX by right clicking in the Status column of the Services panel for the MIXRuntime service and selecting Start. After you do this you will see that the service is running, so MIX is running.
+{{:pasted:20220324-165849.png}}
+You can also start the service in the command shell (or write a batch file to do this) by typing "mixruntime start".
+====Stopping the Service====
+The service can be stopped by right clicking on the "Running" status in the Service console and selecting "Stop". Alternatively you can stop the service on the command line using "mixruntime stop".