Gatus Deployment

Meet Gatus, your multi-talented health dashboard and digital Sherlock Holmes. It monitors various services, evaluates conditions, and serenades you with real-time insights for your digital kingdom.

What's Gatus?

Gatus: Your Health Dashboard Maestro

Imagine having a vigilant guardian for your digital realm, serenading you with real-time insights. That's Gatus, the developer's best-kept secret for monitoring your online services.

1. Master of Multifaceted Monitoring: Gatus is like a Swiss Army knife for your digital health. It doesn't just watch over your services; it excels at monitoring HTTP, ICMP, TCP, and even DNS queries. It's the ultimate multitasker for keeping an eye on your service's well-being.

2. The Sherlock Holmes of Digital Health: Gatus is no ordinary observer; it's a detective when it comes to service health. It investigates status codes, response times, certificate expirations, and even delves into response content. In the world of digital health checks, it's the Sherlock Holmes that never misses a clue.

3. Symphony of Alerts: But Gatus doesn't just silently detect issues; it knows how to make an entrance. You can pair your health checks with alerts that notify you through platforms like Slack, PagerDuty, Pushover, Discord, Twilio, and more. It's like having your personal orchestra conductor for service disruptions.

4. Versatile Sentry: Gatus is a chameleon. Whether you're safeguarding web services, databases, or other critical components, it's the vigilant sentry that adapts to your needs. You get to configure it to match your environment.

5. Intuitive Maestro's Baton: Navigating Gatus's user interface is as smooth as conducting an orchestra. It's the intuitive conductor's wand that helps you effortlessly orchestrate your monitoring checks.

6. In-Depth Insights: Gatus goes beyond acknowledging issues; it provides in-depth insights. You can dive into response data, error codes, and trends to conduct a thorough diagnosis of your services.

7. Open-Source Symphony: Behind the scenes, Gatus is powered by an open-source orchestra of contributors. It's a global ensemble of developers and sysadmins collaborating to fine-tune the health-check symphony.

8. Seamless Communication: Gatus is a maestro when it comes to cross-channel communication. Whether you prefer the conversational style of Slack, PagerDuty's precision, or the immediacy of Twilio's SMS, it ensures that you're always in the know.

9. Powered by Data: With Gatus as your guide, you make data-driven decisions. It's like having a crystal ball that foretells issues before they disrupt your digital kingdom.

In the world of health dashboards, Gatus is the soothing ballad for the tech-savvy soul. It's your conductor, your judge, and your sentinel—all rolled into one. As dependable as your oldest friend and as speedy as Usain Bolt, Gatus is your trusty sidekick in the ever-watchful world of online monitoring!

How It Works:

How Gatus Works: The Symphony of Service Health

Picture Gatus as the conductor of your service health orchestra, orchestrating the harmony of monitoring and alerting in a truly unique way:

1. Monitoring Mastery: Gatus sweeps the stage, monitoring your services with a range of queries: HTTP, ICMP, TCP, and DNS. It's like having a virtuoso who can play any instrument in the orchestra.

2. Condition Evaluation: This conductor doesn't just listen; it evaluates each performance rigorously. It checks the status code, response time, certificate expiration, and even the body of responses. It's like having a keen-eyed music critic for your services.

3. Alerting Overture: Gatus doesn't stop at detection; it's the maestro of alerting. Pair your health checks with alerts that can harmonize through Slack, PagerDuty, Pushover, Discord, Twilio, and more. It's like having an entire symphony of notification methods at your disposal.

4. Adaptability Encore: Just like a seasoned conductor adjusts the tempo, Gatus adapts to your unique needs. It can guard web services, databases, and other critical components with ease. It's the versatile conductor who knows every musical genre.

5. User-Friendly Baton: Gatus wields a user-friendly interface, making it simple to compose your monitoring symphony. It's like having an intuitive conductor's baton in hand, ready to guide your checks.

6. Detailed Composition: Gatus doesn't skim over issues; it delves deep into the score. Explore response data, error codes, and trends for a comprehensive diagnosis of your services. It's like having the sheet music to every note played.

7. Open-Source Orchestra: Behind Gatus's curtain is a global ensemble of developers and sysadmins, collaborating to fine-tune the health-check symphony. It's an open-source orchestra, welcoming contributions from around the world.

8. Cross-Channel Performance: Gatus knows how to communicate. Whether it's the casual chat of Slack, the urgency of PagerDuty's alerts, or the directness of Twilio's SMS, it ensures you hear every note.

9. Data-Driven Crescendo: With Gatus, your decisions crescendo into data-driven masterpieces. It's like having a crystal ball that reveals issues before they become disruptive solos in your digital realm.

10. Soothing the Tech-Savvy Soul: In the realm of health dashboards, Gatus is the soothing ballad for the tech-savvy soul. It's your conductor, your critic, and your guardian—an all-in-one symphony of service health.

Gatus conducts your service health with precision, ensuring that your digital orchestra always plays in tune. It's like music to the ears of tech enthusiasts and service guardians alike.

Steps And Procedure

This deployment utilizes the official gatus Docker image. Here's a step-by-step guide to get you started:
2. Click on the "Install" button to initiate the installation process.
3. Fill in all the required fields with the necessary information.
4. If you prefer, you can click on the "Advanced" option to access additional settings (this step is optional).
5. After making your selections, press the "Install" button to proceed.
6. Once the installation is complete, you'll be directed to the "My Apps" page, where you'll find a list of all the applications you've deployed.
7. Copy the Hostname of the gatus application without the NodePort and paste it into your preferred browser's address bar.
8. Voilà! You're now able to access the gatus webpage and explore its content.
By following these straightforward steps, you'll have successfully deployed gatus application and gained access to its features through a seamless and user-friendly process.

Installation

Docker Image

Application name

Eg: gatus(you can put any name)

Resource Allocation

0-100%(10 % of your allocated resources (CPU, RAM) will be used for this application.)

PROTOCOL

Protocol

Protocol Value

Http

8080

Tcp

Install with Default

Advanced

(select this if you want install with default settings if don't have environment value and working directory)

(select this if you want to go with advanced settings, where you select you own environment value and working directory)

If you choose Advanced option:

ENV VARIABLE

Give env variable.

Eg:key==value

WORKING DIR

WORKDIR for the application.

Eg:usr/src/yourAPP

Here use ( use the path after " :" )

--mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml

Access

Public

Private

(select this if you want to make it public)

(select this if you want to make it private)

Step-by-Step Guide to gatus Deployment

Docker Image Selection:
- Docker Image Name:gatus
Application Details:
- Application Name: gatus
- Resource Allocation: Set the desired resource allocation from 0-100%.
Protocol Configuration:
- Protocol: HTTP
- Port: 8080
Installation Options:
- Choose between "Default" or "Advanced" installation.
Advanced Installation (Optional):
- If selecting "Advanced," you can customize the environment variables and working directory:
- Environment Variables:
  Environment variables are dynamic values used by a containerized application for configuration. They are defined as key-value pairs, like API_KEY=xyz, and provide flexibility to adjust an app's behavior without changing its code.
  - Environment Variables: Define environment variables with keys and values (e.g., key=value).
- Working Directory:
  The working directory is the starting point inside a container where an app's files are located. It affects relative file paths and operations. For example, if set to /usr/src/yourAPP, an app will reference files from there, like /usr/src/yourAPP/data.txt.
  - Working Directory: Set the working directory for the application (e.g., usr/src/yourAPP).
  - Here use ( use the path after " :" )
  - --mount type=bind,source="$(pwd)"/config.yaml,target=/config/config.yaml
Access Configuration:
- Choose between "Public" or "Private" access to the deployed application.
Installation:
- Click the "Install" button to initiate the deployment process.

By following these steps, you can effortlessly deploy an gatus instance with your chosen configurations. This enables you to tailor the environment to match your application's requirements and specifications. Whether opting for the default installation or delving into advanced settings, our platform ensures a seamless deployment experience while providing you the flexibility to customize according to your needs.

Visual Snapshots

Youtube Tutorial

Check out our youtube video for more clarification.

FAQ

About uptime gatusimage we used.

This is the official uptime gatus image.

Can I deploy my own uptime gatus image with modified configuration ?

Yes, you can simply deploy any version or modified image to our platform by linking your docker hub account to our platform.

Are my data persistent ?

For the free user there is no persistence, and for the premium user you can different type of persistence.

Join us