diff --git a/umbraco-cloud/getting-started/the-umbraco-cloud-portal/README.md b/umbraco-cloud/getting-started/the-umbraco-cloud-portal/README.md index 3836beaf4b7..6e2d1e2bcb0 100644 --- a/umbraco-cloud/getting-started/the-umbraco-cloud-portal/README.md +++ b/umbraco-cloud/getting-started/the-umbraco-cloud-portal/README.md @@ -122,21 +122,3 @@ In the Umbraco Cloud portal, you can find a link to the **Release Notes** in the ### Logout The Logout option allows you to securely log out of your Umbraco Cloud account. - -## Environment error log - -Each environment has an error log that appears only if there are any unread errors in that specific environment. You can view the errors by clicking on **View errors** in the environment menu. - -Once you're there, you can manually mark each error as read which will move it from the "New" section to the "Read" section. Errors marked as read will be permanently deleted after 30 days. - -During development, you can happen to gather a large number of errors which might cause the error page to load slowly. A fix for that would be to locally connect to the database for that specific environment and delete the errors. You can read more about connecting to the environment database locally in the section about [Database on Umbraco Cloud](../../databases/cloud-database/). - -Environment errors are stored in the `UCErrorLog` table. - -The query below will delete 90% of the errors. The query will always delete the oldest errors first. You can tweak the query to delete any percentage of errors by changing the number in the first row. - -```sql -DELETE TOP(90) PERCENT - FROM [dbo].[UCErrorLog] - WHERE [Read] = 0 -``` diff --git a/umbraco-cloud/set-up/images/advanced-settings.png b/umbraco-cloud/set-up/images/advanced-settings.png new file mode 100644 index 00000000000..ff3e8ea487f Binary files /dev/null and b/umbraco-cloud/set-up/images/advanced-settings.png differ diff --git a/umbraco-cloud/set-up/images/automatic-upgrades.png b/umbraco-cloud/set-up/images/automatic-upgrades.png new file mode 100644 index 00000000000..eaafe70c9b5 Binary files /dev/null and b/umbraco-cloud/set-up/images/automatic-upgrades.png differ diff --git a/umbraco-cloud/set-up/images/availability-performance.png b/umbraco-cloud/set-up/images/availability-performance.png new file mode 100644 index 00000000000..eeef035f6cc Binary files /dev/null and b/umbraco-cloud/set-up/images/availability-performance.png differ diff --git a/umbraco-cloud/set-up/images/backups.png b/umbraco-cloud/set-up/images/backups.png new file mode 100644 index 00000000000..8946d3f8787 Binary files /dev/null and b/umbraco-cloud/set-up/images/backups.png differ diff --git a/umbraco-cloud/set-up/images/cdn-caching.png b/umbraco-cloud/set-up/images/cdn-caching.png new file mode 100644 index 00000000000..2fb2eb31e05 Binary files /dev/null and b/umbraco-cloud/set-up/images/cdn-caching.png differ diff --git a/umbraco-cloud/set-up/images/certificates.png b/umbraco-cloud/set-up/images/certificates.png new file mode 100644 index 00000000000..c650aaa7720 Binary files /dev/null and b/umbraco-cloud/set-up/images/certificates.png differ diff --git a/umbraco-cloud/set-up/images/connections.png b/umbraco-cloud/set-up/images/connections.png new file mode 100644 index 00000000000..69f4f80c336 Binary files /dev/null and b/umbraco-cloud/set-up/images/connections.png differ diff --git a/umbraco-cloud/set-up/images/dedicated-resources.png b/umbraco-cloud/set-up/images/dedicated-resources.png new file mode 100644 index 00000000000..c9f13316d1f Binary files /dev/null and b/umbraco-cloud/set-up/images/dedicated-resources.png differ diff --git a/umbraco-cloud/set-up/images/delete-project.png b/umbraco-cloud/set-up/images/delete-project.png new file mode 100644 index 00000000000..42b45fe1a20 Binary files /dev/null and b/umbraco-cloud/set-up/images/delete-project.png differ diff --git a/umbraco-cloud/set-up/images/environments-new.png b/umbraco-cloud/set-up/images/environments-new.png new file mode 100644 index 00000000000..17a87199b2e Binary files /dev/null and b/umbraco-cloud/set-up/images/environments-new.png differ diff --git a/umbraco-cloud/set-up/images/hostnames.png b/umbraco-cloud/set-up/images/hostnames.png new file mode 100644 index 00000000000..5083411c061 Binary files /dev/null and b/umbraco-cloud/set-up/images/hostnames.png differ diff --git a/umbraco-cloud/set-up/images/management-api-security.png b/umbraco-cloud/set-up/images/management-api-security.png new file mode 100644 index 00000000000..795ac0c5f47 Binary files /dev/null and b/umbraco-cloud/set-up/images/management-api-security.png differ diff --git a/umbraco-cloud/set-up/images/project-history.png b/umbraco-cloud/set-up/images/project-history.png new file mode 100644 index 00000000000..50dda6ab1fd Binary files /dev/null and b/umbraco-cloud/set-up/images/project-history.png differ diff --git a/umbraco-cloud/set-up/images/public-access.png b/umbraco-cloud/set-up/images/public-access.png new file mode 100644 index 00000000000..87c572c18ed Binary files /dev/null and b/umbraco-cloud/set-up/images/public-access.png differ diff --git a/umbraco-cloud/set-up/images/rename-project.png b/umbraco-cloud/set-up/images/rename-project.png new file mode 100644 index 00000000000..2b2714fcf16 Binary files /dev/null and b/umbraco-cloud/set-up/images/rename-project.png differ diff --git a/umbraco-cloud/set-up/images/secrets.png b/umbraco-cloud/set-up/images/secrets.png new file mode 100644 index 00000000000..c3c79f3d0d0 Binary files /dev/null and b/umbraco-cloud/set-up/images/secrets.png differ diff --git a/umbraco-cloud/set-up/images/settings-menu.png b/umbraco-cloud/set-up/images/settings-menu.png new file mode 100644 index 00000000000..70f32ef03fc Binary files /dev/null and b/umbraco-cloud/set-up/images/settings-menu.png differ diff --git a/umbraco-cloud/set-up/images/summary-details.png b/umbraco-cloud/set-up/images/summary-details.png new file mode 100644 index 00000000000..2c8dc93a214 Binary files /dev/null and b/umbraco-cloud/set-up/images/summary-details.png differ diff --git a/umbraco-cloud/set-up/images/transport-security.png b/umbraco-cloud/set-up/images/transport-security.png new file mode 100644 index 00000000000..13e606fe9c5 Binary files /dev/null and b/umbraco-cloud/set-up/images/transport-security.png differ diff --git a/umbraco-cloud/set-up/images/upgrade-project.png b/umbraco-cloud/set-up/images/upgrade-project.png new file mode 100644 index 00000000000..779f4adb17d Binary files /dev/null and b/umbraco-cloud/set-up/images/upgrade-project.png differ diff --git a/umbraco-cloud/set-up/images/usage-new.png b/umbraco-cloud/set-up/images/usage-new.png new file mode 100644 index 00000000000..32b73c0e1d1 Binary files /dev/null and b/umbraco-cloud/set-up/images/usage-new.png differ diff --git a/umbraco-cloud/set-up/images/webhooks.png b/umbraco-cloud/set-up/images/webhooks.png new file mode 100644 index 00000000000..329d58666ec Binary files /dev/null and b/umbraco-cloud/set-up/images/webhooks.png differ diff --git a/umbraco-cloud/set-up/project-settings/README.md b/umbraco-cloud/set-up/project-settings/README.md index cc427a51cf1..fa453767a23 100644 --- a/umbraco-cloud/set-up/project-settings/README.md +++ b/umbraco-cloud/set-up/project-settings/README.md @@ -1,160 +1,219 @@ # Project Settings -When working with an Umbraco Cloud project, you can handle a lot of the project configuration directly in the Umbraco Cloud Portal. You can manage the following configurations from the left-side menu: +When working with an Umbraco Cloud project, you can handle the project configuration directly in the Umbraco Cloud Portal. You can manage the following configurations from the left-side menu: -

Settings menu

+![Settings menu](../images/settings-menu.png) ## Overview -### **Environments** +### Environments -See an overview of your environments for your project as well as access the frontend, backend, or clone down the environment. +The Environments section provides an overview of your project’s environments. Here, you can: -
+* Access the Website (frontend) and backend, +* Open Kudu, and +* Clone down the environment locally. -### **Team** +![Environments Overview](../images/environments-new.png) -See who is added to your project, add new Team members, backoffice users and technical contacts, and pending invites. +#### Environment error log -
+Each environment has an error log that appears only if there are any unread errors in that specific environment. You can view the errors by clicking on **Error logs** in the environment menu. +In the Error logs page, you can manually mark each error as read which will move it from the "New" section to the "Read" section. Errors marked as read will be permanently deleted after 30 days. +During development, too many errors can slow down the error page. To fix this, connect to the environment's database locally and delete the errors. Learn how to connect to the database in the [Database on Umbraco Cloud](../../databases/cloud-database/) section. -### Summary +Environment errors are stored in the `UCErrorLog` table. + +The query below deletes 90% of the errors. The query always deletes the oldest errors first. You can tweak the query to delete any percentage of errors by changing the number in the first row. + +```sql +DELETE TOP(90) PERCENT + FROM [dbo].[UCErrorLog] + WHERE [Read] = 0 +``` + +### Team -You can view the **Summary** of your Umbraco Cloud project in the **overview** menu under Summary. +The Team section allows you to: -
Project Overview

Project Summary

+* Manage team members and their permissions on different environments. +* Add new team members. +* Manage backoffice user groups and [Technical contacts](team-members/technical-contact.md) for your project. +* Monitor pending project invitations. + +
+ +### Summary -### [Edit team](team-members/) +The **Summary** section displays key information such as the project plan, the region where the project was created, payment status, and more. -Manage the team members and user permissions on your project. You can also view the backoffice user groups for each team member, view pending project invites, and manage [Technical contacts](team-members/technical-contact.md) for your project. +![Project Summary](../images/summary-details.png) ## Insights ### [Project History](project-history.md) -On the project history page, you can see a history of activities that have happened on your projects. +In the Project History section, you can view a list of high-level activities for your cloud project. + +![Project History](../images/project-history.png) ### [Availability & Performance](availability-performance.md) -You can see metrics related to the overall health and performance of the Azure app service hosting the live environment of your solution. +You can see metrics related to the overall health and performance of the Azure app service hosting the different environments of your solution. + +![Availability & Performance](../images/availability-performance.png) ### [Usage](usage.md) -On your Umbraco Cloud project, it is possible to see the usage of Custom Domains, Media Storage, Content Nodes, and Bandwidth for the project. You can also check if it is using above or below the allowed amount for the plan that your project is on. +The Usage section allows you to: + +* View the usage of Custom Domains, Media Storage, Bandwidth, and Bandwidth History for your project. +* Check whether the project is using above or below the allowed amount for its plan. +* View the top 10 bandwidth usage paths, referrers, and the top 50 media files. + +![Usage](../images/usage-new.png) ## Configuration -### [Connection details](../../databases/) +### [Connections](../../databases/) -Find connection details to your Umbraco Cloud databases. You need to allow your IP to connect to the databases with your local machine. +The Connections section provides connection details for your Umbraco Cloud databases. You need to allow your IP to connect to the databases with your local machine. + +![Connections](../images/connections.png) ### [Automatic Upgrades](../../product-upgrades/minor-upgrades.md) -We handle minor and patch upgrades for the Umbraco components used by Umbraco Cloud, so you don't have to. From the Automatic Upgrades page, you can control if you want to opt in or out of automatic minor upgrades. +The Automatic Upgrades section handles minor and patch upgrades for the Umbraco components used by Umbraco Cloud. By default, new projects are opt-in for these upgrades. -New projects are opt-in by default. +From this page, you can manage whether your site is automatically upgraded to the latest minor version(s) of the Cloud products. To learn more about automatic upgrades, visit the [Upgrades](../../product-upgrades/README.md) section. -### [CDN Caching and Optimization](manage-cdn-caching.md) +![Automatic Upgrades](../images/automatic-upgrades.png) -Manage CDN Cache settings for your project. You can modify default settings, which apply to all hostnames added to the current Project. Alternatively, you can set up specific settings per hostname, if you want to have different settings for certain hostnames. +### [CDN & Caching](manage-cdn-caching.md) -### [Hostnames](manage-hostnames/) +The CDN & Caching section lets you manage CDN Caching and Optimization settings for your project. +You can: + +* Modify the default settings that apply to all hostnames added to the project. +* Set specific caching settings per hostname if different configurations are required for certain hostnames. +* Purge Cache for individual hostnames or all of them. + +![CDN & Caching](../images/cdn-caching.png) -Binding hostnames to your Umbraco Cloud project is done from the **Hostnames** section in the **Configuration** menu on the Umbraco Cloud Portal. +### [Hostnames](manage-hostnames/) -### [Certificates](manage-hostnames/security-certificates.md) (Only available on **Professional** or **Enterprise** plan) +In the Hostnames section, you can bind hostnames to your Umbraco Cloud project. -If you have your own custom certificate, you can upload and bind it to your custom hostnames. This can be done instead of using the TLS: Transport Layer Security (HTTPS) certificates provided by the Umbraco Cloud service. +![Hostnames](../images/hostnames.png) ### [Webhooks](../../deployment/deployment-webhook.md) -It is possible to configure a deployment webhook on your environments on Umbraco Cloud projects. This will be triggered upon successful deployments, you can configure where you would like information about the deployment to be posted. +You can configure deployment webhooks for your environments in this section. Webhooks are triggered upon successful deployments, and you can specify where the deployment information is sent. + +![Webhooks](../images/webhooks.png) ### Advanced -Manage **Advanced** settings for your project from the **Configuration** tab: +The Advanced section provides options for managing advanced settings for your project, including: -* [CI/CD Flow](umbraco-cicd/) -* [Enable static outbound IP addresses](external-services.md#enabling-static-outbound-ip-addresses) for projects on a **Standard**, **Professional**, or **Enterprise** plan. -* Enable IIS logging for each of your environments. The log files can be accessed through kudu in `C:\home\LogFiles\http`. There is a rolling size limit on the log files of 100 MB. Once the limit is reached, the oldest log files will be overwritten by new ones. +* [Umbraco CI/CD Flow](umbraco-cicd/) +* [Enable static outbound IP addresses](external-services.md#enabling-static-outbound-ip-addresses) for projects on **Standard**, **Professional**, or **Enterprise** plans. +* Enable IIS logging for each environment. The log files can be accessed in Kudu at `C:\home\LogFiles\http`. IIS logs have a rolling size limit of 100 MB, overwriting the oldest files once the limit is reached. * [Enable loading of a client certificate from the file system](application-settings.md#enable-client-certificate-loaded-from-file-system-explained). -* Change .NET framework runtime for your Umbraco installation for each environment of your cloud project. +* Change the .NET framework runtime for each environment of your Umbraco Cloud project. {% hint style="info" %} -When enabling IIS logging, the site will have to restart. For more information about IIS logging, look at the [Official Microsoft Documentation](https://docs.microsoft.com/en-us/iis/configuration/system.webserver/httplogging). +Enabling IIS logging will cause the site to restart. For additional information, refer to the [Microsoft Documentation](https://docs.microsoft.com/en-us/iis/configuration/system.webserver/httplogging). {% endhint %} -

Advanced Settings

+![Advanced Settings](../images/advanced-settings.png) ### [Backups](../../databases/backups.md#backup-on-umbraco-cloud) -With this setting, it is possible to create a database backup of one or more of your cloud environments. +The Backups section enables you to create database backups for one or more of your cloud environments. + +![Backups](../images/backups.png) ## Security -### [Public access](public-access.md) +### [Public Access](public-access.md) {% hint style="info" %} -Public access is by default available for projects created after the 10th of January 2023. +By default, Public access is available for projects created after the 10th of January 2023. The [Umbraco.Cloud.Cms.PublicAccess](https://www.nuget.org/packages/Umbraco.Cloud.Cms.PublicAccess) package can be installed to enable Public access for projects created before the 10th of January 2023. {% endhint %} -You can deny access to your project with the Public access setting under the security tab. +The Public access setting, found under the Security tab, allows you to deny access to your project. Users who are not part of the project or whose IP addresses have not been allowed will not be able to access the project. -Users who are not part of the project or whose IP has not been allowed will not be able to access the project. +You can enable or disable this setting on the Public access page. Access to manage Public access requires your project to be on the Standard plan or higher. -You can disable/enable it with one click on the Public access page. - -Access to manage Public access requires your project to be on the Standard plan or higher. +![Public Access](../images/public-access.png) ### [Transport Security](manage-security.md) -Manage transport security settings for your project. You can configure certain transport security options for all hostnames or specific hostnames within your project. +The Transport Security section enables you to manage transport security settings for your project. You can configure specific transport security options for all hostnames or individual hostnames within your project. + +![Transport Security](../images/transport-security.png) ### [Management API Security](management-api-security.md) -Securing access to back-end services of your project can be done from the **Security** menu on the Umbraco Cloud Portal. +The Management API Security section allows you to secure access to the backend services of your project. This can be managed from the Security menu on the Umbraco Cloud Portal. -### [Secrets Management](secrets-management.md) +![Management API Security](../images/management-api-security.png) + +### [Certificates](manage-hostnames/security-certificates.md) + +{% hint style="info" %} +This feature is only available on **Professional** or **Enterprise** plan. +{% endhint %} -If your Umbraco Cloud project uses sensitive information such as API keys, encryption keys, and connection strings, it is recommended to store these as secrets.\ +If you have a custom certificate, you can upload and bind it to your custom hostnames. This can be done instead of using the TLS: Transport Layer Security (HTTPS) certificates provided by the Umbraco Cloud service. +![Certificates](../images/certificates.png) + +### [Secrets](secrets-management.md) + +The Secrets Management section is used for storing sensitive information such as API keys, encryption keys, and connection strings used by your Umbraco Cloud project. + +![Secrets](../images/secrets.png) ## Management -### Upgrade Plan +### [Dedicated Resources](dedicated-resources.md) + +You can change your Umbraco Cloud project to run in a dedicated setup with additional computational resources compared to the shared setup. You can choose between different dedicated options depending on the number of resources you will need for your project. -You can upgrade your project to a **Standard** or a **Professional** plan, from the **Settings** menu, depending on your needs. The option is not available if you are already on the specific plan or if you are running in **Trial** mode. +![Dedicated Resources](../images/dedicated-resources.png) -### Rename project +### Upgrade Project -You can rename your Umbraco Cloud project from the **Management tab** in the menu. +You can upgrade your project to a **Standard** or a **Professional** plan from the **Management** menu, depending on your needs. The option is not available if you are already on a specific plan or if you are running in **Trial** mode. -
+![Upgrade Project](../images/upgrade-project.png) -
Rename project

Rename project

+### Rename Project -
+You can rename your Umbraco Cloud project from the **Management** menu. {% hint style="info" %} -If you are working locally, you need to update the origin of your local git repository to point to the new clone URL. Alternatively, you can make a fresh local clone of the project, once you’ve changed your project name. +If you are working locally, you need to update the origin of your local git repository to point to the new clone URL. Alternatively, you can make a fresh local clone of the project once you’ve changed your project name. {% endhint %} -### [Renaming the Project file and folder](../working-locally.md#renaming-the-project-files-and-folders) - -You can rename your project from the **Rename Project** section in the **Management tab** menu on the Umbraco Cloud Portal. When you rename a project, the default hostnames and clone URLs assigned to the project are updated to match the new project name. You can also rename your project files and folders locally. +![Rename Project](../images/rename-project.png) -### [Dedicated Resources](dedicated-resources.md) +#### [Renaming the Project file and folder](../working-locally.md#renaming-the-project-files-and-folders) -You can change your Umbraco Cloud project to run in a dedicated setup with additional computational resources compared to the shared setup. You can choose between the different dedicated options depending on the number of resources you will need for your project. +You can rename your project from the **Rename Project** section in the **Management** menu on the Umbraco Cloud Portal. When you rename a project, the default hostnames and clone URLs assigned to the project are updated to match the new project name. You can also rename your project files and folders locally. ### Delete Project -You can delete your Umbraco Cloud project from the **Management tab** menu. Deleting your Umbraco Cloud project is permanent - all data, media, databases, configuration, setup, and domain bindings are removed in the process. +You can delete your Umbraco Cloud project from the **Management** menu. Deleting your Umbraco Cloud project is permanent - all data, media, databases, configuration, setup, and domain bindings are removed in the process. {% hint style="info" %} Deleting your Umbraco Cloud project will also cancel any subscriptions you have set up for the project. {% endhint %} + +![Delete Project](../images/delete-project.png)