# ProjectConfig Schema

```txt
https://ns.adobe.com/helix/config/project
```



| Abstract            | Extensible | Status         | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                      |
| :------------------ | :--------- | :------------- | :----------- | :---------------- | :-------------------- | :------------------ | :------------------------------------------------------------------------------ |
| Can be instantiated | No         | Unknown status | No           | Forbidden         | Forbidden             | none                | [project-config.schema.json](project-config.schema.json "open original schema") |

## ProjectConfig Type

`object` ([ProjectConfig](project-config.md))

# ProjectConfig Properties

| Property                | Type     | Required | Nullable       | Defined by                                                                                                                    |
| :---------------------- | :------- | :------- | :------------- | :---------------------------------------------------------------------------------------------------------------------------- |
| [name](#name)           | `string` | Optional | cannot be null | [ProjectConfig](project-config-properties-name.md "https://ns.adobe.com/helix/config/project#/properties/name")               |
| [project](#project)     | `string` | Optional | cannot be null | [ProjectConfig](project-config-properties-project.md "https://ns.adobe.com/helix/config/project#/properties/project")         |
| [timezone](#timezone)   | `string` | Optional | cannot be null | [ProjectConfig](project-config-properties-timezone.md "https://ns.adobe.com/helix/config/project#/properties/timezone")       |
| [host](#host)           | `string` | Optional | cannot be null | [ProjectConfig](project-config-properties-host.md "https://ns.adobe.com/helix/config/project#/properties/host")               |
| [blueprint](#blueprint) | `string` | Optional | cannot be null | [ProjectConfig](project-config-properties-blueprint.md "https://ns.adobe.com/helix/config/project#/properties/blueprint")     |
| [slack](#slack)         | Merged   | Optional | cannot be null | [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/slack")           |
| [metadata](#metadata)   | Merged   | Optional | cannot be null | [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/metadata")        |
| [cdn](#cdn)             | `object` | Optional | cannot be null | [ProjectConfig](project-config-cdn.md "https://ns.adobe.com/helix/config/cdn#/properties/cdn")                                |
| [access](#access)       | `object` | Optional | cannot be null | [ProjectConfig](project-config-properties-siteaccessconfig.md "https://ns.adobe.com/helix/config/project#/properties/access") |
| [admin](#admin)         | `object` | Optional | cannot be null | [ProjectConfig](project-config-properties-adminconfig.md "https://ns.adobe.com/helix/config/project#/properties/admin")       |

## name

Name of the project used by the slack bot when reporting.

`name`

*   is optional

*   Type: `string`

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-name.md "https://ns.adobe.com/helix/config/project#/properties/name")

### name Type

`string`

## project

Name of the project used by the sidekick.

`project`

*   is optional

*   Type: `string`

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-project.md "https://ns.adobe.com/helix/config/project#/properties/project")

### project Type

`string`

## timezone

Timezone to be used by the slack bot when reporting times.

`timezone`

*   is optional

*   Type: `string`

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-timezone.md "https://ns.adobe.com/helix/config/project#/properties/timezone")

### timezone Type

`string`

### timezone Examples

```yaml
Europe/Zurich

```

## host

Production host use by the slack bot to display project information.

`host`

*   is optional

*   Type: `string`

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-host.md "https://ns.adobe.com/helix/config/project#/properties/host")

### host Type

`string`

## blueprint

configuration blueprint repository in the owner/repo format.

`blueprint`

*   is optional

*   Type: `string`

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-blueprint.md "https://ns.adobe.com/helix/config/project#/properties/blueprint")

### blueprint Type

`string`

### blueprint Examples

```yaml
adobe/helix-website

```

## slack

the slack teamId/channelID(s) where the slack bot is used.

`slack`

*   is optional

*   Type: merged type ([Details](project-config-defs-stringorarray.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/slack")

### slack Type

merged type ([Details](project-config-defs-stringorarray.md))

one (and only one) of

*   [Untitled string in ProjectConfig](project-config-defs-stringorarray-oneof-0.md "check type definition")

*   [Untitled array in ProjectConfig](project-config-defs-stringorarray-oneof-1.md "check type definition")

## metadata

source paths for metadata.

`metadata`

*   is optional

*   Type: merged type ([Details](project-config-defs-stringorarray.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-defs-stringorarray.md "https://ns.adobe.com/helix/config/project#/properties/metadata")

### metadata Type

merged type ([Details](project-config-defs-stringorarray.md))

one (and only one) of

*   [Untitled string in ProjectConfig](project-config-defs-stringorarray-oneof-0.md "check type definition")

*   [Untitled array in ProjectConfig](project-config-defs-stringorarray-oneof-1.md "check type definition")

## cdn

The CDN config

`cdn`

*   is optional

*   Type: `object` ([ProjectCDNConfig](project-config-cdn.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-cdn.md "https://ns.adobe.com/helix/config/cdn#/properties/cdn")

### cdn Type

`object` ([ProjectCDNConfig](project-config-cdn.md))

## access



`access`

*   is optional

*   Type: `object` ([SiteAccessConfig](project-config-properties-siteaccessconfig.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-siteaccessconfig.md "https://ns.adobe.com/helix/config/project#/properties/access")

### access Type

`object` ([SiteAccessConfig](project-config-properties-siteaccessconfig.md))

## admin



`admin`

*   is optional

*   Type: `object` ([AdminConfig](project-config-properties-adminconfig.md))

*   cannot be null

*   defined in: [ProjectConfig](project-config-properties-adminconfig.md "https://ns.adobe.com/helix/config/project#/properties/admin")

### admin Type

`object` ([AdminConfig](project-config-properties-adminconfig.md))

# ProjectConfig Definitions

## Definitions group stringOrArray

Reference this group by using

```json
{"$ref":"https://ns.adobe.com/helix/config/project#/$defs/stringOrArray"}
```

| Property | Type | Required | Nullable | Defined by |
| :------- | :--- | :------- | :------- | :--------- |