ae7d6f97d2
* chore: lint packages/payload * chore: lint packages/db-postgres * chore: lint packages/db-mongodb * chore: update eslintrc exclusion rules * chore: update eslintrc exclusion rules * chore: lint misc files * chore: run prettier through packages * chore: run eslint on payload again * chore: prettier misc files * chore: prettier docs
62 lines
5.1 KiB
Plaintext
62 lines
5.1 KiB
Plaintext
---
|
||
title: Project Configuration
|
||
label: Configuration
|
||
order: 20
|
||
desc: Quickly configure and deploy your Payload Cloud project in a few simple steps.
|
||
keywords: configuration, config, settings, project, cloud, payload cloud, deploy, deployment
|
||
---
|
||
|
||
### Select your plan
|
||
|
||
Once you have created a project, you will need to select your plan. This will determine the resources that are allocated to your project and the features that are available to you.
|
||
|
||
<Banner type="success">
|
||
Note: All Payload Cloud teams that deploy a project require a card on file. This helps us prevent
|
||
fraud and abuse on our platform. If you select a plan with a free trial, you will not be charged
|
||
until your trial period is over. We’ll remind you 7 days before your trial ends and you can cancel
|
||
anytime.
|
||
</Banner>
|
||
|
||
### Project Details
|
||
|
||
| Option | Description |
|
||
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| **Region** | Select the region closest to your audience. This will ensure the fastest communication between your data and your client. |
|
||
| **Project Name** | A name for your project. You can change this at any time. |
|
||
| **Project Slug** | Choose a unique slug to identify your project. This needs to be unique for your team and you can change it any time. |
|
||
| **Team** | Select the team you want to create the project under. If this is your first project, a personal team will be created for you automatically. You can modify your team settings and invite new members at any time from the Team Settings page. |
|
||
|
||
### Build Settings
|
||
|
||
If you are deploying a new project from a template, the following settings will be automatically configured for you. If you are using your own repository, you need to make sure your build settings are accurate for your project to deploy correctly.
|
||
|
||
| Option | Description |
|
||
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||
| **Root Directory** | The folder where your `package.json` file lives. |
|
||
| **Install Command** | The command used to install your modules, for example: `yarn install` or `npm install` |
|
||
| **Build Command** | The command used to build your application, for example: `yarn build` or `npm run build` |
|
||
| **Serve Command** | The command used to serve your application, for example: `yarn serve` or `npm run serve` |
|
||
| **Branch to Deploy** | Select the branch of your repository that you want to deploy from. This is the branch that will be used to build your project when you commit new changes. |
|
||
| **Default Domain** | Set a default domain for your project. This must be unique and you will not able to change it. You can always add a custom domain later in your project settings. |
|
||
|
||
### Environment Variables
|
||
|
||
Any of the features in Payload Cloud that require environment variables will automatically be provided to your application. If your app requires any custom environment variables, you can set them here.
|
||
|
||
<Banner type="warning">
|
||
Note: For security reasons, any variables you wish to provide to the Admin panel must be prefixed
|
||
with `PAYLOAD_PUBLIC_`. Learn more
|
||
[here](https://payloadcms.com/docs/admin/webpack#admin-environment-vars).
|
||
</Banner>
|
||
|
||
### Payment
|
||
|
||
Payment methods can be set per project and can be updated any time. You can use team’s default payment method, or add a new one. Modify your payment methods in your Project settings / Team settings.
|
||
|
||
<Banner type="success">
|
||
<strong>Note:</strong> All Payload Cloud teams that deploy a project require a card on file. This
|
||
helps us prevent fraud and abuse on our platform. If you select a plan with a free trial, you will
|
||
not be charged until your trial period is over. We’ll remind you 7 days before your trial ends and
|
||
you can cancel anytime.
|
||
</Banner>
|