https://github.com/mridang/serverless-servestatic-plugin
A plugin for the serverless framework to deploy static assets to S3
https://github.com/mridang/serverless-servestatic-plugin
aws cloudformation cloudfront custom-resources deployment iac s3 serverless serverless-plugin static-assets
Last synced: about 1 year ago
JSON representation
A plugin for the serverless framework to deploy static assets to S3
- Host: GitHub
- URL: https://github.com/mridang/serverless-servestatic-plugin
- Owner: mridang
- License: apache-2.0
- Created: 2024-09-17T02:25:01.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-05T05:04:51.000Z (over 1 year ago)
- Last Synced: 2025-02-28T05:56:26.274Z (about 1 year ago)
- Topics: aws, cloudformation, cloudfront, custom-resources, deployment, iac, s3, serverless, serverless-plugin, static-assets
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@mridang/serverless-servestatic-plugin
- Size: 962 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
A plugin for the Serverless framework to deploy the static assets into a separate
deployment bucket.
This ensures that that the lambda isn't invoked for serving assets which in turn
reduces the costs and improves performace.
> [!NOTE]
> This plugin has only been tested with the AWS provider and will
> not work if you are deploying to other providers e.g. GCP.
## Installation
Install using NPM by using the following command
```sh
npm install --save-dev @mridang/serverless-servestatic-plugin
```
And then add the plugin to your `serverless.yml` file:
```yaml
plugins:
- @mridang/serverless-servestatic-plugin
```
A thorough guide on installing plugins can be found at
https://www.serverless.com/framework/docs-guides-plugins
## Usage
### Configuration
The configuration of the plugin is done by defining a custom `servestatic`
object in your serverless.yml with your specific configuration.
All settings are optional and will be set to reasonable defaults if missing.
See the sections below for detailed descriptions of the settings.
```yaml
custom:
servestatic:
include:
- 'public/**/*' # The list of assets to be included
exclude:
- '**/' # The list of assets to be excluded
public: false # A boolean indicating whether thr S3 bucket is public
```
If `public` is enabled, the assets in the bucket can be served directly from the
bucket. Public acess can be disabled if you intend to front the bucket via
CloudFront.
#### Using CloudFront
When you trigger a deployment, the custom resource will unpack all the assets
that the match the glob patterns into the bucket that will be used for serving
static assets.
```
$ sls deploy
Deploying test-logcls to stage dev (us-east-1)
Compiling with Typescript...
Using local tsconfig.json - tsconfig.json
Typescript compiled.
✔ Service deployed to stack test-logcls-dev (104s)
endpoint: https://sfukfimmof3tinylzdbum77uvdu0xtznt.lambda-url.us-east-1.on.aws/
functions:
probot: test-logcls-dev-probot (22 MB)
Need a faster logging experience than CloudWatch? Try our Dev Mode in Console: run "serverless dev"
```
## Contributing
If you have suggestions for how this app could be improved, or
want to report a bug, open an issue - we'd love all and any
contributions.
## License
Apache License 2.0 © 2024 Mridang Agarwalla