176 lines
11 KiB
Plaintext
176 lines
11 KiB
Plaintext
---
|
|
title: The Payload Config
|
|
label: Overview
|
|
order: 10
|
|
desc: The Payload Config is central to everything that Payload does, from adding custom React components, to modifying collections, controlling localization and much more.
|
|
keywords: overview, config, configuration, documentation, Content Management System, cms, headless, javascript, node, react, nextjs
|
|
---
|
|
|
|
Payload is a _config-based_, code-first CMS and application framework. The Payload Config is central to everything that Payload does, allowing for the deep configuration of your application through a simple API.
|
|
|
|
Everything from your [Database](../database/overview) choice, to the appearance of the [Admin Panel](../admin/overview), is fully controlled through the Payload Config. From here you can define [Fields](../fields/overview), add [Localization](./localization), enable [Authentication](../authentication/overview), configure [Access Control](../access-control/overview), and so much more.
|
|
|
|
The Payload Config is a `payload.config.ts` file typically located in the root of your project:
|
|
|
|
```ts
|
|
import { buildConfig } from 'payload'
|
|
|
|
export default buildConfig({
|
|
// Your config goes here
|
|
})
|
|
```
|
|
|
|
The Payload Config is strongly typed and ties directly into Payload's TypeScript codebase. This means your IDE (such as VSCode) will provide helpful information like type-ahead suggestions while you write your config.
|
|
|
|
<Banner type="success">
|
|
<strong>Tip:</strong>
|
|
The location of your Payload Config can be customized. [More details](#customizing--automating-config-location-detection).
|
|
</Banner>
|
|
|
|
## Config Options
|
|
|
|
To author your Payload Config, first determine which [Database](../database/overview) you'd like to use, then use [Collections](./collections) or [Globals](./globals) to define the schema of your data.
|
|
|
|
Here is one of the simplest possible Payload configs:
|
|
|
|
```ts
|
|
import { buildConfig } from 'payload'
|
|
import { mongooseAdapter } from '@payloadcms/db-mongodb'
|
|
// import { postgresAdapter } from '@payloadcms/db-postgres'
|
|
|
|
export default buildConfig({
|
|
secret: process.env.PAYLOAD_SECRET,
|
|
db: mongooseAdapter({
|
|
url: process.env.DATABASE_URI,
|
|
}),
|
|
collections: [
|
|
{
|
|
slug: 'pages',
|
|
fields: [
|
|
{
|
|
name: 'title',
|
|
type: 'text'
|
|
}
|
|
]
|
|
}
|
|
],
|
|
})
|
|
```
|
|
|
|
<Banner type="success">
|
|
<strong>More:</strong>
|
|
For a more complex example, see the [Public Demo](https://github.com/payloadcms/public-demo) source code on GitHub.
|
|
</Banner>
|
|
|
|
The following options are available:
|
|
|
|
| Option | Description |
|
|
| ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
| **`admin`** | The configuration options for the Admin Panel, including Custom Components, Live Preview, etc. [More details](../admin/overview#admin-options). |
|
|
| **`bin`** | Register custom bin scripts with the `payload` bin function. |
|
|
| **`editor`** | The Rich Text Editor which will be used by `richText` fields. [More details](../rich-text/overview). |
|
|
| **`db`** \* | The Database Adapter which will be used by Payload. [More details](../database/overview). |
|
|
| **`serverURL`** | A string used to define the absolute URL of your app including the protocol, for example `https://example.com`. No paths allowed, only protocol, domain and (optionally) port |
|
|
| **`collections`** | An array of Collections for Payload to manage. [More details](./collections). |
|
|
| **`globals`** | An array of Globals for Payload to manage. [More details](./globals). |
|
|
| **`cors`** | Either a whitelist array of URLS to allow CORS requests from, or a wildcard string (`'*'`) to accept incoming requests from any domain. |
|
|
| **`localization`** | Opt-in and control how Payload handles the translation of your content into multiple locales. [More details](./localization). |
|
|
| **`graphQL`** | Manage GraphQL-specific functionality, including custom queries and mutations, query complexity limits, etc. [More details](../graphql/overview#graphql-options). |
|
|
| **`cookiePrefix`** | A string that will be prefixed to all cookies that Payload sets. |
|
|
| **`csrf`** | A whitelist array of URLs to allow Payload cookies to be accepted from as a form of CSRF protection. [More details](../authentication/overview#csrf-protection). |
|
|
| **`defaultDepth`** | If a user does not specify `depth` while requesting a resource, this depth will be used. [More details](../getting-started/concepts#depth). |
|
|
| **`defaultMaxTextLength`** | The maximum allowed string length to be permitted application-wide. Helps to prevent malicious public document creation. |
|
|
| **`maxDepth`** | The maximum allowed depth to be permitted application-wide. This setting helps prevent against malicious queries. Defaults to `10`. |
|
|
| **`indexSortableFields`** | Automatically index all sortable top-level fields in the database to improve sort performance and add database compatibility for Azure Cosmos and similar. |
|
|
| **`upload`** | Base Payload upload configuration. [More details](../upload/overview#payload-wide-upload-options). |
|
|
| **`routes`** | Control the routing structure that Payload binds itself to. Specify `admin`, `api`, `graphQL`, and `graphQLPlayground`. [More details](../admin/overview#root-level-routes). |
|
|
| **`email`** | Configure the Email Adapter for Payload to use. [More details](../email/overview). |
|
|
| **`debug`** | Enable to expose more detailed error information. |
|
|
| **`telemetry`** | Disable Payload telemetry by passing `false`. [More details](#telemetry). |
|
|
| **`rateLimit`** | Control IP-based rate limiting for all Payload resources. Used to prevent DDoS attacks, etc. [More details](../production/preventing-abuse#rate-limiting-requests). |
|
|
| **`hooks`** | Tap into Payload-wide hooks. [More details](../hooks/overview). |
|
|
| **`plugins`** | An array of Payload plugins. [More details](../plugins/overview). |
|
|
| **`endpoints`** | An array of custom API endpoints added to the Payload router. [More details](../rest-api/overview#custom-endpoints). |
|
|
| **`custom`** | Extension point for adding custom data (e.g. for plugins). |
|
|
| **`i18n`** | Internationalization configuration. Pass all i18n languages you'd like the admin UI to support. Defaults to English-only. [More details](./i18n). |
|
|
| **`secret`** \* | A secure, unguessable string that Payload will use for any encryption workflows - for example, password salt / hashing. |
|
|
| **`sharp`** | If you would like Payload to offer cropping, focal point selection, and automatic media resizing, install and pass the Sharp module to the config here. |
|
|
| **`typescript`** | Configure TypeScript settings here. [More details](#typescript). |
|
|
|
|
_\* An asterisk denotes that a property is required._
|
|
|
|
<Banner type="warning">
|
|
<strong>Reminder:</strong>
|
|
Some properties are removed from the client-side bundle. [More details](../admin/components#accessing-the-payload-config).
|
|
</Banner>
|
|
|
|
## Config Location
|
|
|
|
For Payload command-line scripts, we need to be able to locate your Payload Config. We'll check a variety of locations for the presence of `payload.config.ts` by default, including the root current working directory, your `tsconfig`'s `rootDir`, and your `tsconfig`'s `outDir`.
|
|
|
|
In development mode, if the configuration file is not found at the root, Payload will attempt to read your `tsconfig.json`, and search in the directory specified in `compilerOptions.rootDir` (typically "src").
|
|
|
|
In production mode, Payload will first attempt to find the config file in the output directory specified in `compilerOptions.outDir` of your `tsconfig.json`, then fallback to the source directory (`compilerOptions.rootDir`), and finally will check the 'dist' directory.
|
|
|
|
Please ensure your `tsconfig.json` is properly configured if you want Payload to accurately auto-detect your configuration file location. If `tsconfig.json` does not exist or doesn't specify `rootDir` or `outDir`, Payload will default to the current working directory.
|
|
|
|
### Customizing the Config Location
|
|
|
|
In addition to the above automated detection, you can specify your own location for the Payload Config. This is done by using the environment variable `PAYLOAD_CONFIG_PATH`. The path you provide via this environment variable can either be absolute or relative to your current working directory. This can be useful in situations where your Payload Config is not in a standard location, or you wish to switch between multiple configurations.
|
|
|
|
**Example in package.json:**
|
|
|
|
```json
|
|
{
|
|
"scripts": {
|
|
"payload": "PAYLOAD_CONFIG_PATH=/path/to/custom-config.ts payload"
|
|
}
|
|
}
|
|
```
|
|
|
|
When `PAYLOAD_CONFIG_PATH` is set, Payload will use this path to load the configuration, bypassing all automated detection.
|
|
|
|
## TypeScript
|
|
|
|
Payload exposes a variety of TypeScript settings that you can leverage on your Config's `typescript` property.
|
|
|
|
**`autoGenerate`**
|
|
|
|
By default, in Next.js development mode, Payload will auto-generate TypeScript interfaces for all collections and globals that your config defines.
|
|
|
|
You can opt out by setting `typescript.autoGenerate: false`.
|
|
|
|
**`declare`**
|
|
|
|
By default, Payload adds a `declare` block to your generated types, which makes sure that Payload uses your generated types for all Local API methods. This promotes strong typing across all of Payload's APIs. However, if you are using your Payload Config in a monorepo sub-package, and you are using it in multiple applications, you might want to disable this automatic declaration and then manually add the `declare` block to a file that you control.
|
|
|
|
In these cases, you can set `typescript.declare: false` to opt out.
|
|
|
|
**`outputFile`**
|
|
|
|
You can control the output path and filename of Payload's auto-generated types by defining the `typescript.outputFile` property to a full, absolute path.
|
|
|
|
### Importing Payload Config types
|
|
|
|
You can import config types as follows:
|
|
|
|
```ts
|
|
import { Config } from 'payload'
|
|
|
|
// This is the type used for an incoming Payload Config.
|
|
// Only the bare minimum properties are marked as required.
|
|
```
|
|
|
|
```ts
|
|
import { SanitizedConfig } from 'payload'
|
|
|
|
// This is the type used after an incoming Payload Config is fully sanitized.
|
|
// Generally, this is only used internally by Payload.
|
|
```
|
|
|
|
## Telemetry
|
|
|
|
Payload collects **completely anonymous** telemetry data about general usage. This data is super important to us and helps us accurately understand how we're growing and what we can do to build the software into everything that it can possibly be. The telemetry that we collect also help us demonstrate our growth in an accurate manner, which helps us as we seek investment to build and scale our team. If we can accurately demonstrate our growth, we can more effectively continue to support Payload as free and open-source software. To opt out of telemetry, you can pass `telemetry: false` within your Payload Config.
|
|
|
|
For more information about what we track, take a look at our [privacy policy](/privacy).
|