Repo-Mirror/cloudflare-error-page
9
0
Fork 0
mirror of https://github.com/donlon/cloudflare-error-page.git synced 2025-12-19 14:59:28 +00:00
Code Issues Releases Activity

doc: add more comments in example in readme

Browse Source
This commit is contained in:
Anthony Donlon
2025-11-19 21:18:53 +08:00
parent 463b4e7151
commit eeee5dedba
1 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -18,20 +18,26 @@ Then you can generate an error page based on parameters you like. (See [example.
import webbrowser import webbrowser
from cloudflare_error_page import render as render_cf_error_page from cloudflare_error_page import render as render_cf_error_page
# This function renders an error page based on the input parameters
error_page = render_cf_error_page({ error_page = render_cf_error_page({
# Browser status is ok
'browser_status': { 'browser_status': {
"status": 'ok', "status": 'ok',
}, },
# Cloudflare status is error
'cloudflare_status': { 'cloudflare_status': {
"status": 'error', "status": 'error',
"status_text": 'Not Working', "status_text": 'Not Working',
}, },
# Host status is also ok
'host_status': { 'host_status': {
"status": 'ok', "status": 'ok',
"location": 'example.com', "location": 'example.com',
}, },
'error_source': 'cloudflare', # 'browser', 'cloudflare', or 'host' # can be 'browser', 'cloudflare', or 'host'
'error_source': 'cloudflare',
# Texts shown in the bottom of the page
'what_happened': '<p>There is an internal server error on Cloudflare\'s network.</p>', 'what_happened': '<p>There is an internal server error on Cloudflare\'s network.</p>',
'what_can_i_do': '<p>Please try again in a few minutes.</p>', 'what_can_i_do': '<p>Please try again in a few minutes.</p>',
}) })