Umbraco Cloud
CMSHeartcoreDXPMarketplace
  • What is Umbraco Cloud?
  • Frequently asked questions
  • Security
    • Web Application Firewall
  • Sustainability Best Practices
  • Getting Started
    • Explore Umbraco Cloud
    • The Cloud Portal
      • Organizations
      • Sustainability Dashboard
    • Project Overview
    • Environments
    • Flexible Environments (beta)
    • Baselines
      • Baseline Merge Conflicts
      • Break Reference between Baseline and Child Project
      • Handling configuration files
      • Pushing Upgrades to a Child Project
    • Plans
    • Migrate to Umbraco Cloud
    • Repositories in a Cloud Project
    • Best Practice for Working in Teams
    • Migrate between regions
  • Set up
    • Ready to Set Up Your Project?
    • Working with a Local Clone
      • Legacy Umbraco Visual Studio Setup
    • Manage Environments
    • Project Settings
      • Managing Transport Security
      • CDN Caching and Optimizations
      • Dedicated Resources
      • Upgrade your Plan
      • Public Access
      • Managing Hostnames
        • New Certificate Authority for custom hostnames
        • Rewrite rules
        • Custom Certificates
      • Management API Security
      • Umbraco CI/CD Flow
        • Cloud API For CI/CD Flow
        • Configuring a CI/CD pipeline
          • Azure DevOps
          • GitHub Actions
        • Troubleshooting
        • Known Limitations and Considerations
      • External Services
      • Usage
        • Bandwidth
      • Availability and Performance
      • Team Members
        • Technical Contact
      • Secrets Management
      • Project History
    • Private NuGet Feed on Umbraco Cloud
    • Going Live
    • Media
    • External Login Providers
    • Azure Blob Storage
      • Connect to Azure Storage Explorer to upload files manually
      • Connect and Upload Files Programmatically to Azure Blob Storage
    • Users
    • Multi-Factor Authentication
    • Application Insights
    • Config Transforms
    • SMTP Settings
    • Payments
      • Subscription migration information and FAQ
    • Power Tools (Kudu)
      • View the Files on your Cloud Environments
      • Generate UDA files
      • Manually run Extractions on your Cloud Environments
  • Deployments
    • Deployment
    • Deploying between environments
    • Transferring Content, Media, Members, and Forms
    • Deploying Deletions
    • Deployment Webhook
    • Deploying Changes
    • Umbraco Forms on Cloud
    • Deploy Dashboard
    • Hotfixes
      • Apply hotfix by manually moving files
      • Apply hotfix by using Git
    • Restoring Content
      • Partial Restores
  • Databases
    • Keep Your Data Secure and Accessible
    • Working with databases
    • Database backups
    • Database
      • Connecting to the Database on Mac
    • Working with a Cloud database locally
  • Product Upgrades
    • Stay Up to Date with Umbraco Cloud
    • Product Upgrades
    • Major Upgrades
    • Minor Upgrades
    • Version Specific Upgrades
      • Migrate from Umbraco 8 to the latest version
      • Migrate from Umbraco 7 to Umbraco 8 on Umbraco Cloud
    • Upgrade your projects manually
      • Manual upgrade of Umbraco CMS
      • Manual upgrade of Umbraco Deploy
    • Dependencies on Umbraco Cloud
  • Troubleshooting
    • Resolve Issues Quickly and Efficiently
    • Troubleshooting FAQ
    • Log files
    • The Umbraco Backoffice
    • The Frontend
    • The Umbraco Cloud Portal
    • Site Performance checklist
    • Troubleshooting deployments
      • Extraction error: Config transforms failing
      • Extraction error: Data Type collisions
      • Dependency Exception
      • Merge Conflicts on Flexible Environments
      • Troubleshooting deployments failing with no error message
      • Troubleshooting duplicate dictionary items
      • Troubleshooting language mismatches
      • Path too long Exception
      • Schema Mismatches
      • How to resolve collision errors
      • Extraction error: "Type not found! "
    • Cloud Errors
  • Release Notes
    • Overview 2025
      • April 2025
      • March 2025
      • February 2025
      • January 2025
    • Overview 2024
      • December 2024
      • November 2024
      • October 2024
      • September 2024
      • August 2024
      • July 2024
      • May 2024
      • April 2024
      • March 2024
      • February 2024
      • January 2024
    • Overview 2023
      • December 2023
      • October 2023
      • September 2023
      • August 2023
      • June 2023
      • May 2023
      • April 2023
      • March 2023
      • February 2023
      • January 2023
    • Overview 2022
      • December 2022
      • November 2022
      • September 2022
      • August 2022
      • June 2022
      • May 2022
      • April 2022
      • March 2022
      • February 2022
      • January 2022
Powered by GitBook
On this page
  • Video Tutorial
  • Tools
  • Cloning an Umbraco Cloud Project
  • Running the site Locally
  • Working with Visual Studio
  • Adding a Solution File to your Cloud Project
  • Adding Additional Projects to Your Solution
  • Renaming the Project Files and Folders

Was this helpful?

Edit on GitHub
Export as PDF
  1. Set up

Working with a Local Clone

This article explains how you can work with a local clone of your Umbraco Cloud project. The tutorial works with both Windows and Mac.

PreviousReady to Set Up Your Project?NextLegacy Umbraco Visual Studio Setup

Last updated 2 months ago

Was this helpful?

Video Tutorial

Tools

We recommend using the following tools to work with a local clone of your Umbraco Cloud project:

  • Git needs to be installed on your computer to clone down the project and push your changes up to Cloud.

    • We recommend using one of the following git-clients if you are new to Git:

In the root of your local project, there is a README file containing information about the project structure and the build process on Umbraco Cloud.

Cloning an Umbraco Cloud Project

To clone an Umbraco Cloud project, follow these steps:

  1. Open the project you wish to clone in the Umbraco Cloud Portal.

  2. Click on the arrow next to the Development environment.

  3. Select Clone project.

  1. Copy the clone URL to copy the Development environment's git repository endpoint.

  1. Use your favorite Git client to clone down the project. In this guide, we will use Git Bash.

  2. Type the following command in the Git Bash terminal:

git clone <Git clone URL>

The <Git clone URL> should be the URL you copied from the Cloud Development environment.

  1. Press Enter.

Once the project has been cloned, you will get a folder with files for your Umbraco Cloud project. Now, you have a copy of your Umbraco Cloud Development environment that you can run locally.

Running the site Locally

With dotnet installed, run the following commands in a terminal application of your choice. You can also refer to the Readme file in the project folder.

  1. Navigate to the newly created project folder.

  2. Run the following commands:

cd src/UmbracoProject
  1. Build and run the project:

dotnet build
dotnet run

The terminal output will show the application starting up and will include localhost URLs which you can use to browse to your local Umbraco site.

We recommend setting up a developer certificate and running the website under HTTPS. If you haven't configured one already, run the following command:

dotnet dev-certs https --trust

The first time the project is run locally, you will see the Restore from Umbraco Cloud screen. If the environment you have cloned already contains Umbraco Deploy metadata files (such as Document Types, Templates, etc), these are automatically extracted with the option to restore content from the Cloud environment into the local installation.

Click Restore to restore your site's content if any. Wait until this process is completed as it also creates the local SQLite database for your site.

Working with Visual Studio

When working locally, we recommend using Visual Studio but you can use any other development tool of your choice.

Once the project has been cloned down, you will get a folder with files for your Umbraco Cloud project.

  1. Navigate to src/UmbracoProject. Here, you will find the files for your Umbraco installation.

  1. Open the UmbracoProject.csproj file in Visual Studio.

  2. Build and run your solution in Visual Studio.

Adding a Solution File to your Cloud Project

Working with Visual Studio, you will likely want a solution file, so you and your team can work with an Umbraco Cloud project and have the option to add additional projects.

If you want to add a solution file for your Cloud project, you can do it either:

Using the Command Line

Using the terminal of your choice, navigate to the root of the git repository of your Umbraco Cloud project and enter the following command:

dotnet new sln --name <MyAwesomeSolution>

Using Visual Studio

  1. Open the UmbracoProject.csproj project in Visual Studio.

  2. Click on the solution:

  1. Save the solution file using the Save as option:

  1. Provide a File name to create the solution file in the folder that you specified.

When creating a solution file, we recommend placing it at the root of the git repository.

Adding Additional Projects to Your Solution

When creating new projects alongside the default Umbraco project, we recommend adding the projects to the src folder in the git repository.

If you want to add additional projects to your solution, you can do it either through the:

Command Line

Run the following commands to add additional projects to your solution:

dotnet new classlib --name MyAwesomeProject.Web --output src/MyAwesomeProject.Web
dotnet sln add .\src\MyAwesomeProject.Code\MyAwesomeProject.Code.csproj
dotnet sln add .\src\MyAwesomeProject.Web\MyAwesomeProject.Web.csproj

Visual Studio

  1. Open the UmbracoProject.csproj project in Visual studio.

  2. Click on the solution:

  1. Right-click the solution and choose Add -> New Project...

  1. Add a class library using the latest .NET SDK to your project:

Once the Class library (.Core) has been added, you can see the project(s) that have been added in Solution Explorer.

Renaming the Project Files and Folders

To rename your Umbraco Cloud project files and folder, do the following:

  1. Navigate to the .umbraco file at the root of the project and view the following:

[project]
base = "src/UmbracoProject"
csproj = "UmbracoProject.csproj"

The base property provides the folder location which contains the application and the csproj property is the name of the .csproj file.

  1. Rename the UmbracoProject directory and .csproj file.

  2. Update the .umbraco file with the new name and any C# code namespaces reflecting the name of your project.

  3. Additionally, if you prefer to organize your code, you can add additional Class Library projects that are referenced by the Umbraco application .csproj file.

For example: Rename UmbracoProject.csproj to MyAwesomeProject.Web.csproj and have one or more additional class library projects such as MyAwesomeProject.Code.csproj

[project]
base = "src/MyAwesomeProject.Web"
csproj = "MyAwesomeProject.Web.csproj"

It's a good idea to update the namespace used in the Program.cs, Startup.cs and _ViewImports.cshtml files so the naming is consistent throughout your project structure. Once updated, you will need to clear out the bin and obj folders locally to avoid build errors. When you are done, commit the changes and push them to Cloud.

If you have already built and run the project locally using the original project file and folder, make an update in your local .git repository to reflect the change that has been made. When a Cloud project first runs, a git hook is created to trigger a schema update via Umbraco Deploy when changes are pulled from an upstream environment.

The file you'll need to update is post-merge within .git/hooks/ in your cloned environment files. It can be opened with a text editor. You can either delete the file so it will be recreated with the new path or update it. The default contents are shown below and can be updated to reflect the new path to the umbraco/Deploy folder.

#!/bin/sh
echo > src/UmbracoProject/umbraco/Deploy/deploy

or - for running the project on your local machine.

To run your Umbraco Cloud project locally, you will need to (if you do not have this already).

You can create content, add media, and create your custom code. When you're ready to deploy your changes make sure to have a look at the documentation.

If you have more than "a few" media items, see our recommendations for working with .

Fork
SourceTree
GitKraken
Microsoft Visual Studio
JetBrains Rider
install the latest .NET SDK
deployments
Media on Umbraco Cloud
Using the Command Line
Using Visual Studio
Command Line
Visual Studio
Learn how to clone your Umbraco Cloud project and work with it locally.
Clone project option
Copy the clone URL
Cloned Project
Terminal Output
clone dialog
Umbraco files
Umbraco files
Visual studio solution
save file as
Solution
add new project
Class library
New project added
Clone project option
Copy the clone URL
Umbraco files
Umbraco files