docs: document fallback pages provided by the service#17
Open
MikkelHebel wants to merge 1 commit into
Open
Conversation
|
All Contributors have signed the CLA. Thank you for your cooperation! |
Member
Author
|
I have read the CLA Document and I hereby sign the CLA |
The0mikkel
requested changes
Jul 10, 2026
Comment on lines
+25
to
+27
| Each page is generated from a file in [`src/content`](./src/content) (see [Development](#development) below) and is served as static HTML behind a reverse proxy, similarly to [`error-fallback`](https://github.com/ctfpilot/error-fallback). Which page is shown is determined by whichever HTTP status code the proxy maps to this service. | ||
|
|
||
| Unlike `error-fallback`, the page content is hidden until client-side JavaScript decides which of two states to show, based on whether the request's subdomain matches the expected `<slug>-<16 hex chars>` challenge-instance pattern: |
Member
There was a problem hiding this comment.
I don't think error-fallback needs to be mentioned in this README.
However, it is very nice to have the touch on JS only - It also highlight the missing information to users with disabled Javascript.
Comment on lines
+42
to
+58
| <details> | ||
| <summary>Preview of each page (valid subdomain state)</summary> | ||
|
|
||
| | | | | ||
| | --- | --- | | ||
| | **Index**  | **404**  | | ||
| | **502 Bad gateway**  | **503 Starting**  | | ||
| | **504 Gateway timeout**  | | | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>Preview of the "Invalid URL" state (shown on every page for a non-matching subdomain)</summary> | ||
|
|
||
|  | ||
|
|
||
| </details> |
Member
There was a problem hiding this comment.
It would be good to mention, that the screenshot are from the light mode, and dark mode is active if the system preffers dark.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Adds a
## Pagessection to the README documenting every page this service can serve, what triggers each one, and what it looks like.docs/images/, captured by runninggenerator.pyThis closes #16