115 lines
12 KiB
Markdown
115 lines
12 KiB
Markdown
# Serverless Nextjs Component
|
|
|
|
Effortless deployment for Next.js apps.
|
|
|
|
### Getting started
|
|
|
|
Set your AWS credentials as environment variables:
|
|
|
|
```bash
|
|
AWS_ACCESS_KEY_ID=accesskey
|
|
AWS_SECRET_ACCESS_KEY=sshhh
|
|
```
|
|
|
|
And simply deploy:
|
|
|
|
```bash
|
|
$ serverless
|
|
```
|
|
|
|
### AWS Permissions
|
|
|
|
By default the Lambda@Edge functions run using AWSLambdaBasicExecutionRole which only allows uploading logs to CloudWatch. If you need permissions beyond this, like for example access to DynamoDB or any other AWS resource you will need your own custom policy arn:
|
|
|
|
```yml
|
|
# serverless.yml
|
|
|
|
myNextApplication:
|
|
component: serverless-next.js
|
|
inputs:
|
|
policy: 'arn:aws:iam::123456789012:policy/MyCustomPolicy'
|
|
```
|
|
|
|
Make sure you add CloudWatch log permissions to your custom policy.
|
|
|
|
The exhaustive list of AWS actions required for a deployment:
|
|
|
|
```
|
|
"acm:DescribeCertificate", // only for custom domains
|
|
"acm:ListCertificates", // only for custom domains
|
|
"acm:RequestCertificate", // only for custom domains
|
|
"cloudfront:CreateCloudFrontOriginAccessIdentity",
|
|
"cloudfront:CreateDistribution",
|
|
"cloudfront:CreateInvalidation",
|
|
"cloudfront:GetDistribution",
|
|
"cloudfront:GetDistributionConfig",
|
|
"cloudfront:ListCloudFrontOriginAccessIdentities",
|
|
"cloudfront:ListDistributions",
|
|
"cloudfront:ListDistributionsByLambdaFunction",
|
|
"cloudfront:ListDistributionsByWebACLId",
|
|
"cloudfront:ListFieldLevelEncryptionConfigs",
|
|
"cloudfront:ListFieldLevelEncryptionProfiles",
|
|
"cloudfront:ListInvalidations",
|
|
"cloudfront:ListPublicKeys",
|
|
"cloudfront:ListStreamingDistributions",
|
|
"cloudfront:UpdateDistribution",
|
|
"iam:AttachRolePolicy",
|
|
"iam:CreateRole",
|
|
"iam:CreateServiceLinkedRole",
|
|
"iam:GetRole",
|
|
"iam:PassRole",
|
|
"lambda:CreateFunction",
|
|
"lambda:EnableReplication",
|
|
"lambda:DeleteFunction", // only for custom domains
|
|
"lambda:GetFunction",
|
|
"lambda:GetFunctionConfiguration",
|
|
"lambda:PublishVersion",
|
|
"lambda:UpdateFunctionCode",
|
|
"lambda:UpdateFunctionConfiguration",
|
|
"route53:ChangeResourceRecordSets", // only for custom domains
|
|
"route53:ListHostedZonesByName",
|
|
"route53:ListResourceRecordSets", // only for custom domains
|
|
"s3:CreateBucket",
|
|
"s3:GetAccelerateConfiguration",
|
|
"s3:GetObject", // only if persisting state to S3 for CI/CD
|
|
"s3:HeadBucket",
|
|
"s3:ListBucket",
|
|
"s3:PutAccelerateConfiguration",
|
|
"s3:PutBucketPolicy",
|
|
"s3:PutObject"
|
|
```
|
|
|
|
### Options
|
|
|
|
| Name | Type | Default Value | Description |
|
|
| ------------- | ----------------- | ------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
|
| domain | `Array` | `null` | For example `['admin', 'portal.com']` |
|
|
| bucketName | `string` | `null` | Custom bucket name where static assets are stored. By default is autogenerated. |
|
|
| bucketRegion | `string` | `null` | Region where you want to host your s3 bucket. Make sure this is geographically closer to the majority of your end users to reduce latency when CloudFront proxies a request to S3. On first deployment, you may experience 307 temporary redirects if the configured region is not us-east-1. See https://aws.amazon.com/premiumsupport/knowledge-center/s3-http-307-response/ for more details. |
|
|
| nextConfigDir | `string` | `./` | Directory where your application `next.config.js` file is. This input is useful when the `serverless.yml` is not in the same directory as the next app. <br>**Note:** `nextConfigDir` should be set if `next.config.js` `distDir` is used |
|
|
| nextStaticDir | `string` | `./` | If your `static` or `public` directory is not a direct child of `nextConfigDir` this is needed |
|
|
| description | `string` | `*lambda-type*@Edge for Next CloudFront distribution` | The description that will be used for both lambdas. Note that "(API)" will be appended to the API lambda description. |
|
|
| policy | `string` | `arn:aws:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole` | The arn policy that will be assigned to both lambdas. |
|
|
| runtime | `string\|object` | `nodejs12.x` | When assigned a value, both the default and api lambdas will be assigned the runtime defined in the value. When assigned to an object, values for the default and api lambdas can be separately defined | |
|
|
| memory | `number\|object` | `512` | When assigned a number, both the default and api lambdas will be assigned memory of that value. When assigned to an object, values for the default and api lambdas can be separately defined | |
|
|
| timeout | `number\|object` | `10` | Same as above |
|
|
| name | `string\|object` | / | When assigned a string, both the default and api lambdas will assigned name of that value. When assigned to an object, values for the default and api lambdas can be separately defined |
|
|
| build | `boolean\|object` | `true` | When true builds and deploys app, when false assume the app has been built and uses the `.next` `.serverless_nextjs` directories in `nextConfigDir` to deploy. If an object is passed `build` allows for overriding what script gets called and with what arguments. |
|
|
| build.cmd | `string` | `node_modules/.bin/next` | Build command |
|
|
| build.args | `Array\|string` | `['build']` | Arguments to pass to the build |
|
|
| build.cwd | `string` | `./` | Override the current working directory |
|
|
| build.enabled | `boolean` | `true` | Same as passing `build:false` but from within the config |
|
|
|
|
| cloudfront | `object` | `{}` | Inputs to be passed to [aws-cloudfront](https://github.com/serverless-components/aws-cloudfront) |
|
|
| domainType | `string` | `"both"` | Can be one of: `"apex"` - apex domain only, don't create a www subdomain. `"www"` - www domain only, don't create an apex subdomain.`"both"` - create both www and apex domains when either one is provided. |
|
|
| publicDirectoryCache | `boolean\|object` | `true` | Customize the `public`/`static` folder asset caching policy. Assigning an object with `value` and/or `test` lets you customize the caching policy and the types of files being cached. Assigning false disables caching |
|
|
| verbose | `boolean` | `false` | Print verbose output to the console. |
|
|
|
|
Custom inputs can be configured like this:
|
|
|
|
```yaml
|
|
myNextApp:
|
|
component: serverless-next.js
|
|
inputs:
|
|
bucketName: my-bucket
|
|
```
|