mirror of
				https://github.com/tormachris/cf-workers-status-page.git
				synced 2025-11-04 12:56:24 +01:00 
			
		
		
		
	chore(readme): change defaults and mention free tier
This commit is contained in:
		
							
								
								
									
										31
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										31
									
								
								README.md
									
									
									
									
									
								
							@@ -12,6 +12,7 @@ You'll need a [Cloudflare Workers account](https://dash.cloudflare.com/sign-up/w
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
* A workers domain set up
 | 
					* A workers domain set up
 | 
				
			||||||
* The Workers Bundled subscription \($5/mo\)
 | 
					* The Workers Bundled subscription \($5/mo\)
 | 
				
			||||||
 | 
					    * [With KV Free Tier its free to try now!](https://blog.cloudflare.com/workers-kv-free-tier/) We are working on optimizations so it will completely fit in Free Tier for 5 minutes checks.
 | 
				
			||||||
* Some websites/APIs to watch 🙂
 | 
					* Some websites/APIs to watch 🙂
 | 
				
			||||||
 | 
					
 | 
				
			||||||
Also, prepare the following secrets
 | 
					Also, prepare the following secrets
 | 
				
			||||||
@@ -25,7 +26,7 @@ You can either deploy with **Cloudflare Deploy Button** using GitHub Actions or
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
### Deploy with Cloudflare Deploy Button
 | 
					### Deploy with Cloudflare Deploy Button
 | 
				
			||||||
 | 
					
 | 
				
			||||||
[](https://deploy.workers.cloudflare.com/?url=https://github.com/eidam/cf-workers-status-page&paid=true)
 | 
					[](https://deploy.workers.cloudflare.com/?url=https://github.com/eidam/cf-workers-status-page)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. Click the button and follow the instructions, you should end up with a clone of this repository
 | 
					1. Click the button and follow the instructions, you should end up with a clone of this repository
 | 
				
			||||||
2. Navigate to your new **GitHub repository > Settings > Secrets** and add the following secrets:
 | 
					2. Navigate to your new **GitHub repository > Settings > Secrets** and add the following secrets:
 | 
				
			||||||
@@ -43,27 +44,27 @@ You can either deploy with **Cloudflare Deploy Button** using GitHub Actions or
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
   ```yaml
 | 
					   ```yaml
 | 
				
			||||||
   settings:
 | 
					   settings:
 | 
				
			||||||
     title: "Status Page"
 | 
					     title: 'Status Page'
 | 
				
			||||||
     url: "https://status-page.eidam.dev" # used for Slack messages
 | 
					     url: 'https://status-page.eidam.dev' # used for Slack messages
 | 
				
			||||||
     logo: logo-192x192.png # image in ./public/ folder
 | 
					     logo: logo-192x192.png # image in ./public/ folder
 | 
				
			||||||
     daysInHistogram: 90 # number of days you want to display in histogram
 | 
					     daysInHistogram: 90 # number of days you want to display in histogram
 | 
				
			||||||
 | 
					
 | 
				
			||||||
     # configurable texts across the status page
 | 
					     # configurable texts across the status page
 | 
				
			||||||
     allmonitorsOperational: "All Systems Operational"
 | 
					     allmonitorsOperational: 'All Systems Operational'
 | 
				
			||||||
     notAllmonitorsOperational: "Not All Systems Operational"
 | 
					     notAllmonitorsOperational: 'Not All Systems Operational'
 | 
				
			||||||
     monitorLabelOperational: "Operational"
 | 
					     monitorLabelOperational: 'Operational'
 | 
				
			||||||
     monitorLabelNotOperational: "Not Operational"
 | 
					     monitorLabelNotOperational: 'Not Operational'
 | 
				
			||||||
     monitorLabelNoData: "No data"
 | 
					     monitorLabelNoData: 'No data'
 | 
				
			||||||
     dayInHistogramNoData: "No data"
 | 
					     dayInHistogramNoData: 'No data'
 | 
				
			||||||
     dayInHistogramOperational: "All good"
 | 
					     dayInHistogramOperational: 'All good'
 | 
				
			||||||
     dayInHistogramNotOperational: "Some checks failed"
 | 
					     dayInHistogramNotOperational: 'Some checks failed'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
   # list of monitors
 | 
					   # list of monitors
 | 
				
			||||||
   monitors:
 | 
					   monitors:
 | 
				
			||||||
     - id: status-page-eidam-dev # unique identifier
 | 
					     - id: workers-cloudflare-com # unique identifier
 | 
				
			||||||
       name: Eidam's Status Page
 | 
					       name: workers.cloudflare.com
 | 
				
			||||||
       description: 'https://status-page.eidam.dev' # default=empty
 | 
					       description: 'You write code. They handle the rest.' # default=empty
 | 
				
			||||||
       url: 'https://status-page.eidam.dev/' # URL to fetch
 | 
					       url: 'https://workers.cloudflare.com/' # URL to fetch
 | 
				
			||||||
       method: GET # default=GET
 | 
					       method: GET # default=GET
 | 
				
			||||||
       expectStatus: 200 # operational status, default=200
 | 
					       expectStatus: 200 # operational status, default=200
 | 
				
			||||||
       followRedirect: false # should fetch follow redirects, default=false
 | 
					       followRedirect: false # should fetch follow redirects, default=false
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										45
									
								
								config.yaml
									
									
									
									
									
								
							
							
						
						
									
										45
									
								
								config.yaml
									
									
									
									
									
								
							@@ -1,37 +1,36 @@
 | 
				
			|||||||
settings:
 | 
					settings:
 | 
				
			||||||
  title: "Status Page"
 | 
					  title: 'Status Page'
 | 
				
			||||||
  url: "https://status-page.eidam.dev" # used for Slack messages
 | 
					  url: 'https://status-page.eidam.dev' # used for Slack messages
 | 
				
			||||||
  logo: logo-192x192.png # image in ./public/ folder
 | 
					  logo: logo-192x192.png # image in ./public/ folder
 | 
				
			||||||
  daysInHistogram: 90 # number of days you want to display in histogram
 | 
					  daysInHistogram: 90 # number of days you want to display in histogram
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  allmonitorsOperational: "All Systems Operational"
 | 
					  allmonitorsOperational: 'All Systems Operational'
 | 
				
			||||||
  notAllmonitorsOperational: "Not All Systems Operational"
 | 
					  notAllmonitorsOperational: 'Not All Systems Operational'
 | 
				
			||||||
  monitorLabelOperational: "Operational"
 | 
					  monitorLabelOperational: 'Operational'
 | 
				
			||||||
  monitorLabelNotOperational: "Not Operational"
 | 
					  monitorLabelNotOperational: 'Not Operational'
 | 
				
			||||||
  monitorLabelNoData: "No data"
 | 
					  monitorLabelNoData: 'No data'
 | 
				
			||||||
  dayInHistogramNoData: "No data"
 | 
					  dayInHistogramNoData: 'No data'
 | 
				
			||||||
  dayInHistogramOperational: "All good"
 | 
					  dayInHistogramOperational: 'All good'
 | 
				
			||||||
  dayInHistogramNotOperational: "Some checks failed"
 | 
					  dayInHistogramNotOperational: 'Some checks failed'
 | 
				
			||||||
 | 
					
 | 
				
			||||||
monitors:
 | 
					monitors:
 | 
				
			||||||
  - id: status-page-eidam-dev # unique identifier
 | 
					   - id: workers-cloudflare-com # unique identifier
 | 
				
			||||||
    name: Eidam's Status Page
 | 
					     name: workers.cloudflare.com
 | 
				
			||||||
    description: 'https://status-page.eidam.dev' # default=empty
 | 
					     description: 'You write code. They handle the rest.' # default=empty
 | 
				
			||||||
    url: 'https://status-page.eidam.dev/' # URL to fetch
 | 
					     url: 'https://workers.cloudflare.com/' # URL to fetch
 | 
				
			||||||
     method: GET # default=GET
 | 
					     method: GET # default=GET
 | 
				
			||||||
    expectStatus: 200 # operational status, default=200
 | 
					     expectStatus: 200 # operational status, default=200
 | 
				
			||||||
     followRedirect: false # should fetch follow redirects, default=false
 | 
					     followRedirect: false # should fetch follow redirects, default=false
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  - id: cf-workers-status-page
 | 
					  - id: www-cloudflare-com
 | 
				
			||||||
    name: Github.com Cloudflare Workers Status Page
 | 
					    name: www.cloudflare.com
 | 
				
			||||||
    description: Is the Github repository public?
 | 
					    description: 'Built for anything connected to the Internet.'
 | 
				
			||||||
    url: 'https://github.com/eidam/cf-workers-status-page'
 | 
					    url: 'https://github.com/eidam/cf-workers-status-page'
 | 
				
			||||||
    method: GET
 | 
					    method: GET
 | 
				
			||||||
    expectStatus: 200
 | 
					    expectStatus: 200
 | 
				
			||||||
 | 
					
 | 
				
			||||||
  - id: eidam-dev
 | 
					  - id: blog-cloudflare-com
 | 
				
			||||||
    name: Eidam.dev (403)
 | 
					    name: The Cloudflare Blog
 | 
				
			||||||
    description: 'Eidam.dev homepage, there is none'
 | 
					    url: 'https://blog.cloudflare.com/'
 | 
				
			||||||
    url: 'https://eidam.dev'
 | 
					 | 
				
			||||||
    method: GET
 | 
					    method: GET
 | 
				
			||||||
    expectStatus: 403
 | 
					    expectStatus: 200
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user