No edit summary
No edit summary
(18 intermediate revisions by 3 users not shown)
Line 1: Line 1:
On this page you will learn how to install the MSP Challenge on your computer.
On this page, you'll learn:
*How to install the MSP Challenge client for Windows
*How to install the MSP Challenge client for macOS
*How to install the full MSP Challenge Simulation Platform


==MSP Challenge client installation==
==Client-only installation instructions==
Please note that the MSP Challenge client is a Windows-only application developed in Unity, for Windows 10 specifically.<br>
This is useful if you only want to quickly try out MSP Challenge, or if you are an end user getting ready to join an MSP Challenge session. This is because you will only install the client application, i.e., the application that end users use. After installation you can [[Connecting to a server|log on to one of our demo servers]]. Note that this is suitable for demonstration purposes only (so not full-on sessions) as the demo servers are accessible to anyone anywhere in the world and reset themselves daily.
You can either [[Download|install the client through the installer, or manually through the ZIP file]].<br>
===Instructions for Windows 10 or 11===
For more information about how to actually use the MSP Challenge client, please consult the tutorial videos about [[Connecting to a server|connecting to an MSP Challenge server]] and using all the [[Using the main features|software features]].
Note that we officially started supporting Windows 11 since version 4.0-beta10.
===Option 1: using the installer===


#You '''will''' need to have administrator privileges / installation rights on your computer to use the installer.
You have two options:
#Simply run the downloaded installer file and complete the Wizard.
#Download the '''ZIP''' file from the [[Download]] page, unpack the MSP Challenge folder contained in it to a location of your choice (e.g. the Documents folder or the Desktop), open that folder, and run MSP Challenge.exe. If you like, you can create a Shortcut to MSP Challenge.exe and put it on your Desktop or your Start Menu.
#Afterwards, you'll be able to start the MSP Challenge client through the shortcut added to your Start menu and/or Desktop (depending on your chosen options during installation).
#'''Or''' download the latest client-only '''installer''' from the [[Download]] page and run it. You'll be presented with an installation wizard. Just follow the steps. The installer will add a shortcut to your Start menu, and optionally one on your Desktop (depending on whether you selected that option during installation).
===Option 2: using the ZIP file===


#You '''won't''' need to have administrator privileges / installation rights on your computer for this option.
===Instructions for macOS===
#Open the ZIP file and move the 'MSP Challenge' folder it contains to your Desktop or a folder in My Documents if you prefer.
Simply download the latest client-only ZIP from the [[Download]] page, and allow macOS to unpack it first. If you like, you can then drag the MSP Challenge app over to Applications and/or your Dock.
#Open the 'MSP Challenge' folder (wherever you put it - Desktop, My Documents, ...) and double-click on the 'MSP Challenge' shortcut to run the client.
#Windows (Defender) SmartScreen might warn you not to open an unrecognised application downloaded from the internet such as this one (see screenshot). You'll have to ignore any such warning to continue: Click on 'More info' and 'Run anyway'.


==MSP Challenge server installation==
==Full platform installation instructions==
(Under development.)
'''<u>Only install the full platform if you intend to turn your computer into a server, i.e., a computer open to participants with the client to connect to, thus a computer open to outside connections.</u>'''


{{Category|name=InProgress}}
Since version 4.0.0, you have two options for setting up a server. Perhaps it goes without saying, but to be clear: pick '''one or the other''', not both'''.'''
 
=== Option 1: Fresh installation through Docker (on Linux or Windows) ===
This section pertains to '''fresh''' installations (so '''not''' upgrades) through '''Docker''' on Linux or Windows only. We have supported Docker since version 4.0.0.
 
If you're interested in running the Server through Docker, we assume a (basic) system administrator's level of expertise. In other words, we assume you are a bit familiar with Docker itself.
 
On Linux, you can follow the [[Docker server installation|instructions on this separate page]] to set this all up.
 
For Windows, you can download and install the Docker Desktop application, and use the default installation settings. Then you can/should still open up a Git Bash command-line app and follow the same instructions as explained above concerning Linux, starting from 'Now obtain the MSP Challenge Server code'.
 
You can, if you want, hire a virtual machine from a service such as Microsoft Azure, and install the server on there using Docker. We have done this at BUas many times. Here's [[Microsoft Azure setup notes|a page about using Microsoft Azure to do this]].
 
=== Option 2: Fresh installation on Windows ===
This section pertains to '''fresh''' installations (so '''not''' upgrades) on '''Windows''' only.
 
When it concerns Windows, we currently support Windows 10, 11 (since 4.0-beta10) or Windows Server 2016/2019 only.
 
Start by just downloading the full-platform installer from the [[Download]] page and running it.
 
You'll be presented with an installation wizard. Just follow the steps. The installer will add the following shortcuts to your Start menu, and optionally on your Desktop (depending on whether you selected that option during installation):
*MSP Challenge Client: the same client application as you would get with client-only installation
*[[Setting_up_your_own_server|MSP Challenge Server Manager]]: the web application with which you set up your MSP Challenge sessions
*[[Customise_your_session|MSP Challenge Server Configuration Editor]]: an application with which you can create or alter session configurations
The server-side of MSP Challenge functions as a web application. The full platform therefore also installs and configures XAMPP, specifically a bundle of Apache2 web server, MariaDB database server and PHP7 (and Symfony since 4.0-beta10). It sets up a random root password for your MariaDB root user.
 
Note: As of version 4.0-beta9, the full platform '''un'''installer will also completely uninstall XAMPP. Previous versions did not do this during uninstallation.
=== Upgrading from a previous version ===
When you already have a previous version of the server software (and the rest of the full platform) installed, you should first uninstall it and then install the newest version.
 
This means that absolutely everything will be replaced and upgraded. You'll lose your existing MSP Challenge sessions!
 
So... '''<u>IMPORTANT!</u> You'll have to backup your existing MSP Challenge sessions''' using the Save feature of the Server Manager application, and by then downloading the ZIP file to your computer. Make sure the save and download work, by reuploading the saved ZIP and reloading the saved session. Did everything work? Then you're ready for the upgrade.
 
You'll be able to re-upload the ZIP file again after the upgrade, and then you'll be able to reload a session using that save.
 
'''Note:''' after upgrading, if the Server Manager returns errors, it might require a 'hard refresh'. Press the Shift key and click on the Refresh button in your browser while logged on to the Server Manager to do this.

Revision as of 08:12, 18 April 2024

On this page, you'll learn:

  • How to install the MSP Challenge client for Windows
  • How to install the MSP Challenge client for macOS
  • How to install the full MSP Challenge Simulation Platform

Client-only installation instructions

This is useful if you only want to quickly try out MSP Challenge, or if you are an end user getting ready to join an MSP Challenge session. This is because you will only install the client application, i.e., the application that end users use. After installation you can log on to one of our demo servers. Note that this is suitable for demonstration purposes only (so not full-on sessions) as the demo servers are accessible to anyone anywhere in the world and reset themselves daily.

Instructions for Windows 10 or 11

Note that we officially started supporting Windows 11 since version 4.0-beta10.

You have two options:

  1. Download the ZIP file from the Download page, unpack the MSP Challenge folder contained in it to a location of your choice (e.g. the Documents folder or the Desktop), open that folder, and run MSP Challenge.exe. If you like, you can create a Shortcut to MSP Challenge.exe and put it on your Desktop or your Start Menu.
  2. Or download the latest client-only installer from the Download page and run it. You'll be presented with an installation wizard. Just follow the steps. The installer will add a shortcut to your Start menu, and optionally one on your Desktop (depending on whether you selected that option during installation).

Instructions for macOS

Simply download the latest client-only ZIP from the Download page, and allow macOS to unpack it first. If you like, you can then drag the MSP Challenge app over to Applications and/or your Dock.

Full platform installation instructions

Only install the full platform if you intend to turn your computer into a server, i.e., a computer open to participants with the client to connect to, thus a computer open to outside connections.

Since version 4.0.0, you have two options for setting up a server. Perhaps it goes without saying, but to be clear: pick one or the other, not both.

Option 1: Fresh installation through Docker (on Linux or Windows)

This section pertains to fresh installations (so not upgrades) through Docker on Linux or Windows only. We have supported Docker since version 4.0.0.

If you're interested in running the Server through Docker, we assume a (basic) system administrator's level of expertise. In other words, we assume you are a bit familiar with Docker itself.

On Linux, you can follow the instructions on this separate page to set this all up.

For Windows, you can download and install the Docker Desktop application, and use the default installation settings. Then you can/should still open up a Git Bash command-line app and follow the same instructions as explained above concerning Linux, starting from 'Now obtain the MSP Challenge Server code'.

You can, if you want, hire a virtual machine from a service such as Microsoft Azure, and install the server on there using Docker. We have done this at BUas many times. Here's a page about using Microsoft Azure to do this.

Option 2: Fresh installation on Windows

This section pertains to fresh installations (so not upgrades) on Windows only.

When it concerns Windows, we currently support Windows 10, 11 (since 4.0-beta10) or Windows Server 2016/2019 only.

Start by just downloading the full-platform installer from the Download page and running it.

You'll be presented with an installation wizard. Just follow the steps. The installer will add the following shortcuts to your Start menu, and optionally on your Desktop (depending on whether you selected that option during installation):

The server-side of MSP Challenge functions as a web application. The full platform therefore also installs and configures XAMPP, specifically a bundle of Apache2 web server, MariaDB database server and PHP7 (and Symfony since 4.0-beta10). It sets up a random root password for your MariaDB root user.

Note: As of version 4.0-beta9, the full platform uninstaller will also completely uninstall XAMPP. Previous versions did not do this during uninstallation.

Upgrading from a previous version

When you already have a previous version of the server software (and the rest of the full platform) installed, you should first uninstall it and then install the newest version.

This means that absolutely everything will be replaced and upgraded. You'll lose your existing MSP Challenge sessions!

So... IMPORTANT! You'll have to backup your existing MSP Challenge sessions using the Save feature of the Server Manager application, and by then downloading the ZIP file to your computer. Make sure the save and download work, by reuploading the saved ZIP and reloading the saved session. Did everything work? Then you're ready for the upgrade.

You'll be able to re-upload the ZIP file again after the upgrade, and then you'll be able to reload a session using that save.

Note: after upgrading, if the Server Manager returns errors, it might require a 'hard refresh'. Press the Shift key and click on the Refresh button in your browser while logged on to the Server Manager to do this.

This page was last edited on 18 April 2024, at 08:12. Content is available under GPLv3 unless otherwise noted.