Add support for custom 404 document #38
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Thorsten Hans <[email protected]>
itowlson
approved these changes
Aug 27, 2023
readme.md
Outdated
| @@ -60,6 +60,19 @@ files = [{ source = "test", destination = "/" }] | |||
| environment = { FALLBACK_PATH = "index.html" } | |||
| ``` | |||
|
|
|||
| ### Using a custom 404 document | |||
|
|
|||
| You can configure a `CUSTOM_404_PATH` environment variable that points to a file that will be served instead of returning a plain 404 Not Found response. If the `CUSTOM_404_PATH` environment variable is not set or points to a non-existing file, the default 404 Not Found response is returned. | |||
There was a problem hiding this comment.
Possibly worth noting that the custom 404 file has to be included as an asset. (This might not "just happen" if, say, the file server was configured to serve the /images directory instead of the whole site.) And that the path is the mount path inside the fileserver component. (In your example, the source file would have to be test/custom-404.html in order to get mounted as custom-404.html.)
There was a problem hiding this comment.
I've rewritten the paragraph, maybe you can check again @itowlson
Signed-off-by: Thorsten Hans <[email protected]>
itowlson
approved these changes
Aug 28, 2023
radu-matei
approved these changes
Aug 28, 2023
There was a problem hiding this comment.
This looks great, thanks for your contribution, @ThorstenHans!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With this PR
spin-fileservercan be configured to serve a custom 404 document instead of returning the default 404 Not Found response using theCUSTOM_404_PATHenvironment variable.If the path specified in
CUSTOM_404_PATHdoesn't exist, the default 404 Not Found response is returned to the user.