cmd/hdrwtch: make this ready

Signed-off-by: Xe Iaso <me@xeiaso.net>

6 files changed, 123 insertions, 0 deletions

diff --git a/cmd/hdrwtch/docs/alerts.md b/cmd/hdrwtch/docs/alerts.md
new file mode 100644
index 0000000..59b5c3e
--- /dev/null
+++ b/cmd/hdrwtch/docs/alerts.md
@@ -0,0 +1,20 @@
+---
+title: "Alerts"
+date: 2024-08-21
+updated: 2024-08-21
+slug: "/alerts"
+---
+
+When the Last-Modified header of a URL changes, hdrwtch sends an alert to the user who is monitoring that URL. The alert contains the URL that was monitored, the previous Last-Modified header value, the new Last-Modified header value, and the time of the change.
+
+Here is an example alert:
+
+<div class="flex items-start gap-2.5 not-prose">
+   <div class="flex flex-col w-full max-w-[320px] leading-1.5 p-4 border-gray-200 bg-gray-100 rounded-e-xl rounded-es-xl dark:bg-gray-700">
+      <p class="text-sm font-normal py-2.5 text-gray-900 dark:text-white"><span class="font-medium">Changing route</span>:<br /><br />Last modified: Wed, 21 Aug 2024 18:18:15 GMT<br />Region: yow-dev<br />Status code: 200<br />Remark:</p>
+   </div>
+</div>
+
+The alert is sent to the user via the messaging service that the user has configured in their account settings, but it defaults to Telegram if no other service is configured.
+
+If there is an error making the request, the remark field will contain the error message.
diff --git a/cmd/hdrwtch/docs/contact.md b/cmd/hdrwtch/docs/contact.md
new file mode 100644
index 0000000..fee80d0
--- /dev/null
+++ b/cmd/hdrwtch/docs/contact.md
@@ -0,0 +1,8 @@
+---
+title: "Contact"
+date: 2024-08-21
+updated: 2024-08-21
+slug: "/contact"
+---
+
+To get in touch with us, please send an email to [hdrwtch@xeserv.us](mailto:hdrwtch@xeserv.us). We will respond to your inquiry as soon as possible.
diff --git a/cmd/hdrwtch/docs/index.md b/cmd/hdrwtch/docs/index.md
new file mode 100644
index 0000000..ce50e1b
--- /dev/null
+++ b/cmd/hdrwtch/docs/index.md
@@ -0,0 +1,28 @@
+---
+title: "hdrwtch"
+date: 2024-08-21
+updated: 2024-08-21
+slug: "/"
+---
+
+hdrwtch is a tool that watches for changes in the `Last-Modified` header of a URL. You can use this to monitor the freshness of a web page, or to trigger an action when a page is updated.
+
+## Setup
+
+1. [Log in](/login) with Telegram.
+2. Configure [a new probe](/probe).
+3. Sit back and wait for updates.
+
+[Alerts](/docs/alerts) will be sent to you via Telegram when a probe detects a change in the `Last-Modified` header. They will be aggregated into [reports](/docs/reports) that you can view at any time.
+
+## Pricing
+
+hdrwtch is free to use for up to 5 probes. For more than 5 probes, you will need to [upgrade to a paid plan](/docs/pricing).
+
+## FAQ
+
+Here are some frequently asked questions about hdrwtch and their answers.
+
+### Why is hdrwtch in my logs?
+
+A user configured a probe to watch a URL that you control. This is not a security risk. Please see ["Why is hdrwtch in my logs?"](/docs/why-in-logs) for more information.
diff --git a/cmd/hdrwtch/docs/pricing.md b/cmd/hdrwtch/docs/pricing.md
new file mode 100644
index 0000000..e10000f
--- /dev/null
+++ b/cmd/hdrwtch/docs/pricing.md
@@ -0,0 +1,45 @@
+---
+title: "Pricing"
+date: 2024-08-21
+updated: 2024-08-21
+slug: "/pricing"
+---
+
+hdrwtch offers the following pricing plans:
+
+## Free plan
+
+$0 per month
+
+| Feature           | Limit          |
+| ----------------- | -------------- |
+| Probes            | 5              |
+| Messaging         | Telegram only  |
+| History retention | 1 month        |
+| Support           | Community only |
+
+## Pro plan
+
+$3 per month
+
+| Feature           | Limit                     |
+| ----------------- | ------------------------- |
+| Probes            | 50                        |
+| Messaging         | Telegram, Email, Webhooks |
+| History retention | 6 months                  |
+| Support           | Email only                |
+
+## Enterprise plan
+
+Custom pricing depending on requirements
+
+| Feature           | Limit                                 |
+| ----------------- | ------------------------------------- |
+| Probes            | Unlimited                             |
+| Messaging         | Telegram, Email, Webhooks, Slack, SMS |
+| History retention | 1 year                                |
+| Support           | Email, Phone, Chat                    |
+
+---
+
+To upgrade to a paid plan, please [contact us](/docs/contact).
diff --git a/cmd/hdrwtch/docs/reports.md b/cmd/hdrwtch/docs/reports.md
new file mode 100644
index 0000000..22e50b1
--- /dev/null
+++ b/cmd/hdrwtch/docs/reports.md
@@ -0,0 +1,8 @@
+---
+title: "Reports"
+date: 2024-08-21
+updated: 2024-08-21
+slug: "/reports"
+---
+
+Reports are a work-in-progress feature and will be made public at a later date. Stay tuned for updates!
diff --git a/cmd/hdrwtch/docs/why-in-logs.md b/cmd/hdrwtch/docs/why-in-logs.md
new file mode 100644
index 0000000..f09f15e
--- /dev/null
+++ b/cmd/hdrwtch/docs/why-in-logs.md
@@ -0,0 +1,14 @@
+---
+title: "Why is hdrwtch in my logs?"
+date: 2024-08-21
+updated: 2024-08-21
+slug: "/why-in-logs"
+---
+
+hdrwtch is showing up in your logs because a user is monitoring your website. This allows that user to receive notifications when the contents of a specific URL change. The user can also monitor the status of the website and receive notifications when the website goes down or comes back up.
+
+If you want to block hdrwtch from monitoring your website, you can do so filtering out the user agent string `hdrwtch` in your server configuration. This will prevent hdrwtch from accessing your website and monitoring its contents, but it will also prevent the user from receiving notifications about your website.
+
+hdrwtch is configured to check URLs every 15 minutes.
+
+If you have any questions or concerns about hdrwtch, please [contact us](/docs/contact). We are happy to help you with any issues you may have.