Improve dotnet templates

src/Umbraco.Infrastructure/Install/FilePermissionHelper.cs

@@ -51,7 +51,6 @@ public FilePermissionHelper(IOptions<GlobalSettings> globalSettings, IIOHelper i
         {
             hostingEnvironment.MapPathContentRoot(Constants.SystemDirectories.Bin),
             hostingEnvironment.MapPathContentRoot(Constants.SystemDirectories.Umbraco),
-            hostingEnvironment.MapPathWebRoot(_globalSettings.UmbracoPath),
             hostingEnvironment.MapPathContentRoot(Constants.SystemDirectories.Packages),
         };
     }

src/Umbraco.Web.UI/Program.cs

@@ -3,7 +3,9 @@
 builder.CreateUmbracoBuilder()
     .AddBackOffice()
     .AddWebsite()
+#if UseDeliveryApi
     .AddDeliveryApi()
+#endif
     .AddComposers()
     .Build();
 
@@ -23,6 +25,9 @@
     })
     .WithEndpoints(u =>
     {
+        /*#if (UmbracoRelease = 'LTS')
+        u.UseInstallerEndpoints();
+        #endif */
         u.UseBackOfficeEndpoints();
         u.UseWebsiteEndpoints();
     });

templates/Umbraco.Templates.csproj

@@ -19,6 +19,7 @@
     <Content Include="UmbracoPackage\**" Exclude="bin;obj" />
     <Content Include="UmbracoPackageRcl\**" Exclude="bin;obj" />
     <Content Include="UmbracoProject\**" Exclude="bin;obj" />
+    <Content Include="UmbracoDockerCompose\**" Exclude="bin;obj"/>
     <Content Include="..\src\Umbraco.Web.UI\Views\Partials\blocklist\**">
       <Link>UmbracoProject\Views\Partials\blocklist\%(RecursiveDir)%(Filename)%(Extension)</Link>
       <PackagePath>UmbracoProject\Views\Partials\blocklist</PackagePath>
@@ -47,7 +48,7 @@
       </_TemplateJsonFiles>
     </ItemGroup>
     <Copy SourceFiles="@(_TemplateJsonFiles)" DestinationFiles="%(DestinationFile)" />
-    <JsonPathUpdateValue JsonFile="%(_TemplateJsonFiles.DestinationFile)" Path="$.symbols.UmbracoVersion.defaultValue" Value="&quot;$(PackageVersion)&quot;" />
+    <JsonPathUpdateValue JsonFile="%(_TemplateJsonFiles.DestinationFile)" Path="$.symbols.FinalVersion.parameters.cases.[0].value" Value="&quot;$(PackageVersion)&quot;" />
     <ItemGroup>
       <_PackageFiles Include="%(_TemplateJsonFiles.DestinationFile)">
         <PackagePath>%(_TemplateJsonFiles.RelativeDir)</PackagePath>

templates/UmbracoDockerCompose/.env

@@ -0,0 +1 @@
+DB_PASSWORD=Password1234

templates/UmbracoDockerCompose/.template.config/dotnetcli.host.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "https://json.schemastore.org/dotnetcli.host.json",
+  "symbolInfo": {
+    "ProjectName": {
+      "longName": "ProjectName",
+      "shortName": "P"
+    },
+    "DatabasePassword": {
+      "longName": "DatabasePassword",
+      "shortName": "dbpw"
+    },
+    "Port":
+    {
+      "longName": "Port",
+      "shortName": "p"
+    }
+  },
+  "usageExamples": [
+    "dotnet new umbraco-compose -P MyProject",
+    "dotnet new umbraco-compose --ProjectName MyProject",
+    "dotnet new umbraco-compose -P -MyProject -dbpw MyStr0ngP@ssword",
+    "dotnet new umbraco-compose -P -MyProject --DatabasePassword MyStr0ngP@ssword"
+  ]
+}

templates/UmbracoDockerCompose/.template.config/ide.host.json

@@ -0,0 +1,23 @@
+{
+  "$schema": "https://json.schemastore.org/ide.host.json",
+  "order": 0,
+  "icon": "../../icon.png",
+  "description": {
+    "id": "UmbracoDockerCompose",
+    "text": "Umbraco Docker Compose - Docker compose for Umbraco CMS and associated database"
+  },
+  "symbolInfo": [
+    {
+      "id": "ProjectName",
+      "isVisible": true
+    },
+    {
+      "id": "DatabasePassword",
+      "isVisible": true
+    },
+    {
+      "id": "Port",
+      "isVisible": true
+    }
+  ]
+}

templates/UmbracoDockerCompose/.template.config/template.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://json.schemastore.org/template.json",
+  "author": "Umbraco HQ",
+  "classifications": [
+    "Web",
+    "CMS",
+    "Umbraco"
+  ],
+  "name": "Umbraco Docker Compose",
+  "description": "Creates the prerequisites for developing Umbraco in Docker containers",
+  "groupIdentity": "Umbraco.Templates.UmbracoDockerCompose",
+  "identity": "Umbraco.Templates.UmbracoDockerCompose",
+  "shortName": "umbraco-compose",
+  "tags": {
+    "type": "item"
+  },
+  "symbols": {
+    "ProjectName": {
+      "type": "parameter",
+      "description": "The name of the project the Docker Compose file will be created for",
+      "datatype": "string",
+      "replaces": "UmbracoProject",
+      "isRequired": true
+    },
+    "DatabasePassword": {
+      "type": "parameter",
+      "description": "The password to the database, will be stored in .env file",
+      "datatype": "string",
+      "replaces": "Password1234",
+      "defaultValue": "Password1234"
+    },
+    "Port": {
+      "type": "parameter",
+      "description": "The port forward on the docker container, this is the port you use to access the site",
+      "datatype": "string",
+      "replaces": "TEMPLATE_PORT",
+      "defaultValue": "44372"
+    },
+    "ImageName": {
+      "type": "generated",
+      "generator": "casing",
+      "parameters": {
+        "source": "ProjectName",
+        "toLower": true
+      },
+      "replaces": "umbraco_image"
+    }
+  }
+}

templates/UmbracoDockerCompose/Database/Dockerfile

@@ -0,0 +1,21 @@
+FROM mcr.microsoft.com/azure-sql-edge:latest
+
+ENV ACCEPT_EULA=Y
+
+USER root
+
+RUN mkdir /var/opt/sqlserver
+
+RUN chown mssql /var/opt/sqlserver
+
+ENV MSSQL_BACKUP_DIR="/var/opt/mssql"
+ENV MSSQL_DATA_DIR="/var/opt/mssql/data"
+ENV MSSQL_LOG_DIR="/var/opt/mssql/log"
+
+EXPOSE 1433/tcp
+COPY setup.sql /
+COPY startup.sh /
+COPY healthcheck.sh /
+
+ENTRYPOINT [ "/bin/bash", "startup.sh" ]
+CMD [ "/opt/mssql/bin/sqlservr" ]

templates/UmbracoDockerCompose/Database/healthcheck.sh

@@ -0,0 +1,15 @@
+value="$(/opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P "$SA_PASSWORD" -d master -Q "SELECT state_desc FROM sys.databases WHERE name = 'umbracoDb'" | awk 'NR==3')"
+
+# This checks for any non-zero length string, and $value will be empty when the database does not exist.
+if [ -n "$value" ]
+then
+  echo "ONLINE"
+  return 0 # With docker 0 = success
+else
+  echo "OFFLINE"
+  return 1 # And 1 = unhealthy
+fi
+
+# This is useful for debugging
+# echo "Value is:"
+# echo "$value"

templates/UmbracoDockerCompose/Database/setup.sql

@@ -0,0 +1,10 @@
+USE [master]
+GO
+
+IF NOT EXISTS (SELECT * FROM sys.databases WHERE name = 'UmbracoDb')
+    BEGIN
+        CREATE DATABASE [umbracoDb]
+    END;
+GO
+
+USE UmbracoDb;

templates/UmbracoDockerCompose/Database/startup.sh

@@ -0,0 +1,23 @@
+#!/bin/bash
+set -e
+
+# Taken from: https://github.com/CarlSargunar/Umbraco-Docker-Workshop
+if [ "$1" = '/opt/mssql/bin/sqlservr' ]; then
+  # If this is the container's first run, initialize the application database
+  if [ ! -f /tmp/app-initialized ]; then
+    # Initialize the application database asynchronously in a background process. This allows a) the SQL Server process to be the main process in the container, which allows graceful shutdown and other goodies, and b) us to only start the SQL Server process once, as opposed to starting, stopping, then starting it again.
+    function initialize_app_database() {
+      # Wait a bit for SQL Server to start. SQL Server's process doesn't provide a clever way to check if it's up or not, and it needs to be up before we can import the application database
+      sleep 15s
+
+      #run the setup script to create the DB and the schema in the DB
+      /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P "$SA_PASSWORD" -d master -i setup.sql
+
+      # Note that the container has been initialized so future starts won't wipe changes to the data
+      touch /tmp/app-initialized
+    }
+    initialize_app_database &
+  fi
+fi
+
+exec "$@"

templates/UmbracoDockerCompose/docker-compose.yml

@@ -0,0 +1,102 @@
+services:
+  umb_database:
+    container_name: umbraco_image_database
+    build:
+      context: ./Database
+    environment:
+      SA_PASSWORD: ${DB_PASSWORD}
+      MSSQL_SA_PASSWORD: ${DB_PASSWORD}
+    ports:
+      - "1433:1433"
+      - "1434:1434"
+    volumes:
+      - umb_database:/var/opt/mssql
+    networks:
+      - umbnet
+    healthcheck:
+      # This healthcheck is to make sure that the database is up and running before the umbraco container starts.
+      # It works by querying the database for the state of the umbracoDb database, ensuring it exists.
+      test: ./healthcheck.sh
+      interval: 5m
+      timeout: 5s
+      retries: 3
+      start_period: 15s # Bootstrap duration, for this duration failures does not count towards max retries.
+      start_interval: 5s # How long after the health check has started to run the healthcheck again.
+
+  umbraco_image:
+    image: umbraco_image
+    environment:
+        - ASPNETCORE_ENVIRONMENT=Development
+        - ConnectionStrings__umbracoDbDSN=Server=umb_database;Database=umbracoDb;User Id=sa;Password=${DB_PASSWORD};TrustServerCertificate=true;
+        - ConnectionStrings__umbracoDbDSN_ProviderName=Microsoft.Data.SqlClient
+    volumes:
+      - umb_media:/app/wwwroot/media
+      - umb_scripts:/app/wwwroot/scripts
+      - umb_styles:/app/wwwroot/css
+      - umb_logs:/app/umbraco/Logs
+      - umb_views:/app/Views
+      - umb_data:/app/umbraco
+      - umb_models:/app/umbraco/models
+    build:
+      context: .
+      dockerfile: UmbracoProject/Dockerfile
+      args:
+        - BUILD_CONFIGURATION=Debug
+
+    depends_on:
+      umb_database:
+        condition: service_healthy
+    restart: always
+    ports:
+      - "TEMPLATE_PORT:8080"
+    networks:
+      - umbnet
+    develop:
+      # This allows you to run docker compose watch, after doing so the container will rebuild when the models are changed.
+      # Once a restart only feature is implemented (https://github.com/docker/compose/issues/11446)
+      # It would be really nice to add a restart only watch to \Views, since the file watchers for recompilation of Razor views does not work with docker.
+      watch:
+        - path: ./UmbracoProject/umbraco/models
+          action: rebuild
+
+# These volumes are all made as bind mounts, meaning that they are bound to the host machine's file system.
+# This is to better facilitate local development in the IDE, so the views, models, etc... are available in the IDE.
+# This can be changed by removing the driver and driver_opts from the volumes.
+volumes:
+  umb_media:
+    driver: local
+    driver_opts:
+      type: none
+      device: ./UmbracoProject/wwwroot/media
+      o: bind
+  umb_scripts:
+    driver: local
+    driver_opts:
+      type: none
+      device: ./UmbracoProject/wwwroot/scripts
+      o: bind
+  umb_styles:
+    driver: local
+    driver_opts:
+      type: none
+      device: ./UmbracoProject/wwwroot/css
+      o: bind
+  umb_logs:
+  umb_views:
+    driver: local
+    driver_opts:
+      type: none
+      device: ./UmbracoProject/Views
+      o: bind
+  umb_data:
+  umb_models:
+    driver: local
+    driver_opts:
+      type: none
+      device: ./UmbracoProject/umbraco/models
+      o: bind
+  umb_database:
+
+networks:
+  umbnet:
+    driver: bridge

templates/UmbracoProject/.dockerignore

@@ -0,0 +1,25 @@
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.idea
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/bin
+**/charts
+**/docker-compose*
+**/Dockerfile*
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+LICENSE
+README.md

templates/UmbracoProject/.template.config/dotnetcli.host.json

@@ -8,12 +8,25 @@
     },
     "UmbracoVersion": {
       "longName": "version",
-      "shortName": "v"
+      "shortName": "v",
+      "isHidden": true
+    },
+    "UmbracoRelease": {
+      "longName": "release",
+      "shortName": "r"
     },
     "UseHttpsRedirect": {
       "longName": "use-https-redirect",
       "shortName": ""
     },
+    "UseDeliveryApi": {
+      "longName": "use-delivery-api",
+      "shortName": "da"
+    },
+    "Docker": {
+      "longName": "add-docker",
+      "shortName": ""
+    },
     "SkipRestore": {
       "longName": "no-restore",
       "shortName": ""
@@ -58,6 +71,18 @@
       "longName": "PackageTestSiteName",
       "shortName": "p",
       "isHidden": true
+    },
+    "ModelsBuilderMode": {
+      "longName": "models-mode",
+      "shortName": "mm"
+    },
+    "StarterKit": {
+      "longName": "starter-kit",
+      "shortName": "sk"
+    },
+    "DevelopmentMode": {
+      "longName": "development-mode",
+      "shortName": "dm"
     }
   },
   "usageExamples": [