App Error / Status Page

nichu42

Hi there,

It would be pretty cool to have the option to forward users to a status page instead of showing the generic "Cloudron App Error - please retry in a few minutes" page.
I'd really like to forward to my Uptime Kuma page (hosted on another server).

jdaviescoates

@nichu42 that would indeed be nice.

I think ideally we want:

an ability to edit the generic page, plus
the option to redirect it to a URL of our choice

JLX89

You can already use the Cloudron API to setup app status within Uptime Kuma as well as modifying the App Error or Offline pages, if you wanted to add a link to your status page.

There might be a better way of doing this, but I'm doing it this way at the moment inside Uptime Kuma:

Generate an API Key from your profile page (https://my.cloudron.domain/#/profile)
Go to the settings of the app to get the AppId in the URL (https://my.cloudron.domain/#/app/{AppId}/display)
Add a new status monitor in Uptime Kuma (http(s) keyword) and set the keyword to healthy

I personally wouldn’t mind an internal page for admins to get a quick list of apps, backups, or generic server issues with errors so easily fix things if there are issues.

nichu42

@JLX89 Thanks for pointing me to the Cloudron API. That's a much more elegant way to track the status with Uptime Kuma than my current approach! Not to mention that it probably uses less bandwidth than loading the actual app web interface for each uptime check.

Still, I'd like to have a page in the Cloudron GUI that allows me to set up custom error pages.

P.S. / Edit: For others who are reading this thread and like to make use of the API health check, this is the actual URL to enter in Uptime Kuma:
https://my.cloudron.domain/api/v1/apps/{AppIdFromStep2}?access_token={TokenFromStep1}

nebulon

For reference also, if someone needs a bit more detail on the apps health, the api endpoint for this is documented at https://docs.cloudron.io/api.html#tag/Apps/paths/~1apps~1{appid}/get

Not sure if uptime kuma can be scripted that way to extract health and runState from the json result.

jdaviescoates

@nichu42 said in App Error / Status Page:

That's a much more elegant way to track the status with Uptime Kuma than my current approach!

I'm currently just using the standard default HTTP(s) monitor, e.g.

I'm wondering how using the API would be better. Better how?

JLX89

@jdaviescoates I found using the api was much more reliable (json app responses), especially if you're using Cloudflare. I found that if the app was down but Cloudflare (Always On) would show a http response so the app wouldn't be showing the true status.

nichu42

@nebulon said in App Error / Status Page:

Not sure if uptime kuma can be scripted that way to extract health and runState from the json result.

It appears to me that neither JSON key matching nor Regex are implemented yet, but there are open issues for both.

I was just taking the advice from @JLX89 because I felt that checking for runState might not be enough. But could you please explain the check behind health=healthy?

JLX89

@nichu42 said in App Error / Status Page:

@nebulon said in App Error / Status Page:

Not sure if uptime kuma can be scripted that way to extract health and runState from the json result.

It appears to me that neither JSON key matching nor Regex are implemented yet, but there are open issues for both.

I was just taking the advice from @JLX89 because I felt that checking for runState might not be enough. But could you please explain the check behind health=healthy?

I've had it setup using the following and it seems to have been working, if the app goes offline it is reflected in Uptime Kuma.

Monitor Type: HTTPS(s) - Keyword
URL: Cloudron API URL
Keyword: healthy
HTTP Options - Method: "GET"

I'm assuming you could probably pull either of the following based on the Cloudron API documentation: "runState": "running" or "health": "healthy"?

This at least seems to be working for me -- but could be a better way of doing this. The obvious downfall is if you're tracking uptime rather than just status if you make config changes or need to restart the app this is reflected -- so we bumped up the heartbeat retry levels.

nichu42

Revisiting this thread... Is a custom error page a planned feature? Or is it already possible and I just missed it?

BrutalBirdie

@nichu42
If you want to hack around.

️ Notice: totally unofficial!

The files are here /home/yellowtent/box/dashboard/dist/

appstatus.html
notfound.html

You could hack a custom HTML in there, replacing the files (make a backup of the original files), which just redirects to, lets say, an uptime kuma or something else.

Have fun

girish

I guess https://docs.cloudron.io/branding/#custom-pages

nichu42

Excellent, thanks!

BrutalBirdie

@girish OH! I missed that doc. So it is official

nichu42

Ooops, I think it's the second time I have started a thread that could have been answered with a short RTFM. I'm glad that @girish is way too polite.
Thanks, I have set up the custom pages. Works perfectly. Now I can redirect visitors to my (externally hosted) uptime kuma status page when an app is not ressponding.

robi

@nichu42 would you mind letting us know what you implemented and how as the final solution description?

nichu42

@robi
Is there any specific you'd like to know?
I just did as mentioned in the doc:

Created a new directory /home/yellowtent/boxdata/custom_pages
Created two html files app_not_responding.html and notfound.html with nano and pasted in the HTML code that I had prepared on my computer
Saved and voilà

The HTML files contained an explanation of what went wrong and a link to my already existing uptime kuma status page, where I put a note to users if there is a longer downtime (planned or unplanned). I have uptime kuma running on a separate VPS so it does not depend on Cloudron to be working. I am checking for health via API as suggested earlier in this thread. You can see the result here: https://status.42bit.io

robi

@nichu42 Yes, that's excellent, and the 2 html files are interesting for folks to see as inspirations of what to write and how to redirect to an external site.

Especially if they're nice and fancy with CSS!

Example or template code is always nice to have.

nichu42

@robi I'm sorry to disappoint you, but the HTML files I created are very simple. The fancy stuff happens on the uptime kuma page. If you are still interested, here's the code:

<!DOCTYPE html>
<html>
  <head>
    <title>HTTP 503 - Service unavailable</title>
  </head>
  <body>
    <center>
	<h1>HTTP 503 - Service unavailable</h1>
	<p><b>Ooops, sorry. The service you requested is not loading at the moment.<br>
	Hopefully it's just a restart as part of regular maintenance, so</b></p>
	<h2>please try again in a few minutes.</h2>
	<p><b>If you keep getting this error message, please visit our <a href="https://status.42bit.io">status page</a>, which usually has more details about longer outages.</b></p>
	<p>If you think the 42bit.io / blueplanet.social admin should have a look at this, please reach out to <a href="mailto:admin@42bit.io">admin@42bit.io</p></a>
    </center>
  </body>
</html>

<!DOCTYPE html>
<html>
  <head>
    <title>HTTP 404 - Not found</title>
	<meta http-equiv="refresh" content="15; url='https://42bit.io'" />
  </head>
  <body>
    <center>
	<h1>HTTP 404 - Not found</h1>
	<p><b>Sorry, I cannot find what you were looking for.</b></p>
	<p><b>All I can do is redirect you to my <a href="https://42bit.io">home page</a>, which I will try in a few seconds.</b></p>
	<p>If you think the 42bit.io / blueplanet.social admin should have a look at this error, please reach out to <a href="mailto:admin@42bit.io">admin@42bit.io</p></a>
    </center>
  </body>
</html>

Cloudron makes it easy to run web apps like WordPress, Nextcloud, GitLab on your server. Find out more or install now.

Cloudron Forum

App Error / Status Page