Skip to content
Merged
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
1 change: 1 addition & 0 deletions .github/styles/UmbracoDocs/Acronyms.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ exceptions:
- DELETE # HTTP DELETE method
- DHL # International Shipping brand
- DIBS # DIBS by Nets
- DLL # Dynamic-Link Library
- DNS # Domain Name System
- DOM # Document Object Model
- DXP # Digital Experience Platform
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ If too many secrets are added, or if secret values are too large, your environme

It is recommended to:

- Keep secrets small and concise.
- Store only sensitive values as secrets (for example: API keys, connection strings).
- Use `appsettings.json` for general configuration values.
* Keep secrets small and concise.
* Store only sensitive values as secrets (for example: API keys, connection strings).
* Use `appsettings.json` for general configuration values.
{% endhint %}

To add a secret to your environment, follow these steps:
Expand Down Expand Up @@ -176,6 +176,4 @@ The following prefixes are allowed for Secrets on Umbraco Cloud:

It is also possible to use Secrets to save API keys, Passwords, and ReChaptcha for all our Umbraco products on Umbraco Cloud.

Do you have an existing or new secret that you want to add to a key vault that conflicts with the name restrictions?

Then please contact Umbraco support, then we will consider it as soon as possible.
Do you have an existing or new secret that you want to add to a key vault that conflicts with the name restrictions? Contact Umbraco Support and it will be considered as soon as possible.
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ User Permissions for each environment can be set in the **Edit Team** page avail
<figure><img src="images/Edit-Team.png" alt=""><figcaption></figcaption></figure>

* **Admin**: Has access to everything on a project. An admin can delete a project and edit the team. An admin can deploy changes between environments in the Project Portal and has access to git, as well as the Power Tools Kudu.
* **Read**: A team member with Read permissions can only view the project in the portal as well as the backoffices. They are not able to deploy or change anything on the project itself. They can clone down the project, but cannot push changes they have made locally. By default, they are added as an admin in the backoffice so they can make changes in the backoffice. If you want to change this, see Team Member Permissions in the Umbraco Backoffice below.
* **Read**: A team member with Read permissions can only view the project in the portal as well as the backoffice. They are not able to deploy or change anything on the project itself. They can clone down the project, but cannot push changes they have made locally. By default, they are added as an admin in the backoffice so they can make changes in the backoffice. If you want to change this, see Team Member Permissions in the Umbraco Backoffice below.
* **Write**: A team member with Write permissions can do everything on a project except delete it and edit the team. A user with Write permissions can deploy changes between environments through the portal. They have access to the git repositories and can push local changes to the environment.
* **No Access**: A team member with No access permissions cannot restart the environment, deploy changes between environments, check error logs or log files, or access Kudo in the Project Portal. They can view the project in the portal and access the backoffice.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,4 +60,4 @@ To validate your local site and ensure compatibility with the updated schema, us

Here, you can see the status of ongoing or completed deployment processes. The status will show whether an operation has been triggered and is in progress has been completed, or has failed.

The dashboard will show the status based on the marker files on the disk, eg. `deploy-progress`. From the **Deploy** Dashboard, it is also possible to trigger different processes.
The dashboard will show the status based on the marker files on the disk, for example, `deploy-progress`. From the **Deploy** Dashboard, it is also possible to trigger different processes.
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,16 @@

When you have content on your Cloud environment and clone down your project to your local machine, you need to restore the content. You will also need to use the restore option when setting up new Cloud environments.

The restore option can be used to always ensure you work with the latest content when delevoping new features.
The restore option can be used to always ensure you work with the latest content when developing new features.

## How to Restore Content

You can restore the content in the following ways:

1. [Restore when starting up the project locally](./#restore-when-starting-up-the-project-locally)
2. [Workspace Restore](./#workspace-restore)
3. [Tree Restore](./#tree-restore)
4. [Partial Restore](./#partial-restore)
1. [Restore when starting up the project locally](#restore-when-starting-up-the-project-locally)
2. [Workspace Restore](#workspace-restore)
3. [Tree Restore](#tree-restore)
4. [Partial Restore](#partial-restore)

### Restore when starting up the project locally

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Attaching a CI/CD pipeline to a flexible environment is currently not possible.

**Centralized Management**

* With Umbraco CI/CD Flow, you can centralize the management of your deployments, tests, and workflows. This makes it easier to monitor, troubleshoot, and optimize your processes, leading to more efficient and reliable deployments. Automating deployment minimizes the risc for human errors that could have a negative effect on the target environment.
* With Umbraco CI/CD Flow, you can centralize the management of your deployments, tests, and workflows. This makes it easier to monitor, troubleshoot, and optimize your processes, leading to more efficient and reliable deployments. Automating deployment minimizes the risk for human errors that could have a negative effect on the target environment.

Umbraco CI/CD Flow serves as a bridge between your existing CI/CD pipeline and Umbraco Cloud, enabling a more streamlined and automated deployment process. While it offers a number of advantages, there are also limitations that need to be considered. On the page '[Known Limitations and Considerations](knownlimitationsandconsiderations.md)' you will find a detailed list of the pros and cons of using Umbraco CI/CD Flow.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ To use ModelsBuilder with IntelliSense in Visual Studio, you'll need to make som
This will make the models of your Document Types available with IntelliSense in Visual Studio. [You can read more about configuring ModelsBuilder here](https://docs.umbraco.com/umbraco-cms/reference/templating/modelsbuilder).

{% hint style="info" %}
Are using the [Visual Studio Extension for ModelsBuilder](https://marketplace.visualstudio.com/items?itemName=ZpqrtBnk.UmbracoModelsBuilderExtension\&ssr=false) and getting the error message Unauthorized when generating models? You'll need to use or create a backoffice user in your local installation. You then need to supply the credentials for this user in the Visual Studio options. This is necessary because the extension is not able to authenticate against Umbraco Id.
Are using the [Visual Studio Extension for ModelsBuilder](https://marketplace.visualstudio.com/items?itemName=ZpqrtBnk.UmbracoModelsBuilderExtension\&ssr=false) and getting the error message Unauthorized when generating models? You'll need to use or create a backoffice user in your local installation. You then need to supply the credentials for this user in the Visual Studio options. This is necessary because the extension is not able to authenticate against Umbraco ID.
{% endhint %}

### Using Umbraco namespaces in your `*.Core` project
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ When an upload fails, you can click the triangle icon to view more details about
| ------------------------- | -------------------------------------------- |
| ImportBackupAborted | User aborted the upload. |
| ImportBackupFailedUnknown | An unknown error occurred during the upload. |
| ImportBackupFailed | Upoload took too long. |
| ImportBackupFailed | Upload took too long. |

## Restore Database

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,6 @@ and in one of these folders for IIS Express:

If you're using Visual Studio 2015+ check this path: `$(solutionDir)\.vs\config\applicationhost.config`

In Visual Studio 2015+ you can also configure which `applicationhost.config` file is used by altering the `<UseGlobalApplicationHostFile>true|false</UseGlobalApplicationHostFile>` setting in the project file (eg: `MyProject.csproj`). Source: Microsoft Developer Network (MSDN) forum.
In Visual Studio 2015+ you can also configure which `applicationhost.config` file is used by altering the `<UseGlobalApplicationHostFile>true|false</UseGlobalApplicationHostFile>` setting in the project file (for example, `MyProject.csproj`). Source: Microsoft Developer Network (MSDN) forum.

Now that you are all set and ready you can continue to work with your [database locally](local-database.md).
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ You can find and manage the value of the `DOTNET_ENVIRONMENT` environment variab

Create the files in your local project clone to ensure it's added to the repository.

When the file is deployed to the Live environment, the transforms will be applied to the `appSettings.json` file in the `Root` of your project. In the case that you have mutliple mainline environments, the `appSettings.Live.json` will **only** transform the `appSettings.json` on the Live environment.
When the file is deployed to the Live environment, the transforms will be applied to the `appSettings.json` file in the `Root` of your project. In the case that you have multiple mainline environments, the `appSettings.Live.json` will **only** transform the `appSettings.json` on the Live environment.

{% hint style="info" %}
If you don't have a web.config you will need to create one locally as well.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -131,11 +131,11 @@ There is no vulnerable data in this cookie and manipulating or stealing this coo

In the future, the cookie will be set to `HttpOnly` on Umbraco Cloud to conform to best practices. This does not mean that there's anything wrong with the current way it is set.

For more information see [the related GitHub issue](https://github.com/Azure/app-service-announcements/issues/12).
For more information see the [related GitHub issue](https://github.com/Azure/app-service-announcements/issues/12).

## Deny specific IPs from accessing your website

You can block people and bots(like a malicious scanning bot) from accessing your website by adding their IP addresses to a deny-list.
You can block people and bots (like a malicious scanning bot) from accessing your website by adding their IP addresses to a deny-list.

The following rule can be added to your web.config file in the `system.webServer/rewrite/rules/` section.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Umbraco Forms is part of the [auto-upgrades on Umbraco Cloud](../../optimize-and

To avoid having the auto-upgrades overwrite any of your custom settings, we strongly encourage that you use [config transforms](../../build-and-customize-your-solution/set-up-your-project/project-settings/config-transforms.md) when you need custom configuration. Additionally, use [Themes](https://docs.umbraco.com/umbraco-forms/developer/themes) when you need to customize your forms.

Whenever a new minor version of Umbraco Forms is ready, eg. 10.x or 11.x, you will get the option to apply the upgrade to your project. When your project is eligible to receive the new version, you will see an "_Upgrade available!_" label on your left-most environment.
When a new minor version of Umbraco Forms, like 10.x or 11.x, is available, you'll have the option to upgrade your project. When your project is eligible to receive the new version, you will see an "_Upgrade available!_" label on your left-most environment.

### Version-specific changes

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1003,7 +1003,7 @@ Other reasons for missing the upgrade:
* Active deployments during the upgrade attempt.
* Environments running different minor versions, such as one environment on 15.0.x and another on 15.1.x.

For more details, see the [Upgrades](../../optimize-and-maintain-your-site/manage-product-upgrades/product-upgrades/#the-process-of-auto-upgrading-a-umbraco-cloud-project) article.
For more details, see the [Upgrades](../../optimize-and-maintain-your-site/manage-product-upgrades/product-upgrades/README.md#the-process-of-auto-upgrading-a-umbraco-cloud-project) article.

### Do pending commits between environments derail the upgrade process?

Expand Down Expand Up @@ -1063,7 +1063,7 @@ By default, Umbraco Cloud supports HTTP/2.

No, this is not a security risk. The ARRAffinity cookie is set by the load balancer (LB) to track which server the site is on. It is a built-in feature of Azure App Service and is only useful when scaling to multiple servers. Since Umbraco Cloud does not scale sites across multiple servers, this cookie remains unused.

Learn more in our [Security](../../build-and-customize-your-solution/set-up-your-project/security/#cookies-and-security) article.
Learn more in our [Security](../../build-and-customize-your-solution/set-up-your-project/security/README.md#cookies-and-security) article.

### Can wildcard, EV, DV, or OV certificates be used on Umbraco Cloud?

Expand All @@ -1077,7 +1077,7 @@ This warning appears when domain bindings are not set up correctly. Check bindin

Yes. IP filtering can be added to control access. However, Umbraco Deploy must still communicate between environments, and the site should remain accessible locally.

Learn more and how to set it up in the [Security](../../build-and-customize-your-solution/set-up-your-project/security/#restrict-backoffice-access-using-ip-filtering) article.
Learn more and how to set it up in the [Security](../../build-and-customize-your-solution/set-up-your-project/security/README.md#deny-specific-ips-from-accessing-your-website) article.

### Does Umbraco Cloud use Transparent Data Encryption (TDE) for databases?

Expand Down Expand Up @@ -1181,7 +1181,7 @@ Yes, projects created in the EU region can be moved to another region. For more

You can choose a region from the **Region** drop-down list when creating a new project.

### Can a Baseline master project be in one region and a child project in another?
### Can a Baseline `master` project be in one region and a child project in another?

No. Baseline projects must remain within the same region.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Overview of Umbraco Cloud plans, resource quotas, and infrastructur

# Plans

Umbraco Cloud plans - Starter, Standard, and Professional - run on on shared infrastructure, referred to as pools. To ensure consistent performance and prevent resource exhaustion within a pool, each website is assigned a resource quota based on its plan. Resource usage is continuously monitored to maintain stability across all sites.
Umbraco Cloud plans - Starter, Standard, and Professional - run on shared infrastructure, referred to as pools. To ensure consistent performance and prevent resource exhaustion within a pool, each website is assigned a resource quota based on its plan. Resource usage is continuously monitored to maintain stability across all sites.

The shared resources used by Umbraco Cloud websites include:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ Umbraco Cloud will provide two DNS records:
| Record Type | Name | Value/Description |
|-------------|--------------------------------------|-----------------------------------------------------------------------------------------|
| TXT | `_cf-custom-hostname.\<hostname\>` | Provided by Umbraco Cloud |
| CNAME | `_acme-challenge.\<hostname\>` | Points to a domain under Umbraco's control (e.g., \<hostname\>.xxxx.dcv.cloudflare.com) |
| CNAME | `_acme-challenge.\<hostname\>` | Points to a domain under Umbraco's control (for example, `\<hostname\>.xxxx.dcv.cloudflare.com`) |

{% hint style="info" %}
DNS propagation times can vary. Changes may take a while to become active globally. Tools like https://www.nslookup.io/ can help verify that your records are live.
DNS propagation times can vary. Changes may take a while to become active globally. Tools like `https://www.nslookup.io/` can help verify that your records are live.
{% endhint %}

### 3. Check Validation Status
Expand Down Expand Up @@ -82,7 +82,7 @@ In a proxy case, you'll need to ensure that the URI `http://{custom-hostname}/.w

## Custom Certificate

If you plan to use a [custom certificate](security-certificates), the Hostname Pre-Validation method can be used to prove ownership of the hostname. This is done before binding the custom certificate.
If you plan to use a [custom certificate](security-certificates.md), the Hostname Pre-Validation method can be used to prove ownership of the hostname. This is done before binding the custom certificate.

You can do this by following these steps:

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Hotfixes

When managing an Umbraco Cloud project with multiple environments, you might need to push a hotfix to your Live environment. There might be a possiblity that you have pending changes in other environments that are not ready for deployment.
When managing an Umbraco Cloud project with multiple environments, you might need to push a hotfix to your Live environment. There might be a possibility that you have pending changes in other environments that are not ready for deployment.

## Scenario

Expand All @@ -18,8 +18,8 @@ Following Umbraco Cloud's workflow, you should never make changes directly to th

It is possible to apply specific changes to your Live environment without breaking Umbraco Cloud workflow. Here are two approaches:

1. [Deploy hotfix with Git branching](./#deploy-hotfix-with-git-branching)
2. [Move files manually](./#move-files-manually)
1. [Deploy hotfix with Git branching](#deploy-hotfix-with-git-branching)
2. [Move files manually](#move-files-manually)

## [Deploy hotfix with Git branching](using-git.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Before you push the newly created branch to Umbraco Cloud we need to change the
![Add Live as remote](images/live-remote.png)
3. You will be prompted to authenticate - use your Umbraco Cloud credentials.
4. You will see that the history from the Live repository is visible in the Git history.
5. Next step; hit **Push**.
6. Choose to push to the newly added remote, and write **master** to make sure you are pushing to the master branch on the Live environment.
5. Click **Push**.
6. Choose to push to the newly added remote, and write `master` to make sure you are pushing to the master branch on the Live environment.

![Choose remote](images/choose-remote.png)
7. Hit **Submit** and the push will start.
Expand Down
Loading