Below are the instructions for how to mock a small subset of the XM Cloud Application elements in offline mode using Docker. This can allow for a disconnected development, however it is recommend to work in the default connected mode for the best experience.
- DotNet 8.0 (https://dotnet.microsoft.com/en-us/download)
- Docker (https://www.docker.com/products/docker-desktop)
- A windows based machine is required to run the local containers
The containers configured here are setup to use the latest LTSC base container version released by Microsoft. If you are running a BaseOS that isn't compatible, you will need to ammend the ./local-containers/.env file and use the baseOs parameter when running the ./local-containers/scripts/init.ps1 script. You can read more about the different base container versions on the Microsoft Learn Site
A number of PowerShell scripts have been provided to help you configure the repository and interact with the containers. These scripts are located in the ./local-containers/scripts folder.
You first need to initialize the repository, which will configure how the different application elements will run. This will configure the different environment variables required for the Containers to build and run. You can do this by running the ./local-containers/scripts/init.ps1 script in a terminal with elevated privilidges:
./local-containers/scripts/init.ps1 -InitEnv -LicenseXmlPath "C:\path\to\license.xml" -AdminPassword "DesiredAdminPassword"After you have initialised the repository you can use the ./local-containers/scripts/up.ps1 script to build and run the containers:
./local-containers/scripts/up.ps1Once you have finished you can use the ./local-containers/scripts/down.ps1 script to stop the containers:
./local-containers/scripts/down.ps1This will stop all containers, and tidy up any resources that were created.