🛡️
LinkGuard
⭐ Features💳 Pricing

LinkGuard Documentation

Complete guide to using LinkGuard for website monitoring, API integration, and notification setup

Contents

📋Overview

LinkGuard is a friendly and inclusive website monitoring service that helps you keep track of your online presence. We believe everyone deserves reliable monitoring, regardless of who they are or what they do.

🌟 Key Features

  • • Real-time website monitoring
  • • Instant Telegram notifications
  • • Response time tracking
  • • Uptime statistics
  • • Easy dashboard management
  • • Google OAuth authentication

🏗️ Tech Stack

  • • Next.js 14+ with App Router
  • • Prisma ORM + PostgreSQL
  • • NextAuth.js (Google OAuth)
  • • Telegram Bot API
  • • PayPal Subscriptions
  • • Tailwind CSS

🌈 Our Values

LinkGuard is built with inclusivity and accessibility in mind. We provide a welcoming environment where everyone can monitor their websites with confidence, regardless of their technical background or identity.

🚀Getting Started

Quick Start (30 seconds)

  1. 1
    Sign In: Click "Sign In" and authenticate with your Google account
  2. 2
    Add URL: Enter your website URL in the dashboard
  3. 3
    Setup Notifications: Add your Telegram chat ID (optional)
  4. 4
    Done! Your website is now being monitored 🎉

✨ Free Plan

  • • Monitor up to 10 URLs
  • • 1 Telegram notification channel
  • • Daily health checks
  • • Basic dashboard
  • • Community support

⭐ PRO Plan

  • • Monitor up to 100 URLs
  • • 10 Telegram notification channels
  • • Frequent health checks
  • • Advanced analytics
  • • Priority support

📊Dashboard Guide

Adding URLs to Monitor

  1. 1. Navigate to your dashboard after signing in
  2. 2. Find the "Add New URL to Monitor" section
  3. 3. Enter the full URL (e.g., https://example.com)
  4. 4. Optionally, give it a friendly name
  5. 5. Click "Add URL" - it will be checked immediately

URL Management

🟢 Healthy URLs

URLs returning 2xx status codes with reasonable response times

🟡 Slow URLs

URLs taking longer than 3 seconds to respond

🔴 Down URLs

URLs returning error codes or timing out

📊 Analytics

View response times, uptime statistics, and trends

Manual Checks

You can manually trigger a check for any URL by clicking the "Check Now" button in your dashboard.

💡 Pro Tip: Manual checks don't count towards your monitoring limits and are useful for immediate status verification.

📱Telegram Setup

Getting Your Chat ID

  1. 1. Open Telegram and search for @userinfobot
  2. 2. Start a conversation with the bot by clicking "Start"
  3. 3. The bot will reply with your user information including your Chat ID
  4. 4. Copy the Chat ID number (it looks like: 123456789)
  5. 5. Paste it in the Telegram settings section of your LinkGuard dashboard

Multiple Notification Channels

FREE users: Can add 1 Telegram channel

PRO users: Can add up to 10 Telegram channels

💡 You can add group chats, channels, or personal chats. Just make sure the bot can send messages to them!

Notification Format

✅ Website Status Update
🌐 URL: https://example.com
📊 Status: Online
⏱️ Response Time: 250ms
🕒 Time: 2024-01-15, 14:30:25

💳Pricing & Plans

FREE Plan

$0
Forever
  • ✓Monitor up to 10 URLs
  • ✓1 Telegram notification channel
  • ✓Daily health checks
  • ✓Basic dashboard
  • ✓Community support
POPULAR

PRO Plan

$19
per month
  • ✓Monitor up to 100 URLs
  • ✓10 Telegram notification channels
  • ✓Frequent health checks (every 5 minutes)
  • ✓Advanced dashboard with analytics
  • ✓Response time tracking
  • ✓Priority email support

Subscription Management

• Payment: Secure payments processed through PayPal

• Cancellation: Cancel anytime from the pricing page

• Downgrade: Plan changes take effect immediately

• Refunds: Contact support for billing questions

⚡API Reference

Authentication

All API endpoints require authentication through NextAuth.js session cookies. Web applications should use the built-in authentication flow.

Note: Direct API access is currently limited to authenticated web sessions. API tokens for external access are planned for future releases.

Endpoints

🔗 URLs Management

GET/api/urls

Get all monitored URLs for the authenticated user

POST/api/urls

Add a new URL to monitor

Request Body:

{
  "url": "https://example.com",
  "name": "My Website"
}
DELETE/api/urls/[id]

Delete a monitored URL

POST/api/urls/[id]/check

Manually trigger a check for a specific URL

👤 User Management

GET/api/user

Get current user information and settings

PUT/api/user

Update Telegram chat IDs

Request Body:

{
  "telegramChatId": "123456789",
  "action": "add" // or "remove"
}

📊 Statistics

GET/api/urls/stats

Get uptime statistics and analytics for all URLs

GET/api/status

Get system-wide status of all LinkGuard services

🏗️Architecture

Frontend

  • • Next.js 14+ with App Router
  • • React 18 with TypeScript
  • • Tailwind CSS for styling
  • • NextAuth.js for authentication
  • • Client-side routing and SSR

Backend

  • • Next.js API Routes
  • • Prisma ORM with PostgreSQL
  • • Vercel Cron Jobs for monitoring
  • • Telegram Bot API integration
  • • PayPal API for subscriptions

Database Schema

  • • User: accounts, subscriptions, settings
  • • MonitoredUrl: websites to monitor
  • • Check: monitoring results history
  • • Subscription: PayPal payment data
  • • Session/Account: NextAuth tables

External Services

  • • Google OAuth: user authentication
  • • Telegram Bot: notifications
  • • PayPal: subscription billing
  • • Vercel: hosting and deployment
  • • PostgreSQL: database hosting

Data Flow

  1. 1. Authentication: User signs in via Google OAuth through NextAuth.js
  2. 2. URL Management: User adds URLs via dashboard, stored in PostgreSQL
  3. 3. Monitoring: Vercel cron jobs regularly check URLs and store results
  4. 4. Notifications: Status changes trigger Telegram notifications
  5. 5. Analytics: Dashboard displays aggregated monitoring data
  6. 6. Subscriptions: PayPal webhooks update user plan status

🔍Monitoring System

How It Works

1
Scheduled Checks: Vercel cron jobs run every few minutes to check user URLs
2
Health Assessment: Each URL is tested with HTTP HEAD requests and response time measurement
3
Status Determination: URLs are classified as UP, SLOW, or DOWN based on response
4
Notifications: Status changes trigger immediate Telegram notifications

🟢 UP Status

  • • HTTP 2xx status codes
  • • Response time < 3 seconds
  • • No connection errors

🟡 SLOW Status

  • • HTTP 2xx status codes
  • • Response time > 3 seconds
  • • Website accessible but slow

🔴 DOWN Status

  • • HTTP 4xx/5xx status codes
  • • Connection timeouts
  • • DNS resolution failures

Check Intervals

FREE Plan

Daily health checks (24 hour intervals)

PRO Plan

Frequent checks (every 5 minutes)

❓Frequently Asked Questions

How quickly will I be notified of downtime?

FREE users get notifications within 24 hours of downtime. PRO users receive notifications within 5 minutes of any status change.

Can I monitor internal/private websites?

LinkGuard can only monitor publicly accessible websites. Internal networks, localhost, or password-protected sites cannot be monitored.

What happens if I exceed my URL limit?

You'll see an error when trying to add more URLs than your plan allows. Upgrade to PRO for higher limits, or remove some URLs to add new ones.

How do I cancel my PRO subscription?

Go to the Pricing page while logged in and click 'Cancel Subscription'. Your plan will downgrade to FREE at the end of the billing period.

Can I get historical monitoring data?

Yes! All check results are stored and you can view historical uptime statistics and response time trends in your dashboard.

Is my data secure?

Absolutely! We use Google OAuth for authentication, encrypt data in transit, and follow security best practices. We only store URLs and check results - no sensitive data.

Can I monitor APIs or specific endpoints?

Yes! You can monitor any publicly accessible URL, including API endpoints. Just enter the full URL (e.g., https://api.example.com/health).

What if Telegram notifications stop working?

Check that your chat ID is correct and that you haven't blocked the bot. Try removing and re-adding your chat ID in the dashboard.

💬 Still have questions?

We're here to help! LinkGuard is built with community and support in mind. Reach out to us anytime and we'll get back to you as soon as possible.