-
Notifications
You must be signed in to change notification settings - Fork 1
docs: document fallback pages provided by the service #7
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.
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
Open
MikkelHebel
wants to merge
1
commit into
ctfpilot:develop
Choose a base branch
from
Brunnerne:docs/6/document-fallback-pages
base: develop
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -29,6 +29,35 @@ docker pull ghcr.io/ctfpilot/error-fallback:latest | |
|
|
||
| *For the versions available, please see the [releases page](https://github.com/ctfpilot/error-fallback/releases).* | ||
|
|
||
| ## Pages | ||
|
|
||
| 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. Which page is shown is determined by whichever HTTP status code the proxy maps to this service. Every page automatically polls the original request's host and reloads once it starts responding normally again, so the page updates on its own once the underlying issue is resolved. | ||
|
|
||
| | Page | Title | Intended use | | ||
| | ----------- | ----------------------- | ------------------------------------------------------------------------------------- | | ||
| | `index.html` | Error | Generic fallback page for errors that don't have a more specific page | | ||
| | `401.html` | Unauthorized | Authentication is required to access this resource | | ||
| | `403.html` | Forbidden | The request is authenticated but the caller doesn't have permission | | ||
| | `404.html` | Not found | The requested page could not be found | | ||
| | `405.html` | Method Not Allowed | The HTTP method used is not supported for the requested resource | | ||
| | `500.html` | Error | Same generic message as `index.html`, with an added link back to the home page | | ||
| | `502.html` | Bad gateway | The service did not respond correctly | | ||
| | `503.html` | No service available | The service is temporarily unavailable, e.g. while restarting or under maintenance | | ||
| | `504.html` | Gateway timeout | The service did not respond in time, e.g. while restarting or under maintenance | | ||
|
|
||
| <details> | ||
| <summary>Preview of each page</summary> | ||
|
|
||
| | | | | ||
| | --- | --- | | ||
| | **Index**  | **401 Unauthorized**  | | ||
| | **403 Forbidden**  | **404 Not found**  | | ||
| | **405 Method Not Allowed**  | **500 Error**  | | ||
| | **502 Bad gateway**  | **503 No service available**  | | ||
| | **504 Gateway timeout**  | | | ||
|
|
||
| </details> | ||
|
Comment on lines
+48
to
+59
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It would be good to mention, that the screenshot are from the light mode, and dark mode is active if the system preffers dark. |
||
|
|
||
| ### Development | ||
|
|
||
| In order to generate the pages, run the [`generator.py`](./src/generator.py) script in `src`: | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: The "Intended use" column's text should have a "." at the end of the sentences.