Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update assets.mdx #73

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update assets.mdx #73

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5a35b01
Update assets.mdx
tannermares Jun 21, 2024
f6f62f6
Update assets.mdx
tannermares Jun 21, 2024
41046e3
Update assets.mdx
tannermares Jun 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/assets.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import DocLink from "../src/components/DocLink.js"
import ThemedImage from '@theme/ThemedImage'
import useBaseUrl from "@docusaurus/useBaseUrl"

Assets require a <DocLink id="custom-domain" name="Custom Domain Name" /> to link properly when using API Gateway. For Function URLs, the work out of the box. Both API Gateway and Function URLs can benefit from a CloudFront CDN to cache `/assets` and avoid hitting your backend function on each request.
Assets require a <DocLink id="custom-domain" name="Custom Domain Name" /> to link properly when using API Gateway. For Function URLs, this works out of the box. Both API Gateway and Function URLs can benefit from a CloudFront CDN to cache `/assets` and avoid hitting your backend function on each request.

## Serving Static Assets

Expand All @@ -31,7 +31,7 @@ config.public_file_server.headers = {

## Adding CloudFront

[CloudFront](https://aws.amazon.com/cloudfront/) is an amazing CDN and is pretty easy to setup with Rails. Simply point CloudFront to your Rails app and allow the origin to set the cache headers. Because we set the `public_file_server` headers above, everything should work out perfectly. Assuming you have setup a <DocLink id="custom-domain" name="Custom Domain Name" /> via CloudFront, here is how to setup an behavior for your `/assets` path. From your CloudFront distribution
[CloudFront](https://aws.amazon.com/cloudfront/) is an amazing CDN and is pretty easy to setup with Rails. Simply point CloudFront to your Rails app and allow the origin to set the cache headers. Because we set the `public_file_server` headers above, everything should work out perfectly. Assuming you have setup a <DocLink id="custom-domain" name="Custom Domain Name" /> via CloudFront, here is how to setup a behavior for your `/assets` path. From your CloudFront distribution

- Click the "Behaviors" tab
- Click "Create Behavior" button
Expand All @@ -41,7 +41,7 @@ config.public_file_server.headers = {
- Viewer protocol policy: Redirect HTTP to HTTPS
- Allowed HTTP Methods: GET, HEAD
- Restrict viewer access: No
- 🔘 Cache policy and origin request policy (recommended)
- Cache policy and origin request policy (recommended)
- Cache policy: CachingOptimized
- Origin request policy: None

Expand Down