# System requirements

Choose the frontend and API deployment requirements before deployment.

## Before you start

The authenticated **Home** route is not a deployment-settings screen. Use the deployment
configuration below when preparing an environment.

![The authenticated Home route, separate from deployment settings](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/92c84c4d1016e6185b3a63a6d8c80ec6.png)

> **Note:** Do not use **Home** to configure deployment requirements.

| If you need to… | Go to |
| --- | --- |
| Identify the deployment definitions to use | [Find the deployment definitions](#find-the-deployment-definitions) |
| Choose frontend and API configuration | [Understand the deployment baseline](#understand-the-deployment-baseline) |
| Prepare the frontend image | [Prepare the frontend deployment](#prepare-the-frontend-deployment) |
| Prepare the API image and writable paths | [Prepare the API deployment](#prepare-the-api-deployment) |
| Apply configuration to development or production | [Handle development and production deployments](#handle-development-and-production-deployments) |
| Resolve an unsupported operating-system, database, sizing, or browser-version question | [When a requirement is missing](#when-a-requirement-is-missing) |
| Check the authenticated application entry point | [Check the application entry point](#check-the-application-entry-point) |
| Continue with sign-in orientation | [Your first day](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/your-first-day) |
| Find approved support guidance | [Getting help](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/getting-help) |

## Find the deployment definitions

Select the runtime, build, container, and browser settings from the deployment components below.

| Deployment area | Definition to locate | Deployment decision |
| --- | --- | --- |
| Frontend package | Package declaration | Select the Angular package line and TypeScript version. |
| Frontend container | Container definition | Select the build image, web server image, exposed port, and process mode. |
| API project | Project declaration | Select the API target framework. |
| API container | Image definition | Select the Windows container image. |
| API writable paths | API container access setup | Prepare the API's writable locations. |
| Browser support | Frontend browser-support configuration | Use the supported browser families. |

Use the definitions you locate to apply the baseline below.

## Understand the deployment baseline

Configure the frontend package and container, API target and container, API writable paths, and
browser family with the following baseline.

| Area | Required configuration |
| --- | --- |
| Frontend build | Angular packages are declared at `16.2.x`; TypeScript is `4.9.3`. |
| Frontend container | The image builds with `node:16`, serves through `fholzer/nginx-brotli:latest`, exposes port `80`, and starts nginx in the foreground. |
| API target | The API project targets .NET Framework `v4.6`. |
| API container | The image uses `mcr.microsoft.com/dotnet/framework/aspnet:4.8-windowsservercore-ltsc2022`. |
| API writable paths | The image creates `C:\Data`, grants IIS identities full access, and grants access to `Content` when that folder exists. |
| Browser family | The frontend polyfills describe recent Safari, Chrome, Opera, Edge, and iOS and Chrome on mobile. |

Request owner approval before choosing a production operating-system edition outside the API base
image, database-server version, database sizing, CPU, memory, storage, network sizing, or browser
version number. Do not derive those settings from the browser families or container base image.

Use the procedures below to prepare the frontend and API deployments.

## Prepare the frontend deployment

Use this procedure to select the frontend build and serving requirements.

Prerequisites

- The frontend repository and its container definition are available.
- The deployment process can build the declared frontend package.
- Port `80` is available for the frontend container.

Steps

1. Set the frontend Angular package line to `16.2.x`.
2. Set the frontend TypeScript version to `4.9.3`.
3. Configure the frontend build stage to use `node:16`.
4. Configure the frontend server stage to use `fholzer/nginx-brotli:latest`.
5. Set the frontend container port to `80`.
6. Set nginx to run in the foreground.

**Result:** The frontend uses the defined Angular, TypeScript, Node, nginx, port, and
foreground-process settings.

Next, prepare the API deployment.

## Prepare the API deployment

Use this procedure to select the API target, image, and writable paths.

Prerequisites

- The API project and its container definition are available.
- A Windows container environment can use the declared API image.
- The deployment process can create and grant access to the declared writable paths.

Steps

1. Set the API target to .NET Framework `v4.6`.
2. Configure the API image to use `mcr.microsoft.com/dotnet/framework/aspnet:4.8-windowsservercore-ltsc2022`.
3. Configure the API image to create `C:\Data`.
4. Set IIS identity permissions on `C:\Data` to full access.
5. Set API access to `Content` when that folder exists.

**Result:** The API uses the defined .NET Framework target, Windows container image, and
writable-path settings.

Next, apply both preparations to the selected deployment mode.

## Handle development and production deployments

Use the same packaging and runtime choices when preparing development or production deployment.
Request owner approval for any mode-specific configuration.

| Deployment area | Use this defined choice | Owner decision still required |
| --- | --- | --- |
| Frontend runtime and packaging | Angular `16.2.x`, TypeScript `4.9.3`, `node:16`, nginx Brotli, port `80`, and foreground nginx | Any separate development or production configuration |
| API runtime and packaging | .NET Framework `v4.6`, the Windows Server Core API image, and writable-path setup | Any separate development or production configuration |
| Browser support | Recent Safari, Chrome, Opera, Edge, and iOS and Chrome on mobile | A supported browser version number |
| Infrastructure sizing | No sizing value is defined | CPU, memory, storage, or network requirements |

Prerequisites

- The development or production deployment target is selected.
- The frontend and API deployment definitions are available.

Steps

1. Set the frontend build image to `node:16`; see [Prepare the frontend deployment](#prepare-the-frontend-deployment).
2. Set the frontend server image to `fholzer/nginx-brotli:latest`; see [Prepare the frontend deployment](#prepare-the-frontend-deployment).
3. Set the frontend container port to `80`.
4. Set nginx to run in the foreground.
5. Set the API runtime target to .NET Framework `v4.6`; see [Prepare the API deployment](#prepare-the-api-deployment).
6. Set the API image to `mcr.microsoft.com/dotnet/framework/aspnet:4.8-windowsservercore-ltsc2022`; see [Prepare the API deployment](#prepare-the-api-deployment).
7. Set the API writable paths as described in [Prepare the API deployment](#prepare-the-api-deployment).
8. Apply the same runtime, image, port, and writable-path settings to the selected deployment mode.
9. Ask the deployment owner to approve each mode-specific operating-system, database, sizing, or browser setting.

**Result:** The deployment uses the defined frontend and API baseline, while mode-specific settings
are separated for owner approval.

## When a requirement is missing

Use the table below when a deployment decision has no defined value.

| Deployment decision | Required action |
| --- | --- |
| Production operating-system edition outside the API base image | Obtain an owner-approved edition before deployment. |
| Database-server version | Obtain an owner-approved version before deployment. |
| CPU, memory, storage, or network capacity | Obtain owner-approved sizing before deployment. |
| Supported browser version | Obtain an owner-approved version; the listed browser families are not a version requirement. |
| Runtime data for dashboard column sets | Treat the runtime data requirement as a deployment dependency, not as a dashboard setting. |

Continue with [Getting help](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/getting-help) when a deployment owner must approve a decision.

After the deployment decisions are approved, check the authenticated application entry point.

## Check the application entry point

The authenticated application entry point is the **Home** route at `/home`.

The **Home** route requires authentication. After deployment, use the authenticated entry point to
continue with [Your first day](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/your-first-day) for first sign-in orientation.

**Result:** The application entry point is the authenticated `/home` route.
