Update docs and related files

carverauto · Feb 24, 2025 · 50b1372 · 50b1372
1 parent d54607f
commit 50b1372
Show file tree

Hide file tree

Showing 25 changed files with 533 additions and 239 deletions.
diff --git a/.gitignore b/.gitignore
@@ -179,3 +179,9 @@ pkg/cloud/api/web/dist/favicons/
 # Ignore versioned build outputs
 serviceradar-agent_*
 serviceradar-dusk-checker_*
+
+*.rpm
+
+tls/client.csr
+tls/root.csr
+tls/server.csr
diff --git a/docs/docs/getting-started/introduction.md b/docs/docs/getting-started/introduction.md
@@ -1,178 +1,34 @@
 ---
 sidebar_position: 1
-title: Introduction
-description: Get started with ServiceRadar - a distributed network monitoring system
 ---
 
 # Introduction to ServiceRadar
 
-Welcome to ServiceRadar! This guide will help you get started with monitoring your infrastructure, whether you're running a single server or a complex distributed network.
+ServiceRadar is a distributed network monitoring system designed for infrastructure and services in hard-to-reach places or constrained environments.
 
 ## What is ServiceRadar?
 
-ServiceRadar is a distributed network monitoring system designed for infrastructure and services in hard-to-reach places or constrained environments. It provides real-time monitoring of internal services, with cloud-based alerting capabilities to ensure you stay informed even during network or power outages.
+ServiceRadar provides:
+- Real-time monitoring of internal services
+- Cloud-based alerting capabilities
+- Continuous monitoring during network or power outages
+- Distributed architecture for scalability and reliability
 
-:::tip Quick Install
+:::tip What you'll need
 
-```bash
-# On your monitored host:
-curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-agent_1.0.19.deb
-sudo dpkg -i serviceradar-agent_1.0.19.deb
-```
-
-:::
-
-## Key Features
-
-- **Real-time Monitoring**: Monitor systemd services, TCP ports, and custom services
-- **Cloud Integration**: Cloud-based alerting ensures uptime visibility
-- **SNMP Support**: Deep network monitoring with SNMP integration
-- **Network Scanning**: Built-in network sweep capabilities
-- **Secure Design**: Enterprise-grade security with mTLS support
-- **Distributed Architecture**: Scale from single host to complex networks
-
-## System Architecture
-
-ServiceRadar uses a distributed architecture with three main components:
-
-```mermaid
-graph TD
-    subgraph "Monitored Host"
-        A[Agent] --> P1[Process Checker]
-        A --> P2[Port Checker]
-        A --> P3[Custom Checkers]
-    end
-
-    subgraph "Local Network"
-        P[Poller] --> A
-        P --> HTTP[HTTP Checks]
-    end
-    
-    subgraph "Cloud/Internet"
-        P --> CS[Cloud Service]
-        CS --> WH[Webhook Alerts]
-    end
-```
-
-### Components
-
-1. **Agent**
-    - Runs on monitored hosts
-    - Provides service status via gRPC
-    - Supports multiple checker types:
-        - Process monitoring (systemd)
-        - Port checking (TCP)
-        - Custom integrations
-
-2. **Poller**
-    - Coordinates monitoring activities
-    - Runs anywhere in your network
-    - Polls agents at configurable intervals
-    - Reports to cloud service
-    - Multiple pollers supported
-
-3. **Cloud Service**
-    - Receives poller reports
-    - Provides web dashboard
-    - Sends webhook alerts
-    - Runs on reliable external host
-
-## Prerequisites
-
-Before you begin, ensure you have:
-
-- A Linux-based system (Ubuntu/Debian recommended)
+- Linux-based system (Ubuntu/Debian recommended)
 - Root or sudo access
-- Basic understanding of:
-    - Linux system administration
-    - Network services
-    - Basic security concepts
-
-:::note System Requirements
-
-- **Agent**: 256MB RAM, 1 CPU core
-- **Poller**: 512MB RAM, 2 CPU cores
-- **Cloud Service**: 1GB RAM, 2 CPU cores
+- Basic understanding of network services
+- Target services to monitor
 
 :::
 
-## Quick Start
-
-Follow these steps to get started:
-
-1. **Install the Agent**
-   ```bash
-   curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-agent_1.0.19.deb
-   sudo dpkg -i serviceradar-agent_1.0.19.deb
-   ```
-
-2. **Install the Poller**
-   ```bash
-   curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-poller_1.0.19.deb
-   sudo dpkg -i serviceradar-poller_1.0.19.deb
-   ```
+## Quick Start Guide
 
-3. **Install the Cloud Service**
-   ```bash
-   curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-cloud_1.0.19.deb
-   sudo dpkg -i serviceradar-cloud_1.0.19.deb
-   ```
+Get started with ServiceRadar in minutes:
 
-:::caution Before Production Use
-
-Always configure security settings and update default passwords before exposing services to the network.
-
-:::
-
-## Optional Components
-
-ServiceRadar offers additional components for specific monitoring needs:
-
-### SNMP Monitoring
+1. Install the agent:
 ```bash
-curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-snmp-checker_1.0.19.deb
-sudo dpkg -i serviceradar-snmp-checker_1.0.19.deb
-```
-
-### Dusk Node Monitoring
-```bash
-curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-dusk-checker_1.0.19.deb
-sudo dpkg -i serviceradar-dusk-checker_1.0.19.deb
+curl -LO https://github.com/mfreeman451/serviceradar/releases/download/1.0.19/serviceradar-agent_1.0.19.deb
+sudo dpkg -i serviceradar-agent_1.0.19.deb
 ```
-
-## Web Interface
-
-After installation, access the web interface at `http://cloud-host:8090` to view:
-
-- Overall system status
-- Individual node status
-- Service health metrics
-- Historical availability data
-- Alert configurations
-
-![ServiceRadar Dashboard](https://github.com/user-attachments/assets/4d886335-2a22-4559-9487-d96af47b6656)
-
-## Next Steps
-
-- [Detailed Installation Guide](installation.md)
-- [Basic Configuration](configuration.md)
-- [Security Setup](../security/overview.md)
-- [SNMP Configuration](../features/snmp-monitoring.md)
-
-## Getting Help
-
-If you run into issues:
-
-1. Check the [Troubleshooting Guide](../troubleshooting/common-issues.md)
-2. Review [Known Issues](../troubleshooting/known-issues.md)
-3. Join our [Community Forum](https://forum.serviceradar.io)
-
-## Contributing
-
-ServiceRadar is open source and contributions are welcome! Check our [Contributing Guide](../contributing/guidelines.md) to get started.
-
-## Project Status
-
-[![Release](https://github.com/mfreeman451/serviceradar/actions/workflows/release.yml/badge.svg)](https://github.com/mfreeman451/serviceradar/actions/workflows/release.yml)
-[![Tests](https://github.com/mfreeman451/serviceradar/actions/workflows/tests.yml/badge.svg)](https://github.com/mfreeman451/serviceradar/actions/workflows/tests.yml)
-[![Coverage](https://github.com/mfreeman451/serviceradar/actions/workflows/go-coverage.yml/badge.svg)](https://github.com/mfreeman451/serviceradar/actions/workflows/go-coverage.yml)
diff --git a/docs/docusaurus.config.ts b/docs/docusaurus.config.ts
@@ -5,20 +5,20 @@ import type * as Preset from '@docusaurus/preset-classic';
 // This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
 
 const config: Config = {
-  title: 'My Site',
-  tagline: 'Dinosaurs are cool',
+  title: 'ServiceRadar',
+  tagline: 'ServiceRadar Docs',
   favicon: 'img/favicon.ico',
 
   // Set the production url of your site here
-  url: 'https://your-docusaurus-site.example.com',
+  url: 'https://docs.serviceradar.cloud',
   // Set the /<baseUrl>/ pathname under which your site is served
   // For GitHub pages deployment, it is often '/<projectName>/'
   baseUrl: '/',
 
   // GitHub pages deployment config.
   // If you aren't using GitHub pages, you don't need these.
-  organizationName: 'facebook', // Usually your GitHub org/user name.
-  projectName: 'docusaurus', // Usually your repo name.
+  organizationName: 'carverauto', // Usually your GitHub org/user name.
+  projectName: 'serviceradar', // Usually your repo name.
 
   onBrokenLinks: 'throw',
   onBrokenMarkdownLinks: 'warn',
@@ -39,8 +39,8 @@ const config: Config = {
           sidebarPath: './sidebars.ts',
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+          // editUrl:
+          //  'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
         },
         blog: {
           showReadingTime: true,
@@ -50,8 +50,8 @@ const config: Config = {
           },
           // Please change this to your repo.
           // Remove this to remove the "edit this page" links.
-          editUrl:
-            'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
+          // editUrl:
+          //  'https://github.com/facebook/docusaurus/tree/main/packages/create-docusaurus/templates/shared/',
           // Useful options to enforce blogging best practices
           onInlineTags: 'warn',
           onInlineAuthors: 'warn',
@@ -68,9 +68,9 @@ const config: Config = {
     // Replace with your project's social card
     image: 'img/docusaurus-social-card.jpg',
     navbar: {
-      title: 'My Site',
+      title: 'ServiceRadar',
       logo: {
-        alt: 'My Site Logo',
+        alt: 'ServiceRadar logo',
         src: 'img/logo.svg',
       },
       items: [
@@ -82,7 +82,7 @@ const config: Config = {
         },
         {to: '/blog', label: 'Blog', position: 'left'},
         {
-          href: 'https://github.com/facebook/docusaurus',
+          href: 'https://github.com/carverauto/serviceradar',
           label: 'GitHub',
           position: 'right',
         },
@@ -104,16 +104,12 @@ const config: Config = {
           title: 'Community',
           items: [
             {
-              label: 'Stack Overflow',
-              href: 'https://stackoverflow.com/questions/tagged/docusaurus',
+              label: 'GitHub Discussions',
+              href: 'https://github.com/carverauto/serviceradar/discussions',
             },
             {
               label: 'Discord',
-              href: 'https://discordapp.com/invite/docusaurus',
-            },
-            {
-              label: 'X',
-              href: 'https://x.com/docusaurus',
+              href: 'https://discord.gg/dq6qRcmN',
             },
           ],
         },
@@ -126,12 +122,12 @@ const config: Config = {
             },
             {
               label: 'GitHub',
-              href: 'https://github.com/facebook/docusaurus',
+              href: 'https://github.com/carverauto/serviceradar',
             },
           ],
         },
       ],
-      copyright: `Copyright © ${new Date().getFullYear()} My Project, Inc. Built with Docusaurus.`,
+      copyright: `Copyright © ${new Date().getFullYear()} Carver Automation Corporation. Built with Docusaurus.`,
     },
     prism: {
       theme: prismThemes.github,