Redirects and Path Rewrites
app: - redirects: - from: <string> to: <string> ext: <string> status: <number> replace: <bool> assets: <bool> static: <bool> host: <string>
|From||The URL or path to be rewritten/redirected. It accepts a pattern string. '*' matches any sequence of non-Separator characters|
|To||The destination URL or path.|
|Ext||A list of extensions to match. If provided, the from clause will be ignored and only cdn clause will be interpreted. This property expects a string of extensions, separated by a comma.|
|Status||The redirect status. When 'From' is a relative path, it defaults to an empty value and when it's empty the path will be rewritten. When 'From' is a host name, it defaults to 302.|
|Assets||Specifies if the assets should also be considered for this rewrite/redirect. If true, the assets won't be redirected. Any file that has not an .html extension and has not an empty mime type is considered as a static asset. This variable is used only when 'From' is a path and not an absolute URL.|
|Cdn||Tells Stormkit that this request should be served from the CDN and not from the lambdas.|
|Replace||Specifies whether a string replace should be used while redirecting. When used with the |
|Host||Restricts the redirect rule to the specified host name.|
Redirect non-www to www
app: - redirects: - from: stormkit.io to: www.stormkit.io status: 301 replace: true
replace: true we basically tell Stormkit to keep the URL. For instance when it's
true, https://stormkit.io/docs will be redirected to https://www.stormkit.io/docs, when it's false it will be redirected to https://www.stormkit.io.
app: - redirects: - from: /dist/* to: /my-other-dist/ replace: true
You can rewrite paths by using the combination of
* in the
from setting and
replace being set to
true. This will tell Stormkit to replace anything that matches the 'from' statement with the 'to' statement, and keep the rest of the url.
Examples with the above settings:
app: - redirects: - from: /* to: /index.html assets: false
The above example will rewrite all requests to
index.html. It applies only to CDN requests since
cdn is set
true. This is useful for single page applications.
Serve from the CDN
app: - redirects: - from: /favicon.ico to: /favicon.ico cdn: true
By default Stormkit provides an endpoint to serve files from the CDN. Sometimes however we need to serve files from the same domain.
If you're using an isomorphic application, requests to the same domain will tell Stormkit to forward the request to the lambda function. Luckily, by setting the
true we tell Stormkit to serve the files from the CDN.
app: - redirects: - from: /dist/* to: /my-other-dist/ replace: true host: example.org
host parameter is specified, Stormkit will check that the request host matches the parameter value. This is useful when you have a monorepo with multiple apps hosted and you want to make sure that the redirect applies only to given hosts.