Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# may contain OAuth secrets, do not commit
# ignore the license file
license.xml

# may contain OAuth secrets, do not commit
.sitecore/user.json

# NuGet cache for Sitecore CLI
Expand Down
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,26 +2,34 @@

## QUICK START

1. In an ADMIN terminal:
1. Copy your license file to the license folder

2. In an ADMIN terminal:

```ps1
.\init.ps1 -InitEnv -LicenseXmlPath "C:\path\to\license.xml" -AdminPassword "DesiredAdminPassword"
.\init.ps1 -InitEnv -AdminPassword "DesiredAdminPassword"
```

2. Restart your terminal and run:
3. Restart your terminal and run:

```ps1
.\up.ps1
```

3. Follow the instructions to [deploy to XM Cloud](#deploy-to-xmcloud)
4. Follow the instructions to [deploy to XM Cloud](#deploy-to-xmcloud)

5. Create Edge token and [query from edge](#query-edge)

### License File

4. Create Edge token and [query from edge](#query-edge)
If you store your license file in a central location, you can pass a LicenseXmlPath paramter to the init command to use that location.

```ps1
.\init.ps1 -InitEnv -LicenseXmlPath "C:\path\to\license.xml" -AdminPassword "DesiredAdminPassword"
```

***

## About this Solution
This solution is designed to help developers learn and get started quickly
with XMCLoud + SXA.


4 changes: 2 additions & 2 deletions init.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ Param (
ParameterSetName = "env-init")]
[switch]$InitEnv,

[Parameter(Mandatory = $true,
[Parameter(Mandatory = $false,
HelpMessage = "The path to a valid Sitecore license.xml file.",
ParameterSetName = "env-init")]
[string]$LicenseXmlPath,
[string]$LicenseXmlPath =".\license\license.xml",

# We do not need to use [SecureString] here since the value will be stored unencrypted in .env,
# and used only for transient local development environments.
Expand Down
Empty file added license/.gitkeep
Empty file.