Skip to content

Commit

Permalink
Merge branch 'master' into nft-resolve
Browse files Browse the repository at this point in the history
  • Loading branch information
@danielcondemarin
danielcondemarin authored Nov 11, 2020
2 parents 1721da4 + 3ff7563 commit c2e2243
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Please review [features](https://github.com/serverless-nextjs/serverless-next.js
- [Inputs](#inputs)
- [FAQ](#faq)

> :warning: This README may reference new or changed functionality that is not yet published to npm. Please go to [Releases](https://github.com/serverless-nextjs/serverless-next.js/releases), find the correct `@sls-next/serverless-component` version you are using, and open the README for that release for more accurate information.
> :warning: This README reflects the latest changes on the `master` branch. It may or may not yet be published to the `latest` (stable) or `alpha` release in npm. Please go to [Releases](https://github.com/serverless-nextjs/serverless-next.js/releases), find the correct `@sls-next/serverless-component` version you are using, and open the README for that release for more accurate information. If a feature is listed in this README but not working, please first try upgrading to the most recent `alpha` release in npm.
### Motivation

Expand Down Expand Up @@ -450,7 +450,7 @@ The fourth cache behaviour handles next API requests `api/*`.
| minifyHandlers | `boolean` | `false` | Use pre-built minified handlers to reduce code size. Does not minify custom handlers. |
| deploy | `boolean` | `true` | Whether to deploy resources to AWS (available in the latest alpha). Useful if you just need the build outputs (Lambdas and assets) but want to deploy them yourself. Build outputs will be created in the `.serverless_nextjs` directory. You are then responsible to configure AWS yourself: setting CloudFront behaviors with Lambda function associations, uploading assets to S3 with the proper `Cache-Control` headers, etc. |
| enableHTTPCompression | `boolean` | `false` | When set to `true` the Lambda@Edge functions for SSR and API requests will use Gzip to compress the response. Note that you shouldn't need to enable this because CloudFront will compress responses for you out of the box. |
| authentication | `object` | `undefined` | Authentication object for use with basic authentication. It only supports a single username/password combination for now and is inlined in plaintext in the Lambda handler. You must also forward the `Authorization` header for CloudFront behaviors, e.g `defaults`, `api/*`, and `_next/data/*`. **Note: this is meant as a simple means of protecting an environment such as a development/test site, it is not recommended for production use.** |
| authentication | `object` | `undefined` | Authentication object for use with basic authentication (available from 1.19.0-alpha.3). It only supports a single username/password combination for now and is inlined in plaintext in the Lambda handler. You must also forward the `Authorization` header for CloudFront behaviors, e.g `defaults`, `api/*`, and `_next/data/*`. **Note: this is meant as a simple means of protecting an environment such as a development/test site, it is not recommended for production use.** |
| authentication.username | `string` | `undefined` | Username for basic authentication. |
| authentication.password | `string` | `undefined` | Password for basic authentication. **Note: it is highly recommended not to reuse a password here as it gets inlined in plaintext in the Lambda handler.** |

Expand Down

0 comments on commit c2e2243

Please sign in to comment.