From ff88591a787b26c6939563c77fdec21b65240003 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Mon, 21 Jul 2025 14:33:35 +0200 Subject: [PATCH 1/2] Merged contents of Working with Linux/macOS into Working locally article --- umbraco-cloud/.gitbook.yaml | 2 +- .../working-locally/README.md | 48 ++++++++++++++++++- .../working-with-linux-macos.md | 48 ------------------- 3 files changed, 48 insertions(+), 50 deletions(-) delete mode 100644 umbraco-cloud/build-and-customize-your-solution/working-with-linux-macos.md diff --git a/umbraco-cloud/.gitbook.yaml b/umbraco-cloud/.gitbook.yaml index 7703c0a99bf..82fd91d95d3 100644 --- a/umbraco-cloud/.gitbook.yaml +++ b/umbraco-cloud/.gitbook.yaml @@ -131,4 +131,4 @@ redirects: monitor-and-troubleshoot/availability-performance: optimize-and-maintain-your-site/monitor-and-troubleshoot/availability-performance.md set-up/media/connect-to-azure-storage-explorer: build-and-customize-your-solution/handle-deployments-and-environments/media/azure-blob-storage/connect-to-azure-storage-explorer.md set-up/working-locally/working-with-visual-studio: build-and-customize-your-solution/handle-deployments-and-environments/working-locally/legacy-umbraco-visual-studio-setup.md - + build-and-customize-your-solution/working-with-linux-macos: build-and-customize-your-solution/handle-deployments-and-environments/working-locally/README.md diff --git a/umbraco-cloud/build-and-customize-your-solution/handle-deployments-and-environments/working-locally/README.md b/umbraco-cloud/build-and-customize-your-solution/handle-deployments-and-environments/working-locally/README.md index 4885300772c..d722586abee 100644 --- a/umbraco-cloud/build-and-customize-your-solution/handle-deployments-and-environments/working-locally/README.md +++ b/umbraco-cloud/build-and-customize-your-solution/handle-deployments-and-environments/working-locally/README.md @@ -230,4 +230,50 @@ The file you'll need to update is `post-merge` within `.git/hooks/` in your clo echo > src/UmbracoProject/umbraco/Deploy/deploy ``` -*** +## Working with Linux/macOS + +You can work locally with your Umbraco Cloud site without needing a Windows machine or a local web server installed. This enables users on macOS or Linux-based operating systems to use their preferred editor to modify code in their Umbraco Cloud site. + +### The Solution + +1. On the Umbraco Cloud portal, go to your project and clone the site using your favorite Git client. + +
Clone project down

Clone project down

+ +2. Configure a SQL Server connection string using `ConnectionStrings` in `appsettings.json` or `appsettings.Development.json` (the `launchSettings.json` configures the local instance to run as 'Development'): + + ```json + "ConnectionStrings": { + "umbracoDbDSN": "" + } + ``` + +3. Configure the local instance to install unattended by adding the following settings to `appsettings.Development.json`: + + ```json + { + "Umbraco": { + "CMS": { + "Unattended": { + "InstallUnattended": true, + "UnattendedUserName": "", + "UnattendedUserEmail": "", + "UnattendedUserPassword": "" + } + } + } + } + ``` + +{% hint style="info" %} +The `UnattendedUserName`, `UnattendedUserEmail`, and `UnattendedUserPassword` are optional. They are only required if you want to create a local backoffice user. You can alternatively use your Umbraco ID to sign in. +{% endhint %} + +4. In your terminal, navigate to the `src/UmbracoProject` folder and run the following commands to start the project: + + ``` + dotnet build + dotnet run + ``` + +5. When running the site for the first time, the database schema will be inserted automatically into the database (with `"InstallUnattended": true` in `appsettings.Development.json`), so the site will start up ready for use. diff --git a/umbraco-cloud/build-and-customize-your-solution/working-with-linux-macos.md b/umbraco-cloud/build-and-customize-your-solution/working-with-linux-macos.md deleted file mode 100644 index d09dd4741fb..00000000000 --- a/umbraco-cloud/build-and-customize-your-solution/working-with-linux-macos.md +++ /dev/null @@ -1,48 +0,0 @@ ---- -hidden: true ---- - -# Copy of Working with Linux/macOS - -One of the features built into Umbraco Cloud is the ability to work locally with your Umbraco site. This can be done without having a Windows machine with a local web server installed on it. This enables people on macOS or Linux-based OS to use their favorite editor to modify code in their Umbraco Cloud site. - -## The Solution - -1. On the Umbraco Cloud portal, go to your project and clone the site using your favorite Git client. - -
Clone project down

Clone project down

-2. Configure a SQL Server connection string using `ConnectionStrings` in `appsettings.json` or `appsettings.Development.json` (the `launchSettings.json` configures the local instance to run as 'Development'): - - ```json - "ConnectionStrings": { - "umbracoDbDSN": "" - } - ``` -3. Additionally, it's recommended to configure the local instance to install unattended with the following settings in `appsettings.Development.json`: - - ```json - { - "Umbraco": { - "CMS": { - "Unattended": { - "InstallUnattended": true, - "UnattendedUserName": "", - "UnattendedUserEmail": "", - "UnattendedUserPassword": "" - } - } - } - } - ``` - -{% hint style="info" %} -The UserName, Email, and Password are optional properties and _only_ needed if you want to set up a local backoffice user. You can use your Umbraco Id to sign in to the backoffice. -{% endhint %} - -1. On the terminal, navigate to `src/UmbracoProject` folder and run the following commands to start the project: - - ``` - dotnet build - dotnet run - ``` -2. When running the site for the first time, the database schema is automatically inserted into the database (with `"InstallUnattended": true` in `appsettings.Development.json`), so the site starts up ready for use. From e619c51c1899449b9060275a845785fc234210b2 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Mon, 21 Jul 2025 14:34:44 +0200 Subject: [PATCH 2/2] Removed entry from summary.md file --- umbraco-cloud/SUMMARY.md | 1 - 1 file changed, 1 deletion(-) diff --git a/umbraco-cloud/SUMMARY.md b/umbraco-cloud/SUMMARY.md index 5d795b4a5f6..32c1e84cb64 100644 --- a/umbraco-cloud/SUMMARY.md +++ b/umbraco-cloud/SUMMARY.md @@ -78,7 +78,6 @@ * [Connect and Upload Files Programmatically to Azure Blob Storage](build-and-customize-your-solution/handle-deployments-and-environments/media/azure-blob-storage/connect-programatically-to-azure-storage.md) * [Manage Environments](build-and-customize-your-solution/handle-deployments-and-environments/manage-environments.md) * [Sustainability Best Practices](https://docs.umbraco.com/sustainability-best-practices/) -* [Copy of Working with Linux/macOS](build-and-customize-your-solution/working-with-linux-macos.md) ## Expand Your Project’s Capabilities