forked from GithubBackups/healthchecks
Docs overhaul WIP
This commit is contained in:
parent
74ab0d1931
commit
a276c24dd3
@ -75,6 +75,5 @@ urlpatterns = [
|
||||
path("docs/", views.serve_doc, name="hc-docs"),
|
||||
path("docs/api/", views.docs_api, name="hc-docs-api"),
|
||||
path("docs/cron/", views.docs_cron, name="hc-docs-cron"),
|
||||
path("docs/resources/", views.docs_resources, name="hc-docs-resources"),
|
||||
path("docs/<slug:doc>/", views.serve_doc, name="hc-serve-doc"),
|
||||
]
|
||||
|
@ -272,6 +272,7 @@ def serve_doc(request, doc="introduction"):
|
||||
content = open(path, "r", encoding="utf-8").read()
|
||||
content = content.replace("SITE_NAME", settings.SITE_NAME)
|
||||
content = content.replace("PING_URL", settings.PING_ENDPOINT + "your-uuid-here")
|
||||
content = content.replace("IMG_URL", os.path.join(settings.STATIC_URL, "img/docs"))
|
||||
content = content.replace(
|
||||
"PING_EMAIL", "your-uuid-here@%s" % settings.PING_EMAIL_DOMAIN
|
||||
)
|
||||
@ -303,11 +304,6 @@ def docs_cron(request):
|
||||
return render(request, "front/docs_cron.html", {})
|
||||
|
||||
|
||||
def docs_resources(request):
|
||||
ctx = {"page": "docs", "section": "resources"}
|
||||
return render(request, "front/docs_resources.html", ctx)
|
||||
|
||||
|
||||
@require_POST
|
||||
@login_required
|
||||
def add_check(request, code):
|
||||
|
@ -83,11 +83,31 @@ a.section:hover {
|
||||
border-radius: 4px;
|
||||
}
|
||||
|
||||
.docs-content li {
|
||||
.docs-content {
|
||||
line-height: 2;
|
||||
}
|
||||
|
||||
.docs-content h1 {
|
||||
font-size: 24px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.docs-content h2 {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.docs-content ul {
|
||||
padding-left: 15px;
|
||||
}
|
||||
|
||||
.docs-content li {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.docs-content img {
|
||||
max-width: 100%;
|
||||
max-width: 66%;
|
||||
border: 6px solid #DDD;
|
||||
}
|
||||
|
||||
|
||||
|
BIN
static/img/docs/edit_cron_schedule.png
Normal file
BIN
static/img/docs/edit_cron_schedule.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 54 KiB |
BIN
static/img/docs/edit_name.png
Normal file
BIN
static/img/docs/edit_name.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 54 KiB |
BIN
static/img/docs/edit_simple_schedule.png
Normal file
BIN
static/img/docs/edit_simple_schedule.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 35 KiB |
BIN
static/img/docs/emails.png
Normal file
BIN
static/img/docs/emails.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 71 KiB |
BIN
static/img/docs/filtering_rules.png
Normal file
BIN
static/img/docs/filtering_rules.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 41 KiB |
@ -27,7 +27,7 @@ curl -fsS --retry <span class="m">3</span> -X POST --data-raw <span class="s2">&
|
||||
</pre></div>
|
||||
|
||||
|
||||
<h2>As One-Liner</h2>
|
||||
<h2>All in One Line</h2>
|
||||
<p>Finally, all of the above can be packaged in a single line. The one-line
|
||||
version can be put directly in crontab, without using a wrapper script.</p>
|
||||
<div class="highlight"><pre><span></span><span class="nv">m</span><span class="o">=</span><span class="k">$(</span>/usr/bin/certbot renew <span class="m">2</span>><span class="p">&</span><span class="m">1</span><span class="k">)</span><span class="p">;</span> curl -fsS -X POST --data-raw <span class="s2">"</span><span class="nv">$m</span><span class="s2">"</span> <span class="s2">"PING_URL</span><span class="k">$(</span><span class="o">[</span> <span class="nv">$?</span> -ne <span class="m">0</span> <span class="o">]</span> <span class="o">&&</span> <span class="nb">echo</span> -n /fail<span class="k">)</span><span class="s2">"</span>
|
||||
|
@ -34,7 +34,7 @@ if [ $? -ne 0 ]; then url=$url/fail; fi
|
||||
curl -fsS --retry 3 -X POST --data-raw "$m" $url
|
||||
```
|
||||
|
||||
## As One-Liner
|
||||
## All in One Line
|
||||
|
||||
Finally, all of the above can be packaged in a single line. The one-line
|
||||
version can be put directly in crontab, without using a wrapper script.
|
||||
|
58
templates/docs/configuring_checks.html
Normal file
58
templates/docs/configuring_checks.html
Normal file
@ -0,0 +1,58 @@
|
||||
<h1>Configuring Checks</h1>
|
||||
<p>In SITE_NAME, a <strong>Check</strong> represents a single service you want to
|
||||
monitor. For example, when monitoring cron jobs, you would create a separate check for
|
||||
each cron job to be monitored. SITE_NAME pricing plans are structured primarily
|
||||
around how many checks you can have in your account. You can create checks
|
||||
either in SITE_NAME web interface or by calling <a href="../api/">API</a>.</p>
|
||||
<h2>Name, Tags, Description</h2>
|
||||
<p>Describe each check using optional name, tags and description fields.</p>
|
||||
<p><img alt="Editing name, tags and description" src="IMG_URL/edit_name.png" /></p>
|
||||
<ul>
|
||||
<li><strong>Name</strong>: names are optional, but it is a good idea to set them.
|
||||
Good naming becomes especially important as you add more checks in the
|
||||
account. Names are displayed in the web interface, in email reports and in the
|
||||
notifications that SITE_NAME sends out.</li>
|
||||
<li><strong>Tags</strong>: a space-separated list of optional labels. Use tags to organize and group
|
||||
checks within a project. You can tag checks by environment
|
||||
(<code>prod</code>, <code>staging</code>, <code>dev</code>, ...) or by role (<code>www</code>, <code>db</code>, <code>worker</code>, ...) or using
|
||||
any other system.</li>
|
||||
<li><strong>Description</strong>: a free-form text field with any related information for your team
|
||||
or for your future self: what is being monitored, who set it up,
|
||||
what to do in case of failures, where to look for additional information.</li>
|
||||
</ul>
|
||||
<h2>Simple Schedules</h2>
|
||||
<p>SITE_NAME supports two types of schedules: "simple" and "cron". Use "Simple" schedules
|
||||
for monitoring processes that are expected to run at relatively regular time
|
||||
intervals: once an hour, once a day, once a week.</p>
|
||||
<p><img alt="Editing the period and grace time" src="IMG_URL/edit_simple_schedule.png" /></p>
|
||||
<p>For simple schedules you configure two time durations, <strong>Period</strong> and <strong>Grace Time</strong>.</p>
|
||||
<ul>
|
||||
<li><strong>Period</strong>: the expected time between pings</li>
|
||||
<li><strong>Grace Time</strong>: when a check is late, how long to wait before sending an alert.
|
||||
Use this variable to account for small, expected deviations in job execution times.</li>
|
||||
</ul>
|
||||
<h2>Cron Schedules</h2>
|
||||
<p>Use "cron" for monitoring processes with more complex schedules, and to ensure
|
||||
jobs run <strong>at the correct time</strong> (not just at correct intervals).</p>
|
||||
<p><img alt="Editing cron schedule" src="IMG_URL/edit_cron_schedule.png" /></p>
|
||||
<p>You will need to specify Cron Expression, Server's Time Zone and Grace Time.</p>
|
||||
<ul>
|
||||
<li><strong>Cron Expression</strong>: enter the same expression you've used in the crontab.</li>
|
||||
<li><strong>Server's Time Zone</strong>: cron daemon typically uses the local time of the machine it is
|
||||
running on. If the machine is not using UTC timezone, you need to tell SITE_NAME
|
||||
what timezone to use.</li>
|
||||
<li><strong>Grace Time</strong>: same as for simple schedules, how long to wait before sending an alert
|
||||
for a late check.</li>
|
||||
</ul>
|
||||
<h2>Filtering Rules</h2>
|
||||
<p><img alt="Setting filtering rules" src="IMG_URL/filtering_rules.png" /></p>
|
||||
<ul>
|
||||
<li><strong>Allowed request methods for HTTP requests</strong>: optionally require the HTTP ping
|
||||
requests to use HTTP POST. Use this if you run into issues of bots hitting the ping
|
||||
URLs when you send them in email or post them in chat.</li>
|
||||
<li><strong>Subject must contain</strong>: when pinging via <a href="../email/">email</a>, require a particular
|
||||
keyword in the subject line. SITE_NAME will ignore any email messages with the
|
||||
keyword missing. This is useful, for example, when backup software sends
|
||||
emails with "Backup Successful" or "Backup Failed" subject lines after each run,
|
||||
and you want SITE_NAME to ignore the "Backup Failed" messages.</li>
|
||||
</ul>
|
68
templates/docs/configuring_checks.md
Normal file
68
templates/docs/configuring_checks.md
Normal file
@ -0,0 +1,68 @@
|
||||
# Configuring Checks
|
||||
|
||||
In SITE_NAME, a **Check** represents a single service you want to
|
||||
monitor. For example, when monitoring cron jobs, you would create a separate check for
|
||||
each cron job to be monitored. SITE_NAME pricing plans are structured primarily
|
||||
around how many checks you can have in your account. You can create checks
|
||||
either in SITE_NAME web interface or by calling [API](../api/).
|
||||
|
||||
## Name, Tags, Description
|
||||
|
||||
Describe each check using optional name, tags and description fields.
|
||||
|
||||

|
||||
|
||||
* **Name**: names are optional, but it is a good idea to set them.
|
||||
Good naming becomes especially important as you add more checks in the
|
||||
account. Names are displayed in the web interface, in email reports and in the
|
||||
notifications that SITE_NAME sends out.
|
||||
* **Tags**: a space-separated list of optional labels. Use tags to organize and group
|
||||
checks within a project. You can tag checks by environment
|
||||
(`prod`, `staging`, `dev`, ...) or by role (`www`, `db`, `worker`, ...) or using
|
||||
any other system.
|
||||
* **Description**: a free-form text field with any related information for your team
|
||||
or for your future self: what is being monitored, who set it up,
|
||||
what to do in case of failures, where to look for additional information.
|
||||
|
||||
## Simple Schedules
|
||||
|
||||
SITE_NAME supports two types of schedules: "simple" and "cron". Use "Simple" schedules
|
||||
for monitoring processes that are expected to run at relatively regular time
|
||||
intervals: once an hour, once a day, once a week.
|
||||
|
||||

|
||||
|
||||
For simple schedules you configure two time durations, **Period** and **Grace Time**.
|
||||
|
||||
* **Period**: the expected time between pings
|
||||
* **Grace Time**: when a check is late, how long to wait before sending an alert.
|
||||
Use this variable to account for small, expected deviations in job execution times.
|
||||
|
||||
## Cron Schedules
|
||||
|
||||
Use "cron" for monitoring processes with more complex schedules, and to ensure
|
||||
jobs run **at the correct time** (not just at correct intervals).
|
||||
|
||||

|
||||
|
||||
You will need to specify Cron Expression, Server's Time Zone and Grace Time.
|
||||
|
||||
* **Cron Expression**: enter the same expression you've used in the crontab.
|
||||
* **Server's Time Zone**: cron daemon typically uses the local time of the machine it is
|
||||
running on. If the machine is not using UTC timezone, you need to tell SITE_NAME
|
||||
what timezone to use.
|
||||
* **Grace Time**: same as for simple schedules, how long to wait before sending an alert
|
||||
for a late check.
|
||||
|
||||
## Filtering Rules
|
||||
|
||||

|
||||
|
||||
* **Allowed request methods for HTTP requests**: optionally require the HTTP ping
|
||||
requests to use HTTP POST. Use this if you run into issues of bots hitting the ping
|
||||
URLs when you send them in email or post them in chat.
|
||||
* **Subject must contain**: when pinging via [email](../email/), require a particular
|
||||
keyword in the subject line. SITE_NAME will ignore any email messages with the
|
||||
keyword missing. This is useful, for example, when backup software sends
|
||||
emails with "Backup Successful" or "Backup Failed" subject lines after each run,
|
||||
and you want SITE_NAME to ignore the "Backup Failed" messages.
|
@ -1,9 +1,10 @@
|
||||
<h1>Email</h1>
|
||||
<p>As an alternative to HTTP/HTTPS requests, you can "ping" checks by
|
||||
sending an emails to special email addresses.</p>
|
||||
<h2>Use Case: Email Delivery Monitoring</h2>
|
||||
<p>Consider a cron job which runs weekly and sends weekly email
|
||||
reports to a list of e-mail addresses. You have already set up a check to get alerted
|
||||
<p><img alt="Email address for pinging via email" src="IMG_URL/emails.png" /></p>
|
||||
<h2>Use Case: Newsletter Delivery Monitoring</h2>
|
||||
<p>Consider a cron job which runs weekly and sends weekly newsletters
|
||||
to a list of e-mail addresses. You have already set up a check to get alerted
|
||||
when your cron job fails to run. But what you ultimately want to check is if
|
||||
<strong>your emails are getting sent and delivered</strong>.</p>
|
||||
<p>The solution: set up another check, and add its email address to your list of
|
||||
|
@ -3,10 +3,12 @@
|
||||
As an alternative to HTTP/HTTPS requests, you can "ping" checks by
|
||||
sending an emails to special email addresses.
|
||||
|
||||
## Use Case: Email Delivery Monitoring
|
||||

|
||||
|
||||
Consider a cron job which runs weekly and sends weekly email
|
||||
reports to a list of e-mail addresses. You have already set up a check to get alerted
|
||||
## Use Case: Newsletter Delivery Monitoring
|
||||
|
||||
Consider a cron job which runs weekly and sends weekly newsletters
|
||||
to a list of e-mail addresses. You have already set up a check to get alerted
|
||||
when your cron job fails to run. But what you ultimately want to check is if
|
||||
**your emails are getting sent and delivered**.
|
||||
|
||||
|
@ -1,14 +1,14 @@
|
||||
<h2>SITE_NAME</h2>
|
||||
<h1>SITE_NAME</h1>
|
||||
<p>SITE_NAME is a service for monitoring cron jobs and similar periodic processes:</p>
|
||||
<ul>
|
||||
<li>SITE_NAME <strong>listens for pings</strong> from services being monitored.</li>
|
||||
<li>SITE_NAME <strong>listens for HTTP requests ("pings")</strong> from services being monitored.</li>
|
||||
<li>It <strong>keeps silent</strong> as long as pings arrive on time.</li>
|
||||
<li>It <strong>raises an alert</strong> as soon as a ping does not arrive on time.</li>
|
||||
</ul>
|
||||
<p>SITE_NAME works as a <a href="https://en.wikipedia.org/wiki/Dead_man%27s_switch">dead man's switch</a> for processes that need to
|
||||
run continuously or on regular, known schedule:</p>
|
||||
run continuously or on regular, known schedule. For example:</p>
|
||||
<ul>
|
||||
<li>filesystem, database backups</li>
|
||||
<li>filesystem backups, database backups</li>
|
||||
<li>task queues</li>
|
||||
<li>database replication status</li>
|
||||
<li>report generation scripts</li>
|
||||
|
@ -1,15 +1,15 @@
|
||||
## SITE_NAME
|
||||
# SITE_NAME
|
||||
|
||||
SITE_NAME is a service for monitoring cron jobs and similar periodic processes:
|
||||
|
||||
* SITE_NAME **listens for pings** from services being monitored.
|
||||
* SITE_NAME **listens for HTTP requests ("pings")** from services being monitored.
|
||||
* It **keeps silent** as long as pings arrive on time.
|
||||
* It **raises an alert** as soon as a ping does not arrive on time.
|
||||
|
||||
SITE_NAME works as a [dead man's switch](https://en.wikipedia.org/wiki/Dead_man%27s_switch) for processes that need to
|
||||
run continuously or on regular, known schedule:
|
||||
run continuously or on regular, known schedule. For example:
|
||||
|
||||
* filesystem, database backups
|
||||
* filesystem backups, database backups
|
||||
* task queues
|
||||
* database replication status
|
||||
* report generation scripts
|
||||
|
@ -1,24 +1,26 @@
|
||||
<h2>Monitoring Cron Jobs</h2>
|
||||
<p>SITE_NAME is perfectly suited for monitoring cron jobs.
|
||||
Let's look at an example: a machine with the following cron job:</p>
|
||||
<h1>Monitoring Cron Jobs</h1>
|
||||
<p>SITE_NAME is perfectly suited for monitoring cron jobs. All you have to do is
|
||||
update your cron job command to send a HTTP request to SITE_NAME
|
||||
after a job completes.</p>
|
||||
<p>Let's look at an example:</p>
|
||||
<div class="highlight"><pre><span></span>$ crontab -l
|
||||
<span class="c1"># m h dom mon dow command</span>
|
||||
<span class="m">8</span> <span class="m">6</span> * * * /home/user/backup.sh
|
||||
</pre></div>
|
||||
|
||||
|
||||
<p>You can use SITE_NAME to get a notification whenever the <code>backup.sh</code> script does not
|
||||
complete successfully. Here is how to set that up.</p>
|
||||
<p>The above job runs <code>/home/user/backup.sh</code> every day at 6:08. The backup
|
||||
script is presumably a headless, background process. Even if it works
|
||||
correctly currently, it can start silently failing in future, without
|
||||
anyone noticing.</p>
|
||||
<p>You can set up SITE_NAME to notify you whenever the backup script doesn't
|
||||
run on time and complete successfully. Here are the steps to do that.</p>
|
||||
<ol>
|
||||
<li>
|
||||
<p>If you have not already, sign up for a free SITE_NAME account.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>In your SITE_NAME account, <strong>add a new check</strong>.</p>
|
||||
<p>Note: in SITE_NAME, a <strong>check</strong> represents a single service you want to
|
||||
monitor. For example, a single cron job. For each additional cron job you will
|
||||
create another check. SITE_NAME pricing plans are structured primarily
|
||||
around how many checks you can have in the account.</p>
|
||||
</li>
|
||||
<li>
|
||||
<p>Give the check <strong>a meaningful name</strong>. Good naming will become
|
||||
|
@ -1,7 +1,10 @@
|
||||
## Monitoring Cron Jobs
|
||||
# Monitoring Cron Jobs
|
||||
|
||||
SITE_NAME is perfectly suited for monitoring cron jobs.
|
||||
Let's look at an example: a machine with the following cron job:
|
||||
SITE_NAME is perfectly suited for monitoring cron jobs. All you have to do is
|
||||
update your cron job command to send a HTTP request to SITE_NAME
|
||||
after a job completes.
|
||||
|
||||
Let's look at an example:
|
||||
|
||||
```bash
|
||||
$ crontab -l
|
||||
@ -9,18 +12,18 @@ $ crontab -l
|
||||
8 6 * * * /home/user/backup.sh
|
||||
```
|
||||
|
||||
You can use SITE_NAME to get a notification whenever the `backup.sh` script does not
|
||||
complete successfully. Here is how to set that up.
|
||||
The above job runs `/home/user/backup.sh` every day at 6:08. The backup
|
||||
script is presumably a headless, background process. Even if it works
|
||||
correctly currently, it can start silently failing in future, without
|
||||
anyone noticing.
|
||||
|
||||
You can set up SITE_NAME to notify you whenever the backup script doesn't
|
||||
run on time and complete successfully. Here are the steps to do that.
|
||||
|
||||
1. If you have not already, sign up for a free SITE_NAME account.
|
||||
|
||||
1. In your SITE_NAME account, **add a new check**.
|
||||
|
||||
Note: in SITE_NAME, a **check** represents a single service you want to
|
||||
monitor. For example, a single cron job. For each additional cron job you will
|
||||
create another check. SITE_NAME pricing plans are structured primarily
|
||||
around how many checks you can have in the account.
|
||||
|
||||
1. Give the check **a meaningful name**. Good naming will become
|
||||
increasingly important as you add more checks to your account.
|
||||
|
||||
|
35
templates/docs/resources.html
Normal file
35
templates/docs/resources.html
Normal file
@ -0,0 +1,35 @@
|
||||
<h1>Third-Party Resources</h1>
|
||||
<p>A collection of third-party software projects that integrate with SITE_NAME.
|
||||
Please submit additions and corrections
|
||||
<a href="https://github.com/healthchecks/healthchecks/issues">on GitHub</a>.</p>
|
||||
<h2>Deployment Tools</h2>
|
||||
<ul>
|
||||
<li><a href="https://github.com/iphoting/healthchecks/">iphoting/healthchecks</a> – Deploy Healthchecks to Heroku</li>
|
||||
<li><a href="https://github.com/haswalt/docker-healthchecks">haswalt/docker-healthchecks</a> – Docker image</li>
|
||||
<li><a href="https://github.com/galexrt/docker-healthchecks">galexrt/docker-healthchecks</a> – Docker image</li>
|
||||
<li><a href="https://github.com/linuxserver/docker-healthchecks">linuxserver/docker-healthchecks</a> – Docker image</li>
|
||||
<li><a href="https://galaxy.ansible.com/coaxial/healthchecks">coaxial/healthchecks</a> – Ansible role for deploying Healthchecks</li>
|
||||
</ul>
|
||||
<h2>API Wrappers</h2>
|
||||
<ul>
|
||||
<li><a href="https://github.com/jwulf/healthchecks.io">jwulf/healthchecks.io</a> – API wrapper in Javascript. Supports pinging.</li>
|
||||
<li><a href="https://github.com/MyPropertyOffice/node-hchk">MyPropertyOffice/node-hchk</a> – API wrapper in Javascript. Supports listing, creating, updating, deleting, pausing and pinging checks. Supports listing integrations.</li>
|
||||
<li><a href="https://github.com/gyde-tv/checks">gyde-tv/checks</a> – API wrapper in Ruby. Supports pinging.</li>
|
||||
<li><a href="https://github.com/kristofferahl/go-healthchecksio">kristofferahl/go-healthchecksio</a> – API wrapper in Go. Supports listing, creating, updating, deleting, pausing, pinging.</li>
|
||||
<li><a href="https://github.com/frozzare/go-healthchecks">frozzare/go-healthchecks</a> – API wrapper in Go. Supports pinging and failing.</li>
|
||||
<li><a href="https://github.com/healthchecks/hchk">healthchecks/hchk</a> – API wrapper & CLI in Python. Supports creating, pinging.</li>
|
||||
<li><a href="https://github.com/pforret/crontask">crontask.sh</a> – bash wrapper to use in crontab. Supports pinging.</li>
|
||||
</ul>
|
||||
<h2>Plugins & Integrations</h2>
|
||||
<ul>
|
||||
<li><a href="https://github.com/kristofferahl/terraform-provider-healthchecksio">terraform-provider-healthchecksio</a> – Terraform Provider for Healthchecks.io.</li>
|
||||
<li><a href="https://github.com/prgTW/healthchecks-bundle">prgTW/healthchecks-bundle</a> – Symfony bundle. Supports listing, creating, pinging, pausing.</li>
|
||||
<li><a href="https://github.com/janiscaunecm/Healthchecks_Magento">janiscaunecm/Healthchecks_Magento</a> – Magento module for Healthchecks.io.</li>
|
||||
<li><a href="https://github.com/binarybucks/restic-tools">binarybucks/restic-tools</a> – Wrapper around restic backup, with Healthchecks.io support.</li>
|
||||
<li><a href="https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook">borgmatic</a> – backup software for servers and workstations, includes Healthchecks.io support.</li>
|
||||
</ul>
|
||||
<h2>Other</h2>
|
||||
<ul>
|
||||
<li><a href="https://github.com/taylus/HealthTray">HealthTray</a> – Watch your healthchecks in Windows system tray.</li>
|
||||
<li><a href="https://github.com/healthchecks/dashboard">healthchecks/dashboard</a> – A standalone HTML page showing the status of the checks in your account.</li>
|
||||
</ul>
|
36
templates/docs/resources.md
Normal file
36
templates/docs/resources.md
Normal file
@ -0,0 +1,36 @@
|
||||
# Third-Party Resources
|
||||
|
||||
A collection of third-party software projects that integrate with SITE_NAME.
|
||||
Please submit additions and corrections
|
||||
[on GitHub](https://github.com/healthchecks/healthchecks/issues).
|
||||
|
||||
## Deployment Tools
|
||||
|
||||
* [iphoting/healthchecks](https://github.com/iphoting/healthchecks/) – Deploy Healthchecks to Heroku
|
||||
* [haswalt/docker-healthchecks](https://github.com/haswalt/docker-healthchecks) – Docker image
|
||||
* [galexrt/docker-healthchecks](https://github.com/galexrt/docker-healthchecks) – Docker image
|
||||
* [linuxserver/docker-healthchecks](https://github.com/linuxserver/docker-healthchecks) – Docker image
|
||||
* [coaxial/healthchecks](https://galaxy.ansible.com/coaxial/healthchecks) – Ansible role for deploying Healthchecks
|
||||
|
||||
## API Wrappers
|
||||
|
||||
* [jwulf/healthchecks.io](https://github.com/jwulf/healthchecks.io) – API wrapper in Javascript. Supports pinging.
|
||||
* [MyPropertyOffice/node-hchk](https://github.com/MyPropertyOffice/node-hchk) – API wrapper in Javascript. Supports listing, creating, updating, deleting, pausing and pinging checks. Supports listing integrations.
|
||||
* [gyde-tv/checks](https://github.com/gyde-tv/checks) – API wrapper in Ruby. Supports pinging.
|
||||
* [kristofferahl/go-healthchecksio](https://github.com/kristofferahl/go-healthchecksio) – API wrapper in Go. Supports listing, creating, updating, deleting, pausing, pinging.
|
||||
* [frozzare/go-healthchecks](https://github.com/frozzare/go-healthchecks) – API wrapper in Go. Supports pinging and failing.
|
||||
* [healthchecks/hchk](https://github.com/healthchecks/hchk) – API wrapper & CLI in Python. Supports creating, pinging.
|
||||
* [crontask.sh](https://github.com/pforret/crontask) – bash wrapper to use in crontab. Supports pinging.
|
||||
|
||||
## Plugins & Integrations
|
||||
|
||||
* [terraform-provider-healthchecksio](https://github.com/kristofferahl/terraform-provider-healthchecksio) – Terraform Provider for Healthchecks.io.
|
||||
* [prgTW/healthchecks-bundle](https://github.com/prgTW/healthchecks-bundle) – Symfony bundle. Supports listing, creating, pinging, pausing.
|
||||
* [janiscaunecm/Healthchecks_Magento](https://github.com/janiscaunecm/Healthchecks_Magento) – Magento module for Healthchecks.io.
|
||||
* [binarybucks/restic-tools](https://github.com/binarybucks/restic-tools) – Wrapper around restic backup, with Healthchecks.io support.
|
||||
* [borgmatic](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook) – backup software for servers and workstations, includes Healthchecks.io support.
|
||||
|
||||
## Other
|
||||
|
||||
* [HealthTray](https://github.com/taylus/HealthTray) – Watch your healthchecks in Windows system tray.
|
||||
* [healthchecks/dashboard](https://github.com/healthchecks/dashboard) – A standalone HTML page showing the status of the checks in your account.
|
@ -12,6 +12,7 @@
|
||||
<a href="{% url 'hc-docs' %}">Introduction</a>
|
||||
</li>
|
||||
{% include "front/docs_nav_item.html" with slug="monitoring_cron_jobs" title="Monitoring cron jobs" %}
|
||||
{% include "front/docs_nav_item.html" with slug="configuring_checks" title="Configuring checks" %}
|
||||
{% include "front/docs_nav_item.html" with slug="signalling_failures" title="Signalling failures" %}
|
||||
{% include "front/docs_nav_item.html" with slug="measuring_script_run_time" title="Measuring script run time" %}
|
||||
{% include "front/docs_nav_item.html" with slug="attaching_logs" title="Attaching logs" %}
|
||||
@ -30,9 +31,7 @@
|
||||
<li{% if section == "api" %} class="active"{% endif %}>
|
||||
<a href="{% url 'hc-docs-api' %}">API</a>
|
||||
</li>
|
||||
<li {% if section == "resources" %} class="active"{% endif %}>
|
||||
<a href="{% url 'hc-docs-resources' %}">Third-party resources</a>
|
||||
</li>
|
||||
{% include "front/docs_nav_item.html" with slug="resources" title="Third-party resources" %}
|
||||
|
||||
<li class="nav-header">Cron</li>
|
||||
<li><a href="{% url 'hc-docs-cron' %}">Cron Syntax Cheatsheet</a></li>
|
||||
|
@ -1,56 +0,0 @@
|
||||
{% extends "front/base_docs.html" %}
|
||||
{% load compress static hc_extras %}
|
||||
|
||||
{% block title %}Third-Party Resources - {% site_name %}{% endblock %}
|
||||
|
||||
{% block description %}
|
||||
<meta name="description" content="Deployment tools, API wrappers, Plugins and Libraries">
|
||||
{% endblock %}
|
||||
|
||||
{% block docs_content %}
|
||||
<h1>Third-Party Resources</h1>
|
||||
|
||||
<p>A collection of third-party software projects that integrate
|
||||
with Healthchecks. Please submit additions and corrections
|
||||
<a href="https://github.com/healthchecks/healthchecks/issues">on GitHub</a>.
|
||||
</p>
|
||||
|
||||
<h2>Deployment Tools</h2>
|
||||
|
||||
<ul>
|
||||
{% include "front/single_resource.html" with url="https://github.com/iphoting/healthchecks/" name="iphoting/healthchecks" desc="Deploy Healthchecks to Heroku" %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/haswalt/docker-healthchecks" name="haswalt/docker-healthchecks" desc="Docker image" %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/galexrt/docker-healthchecks" name="galexrt/docker-healthchecks" desc="Docker image" %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/linuxserver/docker-healthchecks" name="linuxserver/docker-healthchecks" desc="Docker image" %}
|
||||
{% include "front/single_resource.html" with url="https://galaxy.ansible.com/coaxial/healthchecks" name="coaxial/healthchecks" desc="Ansible role for deploying Healthchecks" %}
|
||||
</ul>
|
||||
|
||||
<h2>API Wrappers</h2>
|
||||
|
||||
<ul>
|
||||
{% include "front/single_resource.html" with url="https://github.com/jwulf/healthchecks.io" name="jwulf/healthchecks.io" desc="API wrapper in Javascript. Supports pinging." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/MyPropertyOffice/node-hchk" name="MyPropertyOffice/node-hchk" desc="API wrapper in Javascript. Supports listing, creating, updating, deleting, pausing and pinging checks. Supports listing integrations." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/gyde-tv/checks" name="gyde-tv/checks" desc="API wrapper in Ruby. Supports pinging." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/kristofferahl/go-healthchecksio" name="kristofferahl/go-healthchecksio" desc="API wrapper in Go. Supports listing, creating, updating, deleting, pausing, pinging." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/frozzare/go-healthchecks" name="frozzare/go-healthchecks" desc="API wrapper in Go. Supports pinging and failing." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/healthchecks/hchk" name="healthchecks/hchk" desc="API wrapper & CLI in Python. Supports creating, pinging." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/pforret/crontask" name="crontask.sh" desc="bash wrapper to use in crontab. Supports pinging." %}
|
||||
</ul>
|
||||
|
||||
<h2>Plugins & Integrations</h2>
|
||||
|
||||
<ul>
|
||||
{% include "front/single_resource.html" with url="https://github.com/kristofferahl/terraform-provider-healthchecksio" name="terraform-provider-healthchecksio" desc="Terraform Provider for Healthchecks.io." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/prgTW/healthchecks-bundle" name="prgTW/healthchecks-bundle" desc="Symfony bundle. Supports listing, creating, pinging, pausing." %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/janiscaunecm/Healthchecks_Magento" name="janiscaunecm/Healthchecks_Magento" desc="Magento module for Healthchecks.io" %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/binarybucks/restic-tools" name="binarybucks/restic-tools" desc="Wrapper around restic backup, with Healthchecks.io support." %}
|
||||
{% include "front/single_resource.html" with url="https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#healthchecks-hook" name="borgmatic" desc="backup software for servers and workstations, includes Healthchecks.io support." %}
|
||||
</ul>
|
||||
|
||||
<h2>Other</h2>
|
||||
|
||||
<ul>
|
||||
{% include "front/single_resource.html" with url="https://github.com/taylus/HealthTray" name="HealthTray" desc="Watch your healthchecks in Windows system tray" %}
|
||||
{% include "front/single_resource.html" with url="https://github.com/healthchecks/dashboard" name="healthchecks/dashboard" desc="A standalone HTML page showing the status of the checks in your account. " %}
|
||||
</ul>
|
||||
{% endblock %}
|
@ -1,3 +0,0 @@
|
||||
<li>
|
||||
<a href="{{ url }}">{{ name }}</a> – {{ desc }}
|
||||
</li>
|
Loading…
x
Reference in New Issue
Block a user